CEGUI
[Implementation Specific]

---

Detailed Description

These interfaces will expose the reasonable functionality of the CEGUI class structure.

Functionality provided here should be considered for making generic, to be provided by other GUI implementations. Should this be reasonable, they will be moved into Common/Interfaces and renamed. Note: Some functionality can not become standardised. Specifically, it should be safe for the CEGUI implementation to assume an object was created by this implementation, and type-cast the Interfaces up to class objects without causing problems.

Data Structures
struct	DigitalSpaces::DICEGUIWindow
	{AAB065FE-7BB6-4db1-A4CB-D1E1A639B69F} More...
struct	DigitalSpaces::DICEGUIFont
struct	DigitalSpaces::DICEGUIImage
struct	DigitalSpaces::DICEGUITooltip
struct	DigitalSpaces::DICEGUIRenderCache
	This DInterface purposely left blank. More...
struct	DigitalSpaces::DICEGUIDragContainer
struct	DigitalSpaces::DICEGUIWindowRenderer
	This DInterface purposely left blank. More...
struct	DigitalSpaces::DICEGUIListboxItem
struct	DigitalSpaces::DICEGUIListHeaderSegment
struct	DigitalSpaces::DICEGUIListbox
struct	DigitalSpaces::DICEGUIMultiColumnList
	{7927AD95-33E2-41e6-9C69-B76CD8F21C46} More...
struct	DigitalSpaces::DICEGUIButton
	{22CB998B-1B54-4c16-9E98-4139C3DFA028} More...
struct	DigitalSpaces::DICEGUIScrollbar
struct	DigitalSpaces::DICEGUIListHeader
struct	DigitalSpaces::DICEGUICheckbox
	{2AEC8629-CED4-46df-976A-99D0F277E423} More...
struct	DigitalSpaces::DICEGUISlider
	{0B65289A-3358-4113-AE2A-FFBF1913A01E} More...
struct	DigitalSpaces::DICEGUIThumb
struct	DigitalSpaces::DICEGUIRadioButton
struct	DigitalSpaces::DICEGUITabButton
struct	DigitalSpaces::DICEGUICombobox
struct	DigitalSpaces::DICEGUIEditbox
struct	DigitalSpaces::DICEGUIFrameWindow
struct	DigitalSpaces::DICEGUIItemEntry
struct	DigitalSpaces::DICEGUIMenuItem
struct	DigitalSpaces::DICEGUIItemListBase
struct	DigitalSpaces::DICEGUIMenuBase
struct	DigitalSpaces::DICEGUIPopupMenu
struct	DigitalSpaces::DICEGUIScrolledItemListBase
struct	DigitalSpaces::DICEGUIItemListbox
struct	DigitalSpaces::DICEGUIComboDropList
struct	DigitalSpaces::DICEGUIMultiLineEditbox
struct	DigitalSpaces::DICEGUIProgressBar
struct	DigitalSpaces::DICEGUIScrollablePane
struct	DigitalSpaces::DICEGUISpinner
struct	DigitalSpaces::DICEGUITabControl
struct	DigitalSpaces::DICEGUITitlebar
struct	DigitalSpaces::DICEGUIImageset
struct	DigitalSpaces::DICEGUI1
Enumerations
enum	DigitalSpaces::CEGUIVerticalAlignment { DigitalSpaces::VA_TOP, DigitalSpaces::VA_CENTRE, DigitalSpaces::VA_BOTTOM }
enum	DigitalSpaces::CEGUIHorizontalAlignment { DigitalSpaces::HA_LEFT, DigitalSpaces::HA_CENTRE, DigitalSpaces::HA_RIGHT }
	Enumerated type used when specifying horizontal alignments. More...
enum	DigitalSpaces::CEGUIMouseCursorImage { DigitalSpaces::BlankMouseCursor = 0, DigitalSpaces::DefaultMouseCursor = -1 }
	Enumeration of special values used for mouse cursor settings in Window objects. More...
enum	DigitalSpaces::CEGUITextFormatting {   DigitalSpaces::LeftAligned, DigitalSpaces::RightAligned, DigitalSpaces::Centred, DigitalSpaces::Justified,   DigitalSpaces::WordWrapLeftAligned, DigitalSpaces::WordWrapRightAligned, DigitalSpaces::WordWrapCentred, DigitalSpaces::WordWrapJustified }
	Enumerated type that contains valid formatting types that can be specified when rendering text into a Rect area (the formatting Rect). More...
enum	DigitalSpaces::CEGUIListHeaderSegmentSortDirection { DigitalSpaces::None, DigitalSpaces::Ascending, DigitalSpaces::Descending }
	Enumeration of possible values for sorting direction used with ListHeaderSegment classes. More...
enum	DigitalSpaces::CEGUIMultiColumnListSelectionMode {   DigitalSpaces::RowSingle, DigitalSpaces::RowMultiple, DigitalSpaces::CellSingle, DigitalSpaces::CellMultiple,   DigitalSpaces::NominatedColumnSingle, DigitalSpaces::NominatedColumnMultiple, DigitalSpaces::ColumnSingle, DigitalSpaces::ColumnMultiple,   DigitalSpaces::NominatedRowSingle, DigitalSpaces::NominatedRowMultiple }
	Enumerated values for the selection modes possible with a Multi-column list. More...
enum	DigitalSpaces::CEGUIItemListBaseSortMode { DigitalSpaces::ItemListBase_Ascending, DigitalSpaces::ItemListBase_Descending, DigitalSpaces::ItemListBase_UserSort }
	Sort modes for ItemListBase Changed the names (Added ItemListBase_) to Distinguish from ListHeaderSegment SortDirection. More...
enum	DigitalSpaces::CEGUITextInputMode { DigitalSpaces::FloatingPoint, DigitalSpaces::Integer, DigitalSpaces::Hexadecimal, DigitalSpaces::Octal }
	Enumerated type specifying possible input and/or display modes for the spinner. More...
enum	DigitalSpaces::CEGUITabPanePosition { DigitalSpaces::Top, DigitalSpaces::Bottom }
Variables
static const DUID	DigitalSpaces::DID_CEGUIListboxItem
	{4B02A99F-5F0D-4da4-99E8-ADFCF085E851}
static const DUID	DigitalSpaces::DID_CEGUIListbox
	{7160BCE5-6754-4450-9E88-BF787F3AC4C1}
static const DUID	DigitalSpaces::DID_CEGUI1
	{755C4D31-8453-4600-94C9-A7E9CDA1D391}

---

Enumeration Type Documentation

enum DigitalSpaces::CEGUIHorizontalAlignment

Enumerated type used when specifying horizontal alignments.

Enumerator:

HA_LEFT	Window's position specifies an offset of it's left edge from the left edge of it's parent.
HA_CENTRE	Window's position specifies an offset of it's horizontal centre from the horizontal centre of it's parent.
HA_RIGHT	Window's position specifies an offset of it's right edge from the right edge of it's parent.

enum DigitalSpaces::CEGUIItemListBaseSortMode

Sort modes for ItemListBase Changed the names (Added ItemListBase_) to Distinguish from ListHeaderSegment SortDirection.

Enumerator:

ItemListBase_Ascending
ItemListBase_Descending
ItemListBase_UserSort

enum DigitalSpaces::CEGUIListHeaderSegmentSortDirection

Enumeration of possible values for sorting direction used with ListHeaderSegment classes.

Enumerator:

None	Items under this segment should not be sorted.
Ascending	Items under this segment should be sorted in ascending order.
Descending	Items under this segment should be sorted in descending order.

enum DigitalSpaces::CEGUIMouseCursorImage

Enumeration of special values used for mouse cursor settings in Window objects.

Enumerator:

BlankMouseCursor	No image should be displayed for the mouse cursor.
DefaultMouseCursor	The default mouse cursor image should be displayed.

enum DigitalSpaces::CEGUIMultiColumnListSelectionMode

Enumerated values for the selection modes possible with a Multi-column list.

Enumerator:

RowSingle
RowMultiple
CellSingle
CellMultiple
NominatedColumnSingle
NominatedColumnMultiple
ColumnSingle
ColumnMultiple
NominatedRowSingle
NominatedRowMultiple

enum DigitalSpaces::CEGUITabPanePosition

Enumerator:

Top
Bottom

enum DigitalSpaces::CEGUITextFormatting

Enumerated type that contains valid formatting types that can be specified when rendering text into a Rect area (the formatting Rect).

Enumerator:

LeftAligned	All text is printed on a single line. The left-most character is aligned with the left edge of the formatting Rect.
RightAligned	All text is printed on a single line. The right-most character is aligned with the right edge of the formatting Rect.
Centred	All text is printed on a single line. The text is centred horizontally in the formatting Rect.
Justified	All text is printed on a single line. The left-most and right-most characters are aligned with the edges of the formatting Rect.
WordWrapLeftAligned	Text is broken into multiple lines no wider than the formatting Rect. The left-most character of each line is aligned with the left edge of the formatting Rect.
WordWrapRightAligned	Text is broken into multiple lines no wider than the formatting Rect. The right-most character of each line is aligned with the right edge of the formatting Rect.
WordWrapCentred	Text is broken into multiple lines no wider than the formatting Rect. Each line is centred horizontally in the formatting Rect.
WordWrapJustified	Text is broken into multiple lines no wider than the formatting Rect. The left-most and right-most characters of each line are aligned with the edges of the formatting Rect.

enum DigitalSpaces::CEGUITextInputMode

Enumerated type specifying possible input and/or display modes for the spinner.

Enumerator:

FloatingPoint	Floating point decimal.
Integer	Integer decimal.
Hexadecimal	Hexadecimal.
Octal	Octal.

enum DigitalSpaces::CEGUIVerticalAlignment

Enumerator:

VA_TOP	Window's position specifies an offset of it's top edge from the top edge of it's parent.
VA_CENTRE	Window's position specifies an offset of it's vertical centre from the vertical centre of it's parent.
VA_BOTTOM	Window's position specifies an offset of it's bottom edge from the bottom edge of it's parent.

---

Variable Documentation

const DUID DigitalSpaces::DID_CEGUI1 [static]

Initial value:

 
        { 0x755c4d31, 0x8453, 0x4600, { 0x94, 0xc9, 0xa7, 0xe9, 0xcd, 0xa1, 0xd3, 0x91 } }

{755C4D31-8453-4600-94C9-A7E9CDA1D391}

This interface reflects the useful functionality of CEGUI::System.

Todo:

Event subscription

See also:

DICEGUI DID_CEGUI1

const DUID DigitalSpaces::DID_CEGUIListbox [static]

Initial value:

 
        { 0x7160bce5, 0x6754, 0x4450, { 0x9e, 0x88, 0xbf, 0x78, 0x7f, 0x3a, 0xc4, 0xc1 } }

{7160BCE5-6754-4450-9E88-BF787F3AC4C1}

const DUID DigitalSpaces::DID_CEGUIListboxItem [static]

Initial value:

 
        { 0x4b02a99f, 0x5f0d, 0x4da4, { 0x99, 0xe8, 0xad, 0xfc, 0xf0, 0x85, 0xe8, 0x51 } }

{4B02A99F-5F0D-4da4-99E8-ADFCF085E851}

See also:

DICEGUIListboxItem DID_CEGUIListboxItem