 MezzanineEngine March 18, 2012 |
Mezzanine::UI Namespace Reference
This namespace is for all the classes belonging to the Graphical User Interface Subsystem. More...
Classes | |
| class | AtlasAndPosition |
| This class stores how the calls to Render are to be done. More... | |
| class | BasicRenderable |
| class | Button |
| This class is a helper class, specifically for use as a button. More... | |
| class | ButtonCallback |
| This class provides customizable functionality to the button class. More... | |
| class | Caption |
| This class is a helper class, specifically for use with text. More... | |
| class | Cell |
| This class is a base class to be used with the CellGrid class. More... | |
| class | CellCallback |
| This class provides customizable functionality to the button class. More... | |
| class | CellGrid |
| This is a widget used to determine spacing and ordering of other widgets(Cells) on a grid like surface. More... | |
| struct | CellPrioritySorter |
| This is a widget used to determine spacing and ordering of other widgets(Cells) on a grid like surface. More... | |
| class | Character |
| This class creates and encapsultes a character that can be used in a Word. More... | |
| class | CheckBox |
| This is a simple widget for storing a bool value. More... | |
| class | DropDownList |
| A widget that displays one selection from a list that can have it's visibility toggled. More... | |
| class | Glyph |
| Class used to describe a single glyph or character available for text operations. More... | |
| class | GlyphData |
| Class used to describe a single glyph or character available for text operations. More... | |
| class | IndexData |
| This is a basic class for storing data relating to a specific zorder in the UI. More... | |
| class | InputCaptureData |
| This class contains all the utilities necessary for capturing input. More... | |
| struct | KerningInfo |
| Basic class used to describe Kerning for a given Glyph. More... | |
| class | Layer |
| This class is the basic container class for UI elements. More... | |
| class | LineList |
| This is an object comprised of a series of lines. More... | |
| class | ListBox |
| This is a widget for displaying a list of captions in a box. More... | |
| class | MarkupText |
| This is a helper class for use with specialized text display. More... | |
| class | Menu |
| This class is a control mechanism for multiple windows in a heirarchy. More... | |
| class | MenuWindow |
| This class is an extended version of the window class for use exclusively with the menu widget. More... | |
| struct | OgreVertex |
| class | PagedCellGrid |
| This is a specialization of the cell grid that allows you to use a spinner to navigate through pages of cells on the grid. More... | |
| class | RadioButton |
| This is a simple widget where only one of it's selections can be selected at a time. More... | |
| class | Rectangle |
| This class is a helper class, specifically for use with background sprites and colours. More... | |
| class | RenderableContainerWidget |
| This is an abstract class for the creation and storage of widgets to be used by other classes. More... | |
| class | RenderableRect |
| This class contains all the utilities necessary for capturing input. More... | |
| class | RenderableSetData |
| This is a helper class for the storage of Renderable Set's in a Tabset. More... | |
| struct | ResizingInfo |
| This is a helper struct for use in resizing UI containers. More... | |
| class | Screen |
| This class is a helper class for creating UI's. It is responsible for storing and keeping track of all the elements of a single UI screen. More... | |
| struct | ScreenInternalData |
| Basic struct holding some of the internal bits of this class that could not be placed on the class directly. More... | |
| class | ScreenVertexData |
| This class stores all vertices pertaining to a layer sorted by their priority for rendering. More... | |
| class | Scrollbar |
| This class is a widget class, to be used alongside any scrollable widget. More... | |
| class | ScrolledCellGrid |
| This is a specialization of the cell grid that allows you to use scrollbars to navigate the cells on the grid. More... | |
| class | Spinner |
| This is a simple widget for a numeric variable in a box. More... | |
| struct | Sprite |
| Basic class used to describe a portion of a texture to be applied to a Quad. More... | |
| class | TabSet |
| This is a widget that stores sets of renderables but only displays one at a time. More... | |
| struct | TemplateParams |
| class | TextButton |
| This is a button class that provides text capabilities. More... | |
| class | TextureAtlas |
| struct | TextureAtlasInternalData |
| struct | Vertex |
| Basic class describing a vertex in the UI to be rendered. More... | |
| struct | VertexData |
| Basic class describing a vertex in the UI to be rendered. More... | |
| class | ViewportUpdateTool |
| This class facilitates the resizing and repositioning of all renderables in the UI system during a viewport update. More... | |
| class | Widget |
| This class is the base class for all widgets. More... | |
| class | WidgetCallback |
| This is a callback class for widgets. More... | |
| class | Window |
| This is a container widget capable of holding any other widget. More... | |
| class | Word |
| This class creates and encapsultes the concept of a word in a MarkupText. More... | |
Typedefs | |
| typedef ResizingInfo< Button * > | OffsetButtonInfo |
| typedef ResizingInfo< Caption * > | OffsetCaptionInfo |
|
typedef ResizingInfo < MarkupText * > | OffsetMarkupTextInfo |
| typedef ResizingInfo< Rectangle * > | OffsetRectangleInfo |
| typedef ResizingInfo< Widget * > | OffsetWidgetInfo |
|
typedef class RenderableContainerWidget | RenderableCollection |
|
typedef std::pair< Vector2, Vector2 > | WidgetResult |
Enumerations | |
| enum | ActivationCondition { AC_OnPress = 0, AC_OnLift = 1 } |
Used primarily by UI buttons to decide how/when a button is activated. More... | |
| enum | Border { Border_North = 0, Border_South = 1, Border_East = 2, Border_West = 3 } |
Used by various basic renderables for border effects. More... | |
| enum | Gradient { Gradient_NorthSouth = 0, Gradient_WestEast = 1, Gradient_Diagonal_1 = 2, Gradient_Diagonal_2 = 3 } |
Used by various basic renderables for applying a gradient effect to a colour or texture on a quad. More... | |
| enum | QuadCorner { QC_TopLeft = 0, QC_TopRight = 1, QC_BottomRight = 2, QC_BottomLeft = 3 } |
Used by Sprites and Glyphs for tracking their placement on a TextureAtlas. More... | |
| enum | RenderPriority { RP_Low, RP_Medium, RP_High } |
Used by UI elements created by layers to determine z-ordering within a layer. More... | |
| enum | ResizeableAnchor { RA_AnchorTopLeft, RA_AnchorTop, RA_AnchorTopRight, RA_AnchorLeft, RA_AnchorMiddle, RA_AnchorRight, RA_AnchorBottomLeft, RA_AnchorBottom, RA_AnchorBottomRight } |
Used by UI container classes to determine their movement behavior when the container is resized. More... | |
| enum | ResizeableTether { RT_TetherBoth, RT_TetherNone, RT_TetherHorizontal, RT_TetherVertical } |
Used by UI container classes to determine their resize behavior when the container is resized. More... | |
| enum | ScrollbarStyle { SB_NoButtons, SB_Separate, SB_TogetherUpLeft, SB_TogetherDownRight } |
Used by the scrollbar class to determine what styling should be used for the scrollbar. More... | |
| enum | SpinnerStyle { Spn_Separate, Spn_Together_Left, Spn_Together_Right } |
Used by the spinner class to determine what styling should be used for the spinner. More... | |
| enum | TextHorizontalAlign { Txt_Left, Txt_Right, Txt_Middle } |
Used by UI classes to determine the placement of text within a given area. More... | |
| enum | TextVerticalAlign { Txt_Top, Txt_Bottom, Txt_Center } |
Used by UI classes to determine the placement of text within a given area. More... | |
Detailed Description
This namespace is for all the classes belonging to the Graphical User Interface Subsystem.
Our GUI subsystem is based on a heavily modified/forked version of Gorilla, and as such uses a similiar structure of classes and layout for it's config files(e.g. .mta files).
Enumeration Type Documentation
Used primarily by UI buttons to decide how/when a button is activated.
Essentially used to decide if a button should activate when it's activation button is pressed or lifted.
Definition at line 54 of file uienumerations.h.
Used by various basic renderables for border effects.
Internally border information is stored in small arrays, and this facilitates the proper index being called every time.
Definition at line 62 of file uienumerations.h.
Used by various basic renderables for applying a gradient effect to a colour or texture on a quad.
Details regarding the colour or texture depends on the individual settings of the renderable the gradient is being applied to. Gradients simply allow one colour on one portion of a quad to fade into another.
Definition at line 73 of file uienumerations.h.
Used by Sprites and Glyphs for tracking their placement on a TextureAtlas.
This helps to ensure the proper indexs are accessed at all times when getting UV information.
Definition at line 83 of file uienumerations.h.
Used by UI elements created by layers to determine z-ordering within a layer.
This essentially means we're adding layers to our layers without the messy and un-intuitive re-coding necessary to actually accomplish that.
Definition at line 94 of file uienumerations.h.
Used by UI container classes to determine their movement behavior when the container is resized.
RA_AnchorTop means it stays in the same position if given a resize event relative to the top. RA_AnchorBottom means the same as RA_AnchorTop but for the bottom of the container. RA_AnchorMiddle means it'll change position by half of the pixels that the container was resized.
Definition at line 105 of file uienumerations.h.
Used by UI container classes to determine their resize behavior when the container is resized.
RT_TetherHorizontal means it will resize itself equally during any Horizontal resizing of the container. RT_TetherVertical means the same as RT_TetherHorizontal, but for Vertical resizes. RT_TetherBoth means it'll do both.
Definition at line 121 of file uienumerations.h.
Used by the scrollbar class to determine what styling should be used for the scrollbar.
These values are mostly self explanitory, the scrollbar class documentation has more details.
Definition at line 131 of file uienumerations.h.
Used by the spinner class to determine what styling should be used for the spinner.
In the case of the buttons being together, the increment button will be above the decrement button.
Definition at line 141 of file uienumerations.h.
Generated on Sun Mar 18 2012 16:55:01 for MezzanineEngine by
1.7.3