Show a text input box. More...

#include <CSMAPI_types.h>

Inheritance diagram for KeyInputInfo:

Public Types
enum	CANCEL_KEY_TYPE { ENTER , ESCAPE , MOUSE_BUTTON }
	Cancel key types. More...

typedef bool(*	ValidateKeyInputCallbackFunc) (KeyInputInfo *pKeyInput, int iKeyValue)
	Func callback for validating input. More...

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.

Public Member Functions
	KeyInputInfo ()
	Default constructor.

	~KeyInputInfo ()
	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...

void	setValue (int iScancode, bool bUseCallback=true)
	Set the value of the keyinput. More...

int	getValue ()
	Get the value of the keyinputinfo. More...

virtual void	setFont (FontObject *pFont)
	Set the font for this element. More...

virtual FontObject *	getFont ()
	Get the font for this GUI element. More...

void	updateDisplayText ()
	Update the display text for this control.

void	startInput ()
	Set this inputbox as 'focused', and start inputting text.

void	stopInput (bool bSaveValue=true)
	Stop inputting text. More...

virtual int	processKeys ()
	Process key input for this element. 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 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
int *	m_PtrKeyValue
	Pointer key value.

ValidateKeyInputCallbackFunc	ValidateInput
	Called when text is finalized (by pressing enter, cancel or clicking outside of the input box). More...

CANCEL_KEY_TYPE	mCancelKey
	Which cancel key was pressed to lose focus.

bool	is_disabled
	Is disabled.

int	margin
	Text margin.

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'.

Additional Inherited Members
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

Show a text input box.

Member Typedef Documentation

◆ ValidateKeyInputCallbackFunc

typedef bool(* KeyInputInfo::ValidateKeyInputCallbackFunc) (KeyInputInfo *pKeyInput, int iKeyValue)

Func callback for validating input.

Parameters

pKeyInput	The GUI element.
iKeyValue	The key the user entered. This is an SDL_Scancode value.

Returns: Returns true if the value should be used, false otherwise.

Member Enumeration Documentation

◆ CANCEL_KEY_TYPE

enum KeyInputInfo::CANCEL_KEY_TYPE

Cancel key types.

Enumerator
ENTER	Enter button todo: Make pressing enter call a callback.
ESCAPE	Escape button.
MOUSE_BUTTON	Mouse button (clicked outside of the input box)

Member Function Documentation

◆ calculate()

virtual void KeyInputInfo::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* KeyInputInfo::getClassName ( )

inlinevirtual

Get this class' name.

Returns: Should return the name of this class.

Reimplemented from GuiBase.

◆ getFont()

virtual FontObject* KeyInputInfo::getFont ( )

inlinevirtual

Get the font for this GUI element.

Returns: Returns the font object for this element.

Reimplemented from GuiBase.

◆ getHoverableCount()

virtual int KeyInputInfo::getHoverableCount ( )

inlinevirtual

Get the number of elements that can be hovered over in this element.

Returns: Returns the amount of elements that can be hovered over in this element.

Reimplemented from GuiBase.

◆ getSelectableCount()

virtual int KeyInputInfo::getSelectableCount ( )

inlinevirtual

Get the selectable number of elements in this element.

Returns: Returns the amount of selectable elements in this element.

Reimplemented from GuiBase.

◆ getValue()

int KeyInputInfo::getValue ( )

Get the value of the keyinputinfo.

Returns: Returns the current key.

◆ isHoverable()

virtual bool KeyInputInfo::isHoverable ( )

virtual

Check hoverability status.

Returns: Returns true if this element can be hovered over.

Implements GuiBase.

◆ isHovered()

virtual bool KeyInputInfo::isHovered ( )

virtual

Check hover status.

Returns: Returns true if this element is being hovered over.

Implements GuiBase.

◆ isSelected()

virtual bool KeyInputInfo::isSelected ( )

virtual

Check selection status.

Returns: Returns true if this element is selected.

Implements GuiBase.

◆ process()

virtual int KeyInputInfo::process ( GUI_POINT mouse )

virtual

Process mouse input for this element.

Returns: Returns ProcessReturnType flags.

See also: ProcessReturnType

Implements GuiBase.

◆ processKeys()

virtual int KeyInputInfo::processKeys ( )

virtual

Process key input for this element.

Returns: Returns ProcessReturnType flags.

See also: ProcessReturnType

Reimplemented from GuiBase.

◆ SelectOnMouseUp()

virtual bool KeyInputInfo::SelectOnMouseUp ( )

inlinevirtual

Select on mouse up.

Returns: Return false if you want this element to be selected on mousedown instead of mouseup

Reimplemented from GuiBase.

◆ setFont()

virtual void KeyInputInfo::setFont ( FontObject * pFont )

virtual

Set the font for this element.

Parameters

pFont The font to use.

Reimplemented from GuiBase.

◆ setHovered()

virtual void KeyInputInfo::setHovered ( int value )

virtual

Set this GUI element as hovered over or not.

Parameters

value The hover value.

Implements GuiBase.

◆ setSelected()

virtual void KeyInputInfo::setSelected ( int value )

virtual

Set this GUI element as selected or not.

Parameters

value The selection value.

Implements GuiBase.

◆ setValue()

void KeyInputInfo::setValue	(	int	iScancode,
		bool	bUseCallback = `true`
	)

Set the value of the keyinput.

Parameters

iScancode	The SDL_Scancode to use.
bUseCallback	Use the OnValueChange callback.
value	The new value.

◆ stopInput()

void KeyInputInfo::stopInput ( bool bSaveValue = true )

Stop inputting text.

Parameters

bSaveValue Save the value.

Member Data Documentation

◆ ValidateInput

ValidateKeyInputCallbackFunc KeyInputInfo::ValidateInput

Called when text is finalized (by pressing enter, cancel or clicking outside of the input box).

Should validate the text. Can be NULL.

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

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ValidateKeyInputCallbackFunc

Member Enumeration Documentation

◆ CANCEL_KEY_TYPE

Member Function Documentation

◆ calculate()

◆ getClassName()

◆ getFont()

◆ getHoverableCount()

◆ getSelectableCount()

◆ getValue()

◆ isHoverable()

◆ isHovered()

◆ isSelected()

◆ process()

◆ processKeys()

◆ SelectOnMouseUp()

◆ setFont()

◆ setHovered()

◆ setSelected()

◆ setValue()

◆ stopInput()

Member Data Documentation

◆ ValidateInput