GUI Button interface. More...

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

Inheritance diagram for nirt::gui::IGUIButton:

Collaboration diagram for nirt::gui::IGUIButton:

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

virtual void	setOverrideFont (IGUIFont *font=0)=0
	Sets another skin independent font.

virtual IGUIFont *	getOverrideFont (void) const =0
	Gets the override font (if any)

virtual IGUIFont *	getActiveFont () const =0
	Get the font which is used right now for drawing.

virtual void	setOverrideColor (video::SColor color)=0
	Sets another color for the button text.

virtual video::SColor	getOverrideColor (void) const =0
	Gets the override color.

virtual video::SColor	getActiveColor () const =0
	Gets the currently used text color.

virtual void	enableOverrideColor (bool enable)=0
	Sets if the button text should use the override color or the color in the gui skin.

virtual bool	isOverrideColorEnabled (void) const =0
	Checks if an override color is enabled.

virtual void	setImage (EGUI_BUTTON_IMAGE_STATE state, video::ITexture *image=0, const core::rect< s32 > &sourceRect=core::rect< s32 >(0, 0, 0, 0))=0
	Sets an image which should be displayed on the button when it is in the given state.

virtual void	setImage (video::ITexture *image=0)=0
	Sets an image which should be displayed on the button when it is in normal state.

virtual void	setImage (video::ITexture *image, const core::rect< s32 > &sourceRect)=0
	Sets a background image for the button when it is in normal state.

virtual void	setPressedImage (video::ITexture *image=0)=0
	Sets a background image for the button when it is in pressed state.

virtual void	setPressedImage (video::ITexture *image, const core::rect< s32 > &sourceRect)=0
	Sets an image which should be displayed on the button when it is in pressed state.

virtual void	setSpriteBank (IGUISpriteBank *bank=0)=0
	Sets the sprite bank used by the button.

virtual void	setSprite (EGUI_BUTTON_STATE state, s32 index, video::SColor color=video::SColor(255, 255, 255, 255), bool loop=false, bool scale=false)=0
	Sets the animated sprite for a specific button state.

virtual s32	getSpriteIndex (EGUI_BUTTON_STATE state) const =0
	Get the sprite-index for the given state or -1 when no sprite is set.

virtual video::SColor	getSpriteColor (EGUI_BUTTON_STATE state) const =0
	Get the sprite color for the given state. Color is only used when a sprite is set.

virtual bool	getSpriteLoop (EGUI_BUTTON_STATE state) const =0
	Returns if the sprite in the given state does loop.

virtual bool	getSpriteScale (EGUI_BUTTON_STATE state) const =0
	Returns if the sprite in the given state is scaled.

virtual void	setIsPushButton (bool isPushButton=true)=0
	Sets if the button should behave like a push button.

virtual void	setPressed (bool pressed=true)=0
	Sets the pressed state of the button if this is a pushbutton.

virtual bool	isPressed () const =0
	Returns if the button is currently pressed.

virtual void	setUseAlphaChannel (bool useAlphaChannel=true)=0
	Sets if the alpha channel should be used for drawing background images on the button (default is false)

virtual bool	isAlphaChannelUsed () const =0
	Returns if the alpha channel should be used for drawing background images on the button.

virtual bool	isPushButton () const =0
	Returns whether the button is a push button.

virtual void	setDrawBorder (bool border=true)=0
	Sets if the button should use the skin to draw its border and button face (default is true)

virtual bool	isDrawingBorder () const =0
	Returns if the border and button face are being drawn using the skin.

virtual void	setScaleImage (bool scaleImage=true)=0
	Sets if the button should scale the button images to fit.

virtual bool	isScalingImage () const =0
	Checks whether the button scales the used images.

virtual bool	getClickShiftState () const =0
	Get if the shift key was pressed in last EGET_BUTTON_CLICKED event.

virtual bool	getClickControlState () const =0
	Get if the control key was pressed in last EGET_BUTTON_CLICKED event.

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

GUI Button interface.

This element can create the following events of type EGUI_EVENT_TYPE:

EGET_BUTTON_CLICKED

Member Function Documentation

◆ enableOverrideColor()

virtual void nirt::gui::IGUIButton::enableOverrideColor ( bool enable )

pure virtual

Sets if the button text should use the override color or the color in the gui skin.

Parameters

enable If set to true, the override color, which can be set with IGUIStaticText::setOverrideColor is used, otherwise the EGDC_BUTTON_TEXT or EGDC_GRAY_TEXT color of the skin.

◆ getActiveColor()

virtual video::SColor nirt::gui::IGUIButton::getActiveColor ( ) const

pure virtual

Gets the currently used text color.

Either a skin-color for the current state or the override color

◆ getActiveFont()

virtual IGUIFont * nirt::gui::IGUIButton::getActiveFont ( ) const

pure virtual

Get the font which is used right now for drawing.

Currently this is the override font when one is set and the font of the active skin otherwise

◆ getClickControlState()

virtual bool nirt::gui::IGUIButton::getClickControlState ( ) const

pure virtual

Get if the control key was pressed in last EGET_BUTTON_CLICKED event.

Generated together with event, so info is available in the event-receiver.

◆ getClickShiftState()

virtual bool nirt::gui::IGUIButton::getClickShiftState ( ) const

pure virtual

Get if the shift key was pressed in last EGET_BUTTON_CLICKED event.

Generated together with event, so info is available in the event-receiver.

◆ getOverrideColor()

virtual video::SColor nirt::gui::IGUIButton::getOverrideColor ( void ) const

pure virtual

Gets the override color.

Returns: : The override color

◆ getOverrideFont()

virtual IGUIFont * nirt::gui::IGUIButton::getOverrideFont ( void ) const

pure virtual

Gets the override font (if any)

Returns: The override font (may be 0)

◆ isOverrideColorEnabled()

virtual bool nirt::gui::IGUIButton::isOverrideColorEnabled ( void ) const

pure virtual

Checks if an override color is enabled.

Returns: true if the override color is enabled, false otherwise

◆ setImage() [1/3]

virtual void nirt::gui::IGUIButton::setImage	(	EGUI_BUTTON_IMAGE_STATE	state,
		video::ITexture *	image = `0`,
		const core::rect< s32 > &	sourceRect = `core::rect< s32 >(0, 0, 0, 0)`
	)

pure virtual

Sets an image which should be displayed on the button when it is in the given state.

Only one image-state can be active at a time. Images are drawn below sprites. If a state is without image it will try to use images from other states as described in EGUI_BUTTON_IMAGE_STATE. Images are a little less flexible than sprites, but easier to use.

Parameters

state	One of EGUI_BUTTON_IMAGE_STATE
image	Image to be displayed or NULL to remove the image
sourceRect	Source rectangle on the image texture. When width or height are 0 then the full texture-size is used (default).

◆ setImage() [2/3]

virtual void nirt::gui::IGUIButton::setImage	(	video::ITexture *	image,
		const core::rect< s32 > &	sourceRect
	)

pure virtual

Sets a background image for the button when it is in normal state.

This is identical to calling setImage(EGBIS_IMAGE_UP, image, sourceRect); and might be deprecated in future revisions.

Parameters

image	Texture containing the image to be displayed
sourceRect	Position in the texture, where the image is located. When width or height are 0 then the full texture-size is used

◆ setImage() [3/3]

virtual void nirt::gui::IGUIButton::setImage ( video::ITexture * image = 0 )

pure virtual

Sets an image which should be displayed on the button when it is in normal state.

This is identical to calling setImage(EGBIS_IMAGE_UP, image); and might be deprecated in future revisions.

Parameters

image Image to be displayed

◆ setIsPushButton()

virtual void nirt::gui::IGUIButton::setIsPushButton ( bool isPushButton = true )

pure virtual

Sets if the button should behave like a push button.

Which means it can be in two states: Normal or Pressed. With a click on the button, the user can change the state of the button.

◆ setOverrideColor()

virtual void nirt::gui::IGUIButton::setOverrideColor ( video::SColor color )

pure virtual

Sets another color for the button text.

When set, this color is used instead of EGDC_BUTTON_TEXT/EGDC_GRAY_TEXT. You don't need to call enableOverrideColor(true), that's done by this function. If you want the the color of the skin back, call enableOverrideColor(false);

Parameters

color New color of the text.

◆ setOverrideFont()

virtual void nirt::gui::IGUIButton::setOverrideFont ( IGUIFont * font = 0 )

pure virtual

Sets another skin independent font.

If this is set to zero, the button uses the font of the skin.

Parameters

font	New font to set.

◆ setPressedImage() [1/2]

virtual void nirt::gui::IGUIButton::setPressedImage	(	video::ITexture *	image,
		const core::rect< s32 > &	sourceRect
	)

pure virtual

Sets an image which should be displayed on the button when it is in pressed state.

This is identical to calling setImage(EGBIS_IMAGE_DOWN, image, sourceRect); and might be deprecated in future revisions.

Parameters

image	Texture containing the image to be displayed
sourceRect	Position in the texture, where the image is located

◆ setPressedImage() [2/2]

virtual void nirt::gui::IGUIButton::setPressedImage ( video::ITexture * image = 0 )

pure virtual

Sets a background image for the button when it is in pressed state.

This is identical to calling setImage(EGBIS_IMAGE_DOWN, image); and might be deprecated in future revisions. If no images is specified for the pressed state via setPressedImage(), this image is also drawn in pressed state.

Parameters

image Image to be displayed

◆ setSprite()

virtual void nirt::gui::IGUIButton::setSprite	(	EGUI_BUTTON_STATE	state,
		s32	index,
		video::SColor	color = `video::SColor(255, 255, 255, 255)`,
		bool	loop = `false`,
		bool	scale = `false`
	)

pure virtual

Sets the animated sprite for a specific button state.

Several sprites can be drawn at the same time. Sprites can be animated. Sprites are drawn above the images.

Parameters

index	Number of the sprite within the sprite bank, use -1 for no sprite
state	State of the button to set the sprite for
index	The sprite number from the current sprite bank
color	The color of the sprite
loop	True if the animation should loop, false if not
scale	True if the sprite should scale to button size, false if not

◆ setSpriteBank()

virtual void nirt::gui::IGUIButton::setSpriteBank ( IGUISpriteBank * bank = 0 )

pure virtual

Sets the sprite bank used by the button.

NOTE: The spritebank itself is not serialized so far. The sprites are serialized. Which means after loading the gui you still have to set the spritebank manually.

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

include/nirtcpp/core/engine/IGUIButton.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ enableOverrideColor()

◆ getActiveColor()

◆ getActiveFont()

◆ getClickControlState()

◆ getClickShiftState()

◆ getOverrideColor()

◆ getOverrideFont()

◆ isOverrideColorEnabled()

◆ setImage() [1/3]

◆ setImage() [2/3]

◆ setImage() [3/3]

◆ setIsPushButton()

◆ setOverrideColor()

◆ setOverrideFont()

◆ setPressedImage() [1/2]

◆ setPressedImage() [2/2]

◆ setSprite()

◆ setSpriteBank()