CaveStoryDialogBoxInfo Class Reference

Custom draw GUI element. More...

#include <CSMAPI_types.h>

Inheritance diagram for CaveStoryDialogBoxInfo:

Public Member Functions
	CaveStoryDialogBoxInfo ()
	Default constructor.
	~CaveStoryDialogBoxInfo ()
	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 GUI_RECT	getContentArea (int iMargin=0)
	Get the content area for this object. 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 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 GuiBase *	getHoverable (int index)
	Get a hoverable sub-element. More...
virtual GuiBase *	getSelectable (int index)
	Get a selectable sub-element. More...
virtual bool	SelectOnMouseUp ()
	Select on mouse up. More...
virtual void	setFont (FontObject *pFont)
	Set the font for this GUI 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	m_FillColor
GUI_COLOR	m_BorderColor
GUI_RECT	m_ContentRect
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'.

Static Protected Attributes
static GUI_RECT	m_TileRect

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.

Detailed Description

Custom draw GUI element.

Member Function Documentation

calculate()

virtual void CaveStoryDialogBoxInfo::calculate ( )

virtual

Re-calculate this element's data.

Warning

You should ALWAYS call this at least once BEFORE you call render()!

Implements GuiBase.

getClassName()

virtual const char* CaveStoryDialogBoxInfo::getClassName ( )

inlinevirtual

Get this class' name.

Returns

Should return the name of this class.

Reimplemented from GuiBase.

getContentArea()

virtual GUI_RECT CaveStoryDialogBoxInfo::getContentArea ( int  iMargin = 0 )

virtual

Get the content area for this object.

Parameters

iMargin

The margin amount.

Returns

Returns the content area.

isHoverable()

virtual bool CaveStoryDialogBoxInfo::isHoverable ( )

virtual

Check hoverability status.

Returns

Returns true if this element can be hovered over.

Implements GuiBase.

isHovered()

virtual bool CaveStoryDialogBoxInfo::isHovered ( )

virtual

Check hover status.

Returns

Returns true if this element is being hovered over.

Implements GuiBase.

isSelected()

virtual bool CaveStoryDialogBoxInfo::isSelected ( )

virtual

Check selection status.

Returns

Returns true if this element is selected.

Implements GuiBase.

process()

virtual int CaveStoryDialogBoxInfo::process ( GUI_POINT  mouse )

virtual

Process mouse input for this element.

Returns

Returns ProcessReturnType flags.

See also

ProcessReturnType

Implements GuiBase.

setHovered()

virtual void CaveStoryDialogBoxInfo::setHovered ( int  value )

virtual

Set this GUI element as hovered over or not.

Parameters

value

The hover value.

Implements GuiBase.

setSelected()

virtual void CaveStoryDialogBoxInfo::setSelected ( int  value )

virtual

Set this GUI element as selected or not.

Parameters

value

The selection value.

Implements GuiBase.

---

The documentation for this class was generated from the following file:

• H:/dev/Cave-Story-Engine-2-CSE2E-v1.2/src/Mod/CSMAPI_types.h