|
Cavestory Mod API
|
Text. More...
#include <CSMAPI_types.h>
Classes | |
| struct | SEL_LIST_ENTRY |
| Stores info for an entry. More... | |
Public Member Functions | |
| SelectableListInfo () | |
| Default constructor. | |
| ~SelectableListInfo () | |
| Default deconstructor. | |
| virtual const char * | getClassName () |
| Get this class' name. More... | |
| virtual void | setSelected (int value) |
| Set this GUI element as selected or not. More... | |
| virtual void | setHovered (int value) |
| Set this GUI element as hovered over or not. More... | |
| virtual bool | isSelected () |
| Check selection status. More... | |
| virtual bool | isHovered () |
| Check hover status. More... | |
| virtual bool | isHoverable () |
| Check hoverability status. More... | |
| virtual int | getSelectableCount () |
| Get the selectable number of elements in this element. More... | |
| virtual int | getHoverableCount () |
| Get the number of elements that can be hovered over in this element. More... | |
| virtual bool | SelectOnMouseUp () |
| Select on mouse up. More... | |
| virtual void | setFont (FontObject *pFont) |
| Set this element's font. More... | |
| bool | AddEntry (int iSelectionId, const char *pText) |
| Add an entry. More... | |
| void | ClearAllEntries () |
| Clear all entries. | |
| int | GetSelectedEntry () |
| Retrieve the selected entry. More... | |
| GUI_RECT | GetEntryRectById (int iSelectedId, bool bUseScrolled=false) |
| Retrieve an entry's rect. More... | |
| void | SetScrollOffset (int iOffsetX, int iOffsetY) |
| Set the scroll offset for all entries. More... | |
| GUI_POINT | GetContentSze () |
| Get the entire content size. More... | |
| virtual int | process (GUI_POINT mouse) |
| Process mouse input for this element. More... | |
| virtual void | calculate () |
| Re-calculate this element's data. More... | |
| virtual void | render () |
| Render this element. | |
Public Member Functions inherited from GuiBase | |
| GuiBase () | |
| Default constructor. | |
| virtual | ~GuiBase () |
| Default deconstructor. | |
| virtual GuiBase * | getHoverable (int index) |
| Get a hoverable sub-element. More... | |
| virtual GuiBase * | getSelectable (int index) |
| Get a selectable sub-element. More... | |
| virtual FontObject * | getFont () |
| Get the font for this GUI element. More... | |
| virtual int | processKeys () |
| Process key input for this element. More... | |
| virtual void | importantRender () |
| Render the important bits of this element. More... | |
| virtual int | getMagnification () |
| GuiBase (const GuiBase &)=delete | |
| GuiBase & | operator= (const GuiBase &)=delete |
| GuiBase (GuiBase &&)=delete | |
| GuiBase & | operator= (GuiBase &&)=delete |
Public Attributes | |
| GUI_COLOR | mColor_Text_Normal |
| The text color. | |
| GUI_COLOR | mColor_Text_Hover |
| The text color when hovered over. | |
| GUI_COLOR | mColor_Text_Selected |
| The text color when selected. | |
| GUI_COLOR | mColor_BG_Normal |
| The normal background color. | |
| GUI_COLOR | mColor_BG_Hover |
| The hovered background color. | |
| GUI_COLOR | mColor_BG_Selected |
| The selected background color. | |
| int | mMargin |
| Entry margin. | |
| bool | mAllowRightClick |
| Allow right click selection. | |
Public Attributes inherited from GuiBase | |
| GuiBase * | pNext |
| GuiBase * | pPrev |
| OnValueChangeCallbackFunc | OnValueChange |
| Called in specific GuiBase children classes to indicate that a value has been changed. | |
| OnValidateChangeCallbackFunc | OnValidateChange |
| Called in specific GuiBase children classes to indicate that a value has been changed. | |
| GUI_RECT | rect |
| The display rect this GUI element will use. | |
| void * | userData |
| Custom user data. | |
| void * | userData2 |
| Custom user data. | |
| unsigned int | customMagnification |
| The magnification to display this element at. | |
| OnHoverChangeCallbackFunc | OnHoverChange |
| Called in specific GuiBase children classes to indicate that the GUI element is being hovered over. | |
| bool | has_special_mouse_processing |
| Has special mouse processing. | |
| GUI_RECT | hotspot_rect |
| The special hotspot rect. | |
| bool | has_special_hotspot_rect |
| Has special hotspot rect; If true, 'process' will be called everytime the mouse is inside of 'hotspot_rect' instead of 'rect'. | |
Protected Attributes | |
| FontObject * | mFont |
| Font for this element. | |
| List< SEL_LIST_ENTRY * > | mEntries |
| Stores all entries for this element. | |
| int | mScrollX |
| The scroll X offset. | |
| int | mScrollY |
| The scroll Y offset. | |
| int | mHovered |
| The highlighted entry. | |
| int | mSelected |
| The selected entry. | |
| bool | mDirty |
| Our 'dirty' variable. More... | |
| SEL_LIST_ENTRY * | mShownLink |
| A link of shown entries. | |
| GUI_POINT | mContentSize |
| Content size. | |
Additional Inherited Members | |
Public Types inherited from GuiBase | |
| enum | ProcessReturnType { PRT_DIRTY = 0b000001 , PRT_IGNORE_MOUSE = 0b000010 , PRT_IGNORE_KEYS = 0b000100 , PRT_SELECTED = 0b001000 , PRT_DISABLE_MOUSE_ON_MOVE = 0b010000 , PRT_CHANGED = 0b100000 } |
| Return flags for GuiBase::process and GuiBase::processKeys. More... | |
| typedef void(* | OnHoverChangeCallbackFunc) (GuiBase *, int value) |
| Hover callback. | |
| typedef void(* | OnValueChangeCallbackFunc) (GuiBase *, const char *&newValue) |
| Value change callback. | |
| typedef bool(* | OnValidateChangeCallbackFunc) (GuiBase *, const char *oldValue, char *newValue) |
| Validate change callback. | |
Static Public Attributes inherited from GuiBase | |
| static unsigned int | defaultCustomMagnification |
| static GuiBase * | gFirst |
Protected Member Functions inherited from GuiBase | |
| void | Link () |
| Link ourselves to the global GUI element linkage. | |
| void | Unlink () |
| Unlink ourselves from the global GUI element linkage. | |
Text.
| bool SelectableListInfo::AddEntry | ( | int | iSelectionId, |
| const char * | pText | ||
| ) |
Add an entry.
| iSelectionId | The ID for this entry. |
| pText | The text for this entry. |
|
virtual |
|
inlinevirtual |
| GUI_POINT SelectableListInfo::GetContentSze | ( | ) |
Get the entire content size.
| GUI_RECT SelectableListInfo::GetEntryRectById | ( | int | iSelectedId, |
| bool | bUseScrolled = false |
||
| ) |
Retrieve an entry's rect.
|
inlinevirtual |
Get the number of elements that can be hovered over in this element.
Reimplemented from GuiBase.
|
inlinevirtual |
Get the selectable number of elements in this element.
Reimplemented from GuiBase.
| int SelectableListInfo::GetSelectedEntry | ( | ) |
Retrieve the selected entry.
|
virtual |
Check hoverability status.
Implements GuiBase.
|
virtual |
|
virtual |
|
virtual |
Process mouse input for this element.
Implements GuiBase.
|
inlinevirtual |
Select on mouse up.
Reimplemented from GuiBase.
|
inlinevirtual |
|
virtual |
| void SelectableListInfo::SetScrollOffset | ( | int | iOffsetX, |
| int | iOffsetY | ||
| ) |
Set the scroll offset for all entries.
| iOffsetX | The X scroll offset. |
| iOffsetY | The Y scroll offset. |
|
virtual |
|
protected |
Our 'dirty' variable.
If this is true, then we need to re-calculate all entries' rects.