1/** 2@page fal_enum_ref Falagard XML Enumeration Reference 3 4@section fal_enum_ref_sec_0 Section Contents 5@ref fal_enum_ref_sec_1 <br> 6@ref fal_enum_ref_sec_2 <br> 7@ref fal_enum_ref_sec_3 <br> 8@ref fal_enum_ref_sec_4 <br> 9@ref fal_enum_ref_sec_5 <br> 10@ref fal_enum_ref_sec_6 <br> 11@ref fal_enum_ref_sec_7 <br> 12@ref fal_enum_ref_sec_8 <br> 13@ref fal_enum_ref_sec_9 <br> 14@ref fal_enum_ref_sec_10 <br> 15@ref fal_enum_ref_sec_11 <br> 16@ref fal_enum_ref_sec_12 <br> 17 18 19@section fal_enum_ref_sec_1 DimensionOperator Enumeration 20@arg @c "Noop" does nothing. 21@arg @c "Add" Adds two dimensions. 22@arg @c "Subtract" Subtracts two dimensions. 23@arg @c "Multiply" Multiplies two dimensions. 24@arg @c "Divide" Divides two dimensions. 25 26@section fal_enum_ref_sec_2 DimensionType Enumeration 27@arg @c "LeftEdge" specifies the left edge of the target item. 28@arg @c "TopEdge" specifies the top edge of the target item. 29@arg @c "RightEdge" specifies the right edge of the target item. 30@arg @c "BottomEdge" specifies the bottom edge of the target item. 31@arg @c "XPosition" specifies the x position co-ordinate of the target item (same as ?LeftEdge?). 32@arg @c "YPosition" specifies the y position co-ordinate of the target item (same as ?TopEdge?). 33@arg @c "Width" specifies the width of the target item. 34@arg @c "Height" specifies the height of the target item. 35@arg @c "XOffset" specifies the x offset of the target item (only applies to Images). 36@arg @c "YOffset" specifies the y offset of the target item (only applies to Images). 37 38@section fal_enum_ref_sec_3 FontMetricType Enumeration 39@arg @c "LineSpacing" gets the vertical line spacing value of the font. 40@arg @c "Baseline" get the vertical baseline value of the font. 41@arg @c "HorzExtent" gets the horizontal extent of a string of text. 42 43@section fal_enum_ref_sec_4 FrameImageComponent Enumeration 44@arg @c "TopLeftCorner" specifies the image be used for the frame's top-left corner. 45@arg @c "TopRightCorner" specifies the image be used for the frame's top-right corner. 46@arg @c "BottomLeftCorner" specifies the image be used for the frame's bottom-left corner. 47@arg @c "BottomRightCorner" specifies the image be used for the frame's bottom-right corner. 48@arg @c "LeftEdge" specifies the image be used for the frame' left edge. 49@arg @c "RightEdge" specifies the image be used for the frame's right edge. 50@arg @c "TopEdge" specifies the image be used for the frame's top edge. 51@arg @c "BottomEdge" specifies the image be used for the frame bottom edge. 52@arg @c "Background" specifies the image be used for the frame's background (area formed within all edges). 53 54@section fal_enum_ref_sec_5 HorizontalAlignment Enumeration 55@arg @c "LeftAligned" x position is an offset of element's left edges. 56@arg @c "CentreAligned" x position is an offset of element's horizontal centre points. 57@arg @c "RightAligned" x position is an offset of element's right edges. 58 59@section fal_enum_ref_sec_6 HorizontalFormat Enumeration 60@arg @c "LeftAligned" Image is left aligned within the prescribed area. 61@arg @c "CentreAligned" Image is horizontally centred within the prescribed area. 62@arg @c "RightAligned" Image is right aligned within the prescribed area. 63@arg @c "Stretched" Image is horizontally stretched to fill the prescribed area. 64@arg @c "Tiled" Image is horizontally tiled to fill the prescribed area. 65 66@section fal_enum_ref_sec_7 HorizontalTextFormat Enumeration 67@arg @c "LeftAligned" lines of text are left aligned within the prescribed area. 68@arg @c "CentreAligned" lines of text are horizontally centred within the prescribed area. 69@arg @c "RightAligned" lines of text are right aligned within the prescribed area. 70@arg @c "Justified" lines of text are justified to the prescribed area. 71@arg @c "WordWrapLeftAligned" text wraps, with lines left aligned within the prescribed area. 72@arg @c "WordWrapCentreAligned" text wraps, with lines horizontally centred in the prescribed area. 73@arg @c "WordWrapRightAligned" text wraps, with lines right aligned within the prescribed area. 74@arg @c "WordWrapJustified" text wraps, within lines justified to the prescribed area. 75 76@section fal_enum_ref_sec_8 PropertyType Enumeration 77@arg @c "Generic" specifies a general purpose property (accessed as CEGUI::String). 78@arg @c "Colour" specifies a property that accesses a single CEGUI::Colour value. 79@arg @c "ColourRect" specifies a property that accesses a CEGUI::ColourRect value. 80@arg @c "UBox" specifies a property that accesses a CEGUI::UBox value. 81@arg @c "URect" specifies a property that accesses a CEGUI::URect value. 82@arg @c "USize" specifies a property that accesses a CEGUI::USize value. 83@arg @c "UDim" specifies a property that accesses a CEGUI::UDim value. 84@arg @c "UVector2" specifies a property that accesses a CEGUI::UVector2 value. 85@arg @c "Sizef" specifies a property that accesses a CEGUI::Sizef value. 86@arg @c "Vector2f" specifies a property that accesses a CEGUI::Vector2f value. 87@arg @c "Vector3f" specifies a property that accesses a CEGUI::Vector3f value. 88@arg @c "Rectf" specifies a property that accesses a CEGUI::Rectf value. 89@arg @c "Font" specifies a property that accesses a font via its name string. 90@arg @c "Image" specifies a property that accesses an image via its name string. 91@arg @c "Quaternion" specifies a property that accesses a CEGUI::Quaternion value. 92@arg @c "AspectMode" specifies a property that accesses a CEGUI::AspectMode value. 93@arg @c "HorizontalAlignment" specifies a property that accesses a CEGUI::HorizontalAlignment enumerated value. 94@arg @c "VerticalAlignment" specifies a property that accesses a CEGUI::VerticalAlignment enumerated value. 95@arg @c "HorizontalTextFormatting" specifies a property that accesses a CEGUI::HorizontalTextFormatting enumerated value. 96@arg @c "VerticalTextFormatting" specifies a property that accesses a CEGUI::VerticalTextFormatting enumerated value. 97@arg @c "WindowUpdateMode" specifies a property that accesses a CEGUI::WindowUpdateMode enumerated value. 98@arg @c "bool" specifies a property that accesses a simple boolean value. 99@arg @c "uint" specifies a property that accesses a simple unsigned integer value. 100@arg @c "unsigned long" specifies a property that accesses a simple unsigned long value. 101@arg @c "int" specifies a property that accesses a simple signed integer value. 102@arg @c "float" specifies a property that accesses a simple single precision floating point value. 103@arg @c "double" specifies a property that accesses a simple double precision floating point value. 104@arg @c "TabControl::TabPanePosition" specifies a property that accesses a CEGUI::TabControl::TabPanePosition enumerated value. 105@arg @c "Spinner::TextInputMode" specifies a property that accesses a CEGUI::Spinner::TextInputMode enumerated value. 106@arg @c "ItemListBase::SortMode" specifies a property that accesses a CEGUI::ItemListBase::SortDirection enumerated value. 107@arg @c "ListHeaderSegment::SortDirection" specifies a property that accesses a CEGUI::ListHeaderSegment::SortDirection enumerated value. 108@arg @c "MultiColumnList::SelectionMode" specifies a property that accesses a CEGUI::MultiColumnList::SelectionMode enumerated value. 109@arg @c "String" specifies a property that accesses a CEGUI::String value. 110@arg @c "VertFormatting" specifies a property that accesses a CEGUI::VertFormatting enumerated value. 111@arg @c "HorzFormatting" specifies a property that accesses a CEGUI::HorzFormatting enumerated value. 112 113@section fal_enum_ref_sec_9 VerticalAlignment Enumeration 114@arg @c "TopAligned" y position is an offset of element's top edges. 115@arg @c "CentreAligned" y position is an offset of element's vertical centre points. 116@arg @c "BottomAligned" y position is an offset of element's bottom edges. 117 118@section fal_enum_ref_sec_10 VerticalFormat Enumeration 119@arg @c "TopAligned" Image is aligned with the top of the prescribed area. 120@arg @c "CentreAligned" Image is vertically centred within the prescribed area. 121@arg @c "BottomAligned" Image is aligned with the bottom of the prescribed area. 122@arg @c "Stretched" Image is vertically stretched to fill the prescribed area. 123@arg @c "Tiled" Image is vertically tiled to fill the prescribed area. 124 125@section fal_enum_ref_sec_11 VerticalTextFormat Enumeration 126@arg @c "TopAligned" Text line block is aligned with the top of the prescribed area. 127@arg @c "CentreAligned" Text line block is vertically centred within the prescribed area. 128@arg @c "BottomAligned" Text line block is aligned with the bottom of the prescribed area. 129 130@section fal_enum_ref_sec_12 ChildEventAction Enumeration 131@arg @c "Redraw" When the event is fired on the child widget, the containing 132widget will be redrawn (non-recursive). 133@arg @c "Layout" When the event is fired on the child widget, the containing 134widget will re-layout its child widget content. 135 136*/ 137