PropertiesEditorDockWidget Class Reference

#include <propertieseditordockwidget.h>

Inheritance diagram for PropertiesEditorDockWidget:

Collaboration diagram for PropertiesEditorDockWidget:

Public Member Functions
	PropertiesEditorDockWidget (QWidget *parent=nullptr)
	PropertiesEditorDockWidget::PropertiesEditorDockWidget Constructor.
	~PropertiesEditorDockWidget () override
	PropertiesEditorDockWidget::~PropertiesEditorDockWidget Destructor.
virtual void	clear ()
	PropertiesEditorDockWidget::clear Remove all editor present in this dock and delete it. They also disabled the button box at the bottom of this dock.
virtual void	apply ()
	PropertiesEditorDockWidget::apply Call the apply method for each editor present in this dock.
virtual void	reset ()
	PropertiesEditorDockWidget::reset Call the reset method for each editor present in this widget.
bool	addEditor (PropertiesEditorWidget *editor, int index=0)
	PropertiesEditorDockWidget::addEditor Add an editor in this dock at index in the main vertical layout (note the button box are displayed at bottom of this layout by default) When an editor is added, we enable the button box.
QList< PropertiesEditorWidget * >	editors () const
	PropertiesEditorDockWidget::editors.
bool	removeEditor (PropertiesEditorWidget *editor)
	PropertiesEditorDockWidget::removeEditor Remove editor from this dock. The editor wasn't delete a the end of this method If the editor was the last on this widget, we disabled the button box.

Protected Attributes
QList< PropertiesEditorWidget * >	m_editor_list

Private Attributes
Ui::PropertiesEditorDockWidget *	ui

Constructor & Destructor Documentation

PropertiesEditorDockWidget()

PropertiesEditorDockWidget::PropertiesEditorDockWidget ( QWidget *  parent = nullptr )

explicit

PropertiesEditorDockWidget::PropertiesEditorDockWidget Constructor.

Parameters

parent

: parent widget

~PropertiesEditorDockWidget()

PropertiesEditorDockWidget::~PropertiesEditorDockWidget ( )

override

PropertiesEditorDockWidget::~PropertiesEditorDockWidget Destructor.

Here is the call graph for this function:

Member Function Documentation

addEditor()

bool PropertiesEditorDockWidget::addEditor	(	PropertiesEditorWidget *	editor,
		int	index = 0
	)

PropertiesEditorDockWidget::addEditor Add an editor in this dock at index in the main vertical layout (note the button box are displayed at bottom of this layout by default) When an editor is added, we enable the button box.

Parameters

editor	: editor to add;
index	: index of editor in the layout

Returns

true if was added (or already add) or false if can't be add (editor = nullptr)

Here is the caller graph for this function:

apply()

void PropertiesEditorDockWidget::apply ( )

virtual

PropertiesEditorDockWidget::apply Call the apply method for each editor present in this dock.

Here is the call graph for this function:

clear()

void PropertiesEditorDockWidget::clear ( )

virtual

PropertiesEditorDockWidget::clear Remove all editor present in this dock and delete it. They also disabled the button box at the bottom of this dock.

Here is the caller graph for this function:

editors()

QList< PropertiesEditorWidget * > PropertiesEditorDockWidget::editors

(

)

const

PropertiesEditorDockWidget::editors.

Returns

all editor used in this dock

Here is the caller graph for this function:

removeEditor()

bool PropertiesEditorDockWidget::removeEditor

(

PropertiesEditorWidget *

editor

)

PropertiesEditorDockWidget::removeEditor Remove editor from this dock. The editor wasn't delete a the end of this method If the editor was the last on this widget, we disabled the button box.

Parameters

editor

: editor to remove

Returns

true on success, else false

Here is the caller graph for this function:

reset()

void PropertiesEditorDockWidget::reset ( )

virtual

PropertiesEditorDockWidget::reset Call the reset method for each editor present in this widget.

Here is the call graph for this function:

Member Data Documentation

m_editor_list

QList<PropertiesEditorWidget *> PropertiesEditorDockWidget::m_editor_list

protected

ui

Ui::PropertiesEditorDockWidget* PropertiesEditorDockWidget::ui

private

---

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

• sources/PropertiesEditor/propertieseditordockwidget.h
• sources/PropertiesEditor/propertieseditordockwidget.cpp