GuiGameListMenuProfile
Engine/source/gui/controls/guiGameListMenuCtrl.h
A gui profile with additional fields specific to GuiGameListMenuCtrl.
Public Types
_Anonymous_ { TEX_NORMAL = 0 TEX_SELECTED = 1 TEX_HIGHLIGHT = 2 TEX_DISABLED = 3 TEX_L_ARROW_OFF = 4 TEX_L_ARROW_ON = 5 TEX_R_ARROW_OFF = 6 TEX_R_ARROW_ON = 7 TEX_FIRST_ARROW = 4 TEX_FIRST_ICON = 8 }
Private Types
Parent
Public Attributes
Absolute position of the split between columns.
Offset for the lower right corner of the hit area.
Offset for the upper left corner of the hit area.
Offset for a row's extra icon.
Public Functions
Enforces range constraints on all required fields.
Gets the extent of arrows for this profile.
Gets the extent of the defined hit area for this profile.
Gets the extent of icons for this profile.
Get the height of rows in this profile.
Row scale is the ratio between the defined row size and the raw size of the bitmap.
Get the width of rows in this profile.
bool
Determines if this profile has textures for the left and right arrows.
bool
onAdd()
Callback when the object is registered with the sim.
Public Static Functions
Initializes fields accessible through the console.
Detailed Description
A gui profile with additional fields specific to GuiGameListMenuCtrl.
Public Types
@97
Enumerator
- TEX_NORMAL = 0
texture index for a normal, unselected row
- TEX_SELECTED = 1
texture index for a selected row
- TEX_HIGHLIGHT = 2
texture index for a highlighted row (moused over, not selected)
- TEX_DISABLED = 3
texture index for a disabled row
- TEX_L_ARROW_OFF = 4
texture index for the left arrow of an unselected row
- TEX_L_ARROW_ON = 5
texture index for the left arrow of a selected row
- TEX_R_ARROW_OFF = 6
texture index for the right arrow of an unselected row
- TEX_R_ARROW_ON = 7
texture index for the right arrow of a selected row
- TEX_FIRST_ARROW = 4
texture index for the first arrow
- TEX_FIRST_ICON = 8
texture index for the first row marker icon
Private Types
typedef GuiControlProfile Parent
Public Attributes
S32 mColumnSplit
Absolute position of the split between columns.
Point2I mHitAreaLowerRight
Offset for the lower right corner of the hit area.
Point2I mHitAreaUpperLeft
Offset for the upper left corner of the hit area.
Point2I mIconOffset
Offset for a row's extra icon.
S32 mRightPad
Extra padding between the right arrow and the hit area.
Point2I mRowSize
The base size of a row.
Private Attributes
Point2F mRowScale
Ratio of row size to actual bitmap size.
Public Functions
GuiGameListMenuProfile()
DECLARE_CONOBJECT(GuiGameListMenuProfile )
enforceConstraints()
Enforces range constraints on all required fields.
Reimplemented by: GuiGameListOptionsProfile
getArrowExtent()
Gets the extent of arrows for this profile.
If there are no arrows you will get a point of (0, 0).
The extent of icons or (0, 0) if there aren't any.
getHitAreaExtent()
Gets the extent of the defined hit area for this profile.
If the hit area is not defined then it defaults to the full size of a row.
The extents of the defined hit area or the full size of the row.
getIconExtent()
Gets the extent of icons for this profile.
If there are no icons you will get a point of (0, 0);
The extent of icons or (0, 0) if there aren't any.
getRowHeight()
Get the height of rows in this profile.
All rows are considered to be the same base height. Rows can have an extra amount of y padding defined when they are added to the control.
The height of rows in this profile.
getRowScale()
Row scale is the ratio between the defined row size and the raw size of the bitmap.
The row scale.
getRowWidth()
Get the width of rows in this profile.
All rows are considered to be the same width.
The width of rows in this profile.
hasArrows()
Determines if this profile has textures for the left and right arrows.
True if the profile's bitmap has textures for the arrows, false otherwise.
onAdd()
Reimplemented from: SimObject