Single line edit box + spin buttons. More...

#include <nirtcpp/core/engine/IGUISpinBox.hpp>

Inheritance diagram for nirt::gui::IGUISpinBox:

Collaboration diagram for nirt::gui::IGUISpinBox:

Public Member Functions
	IGUISpinBox (IGUIEnvironment environment, IGUIElement parent, s32 id, core::rect< s32 > rectangle)
	constructor

virtual IGUIEditBox *	getEditBox () const =0
	Access the edit box used in the spin control.

virtual void	setValue (f32 val)=0
	set the current value of the spinbox

virtual f32	getValue () const =0
	Get the current value of the spinbox.

virtual f32	getValueFor (const wchar_t *text) const =0
	Get the value the spinbox would have for the given text.

virtual void	setRange (f32 min, f32 max)=0
	set the range of values which can be used in the spinbox

virtual f32	getMin () const =0
	get the minimum value which can be used in the spinbox

virtual f32	getMax () const =0
	get the maximum value which can be used in the spinbox

virtual void	setStepSize (f32 step=1.f)=0
	Step size by which values are changed when pressing the spinbuttons.

virtual void	setDecimalPlaces (s32 places)=0

virtual f32	getStepSize () const =0
	get the current step size

virtual void	setValidateOn (u32 validateOn)=0
	Sets when the spinbox has to validate entered text.

virtual u32	getValidateOn () const =0
	Gets when the spinbox has to validate entered text.

virtual f32	getOldValue () const =0
	Gets previous value in EGET_SPINBOX_CHANGED events.

Public Member Functions inherited from nirt::gui::IGUIElement
	IGUIElement (EGUI_ELEMENT_TYPE type, IGUIEnvironment environment, IGUIElement parent, s32 id, const core::rect< s32 > &rectangle)
	Constructor.

virtual	~IGUIElement ()
	Destructor.

IGUIElement *	getParent () const
	Returns parent of this element.

core::rect< s32 >	getRelativePosition () const
	Returns the relative rectangle of this element.

void	setRelativePosition (const core::rect< s32 > &r)
	Sets the relative rectangle of this element.

void	setRelativePosition (const core::position2di &position)
	Sets the relative rectangle of this element, maintaining its current width and height.

void	setRelativePositionProportional (const core::rect< f32 > &r)
	Sets the relative rectangle of this element as a proportion of its parent's area.

core::rect< s32 >	getAbsolutePosition () const
	Gets the absolute rectangle of this element.

core::rect< s32 >	getAbsoluteClippingRect () const
	Returns the visible area of the element.

void	setNotClipped (bool noClip)
	Sets whether the element will ignore its parent's clipping rectangle.

bool	isNotClipped () const
	Gets whether the element will ignore its parent's clipping rectangle.

void	setMaxSize (core::dimension2du size)
	Sets the maximum size allowed for this element.

void	setMinSize (core::dimension2du size)
	Sets the minimum size allowed for this element.

void	setAlignment (EGUI_ALIGNMENT left, EGUI_ALIGNMENT right, EGUI_ALIGNMENT top, EGUI_ALIGNMENT bottom)
	The alignment defines how the borders of this element will be positioned when the parent element is resized.

EGUI_ALIGNMENT	getAlignLeft () const
	How left element border is aligned when parent is resized.

EGUI_ALIGNMENT	getAlignRight () const
	How right element border is aligned when parent is resized.

EGUI_ALIGNMENT	getAlignTop () const
	How top element border is aligned when parent is resized.

EGUI_ALIGNMENT	getAlignBottom () const
	How bottom element border is aligned when parent is resized.

virtual void	updateAbsolutePosition ()
	Updates the absolute position.

virtual IGUIElement *	getElementFromPoint (const core::position2d< s32 > &point)
	Returns the topmost GUI element at the specific position.

virtual bool	isPointInside (const core::position2d< s32 > &point) const
	Returns true if a point is within this element.

virtual void	addChild (IGUIElement *child)
	Adds a GUI element as new child of this element.

virtual void	removeChild (IGUIElement *child)
	Removes a child.

virtual void	remove ()
	Removes this element from its parent.

virtual void	draw ()
	Draws the element and its children.

virtual void	OnPostRender (u32 timeMs)
	animate the element and its children.

virtual void	move (core::position2d< s32 > absoluteMovement)
	Moves this element.

virtual bool	isVisible () const
	Returns true if element is visible.

virtual bool	isTrulyVisible () const
	Check whether the element is truly visible, taking into accounts its parents' visibility.

virtual void	setVisible (bool visible)
	Sets the visible state of this element.

virtual bool	isSubElement () const
	Returns true if this element was created as part of its parent control.

virtual void	setSubElement (bool subElement)
	Sets whether this control was created as part of its parent.

void	setTabStop (bool enable)
	If set to true, the focus will visit this element when using the tab key to cycle through elements.

bool	isTabStop () const
	Returns true if this element can be focused by navigating with the tab key.

void	setTabOrder (s32 index)
	Sets the priority of focus when using the tab key to navigate between a group of elements.

s32	getTabOrder () const
	Returns the number in the tab order sequence.

void	setTabGroup (bool isGroup)
	Sets whether this element is a container for a group of elements which can be navigated using the tab key.

bool	isTabGroup () const
	Returns true if this element is a tab group.

IGUIElement *	getTabGroup ()
	Returns the container element which holds all elements in this element's tab group.

virtual bool	isEnabled () const
	Returns true if element is enabled.

virtual void	setEnabled (bool enabled)
	Sets the enabled state of this element.

virtual void	setText (const wchar_t *text)
	Sets the new caption of this element.

virtual const wchar_t *	getText () const
	Returns caption of this element.

virtual void	setToolTipText (const wchar_t *text)
	Sets the new caption of this element.

virtual const core::stringw &	getToolTipText () const
	Returns caption of this element.

virtual s32	getID () const
	Returns id. Can be used to identify the element.

virtual void	setID (s32 id)
	Sets the id of this element.

virtual bool	OnEvent (const SEvent &event) override
	Called if an event happened.

virtual bool	bringToFront (IGUIElement *element)
	Brings a child to front.

virtual bool	sendToBack (IGUIElement *child)
	Moves a child to the back, so it's siblings are drawn on top of it.

virtual const core::list< IGUIElement * > &	getChildren () const
	Returns list with children of this element.

virtual IGUIElement *	getElementFromId (s32 id, bool searchchildren=false) const
	Finds the first element with the given id.

bool	isMyChild (IGUIElement *child) const

bool	getNextElement (s32 startOrder, bool reverse, bool group, IGUIElement &first, IGUIElement &closest, bool includeInvisible=false, bool includeDisabled=false) const
	searches elements to find the closest next element to tab to

EGUI_ELEMENT_TYPE	getType () const
	Returns the type of the gui element.

virtual bool	hasType (EGUI_ELEMENT_TYPE type) const
	Returns true if the gui element supports the given type.

virtual const c8 *	getTypeName () const
	Returns the type name of the gui element.

virtual const c8 *	getName () const
	Returns the name of the element.

virtual void	setName (const c8 *name)
	Sets the name of the element.

virtual void	setName (const core::stringc &name)
	Sets the name of the element.

virtual void	serializeAttributes (io::IAttributes out, io::SAttributeReadWriteOptions options=0) const override
	Writes attributes of the scene node.

virtual void	deserializeAttributes (io::IAttributes in, io::SAttributeReadWriteOptions options=0) override
	Reads attributes of the scene node.

Public Member Functions inherited from nirt::IReferenceCounted
	IReferenceCounted ()
	Constructor.

virtual	~IReferenceCounted ()
	Destructor.

void	grab () const
	Grabs the object. Increments the reference counter by one.

bool	drop () const
	Drops the object. Decrements the reference counter by one.

s32	getReferenceCount () const
	Get the reference count.

const c8 *	getDebugName () const
	Returns the debug name of the object.

Public Member Functions inherited from nirt::IEventReceiver
virtual	~IEventReceiver ()
	Destructor.

Additional Inherited Members
Protected Member Functions inherited from nirt::gui::IGUIElement
void	addChildToEnd (IGUIElement *child)

void	recalculateAbsolutePosition (bool recursive)

Protected Member Functions inherited from nirt::IReferenceCounted
void	setDebugName (const c8 *newName)
	Sets the debug name of the object.

Protected Attributes inherited from nirt::gui::IGUIElement
core::list< IGUIElement * >	Children
	List of all children of this element.

IGUIElement *	Parent
	Pointer to the parent.

core::rect< s32 >	RelativeRect
	relative rect of element

core::rect< s32 >	AbsoluteRect
	absolute rect of element

core::rect< s32 >	AbsoluteClippingRect
	absolute clipping rect of element

core::rect< s32 >	DesiredRect

core::rect< s32 >	LastParentRect
	for calculating the difference when resizing parent

core::rect< f32 >	ScaleRect
	relative scale of the element inside its parent

core::dimension2du	MaxSize
	maximum and minimum size of the element

core::dimension2du	MinSize

bool	IsVisible
	is visible?

bool	IsEnabled
	is enabled?

bool	IsSubElement
	is a part of a larger whole and should not be serialized?

bool	NoClip
	does this element ignore its parent's clipping rectangle?

core::stringw	Text
	caption

core::stringw	ToolTipText
	tooltip

core::stringc	Name
	users can set this for identifying the element by string

s32	ID
	users can set this for identifying the element by integer

bool	IsTabStop
	tab stop like in windows

s32	TabOrder
	tab order

bool	IsTabGroup
	tab groups are containers like windows, use ctrl+tab to navigate

EGUI_ALIGNMENT	AlignLeft
	tells the element how to act when its parent is resized

EGUI_ALIGNMENT	AlignRight

EGUI_ALIGNMENT	AlignTop

EGUI_ALIGNMENT	AlignBottom

IGUIEnvironment *	Environment
	GUI Environment.

EGUI_ELEMENT_TYPE	Type
	type of element

Detailed Description

Single line edit box + spin buttons.

This element can create the following events of type EGUI_EVENT_TYPE:

EGET_SPINBOX_CHANGED

Member Function Documentation

◆ getOldValue()

virtual f32 nirt::gui::IGUISpinBox::getOldValue ( ) const

pure virtual

Gets previous value in EGET_SPINBOX_CHANGED events.

Note: That value changes as soon as a new value is set (to the new value). So it's only useful to check for last value in the event and has no use otherwise. Also it's possible to mess it up by setting text via the editbox sub-element directly.

◆ getValidateOn()

virtual u32 nirt::gui::IGUISpinBox::getValidateOn ( ) const

pure virtual

Gets when the spinbox has to validate entered text.

Returns: A combination of EGUI_SPINBOX_VALIDATION bit flags

◆ getValueFor()

virtual f32 nirt::gui::IGUISpinBox::getValueFor ( const wchar_t * text ) const

pure virtual

Get the value the spinbox would have for the given text.

Note: There is no rounding for decimal places going on here The reason is that so far spinbox doesn't restrict entering longer numbers (or any other text) (TODO)

◆ setDecimalPlaces()

virtual void nirt::gui::IGUISpinBox::setDecimalPlaces ( s32 places )

pure virtual

Sets the number of decimal places to display. Note: This also rounds the range to the same number of decimal places. Note: This is only used for the buttons so far, text-input ignores it (TODO)

Parameters

places The number of decimal places to display, use -1 to reset

◆ setRange()

virtual void nirt::gui::IGUISpinBox::setRange	(	f32	min,
		f32	max
	)

pure virtual

set the range of values which can be used in the spinbox

Parameters

min	minimum value
max	maximum value

◆ setStepSize()

virtual void nirt::gui::IGUISpinBox::setStepSize ( f32 step = 1.f )

pure virtual

Step size by which values are changed when pressing the spinbuttons.

The step size also determines the number of decimal places to display

Parameters

step	stepsize used for value changes when pressing spinbuttons

◆ setValidateOn()

virtual void nirt::gui::IGUISpinBox::setValidateOn ( u32 validateOn )

pure virtual

Sets when the spinbox has to validate entered text.

Parameters

validateOn Can be any combination of EGUI_SPINBOX_VALIDATION bit flags

◆ setValue()

virtual void nirt::gui::IGUISpinBox::setValue ( f32 val )

pure virtual

set the current value of the spinbox

Parameters

val	value to be set in the spinbox

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

include/nirtcpp/core/engine/IGUISpinBox.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getOldValue()

◆ getValidateOn()

◆ getValueFor()

◆ setDecimalPlaces()

◆ setRange()

◆ setStepSize()

◆ setValidateOn()

◆ setValue()