#include <iDialog.h>

Inherits igor::iWidget.

Inherited by igor::iDialogColorChooser, igor::iDialogColorGradient, igor::iDialogDecisionBox, igor::iDialogFileSelect, igor::iDialogGraph, igor::iDialogIndexMenu, igor::iDialogMenu, and igor::iDialogMessageBox.

Public Member Functions
	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 ()

Protected Member Functions
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 ()

Friends
class	iWidgetManager

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

dialog widget

Constructor & Destructor Documentation

◆ iDialog()

igor::iDialog::iDialog	(	iWidgetType	type = `iWidgetType::iDialog`,
		const iWidgetPtr	parent = `nullptr`
	)

ctor initializes member variables and registers mouse events

◆ ~iDialog()

igor::iDialog::~iDialog ( )

virtual

dtor unregisters mouse events

Member Function Documentation

◆ close()

void igor::iDialog::close ( )

virtual

closes the dialog

◆ getDockingParent()

iWidgetID igor::iDialog::getDockingParent ( ) const

Returns: docking parent id

◆ getPos()

const iaVector2f & igor::iDialog::getPos ( ) const

Returns: position of dialog

◆ getReturnState()

iDialogReturnState igor::iDialog::getReturnState ( ) const

Returns: the return state of this dialog if one was set

◆ getTitle()

const iaString & igor::iDialog::getTitle ( ) const

Returns: title of dialog

◆ hasHeader()

bool igor::iDialog::hasHeader ( ) const

Returns: true if header is enabled

◆ isAcceptingESCToClose()

bool igor::iDialog::isAcceptingESCToClose ( ) const

Returns: true if dialog accepts ESC to close

◆ isDockable()

bool igor::iDialog::isDockable ( ) const

Returns: true if dialog is dock-able

◆ isDocked()

bool igor::iDialog::isDocked ( ) const

Returns: true if dialog is docked

This is currently just an alias for hasParent

◆ isMoveable()

bool igor::iDialog::isMoveable ( ) const

Returns: true if dialog is moveable

◆ isOpen()

bool igor::iDialog::isOpen ( ) const

Returns: true if dialog is open

◆ isResizeable()

bool igor::iDialog::isResizeable ( ) const

Returns: true if dialog is resize-able

◆ onKeyDown()

bool igor::iDialog::onKeyDown ( const iEventKeyDown & event )

overrideprotectedvirtual

handles pressed key event

Parameters

event the key down event

Reimplemented from igor::iWidget.

◆ onMouseKeyDown()

bool igor::iDialog::onMouseKeyDown ( const iEventMouseKeyDown & event )

overrideprotectedvirtual

handles incoming mouse key down events

Parameters

event mouse key down event

Returns: true: if event was consumed and therefore ignored by the parent

Reimplemented from igor::iWidget.

◆ onMouseKeyUp()

bool igor::iDialog::onMouseKeyUp ( const iEventMouseKeyUp & event )

overrideprotectedvirtual

handles mouse key up events

Parameters

event the mouse key up event

Returns: true: if event was consumed and therefore ignored by the parent

Reimplemented from igor::iWidget.

◆ onMouseMove()

void igor::iDialog::onMouseMove ( const iEventMouseMove & event )

overrideprotectedvirtual

handles incoming mouse move events

Parameters

event mouse move event

Reimplemented from igor::iWidget.

◆ open()

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

virtual

shows the dialog on screen

Parameters

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

Reimplemented in igor::iDialogColorGradient, and igor::iDialogMenu.

◆ putInFront()

void igor::iDialog::putInFront ( )

puts dialog in front of others

◆ setAcceptESCToClose()

void igor::iDialog::setAcceptESCToClose ( bool acceptESC )

set wether or not dialog accepts ESC to close the dialog

Parameters

acceptESC if true dialog accepts ESC to close

◆ setDockable()

void igor::iDialog::setDockable ( bool enable )

sets wether or not the dialog is dock-able

Parameters

enable if true dialog is becoming dock-able

◆ setHeaderEnabled()

void igor::iDialog::setHeaderEnabled ( bool enable )

enables/disables header

Parameters

enable if true header will be enabled

◆ setMoveable()

void igor::iDialog::setMoveable ( bool enable )

sets wether or not the dialog is moveable

Parameters

enable if true dialog is becoming moveable

◆ setPos()

void igor::iDialog::setPos ( const iaVector2f & pos )

sets position of dialog

implicitly sets alignment to absolute

Parameters

pos	position of dialog

◆ setResizeable()

void igor::iDialog::setResizeable ( bool enable )

sets wether or not the dialog is resize-able

Parameters

enable if true dialog is becoming resize-able

◆ setReturnState()

void igor::iDialog::setReturnState ( iDialogReturnState returnState )

sets the return state of this dialog

Parameters

returnState the return state to be set

◆ setTitle()

void igor::iDialog::setTitle ( const iaString & title )

sets title displayed in header

Parameters

title the title to set

◆ setX()

void igor::iDialog::setX ( int32 x )

sets horizontal position of dialog

implicitly sets horizontal alignment to absolute

Parameters

x	horizontal position

◆ setY()

void igor::iDialog::setY ( int32 y )

sets vertical position of dialog

implicitly sets vertical alignment to absolute

Parameters

y	vertical position

Friends And Related Function Documentation

◆ iWidgetManager

friend class iWidgetManager

friend

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

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

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ iDialog()

◆ ~iDialog()

Member Function Documentation

◆ close()

◆ getDockingParent()

◆ getPos()

◆ getReturnState()

◆ getTitle()

◆ hasHeader()

◆ isAcceptingESCToClose()

◆ isDockable()

◆ isDocked()

◆ isMoveable()

◆ isOpen()

◆ isResizeable()

◆ onKeyDown()

◆ onMouseKeyDown()

◆ onMouseKeyUp()

◆ onMouseMove()

◆ open()

◆ putInFront()

◆ setAcceptESCToClose()

◆ setDockable()

◆ setHeaderEnabled()

◆ setMoveable()

◆ setPos()

◆ setResizeable()

◆ setReturnState()

◆ setTitle()

◆ setX()

◆ setY()

Friends And Related Function Documentation

◆ iWidgetManager