ezEngine Release 25.08
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ezQtStandardPropertyWidget Class Referenceabstract

Base class for most 'simple' property type widgets. Implements some of the standard functionality. More...

#include <PropertyBaseWidget.moc.h>

Inheritance diagram for ezQtStandardPropertyWidget:
Inheritance graph
[legend]

Public Member Functions

 ezQtStandardPropertyWidget ()
 *** ezQtStandardPropertyWidget ***
 
virtual void SetSelection (const ezHybridArray< ezPropertySelection, 8 > &items) override
 This is called whenever the selection in the editor changes and thus the widget may need to display a different value.
 
- Public Member Functions inherited from ezQtPropertyWidget
 ezQtPropertyWidget ()
 *** BASE ***
 
void Init (ezQtPropertyGridWidget *pGrid, ezObjectAccessorBase *pObjectAccessor, const ezRTTI *pType, const ezAbstractProperty *pProp)
 
ezQtPropertyGridWidget * GetPropertyGrid ()
 
ezObjectAccessorBase * GetObjectAccessor ()
 
const ezRTTI * GetType () const
 
const ezAbstractProperty * GetProperty () const
 
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).
 

Protected Member Functions

void BroadcastValueChanged (const ezVariant &NewValue)
 
virtual void DoPrepareToDie () override
 
const ezVariant & GetOldValue () const
 
virtual void InternalSetValue (const ezVariant &value)=0
 
- Protected Member Functions inherited from ezQtPropertyWidget
void Broadcast (ezPropertyEvent::Type type)
 
void PropertyChangedHandler (const ezPropertyEvent &ed)
 
virtual void OnInit ()=0
 
bool IsUndead () const
 
virtual bool eventFilter (QObject *pWatched, QEvent *pEvent) override
 

Protected Attributes

ezVariant m_OldValue
 
- Protected Attributes inherited from ezQtPropertyWidget
ezQtPropertyGridWidget * m_pGrid = nullptr
 
ezObjectAccessorBase * m_pObjectAccessor = nullptr
 
const ezRTTI * m_pType = nullptr
 
const ezAbstractProperty * m_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.
 

Additional Inherited Members

- Public Slots inherited from ezQtPropertyWidget
void OnCustomContextMenu (const QPoint &pt)
 
- Static Public Member Functions inherited from ezQtPropertyWidget
static const ezRTTI * GetCommonBaseType (const ezHybridArray< ezPropertySelection, 8 > &items)
 
static QColor SetPaletteBackgroundColor (ezColorGammaUB inputColor, QPalette &ref_palette)
 

Detailed Description

Base class for most 'simple' property type widgets. Implements some of the standard functionality.

Member Function Documentation

◆ DoPrepareToDie()

virtual void ezQtStandardPropertyWidget::DoPrepareToDie ( )
inlineoverrideprotectedvirtual

Implements ezQtPropertyWidget.

◆ SetSelection()

void ezQtStandardPropertyWidget::SetSelection ( const ezHybridArray< ezPropertySelection, 8 > &  items)
overridevirtual

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 from ezQtPropertyWidget.

Reimplemented in ezQtExposedBoneWidget, and ezQtVarianceTypeWidget.

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