#include <CInfoBar.hpp>

Inheritance diagram for CInfoBar:

Collaboration diagram for CInfoBar:

Public Types
enum class	EProjectValidForDiamar { IsValid , WarningValid , NotValid }

Public Member Functions
	CInfoBar (bool displayStatusCircle)

	~CInfoBar () override

void	destroyWidget () override

void	setError (const std::string &message)

void	setInfo (const std::string &message)

void	setWarning (const std::string &message)

void	getStateColour (double &red, double &green, double &blue)
	Obtiene el color del estado del projecto para representar en el indicador.

void	setProjectValidState (EProjectValidForDiamar projectValidForDiamar)
	Setea el estado del proyecto para representarlo en el punto indicador de estado con su color correspondiente.

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)

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

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 Types
enum class	EPrvTypeMessage { Info , Error , Warning }

Private Member Functions
IWidget *	createWidget (CDialog *dialogFatherRef) override

void	prvProcessChangeRecursive (uint64_t recursiveLevel)

virtual void	prvProcessCloseChildren ()

Private Attributes
EPrvTypeMessage	m_typeMessage

std::string	m_message

bool	m_displayStatusCircle

EProjectValidForDiamar	m_projectIsValidForDiamar

IWidget *	m_infoBarRef

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

Member Enumeration Documentation

◆ EProjectValidForDiamar

enum class CInfoBar::EProjectValidForDiamar

strong

Enumerator
IsValid
WarningValid
NotValid

◆ EPrvTypeMessage

enum class CInfoBar::EPrvTypeMessage

strongprivate

Enumerator
Info
Error
Warning

Constructor & Destructor Documentation

◆ CInfoBar()

CInfoBar::CInfoBar ( bool displayStatusCircle )

explicit

◆ ~CInfoBar()

CInfoBar::~CInfoBar ( )

override

Member Function Documentation

◆ addDataPanel()

void AbstractComponentGUI::addDataPanel ( IDataPanel ** dataPanel )

inherited

◆ 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

◆ 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

◆ createWidget()

IWidget * CInfoBar::createWidget ( CDialog * dialogFatherRef )

overrideprivatevirtual

Implements AbstractComponentGUI.

◆ destroyWidget()

void CInfoBar::destroyWidget ( )

overridevirtual

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 from AbstractComponentGUI.

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

◆ 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

◆ getStateColour()

void CInfoBar::getStateColour	(	double &	red,
		double &	green,
		double &	blue )

Obtiene el color del estado del projecto para representar en el indicador.

Parameters

[out]	red
[out]	green
[out]	blue

◆ getTooltip()

std::string AbstractComponentGUI::getTooltip ( ) const

nodiscardinherited

◆ getWidget()

IWidget * AbstractComponentGUI::getWidget ( ) const

inherited

◆ grabFocus()

void AbstractComponentGUI::grabFocus ( )

inherited

◆ makeWidget()

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

inherited

◆ prvProcessChangeRecursive()

void AbstractComponentGUI::prvProcessChangeRecursive ( uint64_t recursiveLevel )

privateinherited

◆ prvProcessCloseChildren()

void AbstractComponentGUI::prvProcessCloseChildren ( )

privatevirtualinherited

Reimplemented in AbstractLayout, CLayoutContainer, CLayoutGrid, and CLayoutTabs.

◆ runChange()

void AbstractComponentGUI::runChange ( )

inherited

◆ runClose()

void AbstractComponentGUI::runClose ( )

inherited

◆ runListenersAccept()

void AbstractComponentGUI::runListenersAccept ( )

inherited

◆ runListenersIsAccept()

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

inherited

◆ 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

◆ 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

◆ setError()

void CInfoBar::setError ( const std::string & message )

◆ setHAlignment()

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

inherited

◆ setInactiveVisualFeedback()

void AbstractComponentGUI::setInactiveVisualFeedback ( bool hasInactiveVisualFeedback )

inherited

◆ setInfo()

void CInfoBar::setInfo ( const std::string & message )

◆ setName()

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

inherited

◆ setProjectValidState()

void CInfoBar::setProjectValidState ( CInfoBar::EProjectValidForDiamar projectValidForDiamar )

Setea el estado del proyecto para representarlo en el punto indicador de estado con su color correspondiente.

Parameters

projectValidForDiamar

◆ setTooltip()

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

inherited

◆ setVAlignment()

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

inherited

◆ setVisible()

void AbstractComponentGUI::setVisible ( bool isVisible )

inherited

◆ setWarning()

void CInfoBar::setWarning ( const std::string & message )

◆ updateColor()

void AbstractComponentGUI::updateColor ( )

inherited

Member Data Documentation

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

bool CInfoBar::m_displayStatusCircle

private

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

IWidget* CInfoBar::m_infoBarRef

private

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

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

protectedinherited

◆ m_listenersValidate

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

protectedinherited

◆ m_message

std::string CInfoBar::m_message

private

◆ m_mutableFrameRef

std::weak_ptr<IComponentsGUI> AbstractComponentGUI::m_mutableFrameRef

protectedinherited

◆ m_name

std::string AbstractComponentGUI::m_name

privateinherited

◆ m_projectIsValidForDiamar

EProjectValidForDiamar CInfoBar::m_projectIsValidForDiamar

private

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

EPrvTypeMessage CInfoBar::m_typeMessage

private

◆ m_widget

IWidget* AbstractComponentGUI::m_widget

protectedinherited

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

src/ui/gui/CInfoBar.hpp
src/ui/gui/CInfoBar.cpp

Public Types

Public Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Member Enumeration Documentation

◆ EProjectValidForDiamar

◆ EPrvTypeMessage

Constructor & Destructor Documentation

◆ CInfoBar()

◆ ~CInfoBar()

Member Function Documentation

◆ addDataPanel()

◆ addListenerAccept()

◆ addListenerChange()

◆ addListenerClose()

◆ addListenerIsAccept()

◆ addListenerTimer()

◆ addListenerUpdate()

◆ addListenerValidate()

◆ createWidget()

◆ destroyWidget()

◆ displayPopOver()

◆ emplaceListenerAccept()

◆ emplaceListenerChange()

◆ emplaceListenerClose()

◆ emplaceListenerIsAccept()

◆ emplaceListenerTimer()

◆ getActive()

◆ getBlinking()

◆ getDialogFatherRef()

◆ getInactiveVisualFeedback()

◆ getSize()

◆ getStateColour()

◆ getTooltip()

◆ getWidget()

◆ grabFocus()

◆ makeWidget()

◆ prvProcessChangeRecursive()

◆ prvProcessCloseChildren()

◆ runChange()

◆ runClose()

◆ runListenersAccept()

◆ runListenersIsAccept()

◆ runListenersUpdate()

◆ runValidate()

◆ setActive()

◆ setBlinking()

◆ setColorBackground()

◆ setColorBlink()

◆ setColorForeground()

◆ setDefaultColorBackground()

◆ setDefaultColorBlink()

◆ setDefaultColorForeground()

◆ setDefaultHeightMaximum()

◆ setDefaultMinimum()

◆ setDefaultWidthMaximum()

◆ setDialogFatherOption()

◆ setError()

◆ setHAlignment()

◆ setInactiveVisualFeedback()

◆ setInfo()

◆ setName()

◆ setProjectValidState()

◆ setTooltip()

◆ setVAlignment()

◆ setVisible()

◆ setWarning()

◆ updateColor()

Member Data Documentation

◆ m_alignmentHorizontalComponent

◆ m_alignmentVerticalComponent

◆ m_attrColor

◆ m_componentFatherRef

◆ m_dataPanels

◆ m_dialogFatherRef

◆ m_displayStatusCircle

◆ m_frameRef

◆ m_hasInactiveVisualFeedback