#include <AbstractLayout.hpp>

Inheritance diagram for AbstractLayout:

Collaboration diagram for AbstractLayout:

Classes
struct	SAbstractLayoutData

struct	SComponentsBox

Public Member Functions
	AbstractLayout ()

	~AbstractLayout () override=default

void	addStart (AbstractComponentGUI *components) const

void	addStart (AbstractComponentGUI *components, bool expand, bool fill, iv::types::padding padding=AbstractLayout::kPaddingDefault) const

void	addEnd (AbstractComponentGUI *components) const

void	addEnd (AbstractComponentGUI *components, bool expand, bool fill, iv::types::padding padding=AbstractLayout::kPaddingDefault) const

virtual void	addStartLabeled (AbstractComponentGUI *components, std::string_view label)=0

void	setHAlignmentComponents (CEnumComponentsGUI::EAlignmentHorizontal alignment)

void	setVAlignmentComponents (CEnumComponentsGUI::EAlignmentVertical alignment)

void	setCompact (bool isCompact) const

void	setPadding (iv::types::padding padding) const

void	addListenerShortClick (IListenerClick **listener)

void	emplaceListenerShortClick (std::function< void(CEventClick *evtClick)> clickFunctionCall)
	Agrega un IListenerClick formado mediante una función lambda.

void	runListenersShortClick ()

bool	hasListenersShortClick () const

void	addListenerLongClick (IListenerClick **listener)

void	emplaceListenerLongClick (std::function< void(CEventClick *evtClick)> clickFunctionCall)

void	runListenersLongClick ()

bool	hasListenersLongClick () const

CDialog *	getDialogFatherRef ()

void	setDialogFatherOption (CDialog *dialogFatherRef)

std::string	getTooltip () const

bool	getActive () const

bool	getInactiveVisualFeedback () const

void	getSize (double sizeX, double sizeY) const

IWidget *	makeWidget (CDialog dialogFatherRef, AbstractComponentGUI componentFatherRef)

virtual void	destroyWidget ()

void	addDataPanel (IDataPanel **dataPanel)

void	addListenerAccept (IListenerAccept **listenerAccept)

void	addListenerValidate (IListenerValidate **listenerValidate)

void	addListenerChange (IListenerChange **listenerChange)

void	addListenerClose (IListenerClose **listenerClose)

void	addListenerIsAccept (IListenerIsAccept **listenerIsAccept)

void	addListenerUpdate (IListenerUpdate **listenerUpdate)

void	addListenerTimer (uint64_t timeout, IListenerTimer **timer)
	Agrega un listener de tipo Timer.

void	emplaceListenerAccept (std::function< void()> acceptFunctionCall)
	Agrega un IListenerAccept formado mediante una función lambda.

void	emplaceListenerClose (std::function< void()> closeFunctionCall)
	Agrega un IListenerClose formado mediante una función lambda.

void	emplaceListenerChange (std::function< void(CDialog , AbstractComponentGUI )> changeFunctionCall)
	Agrega un IListenerChange formado mediante una función lambda.

void	emplaceListenerIsAccept (std::function< bool(AbstractComponentGUI , std::string )> isAcceptFunctionCall)
	Agrega un IListenerIsAccept formado mediante una función lambda.

void	emplaceListenerTimer (uint64_t timeout, std::function< bool()> timerExecutionFunctionCall)
	Agrega un IListenerTimer formado mediante una función lambda.

bool	runValidate ()

void	runChange ()

void	runClose ()

bool	runListenersIsAccept (std::string *messageError)

void	runListenersAccept ()

void	runListenersUpdate ()

void	displayPopOver (std::string_view message, iv::types::milliseconds timeout=2000)

void	grabFocus ()

void	setName (const std::string &name)

void	setTooltip (std::string_view tooltip)

void	setActive (bool isActive)

void	setHAlignment (CEnumComponentsGUI::EAlignmentHorizontal alignment)

void	setVAlignment (CEnumComponentsGUI::EAlignmentVertical alignment)

void	setBlinking (bool isBlinking)

void	setColorBlink (iv::types::color colorARGB)

void	setColorBackground (iv::types::color colorARGB)

void	setColorForeground (iv::types::color colorARGB)

void	setDefaultColorBlink ()

void	setDefaultColorBackground ()

void	setDefaultColorForeground ()

void	setDefaultMinimum (iv::types::width sizeX, iv::types::height sizeY)

void	setDefaultWidthMaximum (iv::types::width sizeX)

void	setDefaultHeightMaximum (iv::types::height sizeY)

void	setVisible (bool isVisible)

void	setInactiveVisualFeedback (bool hasInactiveVisualFeedback)

IWidget *	getWidget () const

bool	getBlinking ()

void	updateColor ()

Static Public Attributes
static constexpr iv::types::padding	kPaddingDefault = 5

Protected Member Functions
virtual IWidget *	createLayout ()=0

IWidget *	createWidget (CDialog *dialogFatherRef) override

Protected Attributes
std::vector< IListenerIsAccept * > *	m_listenersIsAccept

std::vector< IListenerAccept * > *	m_listenersAccept

std::vector< IListenerValidate * > *	m_listenersValidate

std::vector< IListenerChange * > *	m_listenersChange

std::vector< IListenerClose * > *	m_listenersClose

std::vector< IListenerUpdate * > *	m_listenersUpdate

const std::weak_ptr< IComponentsGUI > &	m_frameRef {m_mutableFrameRef}

std::weak_ptr< IComponentsGUI >	m_mutableFrameRef

AbstractComponentGUI *	m_componentFatherRef

IWidget *	m_widget

CDialog *	m_dialogFatherRef

Private Member Functions
void	prvProcessCloseChildren () override

void	prvProcessChangeRecursive (uint64_t recursiveLevel)

Private Attributes
std::vector< IListenerClick * >	m_listenersShortClick

std::vector< IListenerClick * >	m_listenersLongClick

std::shared_ptr< SAbstractLayoutData >	m_abstractLayoutData

std::string	m_name

std::string	m_tooltip

bool	m_isVisible

bool	m_isActive

bool	m_hasInactiveVisualFeedback {true}

CEnumComponentsGUI::EAlignmentHorizontal	m_alignmentHorizontalComponent

CEnumComponentsGUI::EAlignmentVertical	m_alignmentVerticalComponent

CAttrColorComp *	m_attrColor

bool	m_hasSizeMinimum

iv::types::width	m_sizeXMinimum

iv::types::height	m_sizeYMinimum

std::optional< iv::types::width >	m_sizeXMaximum

std::optional< iv::types::height >	m_sizeYMaximum

std::vector< std::shared_ptr< SPrvTimerData > >	m_rcpTimers

std::vector< IDataPanel * > *	m_dataPanels

Constructor & Destructor Documentation

◆ AbstractLayout()

AbstractLayout::AbstractLayout ( )

◆ ~AbstractLayout()

AbstractLayout::~AbstractLayout ( )

overridedefault

Member Function Documentation

◆ addDataPanel()

void AbstractComponentGUI::addDataPanel ( IDataPanel ** dataPanel )

inherited

◆ addEnd() [1/2]

void AbstractLayout::addEnd ( AbstractComponentGUI * components ) const

◆ addEnd() [2/2]

void AbstractLayout::addEnd	(	AbstractComponentGUI *	components,
		bool	expand,
		bool	fill,
		iv::types::padding	padding = AbstractLayout::kPaddingDefault ) const

◆ addListenerAccept()

void AbstractComponentGUI::addListenerAccept ( IListenerAccept ** listenerAccept )

inherited

◆ addListenerChange()

void AbstractComponentGUI::addListenerChange ( IListenerChange ** listenerChange )

inherited

◆ addListenerClose()

void AbstractComponentGUI::addListenerClose ( IListenerClose ** listenerClose )

inherited

◆ addListenerIsAccept()

void AbstractComponentGUI::addListenerIsAccept ( IListenerIsAccept ** listenerIsAccept )

inherited

◆ addListenerLongClick()

void AbstractLayout::addListenerLongClick ( IListenerClick ** listener )

◆ addListenerShortClick()

void AbstractLayout::addListenerShortClick ( IListenerClick ** listener )

◆ addListenerTimer()

void AbstractComponentGUI::addListenerTimer	(	uint64_t	timeout,
		IListenerTimer **	timer )

inherited

Agrega un listener de tipo Timer.

Parameters

timeout	tiempo de espera en milisegundos.
timer	referencia al listener Timer.

Note: El listener Timer se destruye al destruir el AbstractComponentGUI.; Si el Timer devuelve False, se destruye y no se vuelve a ejecutar.

◆ addListenerUpdate()

void AbstractComponentGUI::addListenerUpdate ( IListenerUpdate ** listenerUpdate )

inherited

◆ addListenerValidate()

void AbstractComponentGUI::addListenerValidate ( IListenerValidate ** listenerValidate )

inherited

◆ addStart() [1/2]

void AbstractLayout::addStart ( AbstractComponentGUI * components ) const

◆ addStart() [2/2]

void AbstractLayout::addStart	(	AbstractComponentGUI *	components,
		bool	expand,
		bool	fill,
		iv::types::padding	padding = AbstractLayout::kPaddingDefault ) const

Añade un elemento al layout.

Parameters

components	Componente a añadir.
expand	Si se debe expandir el espacio que ocupa (al redimensionar ocupa el mismo espacio relativo)
fill	Si el dibujado debe ocupar todo el espacio que ocupa
padding	Espaciado con los demás

◆ addStartLabeled()

virtual void AbstractLayout::addStartLabeled	(	AbstractComponentGUI *	components,
		std::string_view	label )

pure virtual

Implemented in CLayoutHorizontal, and CLayoutVertical.

◆ createLayout()

virtual IWidget * AbstractLayout::createLayout ( )

protectedpure virtual

Implemented in CLayoutHorizontal, and CLayoutVertical.

◆ createWidget()

IWidget * AbstractLayout::createWidget ( CDialog * dialogFatherRef )

overrideprotectedvirtual

Implements AbstractComponentGUI.

◆ destroyWidget()

void AbstractComponentGUI::destroyWidget ( )

virtualinherited

destroyWidget.

Destroys the widget held by the AbstractComponentGUI object and resets its related references.

This is needed for example by the object CSheet to create and destroy widgets on demand, keeping the component (AbstractComponentGUI), in order to manage multiple cells and preventing a high increase in memory use.

Inherited classes that hold a reference to the related members must reset them too (override this virtual method).

Reimplemented in CCalendar, CCanvas, CCheckButton, CComboBox, CComboBoxString, CEdit, CFrameBin, CGooCanvas, CInfoBar, CLayoutContainer, CLayoutLayers, CLayoutTabs, CList, CPaned, CPickerFileChooser, CProgress, CRadioButton, CSheet, and CTree.

◆ displayPopOver()

void AbstractComponentGUI::displayPopOver	(	std::string_view	message,
		iv::types::milliseconds	timeout = 2000 )

inherited

◆ emplaceListenerAccept()

void AbstractComponentGUI::emplaceListenerAccept ( std::function< void()> acceptFunctionCall )

inherited

Agrega un IListenerAccept formado mediante una función lambda.

Parameters

acceptFunctionCall función lambda a ejecutar por el listener.

Note: Si la función lambda tiene parámetros adicionales, pasar esos parámetros por copia y no referencia.

◆ emplaceListenerChange()

void AbstractComponentGUI::emplaceListenerChange ( std::function< void(CDialog *, AbstractComponentGUI *)> changeFunctionCall )

inherited

Agrega un IListenerChange formado mediante una función lambda.

Parameters

changeFunctionCall función lambda a ejecutar por el listener.

Note: Si la función lambda tiene parámetros adicionales, pasar esos parámetros por copia y no referencia.

◆ emplaceListenerClose()

void AbstractComponentGUI::emplaceListenerClose ( std::function< void()> closeFunctionCall )

inherited

Agrega un IListenerClose formado mediante una función lambda.

Parameters

closeFunctionCall función lambda a ejecutar por el listener.

Note: Si la función lambda tiene parámetros adicionales, pasar esos parámetros por copia y no referencia.

◆ emplaceListenerIsAccept()

void AbstractComponentGUI::emplaceListenerIsAccept ( std::function< bool(AbstractComponentGUI *, std::string *)> isAcceptFunctionCall )

inherited

Agrega un IListenerIsAccept formado mediante una función lambda.

Parameters

isAcceptFunctionCall función lambda a ejecutar por el listener.

Note: Si la función lambda tiene parámetros adicionales, pasar esos parámetros por copia y no referencia.

◆ emplaceListenerLongClick()

void AbstractLayout::emplaceListenerLongClick ( std::function< void(CEventClick *evtClick)> clickFunctionCall )

◆ emplaceListenerShortClick()

void AbstractLayout::emplaceListenerShortClick ( std::function< void(CEventClick *evtClick)> clickFunctionCall )

Agrega un IListenerClick formado mediante una función lambda.

Parameters

clickFunctionCall función lambda a ejecutar por el listener.

Note: Si la función lambda tiene parámetros adicionales, pasar esos parámetros por copia y no referencia.

◆ emplaceListenerTimer()

void AbstractComponentGUI::emplaceListenerTimer	(	uint64_t	timeout,
		std::function< bool()>	timerExecutionFunctionCall )

inherited

Agrega un IListenerTimer formado mediante una función lambda.

Parameters

timeout	tiempo de espera en milisegundos.
timerExecutionFunctionCall	función lambda a ejecutar por el listener.

Note: Si la función lambda devuelve False, el listener Timer se destruye y no se vuelve a invocar.

◆ getActive()

bool AbstractComponentGUI::getActive ( ) const

nodiscardinherited

◆ getBlinking()

bool AbstractComponentGUI::getBlinking ( )

inherited

◆ getDialogFatherRef()

CDialog * AbstractComponentGUI::getDialogFatherRef ( )

inherited

◆ getInactiveVisualFeedback()

bool AbstractComponentGUI::getInactiveVisualFeedback ( ) const

nodiscardinherited

◆ getSize()

void AbstractComponentGUI::getSize	(	double *	sizeX,
		double *	sizeY ) const

inherited

◆ getTooltip()

std::string AbstractComponentGUI::getTooltip ( ) const

nodiscardinherited

◆ getWidget()

IWidget * AbstractComponentGUI::getWidget ( ) const

inherited

◆ grabFocus()

void AbstractComponentGUI::grabFocus ( )

inherited

◆ hasListenersLongClick()

bool AbstractLayout::hasListenersLongClick ( ) const

◆ hasListenersShortClick()

bool AbstractLayout::hasListenersShortClick ( ) const

◆ makeWidget()

IWidget * AbstractComponentGUI::makeWidget	(	CDialog *	dialogFatherRef,
		AbstractComponentGUI *	componentFatherRef )

inherited

◆ prvProcessChangeRecursive()

void AbstractComponentGUI::prvProcessChangeRecursive ( uint64_t recursiveLevel )

privateinherited

◆ prvProcessCloseChildren()

void AbstractLayout::prvProcessCloseChildren ( )

overrideprivatevirtual

Reimplemented from AbstractComponentGUI.

◆ runChange()

void AbstractComponentGUI::runChange ( )

inherited

◆ runClose()

void AbstractComponentGUI::runClose ( )

inherited

◆ runListenersAccept()

void AbstractComponentGUI::runListenersAccept ( )

inherited

◆ runListenersIsAccept()

bool AbstractComponentGUI::runListenersIsAccept ( std::string * messageError )

inherited

◆ runListenersLongClick()

void AbstractLayout::runListenersLongClick ( )

◆ runListenersShortClick()

void AbstractLayout::runListenersShortClick ( )

◆ runListenersUpdate()

void AbstractComponentGUI::runListenersUpdate ( )

inherited

◆ runValidate()

bool AbstractComponentGUI::runValidate ( )

inherited

◆ setActive()

void AbstractComponentGUI::setActive ( bool isActive )

inherited

◆ setBlinking()

void AbstractComponentGUI::setBlinking ( bool isBlinking )

inherited

◆ setColorBackground()

void AbstractComponentGUI::setColorBackground ( iv::types::color colorARGB )

inherited

◆ setColorBlink()

void AbstractComponentGUI::setColorBlink ( iv::types::color colorARGB )

inherited

◆ setColorForeground()

void AbstractComponentGUI::setColorForeground ( iv::types::color colorARGB )

inherited

◆ setCompact()

void AbstractLayout::setCompact ( bool isCompact ) const

◆ setDefaultColorBackground()

void AbstractComponentGUI::setDefaultColorBackground ( )

inherited

◆ setDefaultColorBlink()

void AbstractComponentGUI::setDefaultColorBlink ( )

inherited

◆ setDefaultColorForeground()

void AbstractComponentGUI::setDefaultColorForeground ( )

inherited

◆ setDefaultHeightMaximum()

void AbstractComponentGUI::setDefaultHeightMaximum ( iv::types::height sizeY )

inherited

◆ setDefaultMinimum()

void AbstractComponentGUI::setDefaultMinimum	(	iv::types::width	sizeX,
		iv::types::height	sizeY )

inherited

◆ setDefaultWidthMaximum()

void AbstractComponentGUI::setDefaultWidthMaximum ( iv::types::width sizeX )

inherited

◆ setDialogFatherOption()

void AbstractComponentGUI::setDialogFatherOption ( CDialog * dialogFatherRef )

inherited

◆ setHAlignment()

void AbstractComponentGUI::setHAlignment ( CEnumComponentsGUI::EAlignmentHorizontal alignment )

inherited

◆ setHAlignmentComponents()

void AbstractLayout::setHAlignmentComponents ( CEnumComponentsGUI::EAlignmentHorizontal alignment )

◆ setInactiveVisualFeedback()

void AbstractComponentGUI::setInactiveVisualFeedback ( bool hasInactiveVisualFeedback )

inherited

◆ setName()

void AbstractComponentGUI::setName ( const std::string & name )

inherited

◆ setPadding()

void AbstractLayout::setPadding ( iv::types::padding padding ) const

◆ setTooltip()

void AbstractComponentGUI::setTooltip ( std::string_view tooltip )

inherited

◆ setVAlignment()

void AbstractComponentGUI::setVAlignment ( CEnumComponentsGUI::EAlignmentVertical alignment )

inherited

◆ setVAlignmentComponents()

void AbstractLayout::setVAlignmentComponents ( CEnumComponentsGUI::EAlignmentVertical alignment )

◆ setVisible()

void AbstractComponentGUI::setVisible ( bool isVisible )

inherited

◆ updateColor()

void AbstractComponentGUI::updateColor ( )

inherited

Member Data Documentation

◆ kPaddingDefault

iv::types::padding AbstractLayout::kPaddingDefault = 5

staticconstexpr

◆ m_abstractLayoutData

std::shared_ptr<SAbstractLayoutData> AbstractLayout::m_abstractLayoutData

private

◆ m_alignmentHorizontalComponent

CEnumComponentsGUI::EAlignmentHorizontal AbstractComponentGUI::m_alignmentHorizontalComponent

privateinherited

◆ m_alignmentVerticalComponent

CEnumComponentsGUI::EAlignmentVertical AbstractComponentGUI::m_alignmentVerticalComponent

privateinherited

◆ m_attrColor

CAttrColorComp* AbstractComponentGUI::m_attrColor

privateinherited

◆ m_componentFatherRef

AbstractComponentGUI* AbstractComponentGUI::m_componentFatherRef

protectedinherited

◆ m_dataPanels

std::vector<IDataPanel *>* AbstractComponentGUI::m_dataPanels

privateinherited

◆ m_dialogFatherRef

CDialog* AbstractComponentGUI::m_dialogFatherRef

protectedinherited

◆ m_frameRef

const std::weak_ptr<IComponentsGUI>& AbstractComponentGUI::m_frameRef {m_mutableFrameRef}

protectedinherited

◆ m_hasInactiveVisualFeedback

bool AbstractComponentGUI::m_hasInactiveVisualFeedback {true}

privateinherited

◆ m_hasSizeMinimum

bool AbstractComponentGUI::m_hasSizeMinimum

privateinherited

◆ m_isActive

bool AbstractComponentGUI::m_isActive

privateinherited

◆ m_isVisible

bool AbstractComponentGUI::m_isVisible

privateinherited

◆ m_listenersAccept

std::vector<IListenerAccept *>* AbstractComponentGUI::m_listenersAccept

protectedinherited

◆ m_listenersChange

std::vector<IListenerChange *>* AbstractComponentGUI::m_listenersChange

protectedinherited

◆ m_listenersClose

std::vector<IListenerClose *>* AbstractComponentGUI::m_listenersClose

protectedinherited

◆ m_listenersIsAccept

std::vector<IListenerIsAccept *>* AbstractComponentGUI::m_listenersIsAccept

protectedinherited

◆ m_listenersLongClick

std::vector<IListenerClick *> AbstractLayout::m_listenersLongClick

private

◆ m_listenersShortClick

std::vector<IListenerClick *> AbstractLayout::m_listenersShortClick

private

◆ m_listenersUpdate

std::vector<IListenerUpdate *>* AbstractComponentGUI::m_listenersUpdate

protectedinherited

◆ m_listenersValidate

std::vector<IListenerValidate *>* AbstractComponentGUI::m_listenersValidate

protectedinherited

◆ m_mutableFrameRef

std::weak_ptr<IComponentsGUI> AbstractComponentGUI::m_mutableFrameRef

protectedinherited

◆ m_name

std::string AbstractComponentGUI::m_name

privateinherited

◆ m_rcpTimers

std::vector<std::shared_ptr<SPrvTimerData> > AbstractComponentGUI::m_rcpTimers

privateinherited

◆ m_sizeXMaximum

std::optional<iv::types::width> AbstractComponentGUI::m_sizeXMaximum

privateinherited

◆ m_sizeXMinimum

iv::types::width AbstractComponentGUI::m_sizeXMinimum

privateinherited

◆ m_sizeYMaximum

std::optional<iv::types::height> AbstractComponentGUI::m_sizeYMaximum

privateinherited

◆ m_sizeYMinimum

iv::types::height AbstractComponentGUI::m_sizeYMinimum

privateinherited

◆ m_tooltip

std::string AbstractComponentGUI::m_tooltip

privateinherited

◆ m_widget

IWidget* AbstractComponentGUI::m_widget

protectedinherited

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

src/ui/gui/AbstractLayout.hpp
src/ui/gui/AbstractLayout.cpp

Classes

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ AbstractLayout()

◆ ~AbstractLayout()

Member Function Documentation

◆ addDataPanel()

◆ addEnd() [1/2]

◆ addEnd() [2/2]

◆ addListenerAccept()

◆ addListenerChange()

◆ addListenerClose()

◆ addListenerIsAccept()

◆ addListenerLongClick()

◆ addListenerShortClick()

◆ addListenerTimer()

◆ addListenerUpdate()

◆ addListenerValidate()

◆ addStart() [1/2]

◆ addStart() [2/2]

◆ addStartLabeled()

◆ createLayout()

◆ createWidget()

◆ destroyWidget()

◆ displayPopOver()

◆ emplaceListenerAccept()

◆ emplaceListenerChange()

◆ emplaceListenerClose()

◆ emplaceListenerIsAccept()

◆ emplaceListenerLongClick()

◆ emplaceListenerShortClick()

◆ emplaceListenerTimer()

◆ getActive()

◆ getBlinking()

◆ getDialogFatherRef()

◆ getInactiveVisualFeedback()

◆ getSize()

◆ getTooltip()

◆ getWidget()

◆ grabFocus()

◆ hasListenersLongClick()

◆ hasListenersShortClick()

◆ makeWidget()

◆ prvProcessChangeRecursive()

◆ prvProcessCloseChildren()

◆ runChange()

◆ runClose()

◆ runListenersAccept()

◆ runListenersIsAccept()

◆ runListenersLongClick()

◆ runListenersShortClick()

◆ runListenersUpdate()

◆ runValidate()

◆ setActive()

◆ setBlinking()

◆ setColorBackground()

◆ setColorBlink()

◆ setColorForeground()

◆ setCompact()

◆ setDefaultColorBackground()

◆ setDefaultColorBlink()

◆ setDefaultColorForeground()

◆ setDefaultHeightMaximum()

◆ setDefaultMinimum()

◆ setDefaultWidthMaximum()

◆ setDialogFatherOption()

◆ setHAlignment()

◆ setHAlignmentComponents()

◆ setInactiveVisualFeedback()

◆ setName()

◆ setPadding()

◆ setTooltip()

◆ setVAlignment()

◆ setVAlignmentComponents()

◆ setVisible()