ezEngine Release 25.08
Loading...
Searching...
No Matches
ezQtPropertyWidget Class Referenceabstract

Base class for all property widgets. More...

#include <PropertyBaseWidget.moc.h>

Inheritance diagram for ezQtPropertyWidget:

Public Slots

void OnCustomContextMenu (const QPoint &pt)
 

Public Member Functions

 ezQtPropertyWidget ()
 *** BASE ***
 
void Init (ezQtPropertyGridWidget *pGrid, ezObjectAccessorBase *pObjectAccessor, const ezRTTI *pType, const ezAbstractProperty *pProp)
 
ezQtPropertyGridWidgetGetPropertyGrid ()
 
ezObjectAccessorBaseGetObjectAccessor ()
 
const ezRTTIGetType () const
 
const ezAbstractPropertyGetProperty () const
 
virtual void SetSelection (const ezHybridArray< ezPropertySelection, 8 > &items)
 This is called whenever the selection in the editor changes and thus the widget may need to display a different value.
 
const ezHybridArray< ezPropertySelection, 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 (ezStringBuilder &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 ezHybridArray< ezPropertySelection, 8 > &items, const ezAbstractProperty *pProperty, ezVariantType::Enum &out_type)
 If the property is of type ezVariant 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.
 
ezVariant GetCommonValue (const ezHybridArray< ezPropertySelection, 8 > &items, const ezAbstractProperty *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 ezRTTIGetCommonBaseType (const ezHybridArray< ezPropertySelection, 8 > &items)
 
static QColor SetPaletteBackgroundColor (ezColorGammaUB inputColor, QPalette &ref_palette)
 

Protected Member Functions

void Broadcast (ezPropertyEvent::Type type)
 
void PropertyChangedHandler (const ezPropertyEvent &ed)
 
virtual void OnInit ()=0
 
bool IsUndead () const
 
virtual void DoPrepareToDie ()=0
 
virtual bool eventFilter (QObject *pWatched, QEvent *pEvent) override
 

Protected Attributes

ezQtPropertyGridWidgetm_pGrid = nullptr
 
ezObjectAccessorBasem_pObjectAccessor = nullptr
 
const ezRTTIm_pType = nullptr
 
const ezAbstractPropertym_pProp = nullptr
 
ezHybridArray< ezPropertySelection, 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 ezQtPropertyWidget::HasLabel ( ) const
inlinevirtual

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

Reimplemented in ezQtPropertyEditorTagSetWidget, ezQtPropertyTypeWidget, ezQtPropertyPointerWidget, and ezQtPropertyContainerWidget.

◆ OnInit()

virtual void ezQtPropertyWidget::OnInit ( )
protectedpure virtual

◆ SetIsDefault()

virtual void ezQtPropertyWidget::SetIsDefault ( bool  bIsDefault)
inlinevirtual

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

Reimplemented in ezQtPropertyTypeWidget, and ezQtPropertyContainerWidget.

◆ SetReadOnly()

void ezQtPropertyWidget::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 ezQtFilePropertyWidget, ezQtPropertyEditorIntSpinboxWidget, and ezQtPropertyEditorLineEditWidget.

◆ SetSelection()

void ezQtPropertyWidget::SetSelection ( const ezHybridArray< ezPropertySelection, 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 ezQtCodeEditorPreferencesWidget, ezQtCompilerPreferencesWidget, ezQtExposedBoneWidget, ezQtExposedParametersPropertyWidget, ezQtPropertyEditorCurve1DWidget, ezQtPropertyEditorTagSetWidget, ezQtVarianceTypeWidget, ezQtStandardPropertyWidget, ezQtEmbeddedClassPropertyWidget, ezQtPropertyTypeWidget, ezQtPropertyPointerWidget, ezQtPropertyContainerWidget, and ezQtVariantContainerWidget.


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