xiiQtPropertyTypeWidget Class Reference

#include <PropertyBaseWidget.moc.h>

Inheritance diagram for xiiQtPropertyTypeWidget:

Public Member Functions
	xiiQtPropertyTypeWidget (bool bAddCollapsibleGroup=false)
	*** xiiQtPropertyTypeWidget ***
virtual void	SetSelection (const xiiHybridArray< xiiPropertySelection, 8 > &items) override
	This is called whenever the selection in the editor changes and thus the widget may need to display a different value.
virtual bool	HasLabel () const override
	If this returns true (default), a QLabel is created and the text that GetLabel() returns is displayed.
virtual void	SetIsDefault (bool bIsDefault) override
	Whether the variable that the widget represents is currently set to the default value or has been modified.
Public Member Functions inherited from xiiQtPropertyWidget
	xiiQtPropertyWidget ()
	*** BASE ***
void	Init (xiiQtPropertyGridWidget *pGrid, xiiObjectAccessorBase *pObjectAccessor, const xiiRTTI *pType, const xiiAbstractProperty *pProp)
const xiiAbstractProperty *	GetProperty () const
const xiiHybridArray< xiiPropertySelection, 8 > &	GetSelection () const
virtual const char *	GetLabel (xiiStringBuilder &ref_sTmp) const
	The return value is used to display a label, if HasLabel() returns true.
virtual void	ExtendContextMenu (QMenu &ref_menu)
bool	GetCommonVariantSubType (const xiiHybridArray< xiiPropertySelection, 8 > &items, const xiiAbstractProperty *pProperty, xiiVariantType::Enum &out_type)
	If the property is of type xiiVariant 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.
xiiVariant	GetCommonValue (const xiiHybridArray< xiiPropertySelection, 8 > &items, const xiiAbstractProperty *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
virtual void	OnInit () override
virtual void	DoPrepareToDie () override
Protected Member Functions inherited from xiiQtPropertyWidget
void	Broadcast (xiiPropertyEvent::Type type)
void	PropertyChangedHandler (const xiiPropertyEvent &ed)
bool	IsUndead () const
virtual bool	eventFilter (QObject *pWatched, QEvent *pEvent) override

Protected Attributes
QVBoxLayout *	m_pLayout
xiiQtGroupBoxBase *	m_pGroup
QVBoxLayout *	m_pGroupLayout
xiiQtTypeWidget *	m_pTypeWidget
Protected Attributes inherited from xiiQtPropertyWidget
xiiQtPropertyGridWidget *	m_pGrid = nullptr
xiiObjectAccessorBase *	m_pObjectAccessor = nullptr
const xiiRTTI *	m_pType = nullptr
const xiiAbstractProperty *	m_pProp = nullptr
xiiHybridArray< xiiPropertySelection, 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 xiiQtPropertyWidget
void	OnCustomContextMenu (const QPoint &pt)
Static Public Member Functions inherited from xiiQtPropertyWidget
static const xiiRTTI *	GetCommonBaseType (const xiiHybridArray< xiiPropertySelection, 8 > &items)
static QColor	SetPaletteBackgroundColor (xiiColorGammaUB inputColor, QPalette &ref_palette)

Detailed Description

Used for pointers and embedded classes. Does not inherit from xiiQtEmbeddedClassPropertyWidget as it just embeds a xiiQtTypeWidget for the property's value which handles everything already.

Member Function Documentation

DoPrepareToDie()

void xiiQtPropertyTypeWidget::DoPrepareToDie ( )

overrideprotectedvirtual

Implements xiiQtPropertyWidget.

HasLabel()

virtual bool xiiQtPropertyTypeWidget::HasLabel ( ) const

inlineoverridevirtual

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

Reimplemented from xiiQtPropertyWidget.

OnInit()

void xiiQtPropertyTypeWidget::OnInit ( )

overrideprotectedvirtual

Implements xiiQtPropertyWidget.

SetIsDefault()

void xiiQtPropertyTypeWidget::SetIsDefault ( bool bIsDefault )

overridevirtual

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

Reimplemented from xiiQtPropertyWidget.

SetSelection()

void xiiQtPropertyTypeWidget::SetSelection ( const xiiHybridArray< xiiPropertySelection, 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 xiiQtPropertyWidget.

Reimplemented in xiiQtCodeEditorPreferencesWidget, and xiiQtCompilerPreferencesWidget.

---

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

• /home/runner/work/XII/XII/Source/Tools/Libs/GuiFoundation/PropertyGrid/PropertyBaseWidget.moc.h
• /home/runner/work/XII/XII/Source/Tools/Libs/GuiFoundation/PropertyGrid/Implementation/PropertyBaseWidget.cpp