Several combined GUI elements to form a color picker. More...

#include <CSMAPI_types.h>

Inheritance diagram for ColorPickerInfo:

Public Member Functions
	ColorPickerInfo ()
	Default constructor.

	~ColorPickerInfo ()
	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 GuiBase *	getHoverable (int index)
	Get a hoverable sub-element. More...

virtual GuiBase *	getSelectable (int index)
	Get a selectable sub-element. More...

void	updateColor (bool callback=true)
	Update current color. More...

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

virtual FontObject *	getFont ()
	Get the font for this GUI 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.

virtual void	importantRender ()
	Render the important bits of this element. More...

Public Member Functions inherited from GuiBase
	GuiBase ()
	Default constructor.

virtual	~GuiBase ()
	Default deconstructor.

virtual bool	SelectOnMouseUp ()
	Select on mouse up. More...

virtual int	processKeys ()
	Process key input for this element. More...

virtual int	getMagnification ()

	GuiBase (const GuiBase &)=delete

GuiBase &	operator= (const GuiBase &)=delete

	GuiBase (GuiBase &&)=delete

GuiBase &	operator= (GuiBase &&)=delete

Public Attributes
SliderIntInfo	mSlider_Red
	Red slider.

SliderIntInfo	mSlider_Green
	Green slider.

SliderIntInfo	mSlider_Blue
	Blue slider.

TextInputInfo	mEdit_Red
	Red value textbox.

TextInputInfo	mEdit_Green
	Green value textbox.

TextInputInfo	mEdit_Blue
	Blue value textbox.

void(*	OnRenderSprite )(ColorPickerInfo *pGui, GUI_RECT pRect, GUI_COLOR pColor)
	Called when render() is called. More...

GUI_POINT	spriteSize
	The sprite size to accomadate for when calling OnRenderSprite()

GUI_COLOR	color
	The current color value.

int	margin
	Item 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
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

Several combined GUI elements to form a color picker.

Member Function Documentation

◆ calculate()

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

inlinevirtual

Get this class' name.

Returns: Should return the name of this class.

Reimplemented from GuiBase.

◆ getFont()

virtual FontObject* ColorPickerInfo::getFont ( )

inlinevirtual

Get the font for this GUI element.

Returns: Returns the font object for this element.

Reimplemented from GuiBase.

◆ getHoverable()

virtual GuiBase* ColorPickerInfo::getHoverable ( int index )

virtual

Get a hoverable sub-element.

Parameters

index The sub-element's index.

Returns: Returns a sub-element, NULL if it couldn't be resolved.

Reimplemented from GuiBase.

◆ getHoverableCount()

virtual int ColorPickerInfo::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.

◆ getSelectable()

virtual GuiBase* ColorPickerInfo::getSelectable ( int index )

virtual

Get a selectable sub-element.

Parameters

index The sub-element's index.

Returns: Returns a sub-element, NULL if it couldn't be resolved.

Reimplemented from GuiBase.

◆ getSelectableCount()

virtual int ColorPickerInfo::getSelectableCount ( )

virtual

Get the selectable number of elements in this element.

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

Reimplemented from GuiBase.

◆ importantRender()

virtual void ColorPickerInfo::importantRender ( )

virtual

Render the important bits of this element.

Note: This function is used to draw things that should be at the front of the screen, so make sure to call it AFTER rendering everything else.

Reimplemented from GuiBase.

◆ isHoverable()

virtual bool ColorPickerInfo::isHoverable ( )

virtual

Check hoverability status.

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

Implements GuiBase.

◆ isHovered()

virtual bool ColorPickerInfo::isHovered ( )

virtual

Check hover status.

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

Implements GuiBase.

◆ isSelected()

virtual bool ColorPickerInfo::isSelected ( )

virtual

Check selection status.

Returns: Returns true if this element is selected.

Implements GuiBase.

◆ process()

virtual int ColorPickerInfo::process ( GUI_POINT mouse )

virtual

Process mouse input for this element.

Returns: Returns ProcessReturnType flags.

See also: ProcessReturnType

Implements GuiBase.

◆ setFont()

virtual void ColorPickerInfo::setFont ( FontObject * pFont )

virtual

Set this element's font.

Parameters

pFont The new font.

Reimplemented from GuiBase.

◆ setHovered()

virtual void ColorPickerInfo::setHovered ( int value )

virtual

Set this GUI element as hovered over or not.

Parameters

value The hover value.

Implements GuiBase.

◆ setSelected()

virtual void ColorPickerInfo::setSelected ( int value )

virtual

Set this GUI element as selected or not.

Parameters

value The selection value.

Implements GuiBase.

◆ updateColor()

void ColorPickerInfo::updateColor ( bool callback = true )

Update current color.

Parameters

callback Use the 'OnValueChange' callback

Member Data Documentation

◆ OnRenderSprite

void(* ColorPickerInfo::OnRenderSprite) (ColorPickerInfo *pGui, GUI_RECT pRect, GUI_COLOR pColor)

Called when render() is called.

Renders an icon on the left of the element

Parameters

pGui	The element object.
pRect	The rect of the icon.
pColor	The current color value.

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 Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ calculate()

◆ getClassName()

◆ getFont()

◆ getHoverable()

◆ getHoverableCount()

◆ getSelectable()

◆ getSelectableCount()

◆ importantRender()

◆ isHoverable()

◆ isHovered()

◆ isSelected()

◆ process()

◆ setFont()

◆ setHovered()

◆ setSelected()

◆ updateColor()

Member Data Documentation

◆ OnRenderSprite