Show a tab selector. More...

#include <CSMAPI_types.h>

Inheritance diagram for TabBookInfo:

Classes
struct	TAB
	Dropdown box item struct. More...

Public Types
typedef void(*	OnTabSelectedFunc) (TabBookInfo *, int)
	OnPressed Callback.

typedef void(*	OnTabCloseFunc) (TabBookInfo *, int)
	OnTabClose Callback.

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
	TabBookInfo ()
	Default constructor.

	~TabBookInfo ()
	Default deconstructor.

virtual const char *	getClassName ()
	Get this class' name. More...

virtual void	setFont (FontObject *pFont)
	Set this element's font. More...

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

void	addTab (const char *pTabText, bool bCanBeClosed=false)
	Add an item to the list. More...

void	clearTabs ()
	Clear all items.

int	getTabCount ()
	Get number of selectable options. More...

TAB *	getTab (int tab)
	Get a tab by index. More...

void	setHoveredOverCloseButton (bool bValue)
	Set whether we've hovered over the close button. More...

bool	getHoveredOverCloseButton ()
	Get whether we've hovered over the close button. 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...

void	setCloseHovered (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...

GUI_RECT	getDrawRect ()
	Get the draw offset for this control. 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 bool	SelectOnMouseUp ()
	Select on mouse up. 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_RECT	mTabContentRect
	Content Rect.

OnTabSelectedFunc	OnTabSelectCallback
	The 'on tab selection' callback.

OnTabCloseFunc	OnTabCloseCallback
	The 'on tab closed' callback.

int	mSelectedTab
	The selected tab.

int	mMargin
	Text margin.

bool	mDrawBorder
	Draw the border color.

bool	mDrawFill
	Draw the fill color.

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 tab selector.

Member Function Documentation

◆ addTab()

void TabBookInfo::addTab	(	const char *	pTabText,
		bool	bCanBeClosed = `false`
	)

Add an item to the list.

Parameters

text	The text of the item.
bCanBeClosed	Whether the new tab can be closed.

◆ calculate()

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

inlinevirtual

Get this class' name.

Returns: Should return the name of this class.

Reimplemented from GuiBase.

◆ getDrawRect()

GUI_RECT TabBookInfo::getDrawRect ( )

inline

Get the draw offset for this control.

Returns: Returns this GUI element's rect + the draw offset for tab content.

◆ getFont()

virtual FontObject* TabBookInfo::getFont ( )

inlinevirtual

Get the font for this GUI element.

Returns: Returns the font object for this element.

Reimplemented from GuiBase.

◆ getHoverableCount()

virtual int TabBookInfo::getHoverableCount ( )

virtual

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.

◆ getHoveredOverCloseButton()

bool TabBookInfo::getHoveredOverCloseButton ( )

inline

Get whether we've hovered over the close button.

Returns: Returns the value.

◆ getSelectableCount()

virtual int TabBookInfo::getSelectableCount ( )

virtual

Get the selectable number of elements in this element.

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

Reimplemented from GuiBase.

◆ getTab()

TAB* TabBookInfo::getTab ( int tab )

Get a tab by index.

Parameters

tab	The tab's index.

Returns: Returns the tab from the given index if it exists, otherwise returns NULL.

◆ getTabCount()

int TabBookInfo::getTabCount ( )

Get number of selectable options.

Returns: Returns number of selectable options.

◆ isHoverable()

virtual bool TabBookInfo::isHoverable ( )

virtual

Check hoverability status.

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

Implements GuiBase.

◆ isHovered()

virtual bool TabBookInfo::isHovered ( )

virtual

Check hover status.

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

Implements GuiBase.

◆ isSelected()

virtual bool TabBookInfo::isSelected ( )

virtual

Check selection status.

Returns: Returns true if this element is selected.

Implements GuiBase.

◆ process()

virtual int TabBookInfo::process ( GUI_POINT mouse )

virtual

Process mouse input for this element.

Returns: Returns ProcessReturnType flags.

See also: ProcessReturnType

Implements GuiBase.

◆ processKeys()

virtual int TabBookInfo::processKeys ( )

virtual

Process key input for this element.

Returns: Returns ProcessReturnType flags.

See also: ProcessReturnType

Reimplemented from GuiBase.

◆ setCloseHovered()

void TabBookInfo::setCloseHovered ( int value )

Set this GUI element as hovered over or not.

Parameters

value The hover value.

◆ setFont()

virtual void TabBookInfo::setFont ( FontObject * pFont )

inlinevirtual

Set this element's font.

Parameters

pFont The new font.

Reimplemented from GuiBase.

◆ setHovered()

virtual void TabBookInfo::setHovered ( int value )

virtual

Set this GUI element as hovered over or not.

Parameters

value The hover value.

Implements GuiBase.

◆ setHoveredOverCloseButton()

void TabBookInfo::setHoveredOverCloseButton ( bool bValue )

inline

Set whether we've hovered over the close button.

Parameters

bValue The new value.

◆ setSelected()

virtual void TabBookInfo::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

Classes

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addTab()

◆ calculate()

◆ getClassName()

◆ getDrawRect()

◆ getFont()

◆ getHoverableCount()

◆ getHoveredOverCloseButton()

◆ getSelectableCount()

◆ getTab()

◆ getTabCount()

◆ isHoverable()

◆ isHovered()

◆ isSelected()

◆ process()

◆ processKeys()

◆ setCloseHovered()

◆ setFont()

◆ setHovered()

◆ setHoveredOverCloseButton()

◆ setSelected()