PropertiesEditorWidget Class Reference

The PropertiesEditorWidget class This class extend QWidget method to have a common way to edit properties. More...

#include <propertieseditorwidget.h>

Inheritance diagram for PropertiesEditorWidget:

Collaboration diagram for PropertiesEditorWidget:

Public Member Functions
	PropertiesEditorWidget (QWidget *parent=nullptr)
	PropertiesEditorWidget::PropertiesEditorWidget Constructor.
virtual void	apply ()
virtual void	reset ()
virtual QUndoCommand *	associatedUndo () const
	PropertiesEditorWidget::associatedUndo By default, return a nullptr.
virtual QString	title () const
	PropertiesEditorWidget::title.
virtual void	updateUi ()
virtual bool	setLiveEdit (bool live_edit)
	PropertiesEditorWidget::setLiveEdit Set the editor in live edit mode. When an editor is in live edit mode, every change is applied immediately (no need to call apply). If live edit can be enabled, return true, or else false. By default this method does nothing and returns false (live edit is disabled). Inherited class of PropertiesEditorWidget must reimplement this method to manage the live edit mode.
bool	isLiveEdit () const
	PropertiesEditorWidget::isLiveEdit.

Protected Member Functions
virtual void	enableLiveEdit ()
virtual void	disableLiveEdit ()

Protected Attributes
bool	m_live_edit

Detailed Description

The PropertiesEditorWidget class This class extend QWidget method to have a common way to edit properties.

Constructor & Destructor Documentation

PropertiesEditorWidget()

PropertiesEditorWidget::PropertiesEditorWidget ( QWidget *  parent = nullptr )

explicit

PropertiesEditorWidget::PropertiesEditorWidget Constructor.

Parameters

parent

: parent widget

Member Function Documentation

apply()

virtual void PropertiesEditorWidget::apply ( )

inlinevirtual

Reimplemented in GraphicsTablePropertiesEditor, DynamicElementTextItemEditor, ElementInfoWidget, ElementPropertiesWidget, ImagePropertiesWidget, IndiTextPropertiesWidget, LinkSingleElementWidget, and MasterPropertiesWidget.

Here is the caller graph for this function:

associatedUndo()

QUndoCommand * PropertiesEditorWidget::associatedUndo ( ) const

virtual

PropertiesEditorWidget::associatedUndo By default, return a nullptr.

Returns

nullptr

Reimplemented in GraphicsTablePropertiesEditor, DynamicElementTextItemEditor, ElementInfoWidget, ImagePropertiesWidget, IndiTextPropertiesWidget, LinkSingleElementWidget, MasterPropertiesWidget, and ShapeGraphicsItemPropertiesWidget.

Here is the caller graph for this function:

disableLiveEdit()

virtual void PropertiesEditorWidget::disableLiveEdit ( )

inlineprotectedvirtual

Reimplemented in ElementInfoWidget.

enableLiveEdit()

virtual void PropertiesEditorWidget::enableLiveEdit ( )

inlineprotectedvirtual

Reimplemented in ElementInfoWidget.

isLiveEdit()

bool PropertiesEditorWidget::isLiveEdit

(

)

const

PropertiesEditorWidget::isLiveEdit.

Returns

true if this editor is in live edit mode else return false.

reset()

virtual void PropertiesEditorWidget::reset ( )

inlinevirtual

Reimplemented in ElementPropertiesWidget, ImagePropertiesWidget, and MasterPropertiesWidget.

Here is the caller graph for this function:

setLiveEdit()

bool PropertiesEditorWidget::setLiveEdit ( bool  live_edit )

virtual

PropertiesEditorWidget::setLiveEdit Set the editor in live edit mode. When an editor is in live edit mode, every change is applied immediately (no need to call apply). If live edit can be enabled, return true, or else false. By default this method does nothing and returns false (live edit is disabled). Inherited class of PropertiesEditorWidget must reimplement this method to manage the live edit mode.

Parameters

live_edit

true to enable live edit

Returns

true if live edit is enabled, else false.

Reimplemented in GraphicsTablePropertiesEditor, DynamicElementTextItemEditor, ElementInfoWidget, ElementPropertiesWidget, ImagePropertiesWidget, IndiTextPropertiesWidget, LinkSingleElementWidget, MasterPropertiesWidget, and ShapeGraphicsItemPropertiesWidget.

Here is the caller graph for this function:

title()

QString PropertiesEditorWidget::title ( ) const

virtual

PropertiesEditorWidget::title.

Returns

the title of this editor

Reimplemented in DynamicElementTextItemEditor, ElementInfoWidget, LinkSingleElementWidget, MasterPropertiesWidget, and ShapeGraphicsItemPropertiesWidget.

updateUi()

virtual void PropertiesEditorWidget::updateUi ( )

inlinevirtual

Reimplemented in ElementInfoWidget, ElementPropertiesWidget, ImagePropertiesWidget, IndiTextPropertiesWidget, and ShapeGraphicsItemPropertiesWidget.

Here is the caller graph for this function:

Member Data Documentation

m_live_edit

bool PropertiesEditorWidget::m_live_edit

protected

---

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

• sources/PropertiesEditor/propertieseditorwidget.h
• sources/PropertiesEditor/propertieseditorwidget.cpp