plQtPropertyContainerWidget Class Reference

Base class for all container properties. More...

#include <PropertyBaseWidget.moc.h>

Inheritance diagram for plQtPropertyContainerWidget:

Classes
struct	Element

Public Slots
void	OnElementButtonClicked ()
void	OnDragStarted (QMimeData &ref_mimeData)
void	OnContainerContextMenu (const QPoint &pt)
void	OnCustomElementContextMenu (const QPoint &pt)
Public Slots inherited from plQtPropertyWidget
void	OnCustomContextMenu (const QPoint &pt)

Public Member Functions
	plQtPropertyContainerWidget ()
	*** plQtPropertyContainerWidget ***
virtual void	SetSelection (const plHybridArray< plPropertySelection, 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 plQtPropertyWidget
	plQtPropertyWidget ()
	*** BASE ***
void	Init (plQtPropertyGridWidget *pGrid, plObjectAccessorBase *pObjectAccessor, const plRTTI *pType, const plAbstractProperty *pProp)
const plAbstractProperty *	GetProperty () const
const plHybridArray< plPropertySelection, 8 > &	GetSelection () const
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)
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).

Protected Member Functions
virtual plQtGroupBoxBase *	CreateElement (QWidget *pParent)
virtual plQtPropertyWidget *	CreateWidget (plUInt32 index)
virtual Element &	AddElement (plUInt32 index)
virtual void	RemoveElement (plUInt32 index)
virtual void	UpdateElement (plUInt32 index)=0
void	UpdateElements ()
virtual plUInt32	GetRequiredElementCount () const
virtual void	UpdatePropertyMetaState ()
void	Clear ()
virtual void	OnInit () override
void	DeleteItems (plHybridArray< plPropertySelection, 8 > &items)
void	MoveItems (plHybridArray< plPropertySelection, 8 > &items, plInt32 iMove)
virtual void	DoPrepareToDie () override
virtual void	dragEnterEvent (QDragEnterEvent *event) override
virtual void	dragMoveEvent (QDragMoveEvent *event) override
virtual void	dragLeaveEvent (QDragLeaveEvent *event) override
virtual void	dropEvent (QDropEvent *event) override
virtual void	paintEvent (QPaintEvent *event) override
virtual void	showEvent (QShowEvent *event) override
Protected Member Functions inherited from plQtPropertyWidget
void	Broadcast (plPropertyEvent::Type type)
void	PropertyChangedHandler (const plPropertyEvent &ed)
bool	IsUndead () const
virtual bool	eventFilter (QObject *pWatched, QEvent *pEvent) override

Protected Attributes
QHBoxLayout *	m_pLayout
plQtGroupBoxBase *	m_pGroup
QVBoxLayout *	m_pGroupLayout
plQtAddSubElementButton *	m_pAddButton = nullptr
QPalette	m_Pal
plHybridArray< plVariant, 16 >	m_Keys
plDynamicArray< Element >	m_Elements
plInt32	m_iDropSource = -1
plInt32	m_iDropTarget = -1
Protected Attributes inherited from plQtPropertyWidget
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.

Additional Inherited Members
Static Public Member Functions inherited from plQtPropertyWidget
static const plRTTI *	GetCommonBaseType (const plHybridArray< plPropertySelection, 8 > &items)
static QColor	SetPaletteBackgroundColor (plColorGammaUB inputColor, QPalette &ref_palette)

Detailed Description

Base class for all container properties.

Member Function Documentation

DoPrepareToDie()

void plQtPropertyContainerWidget::DoPrepareToDie ( )

overrideprotectedvirtual

Implements plQtPropertyWidget.

HasLabel()

virtual bool plQtPropertyContainerWidget::HasLabel ( ) const

inlineoverridevirtual

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

Reimplemented from plQtPropertyWidget.

OnInit()

void plQtPropertyContainerWidget::OnInit ( )

overrideprotectedvirtual

Implements plQtPropertyWidget.

SetIsDefault()

void plQtPropertyContainerWidget::SetIsDefault ( bool bIsDefault )

overridevirtual

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

Reimplemented from plQtPropertyWidget.

SetSelection()

void plQtPropertyContainerWidget::SetSelection ( const plHybridArray< plPropertySelection, 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 plQtPropertyWidget.

Reimplemented in plQtExposedParametersPropertyWidget.

---

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