Base class for all property widgets. More...

#include <PropertyBaseWidget.moc.h>

Inheritance diagram for plQtPropertyWidget:

[legend]

Public Slots
void	OnCustomContextMenu (const QPoint &pt)

Public Member Functions
	plQtPropertyWidget ()
	* BASE *

void	Init (plQtPropertyGridWidget pGrid, plObjectAccessorBase pObjectAccessor, const plRTTI pType, const plAbstractProperty pProp)

const plAbstractProperty *	GetProperty () const

virtual void	SetSelection (const plHybridArray< plPropertySelection, 8 > &items)
	This is called whenever the selection in the editor changes and thus the widget may need to display a different value.

const plHybridArray< plPropertySelection, 8 > &	GetSelection () const

virtual bool	HasLabel () const
	If this returns true (default), a QLabel is created and the text that GetLabel() returns is displayed.

virtual const char *	GetLabel (plStringBuilder &ref_sTmp) const
	The return value is used to display a label, if HasLabel() returns true.

virtual void	ExtendContextMenu (QMenu &ref_menu)

virtual void	SetIsDefault (bool bIsDefault)
	Whether the variable that the widget represents is currently set to the default value or has been modified.

bool	GetCommonVariantSubType (const plHybridArray< plPropertySelection, 8 > &items, const plAbstractProperty *pProperty, plVariantType::Enum &out_type)
	If the property is of type plVariant this function returns whether all items have the same type. If true is returned, out_Type contains the common type. Note that 'invalid' can be a common type.

plVariant	GetCommonValue (const plHybridArray< plPropertySelection, 8 > &items, const plAbstractProperty *pProperty)

void	PrepareToDie ()

virtual void	SetReadOnly (bool bReadOnly=true)
	By default disables the widget, but can be overridden to make a widget more interactable (for example to be able to copy text from it).

Static Public Member Functions
static const plRTTI *	GetCommonBaseType (const plHybridArray< plPropertySelection, 8 > &items)

static QColor	SetPaletteBackgroundColor (plColorGammaUB inputColor, QPalette &ref_palette)

Protected Member Functions
void	Broadcast (plPropertyEvent::Type type)

void	PropertyChangedHandler (const plPropertyEvent &ed)

virtual void	OnInit ()=0

bool	IsUndead () const

virtual void	DoPrepareToDie ()=0

virtual bool	eventFilter (QObject pWatched, QEvent pEvent) override

Protected Attributes
plQtPropertyGridWidget *	m_pGrid = nullptr

plObjectAccessorBase *	m_pObjectAccessor = nullptr

const plRTTI *	m_pType = nullptr

const plAbstractProperty *	m_pProp = nullptr

plHybridArray< plPropertySelection, 8 >	m_Items

bool	m_bIsDefault
	Whether the variable that the widget represents is currently set to the default value or has been modified.

Detailed Description

Base class for all property widgets.

Member Function Documentation

◆ HasLabel()

virtual bool plQtPropertyWidget::HasLabel ( ) const

inlinevirtual

If this returns true (default), a QLabel is created and the text that GetLabel() returns is displayed.

Reimplemented in plQtPropertyContainerWidget, plQtPropertyEditorTagSetWidget, plQtPropertyPointerWidget, and plQtPropertyTypeWidget.

◆ OnInit()

virtual void plQtPropertyWidget::OnInit ( )

protectedpure virtual

Implemented in plQtPropertyEditorTagSetWidget.

◆ SetIsDefault()

virtual void plQtPropertyWidget::SetIsDefault ( bool bIsDefault )

inlinevirtual

Whether the variable that the widget represents is currently set to the default value or has been modified.

Reimplemented in plQtPropertyContainerWidget, and plQtPropertyTypeWidget.

◆ SetReadOnly()

void plQtPropertyWidget::SetReadOnly ( bool bReadOnly = true )

virtual

By default disables the widget, but can be overridden to make a widget more interactable (for example to be able to copy text from it).

Reimplemented in plQtFilePropertyWidget, plQtPropertyEditorDoubleSpinboxWidget, plQtPropertyEditorIntSpinboxWidget, and plQtPropertyEditorLineEditWidget.

◆ SetSelection()

void plQtPropertyWidget::SetSelection ( const plHybridArray< plPropertySelection, 8 > & items )

virtual

This is called whenever the selection in the editor changes and thus the widget may need to display a different value.

If the array holds more than one element, the user selected multiple objects. In this case, the code should check whether the values differ across the selected objects and if so, the widget should display "multiple values".

Reimplemented in plQtCompilerPreferencesWidget, plQtEmbeddedClassPropertyWidget, plQtExposedBoneWidget, plQtExposedParametersPropertyWidget, plQtPropertyContainerWidget, plQtPropertyEditorCurve1DWidget, plQtPropertyEditorTagSetWidget, plQtPropertyPointerWidget, plQtPropertyTypeWidget, plQtStandardPropertyWidget, and plQtVarianceTypeWidget.

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

Code/Tools/Libs/GuiFoundation/PropertyGrid/PropertyBaseWidget.moc.h
Code/Tools/Libs/GuiFoundation/PropertyGrid/Implementation/PropertyBaseWidget.cpp

Public Slots

Public Member Functions

Static Public Member Functions

Protected Member Functions