#include <iDialogMenu.h>

Inherits igor::iDialog.

Public Member Functions
	iDialogMenu (const iWidgetPtr parent=nullptr)

virtual	~iDialogMenu ()=default

void	addAction (const iActionPtr action, const iActionContextPtr context=nullptr, bool enabled=true)

void	addAction (const iaString &actionName, const iActionContextPtr context=nullptr, bool enabled=true)

bool	hasEntries () const

void	addCallback (iClickDelegate delegate, const iaString &title, const iaString &description="", const iaString &iconAlias="", bool enabled=true, const iActionContextPtr context=nullptr)

void	addMenu (const iWidgetMenuPtr menu)

void	addSeparator ()

virtual void	open (iDialogCloseDelegate dialogCloseDelegate=iDialogCloseDelegate(), bool modal=false) override

void	clear () override

Public Member Functions inherited from igor::iDialog
	iDialog (iWidgetType type=iWidgetType::iDialog, const iWidgetPtr parent=nullptr)

virtual	~iDialog ()

void	setHeaderEnabled (bool enable)

bool	hasHeader () const

void	setTitle (const iaString &title)

const iaString &	getTitle () const

void	setResizeable (bool enable)

bool	isResizeable () const

void	setDockable (bool enable)

bool	isDockable () const

bool	isDocked () const

iWidgetID	getDockingParent () const

void	setMoveable (bool enable)

bool	isMoveable () const

void	setX (int32 x)

void	setY (int32 y)

void	setPos (const iaVector2f &pos)

const iaVector2f &	getPos () const

virtual void	open (iDialogCloseDelegate dialogCloseDelegate=iDialogCloseDelegate(), bool modal=false)

virtual void	close ()

bool	isOpen () const

iDialogReturnState	getReturnState () const

void	setReturnState (iDialogReturnState returnState)

void	putInFront ()

void	setAcceptESCToClose (bool acceptESC)

bool	isAcceptingESCToClose () const

Public Member Functions inherited from igor::iWidget
iWidgetType	getWidgetType () const

iWidgetKind	getWidgetKind () const

void	setZValue (uint32 zvalue)

uint32	getZValue () const

void	setBackground (const iaColor4f &color)

const iaColor4f &	getBackground () const

void	setForeground (const iaColor4f &color)

const iaColor4f &	getForeground () const

bool	isBlocked () const

bool	hasKeyboardFocus () const

iWidgetState	getState () const

iClickEvent &	getClickEvent ()

iMouseOffClickEvent &	getMouseOffClickEvent ()

iDoubleClickEvent &	getDoubleClickEvent ()

iMouseOverEvent &	getMouseOverEvent ()

iMouseOffEvent &	getMouseOffEvent ()

iChangeEvent &	getChangeEvent ()

iFocusEvent &	getFocusEvent ()

iWheelUpEvent &	getWheelUpEvent ()

iWheelDownEvent &	getWheelDownEvent ()

iContextMenuEvent &	getContextMenuEvent ()

iSelectionChangedEvent &	getSelectionChangedEvent ()

iaVector2f	getActualPos () const

int32	getActualPosX () const

int32	getActualPosY () const

int32	getActualWidth () const

int32	getActualHeight () const

iaRectanglef	getActualRect () const

iaRectanglef	getActualClientRect () const

int32	getRelativePosX () const

int32	getRelativePosY () const

int32	getMinWidth () const

int32	getMinHeight () const

int32	getConfiguredMinWidth () const

int32	getConfiguredMinHeight () const

void	setMinWidth (int32 width)

void	setMinHeight (int32 height)

void	setMinSize (int32 width, int32 height)

void	setAcceptOutOfBoundsClicks (bool acceptOutOfBoundsClick=true)

bool	getAcceptOutOfBoundsClicks () const

iHorizontalAlignment	getHorizontalAlignment () const

iVerticalAlignment	getVerticalAlignment () const

void	setHorizontalAlignment (iHorizontalAlignment horizontalAlignment)

void	setVerticalAlignment (iVerticalAlignment verticalAlignment)

bool	isVisible () const

bool	isEnabled () const

void	setVisible (bool visible=true)

void	setEnabled (bool enabled=true)

iWidgetID	getID () const

iWidgetID	getParentID () const

iWidgetPtr	getParent () const

bool	isMouseOver ()

void	setAcceptDrag (bool acceptDrag)

bool	isAcceptingDrag ()

void	setAcceptDrop (bool acceptDrop)

bool	isAcceptingDrop ()

bool	hasParent () const

void	setGrowingByContent (bool grow=true)

bool	isGrowingByContent () const

iaString	getInfo () const

void	setTooltip (const iaString &text)

iaString	getTooltip () const

const std::vector< iWidgetPtr > &	getChildren () const

virtual void	clear ()

void	setIgnoreChildEventConsumption (bool value=true)

bool	isIgnoringChildEventConsumption () const

iWidgetPtr	getRoot ()

virtual void	blockEvents ()

virtual void	unblockEvents ()

void	setOverlayEnabled (bool overlay)

bool	isOverlayEnabled () const

virtual void	draw ()

virtual void	drawOverlay ()

virtual void	addWidget (iWidgetPtr widget)

virtual void	removeWidget (iWidgetPtr widget)

void	setCursor (iMouseCursorType cursorType)

void	setUserData (const std::any &userData)

std::any	getUserData () const

void	setSelectable (bool selectable)

bool	isSelectable () const

void	setMultiSelection (bool enabled)

bool	isMultiSelectionEnabled () const

void	setSelect (bool select)

bool	isSelected () const

void	clearSelection ()

const std::vector< iWidgetPtr >	getSelection () const

void	setSelection (const std::vector< iWidgetPtr > &selection)

void	refresh ()

Friends
class	iWidgetMenu

Additional Inherited Members
Static Public Member Functions inherited from igor::iWidget
static iWidgetPtr	getKeyboardFocusWidget ()

static IGOR_INLINE float32	getScale ()

Static Public Attributes inherited from igor::iWidget
static const iWidgetID	INVALID_WIDGET_ID = 0

Protected Member Functions inherited from igor::iDialog
virtual bool	onMouseKeyUp (const iEventMouseKeyUp &event) override

virtual bool	onMouseKeyDown (const iEventMouseKeyDown &event) override

virtual void	onMouseMove (const iEventMouseMove &event) override

virtual bool	onKeyDown (const iEventKeyDown &event) override

Protected Member Functions inherited from igor::iWidget
void	clearChildren ()

void	updateMinSize (int32 width, int32 height)

void	setParent (iWidgetPtr parent)

void	setKeyboardFocus ()

void	resetKeyboardFocus ()

void	setClientArea (int32 left, int32 right, int32 top, int32 bottom)

const iaVector2f &	getLastMousePos () const

	iWidget (iWidgetType type, iWidgetKind kind, const iWidgetPtr parent=nullptr)

virtual	~iWidget ()

virtual bool	onEvent (iEvent &event)

virtual bool	onMouseWheel (const iEventMouseWheel &event)

virtual bool	onMouseKeyDown (const iEventMouseKeyDown &event)

virtual bool	onMouseDoubleClick (const iEventMouseKeyDoubleClick &event)

virtual bool	onMouseKeyUp (const iEventMouseKeyUp &event)

virtual void	onMouseMove (const iEventMouseMove &event)

virtual bool	onASCII (const iEventKeyASCII &event)

virtual bool	onKeyDown (const iEventKeyDown &event)

virtual bool	onKeyUp (const iEventKeyUp &event)

virtual void	onLostKeyboardFocus ()

virtual void	onGainedKeyboardFocus ()

virtual void	calcMinSize ()

virtual void	updateAlignment (int32 clientWidth, int32 clientHeight)

virtual void	calcChildOffsets (std::vector< iaRectanglef > &offsets)

virtual void	onDragEnter (iDrag &drag)

virtual void	onDragMove (iDrag &drag, const iaVector2f &mousePos)

virtual void	onDragLeave (iDrag &drag)

virtual void	onDrop (const iDrag &drag, const iaVector2f &mousePos)

virtual void	onDrag ()

virtual void	onRefresh ()

Protected Attributes inherited from igor::iWidget
bool	_selected = false

bool	_isSelectable = false

bool	_isMultiSelectionEnabled = false

std::vector< iWidgetPtr >	_children

int32	_configuredMinWidth = 0

int32	_configuredMinHeight = 0

iClickEvent	_click

iMouseOffClickEvent	_mouseOffClick

iContextMenuEvent	_contextMenu

iDoubleClickEvent	_doubleClick

iMouseOverEvent	_mouseOver

iMouseOffEvent	_mouseOff

iChangeEvent	_change

iFocusEvent	_focus

iWheelUpEvent	_wheelUp

iWheelDownEvent	_wheelDown

iSelectionChangedEvent	_selectionChanged

iaString	_tooltip

iaVector2f	_tooltipPos

iaTime	_tooltipTime = iaTime(0)

bool	_initTooltip = false

uint32	_zValue = 0

bool	_reactOnMouseWheel = true

bool	_blockedEvents = false

bool	_acceptOutOfBoundsClicks = false

bool	_acceptDrop = false

bool	_acceptDrag = false

bool	_isMouseOver = false

bool	_ignoreChildEventConsumption = false

iaVector2f	_lastMousePos

iaVector2f	_lastMousePressPos

bool	_needRefresh = true

Detailed Description

menu dialog

technically a dialog it is used as menu, sub menu or context menu

Constructor & Destructor Documentation

◆ iDialogMenu()

igor::iDialogMenu::iDialogMenu ( const iWidgetPtr parent = nullptr )

init members

Parameters

parent the parent of this widget

◆ ~iDialogMenu()

virtual igor::iDialogMenu::~iDialogMenu ( )

virtualdefault

de initializes gui

Member Function Documentation

◆ addAction() [1/2]

void igor::iDialogMenu::addAction	(	const iActionPtr	action,
		const iActionContextPtr	context = `nullptr`,
		bool	enabled = `true`
	)

adds action to menu

only adds actions that are registered to the action manager actions are not owned by the menu

Parameters

action	the action to be added
context	the action cintext
enabled	if true widget will be enabled

◆ addAction() [2/2]

void igor::iDialogMenu::addAction	(	const iaString &	actionName,
		const iActionContextPtr	context = `nullptr`,
		bool	enabled = `true`
	)

same as add actions just by action name

requires that the action we are searching for was already registered to the action manager

Parameters

actionName	name of the action to be added
context	the action cintext
enabled	if true widget will be enabled

◆ addCallback()

void igor::iDialogMenu::addCallback	(	iClickDelegate	delegate,
		const iaString &	title,
		const iaString &	description = `""`,
		const iaString &	iconAlias = `""`,
		bool	enabled = `true`,
		const iActionContextPtr	context = `nullptr`
	)

add callback entry to menu

Parameters

delegate	the delegate that will be called on click
title	the title or brief description
description	the full description (used as tooltip)
iconAlias	an alias or id for texture resource
enabled	if true widget will be enabled
context	action context

◆ addMenu()

void igor::iDialogMenu::addMenu ( const iWidgetMenuPtr menu )

adds a menu to the menu

Parameters

menu	the menu to add

◆ addSeparator()

void igor::iDialogMenu::addSeparator ( )

adds a spacer

◆ clear()

void igor::iDialogMenu::clear ( )

overridevirtual

clears the widget back to default

Reimplemented from igor::iWidget.

◆ hasEntries()

bool igor::iDialogMenu::hasEntries ( ) const

Returns: true if dialog has actions, callbacks or sub menus on it

◆ open()

void igor::iDialogMenu::open	(	iDialogCloseDelegate	dialogCloseDelegate = `iDialogCloseDelegate()`,
		bool	modal = `false`
	)

overridevirtual

shows the dialog on screen

Parameters

dialogCloseDelegate	the delegate to call after the dialog was closed
modal	if true open this dialog as modal

Reimplemented from igor::iDialog.

Friends And Related Function Documentation

◆ iWidgetMenu

friend class iWidgetMenu

friend

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

/home/martin/dev/Igor/src/igor/igor/ui/dialogs/iDialogMenu.h
/home/martin/dev/Igor/src/igor/igor/ui/dialogs/iDialogMenu.cpp

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ iDialogMenu()

◆ ~iDialogMenu()

Member Function Documentation

◆ addAction() [1/2]

◆ addAction() [2/2]

◆ addCallback()

◆ addMenu()

◆ addSeparator()

◆ clear()

◆ hasEntries()

◆ open()

Friends And Related Function Documentation

◆ iWidgetMenu