GUI Context menu interface. More...

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

Inheritance diagram for nirt::gui::IGUIContextMenu:

Collaboration diagram for nirt::gui::IGUIContextMenu:

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

virtual void	setCloseHandling (ECONTEXT_MENU_CLOSE onClose)=0
	set behavior when menus are closed

virtual ECONTEXT_MENU_CLOSE	getCloseHandling () const =0
	get current behavior when the menu will be closed

virtual u32	getItemCount () const =0
	Get amount of menu items.

virtual u32	addItem (const wchar_t *text, s32 commandId=-1, bool enabled=true, bool hasSubMenu=false, bool checked=false, bool autoChecking=false)=0
	Adds a menu item.

virtual u32	insertItem (u32 idx, const wchar_t *text, s32 commandId=-1, bool enabled=true, bool hasSubMenu=false, bool checked=false, bool autoChecking=false)=0
	Insert a menu item at specified position.

virtual s32	findItemWithCommandId (s32 commandId, u32 idxStartSearch=0) const =0
	Find an item by its CommandID.

virtual void	addSeparator ()=0
	Adds a separator item to the menu.

virtual const wchar_t *	getItemText (u32 idx) const =0
	Get text of the menu item.

virtual void	setItemText (u32 idx, const wchar_t *text)=0
	Sets text of the menu item.

virtual bool	isItemEnabled (u32 idx) const =0
	Check if a menu item is enabled.

virtual void	setItemEnabled (u32 idx, bool enabled)=0
	Sets if the menu item should be enabled.

virtual void	setItemChecked (u32 idx, bool enabled)=0
	Sets if the menu item should be checked.

virtual bool	isItemChecked (u32 idx) const =0
	Check if a menu item is checked.

virtual void	removeItem (u32 idx)=0
	Removes a menu item.

virtual void	removeAllItems ()=0
	Removes all menu items.

virtual s32	getSelectedItem () const =0
	Get the selected item in the menu.

virtual s32	getItemCommandId (u32 idx) const =0
	Get the command id of a menu item.

virtual void	setItemCommandId (u32 idx, s32 id)=0
	Sets the command id of a menu item.

virtual IGUIContextMenu *	getSubMenu (u32 idx) const =0
	Get a pointer to the submenu of an item.

virtual void	setItemAutoChecking (u32 idx, bool autoChecking)=0
	should the element change the checked status on clicking

virtual bool	getItemAutoChecking (u32 idx) const =0
	does the element change the checked status on clicking

virtual void	setEventParent (IGUIElement *parent)=0
	When an eventparent is set it receives events instead of the usual parent element.

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 Context menu interface.

This element can create the following events of type EGUI_EVENT_TYPE:

EGET_ELEMENT_CLOSED
EGET_MENU_ITEM_SELECTED

Member Function Documentation

◆ addItem()

virtual u32 nirt::gui::IGUIContextMenu::addItem	(	const wchar_t *	text,
		s32	commandId = `-1`,
		bool	enabled = `true`,
		bool	hasSubMenu = `false`,
		bool	checked = `false`,
		bool	autoChecking = `false`
	)

pure virtual

Adds a menu item.

Parameters

text	Text of menu item. Set this to 0 to create an separator instead of a real item, which is the same like calling addSeparator();
commandId	Command id of menu item, a simple id you may set to whatever you want.
enabled	Specifies if the menu item should be enabled.
hasSubMenu	Set this to true if there should be a submenu at this item. You can access this submenu via getSubMenu().
checked	Specifies if the menu item should be initially checked.
autoChecking	Specifies if the item should be checked by clicking

Returns: Returns the index of the new item

◆ findItemWithCommandId()

virtual s32 nirt::gui::IGUIContextMenu::findItemWithCommandId	(	s32	commandId,
		u32	idxStartSearch = `0`
	)		const

pure virtual

Find an item by its CommandID.

Parameters

commandId	We are looking for the first item which has this commandID
idxStartSearch	Start searching from this index.

Returns: Returns the index of the item when found or otherwise -1.

◆ getItemCommandId()

virtual s32 nirt::gui::IGUIContextMenu::getItemCommandId ( u32 idx ) const

pure virtual

Get the command id of a menu item.

Parameters

idx	Zero based index of the menu item

◆ getItemText()

virtual const wchar_t * nirt::gui::IGUIContextMenu::getItemText ( u32 idx ) const

pure virtual

Get text of the menu item.

Parameters

idx	Zero based index of the menu item

◆ getSelectedItem()

virtual s32 nirt::gui::IGUIContextMenu::getSelectedItem ( ) const

pure virtual

Get the selected item in the menu.

Returns: Index of the selected item, -1 if none selected.

◆ getSubMenu()

virtual IGUIContextMenu * nirt::gui::IGUIContextMenu::getSubMenu ( u32 idx ) const

pure virtual

Get a pointer to the submenu of an item.

0 is returned if there is no submenu

Parameters

idx	Zero based index of the menu item

Returns: Returns a pointer to the submenu of an item.

◆ insertItem()

virtual u32 nirt::gui::IGUIContextMenu::insertItem	(	u32	idx,
		const wchar_t *	text,
		s32	commandId = `-1`,
		bool	enabled = `true`,
		bool	hasSubMenu = `false`,
		bool	checked = `false`,
		bool	autoChecking = `false`
	)

pure virtual

Insert a menu item at specified position.

Parameters

idx	Position to insert the new element, should be smaller than itemcount otherwise the item is added to the end.
text	Text of menu item. Set this to 0 to create an separator instead of a real item, which is the same like calling addSeparator();
commandId	Command id of menu item, a simple id you may set to whatever you want.
enabled	Specifies if the menu item should be enabled.
hasSubMenu	Set this to true if there should be a submenu at this item. You can access this submenu via getSubMenu().
checked	Specifies if the menu item should be initially checked.
autoChecking	Specifies if the item should be checked by clicking

Returns: Returns the index of the new item

◆ isItemChecked()

virtual bool nirt::gui::IGUIContextMenu::isItemChecked ( u32 idx ) const

pure virtual

Check if a menu item is checked.

Parameters

idx	Zero based index of the menu item

◆ isItemEnabled()

virtual bool nirt::gui::IGUIContextMenu::isItemEnabled ( u32 idx ) const

pure virtual

Check if a menu item is enabled.

Parameters

idx	Zero based index of the menu item

◆ removeItem()

virtual void nirt::gui::IGUIContextMenu::removeItem ( u32 idx )

pure virtual

Removes a menu item.

Parameters

idx	Zero based index of the menu item

◆ setItemChecked()

virtual void nirt::gui::IGUIContextMenu::setItemChecked	(	u32	idx,
		bool	enabled
	)

pure virtual

Sets if the menu item should be checked.

Parameters

idx	Zero based index of the menu item
enabled	True if it is enabled, otherwise false.

◆ setItemCommandId()

virtual void nirt::gui::IGUIContextMenu::setItemCommandId	(	u32	idx,
		s32	id
	)

pure virtual

Sets the command id of a menu item.

Parameters

idx	Zero based index of the menu item
id	Command id of menu item, a simple id you may set to whatever you want.

◆ setItemEnabled()

virtual void nirt::gui::IGUIContextMenu::setItemEnabled	(	u32	idx,
		bool	enabled
	)

pure virtual

Sets if the menu item should be enabled.

Parameters

idx	Zero based index of the menu item
enabled	True if it is enabled, otherwise false.

◆ setItemText()

virtual void nirt::gui::IGUIContextMenu::setItemText	(	u32	idx,
		const wchar_t *	text
	)

pure virtual

Sets text of the menu item.

Parameters

idx	Zero based index of the menu item
text	New text of the item.

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

include/nirtcpp/core/engine/IGUIContextMenu.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addItem()

◆ findItemWithCommandId()

◆ getItemCommandId()

◆ getItemText()

◆ getSelectedItem()

◆ getSubMenu()

◆ insertItem()

◆ isItemChecked()

◆ isItemEnabled()

◆ removeItem()

◆ setItemChecked()

◆ setItemCommandId()

◆ setItemEnabled()

◆ setItemText()