iv::views::editor::ViewControls Class Reference

ViewControl class that will build the Controls' window. More...

#include <ViewControls.hpp>

Inheritance diagram for iv::views::editor::ViewControls:

Collaboration diagram for iv::views::editor::ViewControls:

Public Member Functions
	ViewControls ()
	~ViewControls () override=default
	ViewControls (const ViewControls &other)=delete
	ViewControls (ViewControls &&other)=delete
ViewControls &	operator= (const ViewControls &other)=delete
ViewControls &	operator= (ViewControls &&other)=delete
bool	isViewEditor () override
std::optional< iv::views::editor::eEditorView >	getEditorViewType () override
IWidget *	makeComponentFrame (CDialog *dialogFather, IComponentsGUI *frame, IListenerChange **listenerChange)
void	runClose ()
bool	runIsAccept (std::string *messageError)
AbstractComponentGUI *	unRefView ()
void	scheduleUpdate (bool schedule=true)
bool	updateScheduled () const
void	update ()
std::string	getTitle () const
AbstractViewPanelEditor *	getPanelEditor ()

Private Member Functions
AbstractComponentGUI *	create (CDialog *dialogFather, AbstractViewPanelEditor **viewPanelEditor) override

Private Attributes
std::string	m_title
AbstractComponentGUI *	m_componentView
AbstractViewPanelEditor *	m_panelEditor
bool	m_updateScheduled

Detailed Description

ViewControl class that will build the Controls' window.

Constructor & Destructor Documentation

ViewControls() [1/3]

iv::views::editor::ViewControls::ViewControls

(

)

~ViewControls()

iv::views::editor::ViewControls::~ViewControls ( )

overridedefault

ViewControls() [2/3]

iv::views::editor::ViewControls::ViewControls ( const ViewControls & other )

delete

ViewControls() [3/3]

iv::views::editor::ViewControls::ViewControls ( ViewControls && other )

delete

Member Function Documentation

create()

AbstractComponentGUI * iv::views::editor::ViewControls::create ( CDialog * dialogFather, AbstractViewPanelEditor ** viewPanelEditor )

overrideprivatevirtual

Implements AbstractView.

getEditorViewType()

std::optional< iv::views::editor::eEditorView > iv::views::editor::ViewControls::getEditorViewType ( )

inlineoverridevirtual

Reimplemented from AbstractView.

getPanelEditor()

AbstractViewPanelEditor * AbstractView::getPanelEditor ( )

inherited

getPanelEditor

Returns

view panel used to build the component view.

getTitle()

std::string AbstractView::getTitle ( ) const

nodiscardinherited

isViewEditor()

bool iv::views::editor::ViewControls::isViewEditor ( )

inlineoverridevirtual

isViewEditor

Returns

true if the view is one of the 'editDiamar' application; false otherwise.

Reimplemented from AbstractView.

makeComponentFrame()

IWidget * AbstractView::makeComponentFrame ( CDialog * dialogFather, IComponentsGUI * frame, IListenerChange ** listenerChange )

inherited

operator=() [1/2]

ViewControls & iv::views::editor::ViewControls::operator= ( const ViewControls & other )

delete

operator=() [2/2]

ViewControls & iv::views::editor::ViewControls::operator= ( ViewControls && other )

delete

runClose()

void AbstractView::runClose ( )

inherited

runIsAccept()

bool AbstractView::runIsAccept ( std::string * messageError )

inherited

scheduleUpdate()

void AbstractView::scheduleUpdate ( bool schedule = true )

inherited

scheduleUpdate

Let the view know that when being drawn next time, it will have to update first.

Parameters

[in]

schedule

flag indicating whether to set a schedule to update the view or not.

unRefView()

AbstractComponentGUI * AbstractView::unRefView ( )

inherited

update()

void AbstractView::update ( )

inherited

update

Updates view without destroying it, only if an update was needed.

updateScheduled()

bool AbstractView::updateScheduled ( ) const

nodiscardinherited

updateScheduled

Returns

true if the an update is scheduled for this view; false otherwise.

Member Data Documentation

m_componentView

AbstractComponentGUI* AbstractView::m_componentView

privateinherited

m_panelEditor

AbstractViewPanelEditor* AbstractView::m_panelEditor

privateinherited

m_title

std::string AbstractView::m_title

privateinherited

m_updateScheduled

bool AbstractView::m_updateScheduled

privateinherited

---

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

• src/ui/views/editor/ViewControls.hpp
• src/ui/views/editor/ViewControls.cpp