Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QtPropertyEditorDelegate Class Reference
+ Inheritance diagram for QtPropertyEditorDelegate:
+ Collaboration diagram for QtPropertyEditorDelegate:

Public Member Functions

 QtPropertyEditorDelegate (QObject *parent=0)
 
void setEditorPrivate (QtTreePropertyBrowserPrivate *editorPrivate)
 
QWidgetcreateEditor (QWidget *parent, const QStyleOptionViewItem &option, const QModelIndex &index) const override
 Returns the widget used to edit the item specified by index for editing.
 
void updateEditorGeometry (QWidget *editor, const QStyleOptionViewItem &option, const QModelIndex &index) const override
 Updates the editor for the item specified by index according to the style option given.
 
void paint (QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const override
 Renders the delegate using the given painter and style option for the item specified by index.
 
QSize sizeHint (const QStyleOptionViewItem &option, const QModelIndex &index) const override
 Returns the size needed by the delegate to display the item specified by index, taking into account the style information provided by option.
 
void setModelData (QWidget *, QAbstractItemModel *, const QModelIndex &) const override
 Gets data from the editor widget and stores it in the specified model at the item index.
 
void setEditorData (QWidget *, const QModelIndex &) const override
 Sets the data to be displayed and edited by the editor from the data model item specified by the model index.
 
bool eventFilter (QObject *object, QEvent *event) override
 Returns true if the given editor is a valid QWidget and the given event is handled; otherwise returns false.
 
void closeEditor (QtProperty *property)
 
QTreeWidgetItemeditedItem () const
 
 QtPropertyEditorDelegate (QObject *parent=0)
 
void setEditorPrivate (QtTreePropertyBrowserPrivate *editorPrivate)
 
QWidgetcreateEditor (QWidget *parent, const QStyleOptionViewItem &option, const QModelIndex &index) const override
 Returns the widget used to edit the item specified by index for editing.
 
void updateEditorGeometry (QWidget *editor, const QStyleOptionViewItem &option, const QModelIndex &index) const override
 Updates the editor for the item specified by index according to the style option given.
 
void paint (QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const override
 Renders the delegate using the given painter and style option for the item specified by index.
 
QSize sizeHint (const QStyleOptionViewItem &option, const QModelIndex &index) const override
 Returns the size needed by the delegate to display the item specified by index, taking into account the style information provided by option.
 
void setModelData (QWidget *, QAbstractItemModel *, const QModelIndex &) const override
 Gets data from the editor widget and stores it in the specified model at the item index.
 
void setEditorData (QWidget *, const QModelIndex &) const override
 Sets the data to be displayed and edited by the editor from the data model item specified by the model index.
 
bool eventFilter (QObject *object, QEvent *event) override
 Returns true if the given editor is a valid QWidget and the given event is handled; otherwise returns false.
 
void closeEditor (QtProperty *property)
 
QTreeWidgetItemeditedItem () const
 
- Public Member Functions inherited from QItemDelegate
 QItemDelegate (QObject *parent=nullptr)
 Constructs an item delegate with the given parent.
 
 ~QItemDelegate ()
 Destroys the item delegate.
 
bool hasClipping () const
 
void setClipping (bool clip)
 
QItemEditorFactoryitemEditorFactory () const
 Returns the editor factory used by the item delegate.
 
void setItemEditorFactory (QItemEditorFactory *factory)
 Sets the editor factory to be used by the item delegate to be the factory specified.
 
- Public Member Functions inherited from QAbstractItemDelegate
 QAbstractItemDelegate (QObject *parent=nullptr)
 Creates a new abstract item delegate with the given parent.
 
virtual ~QAbstractItemDelegate ()
 Destroys the abstract item delegate.
 
virtual void destroyEditor (QWidget *editor, const QModelIndex &index) const
 Called when the editor is no longer needed for editing the data item with the given index and should be destroyed.
 
virtual bool helpEvent (QHelpEvent *event, QAbstractItemView *view, const QStyleOptionViewItem &option, const QModelIndex &index)
 Whenever a help event occurs, this function is called with the event view option and the index that corresponds to the item where the event occurs.
 
virtual QList< int > paintingRoles () const
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QStringbindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThreadthread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectListchildren () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 

Additional Inherited Members

- Public Types inherited from QAbstractItemDelegate
enum  EndEditHint {
  NoHint , EditNextItem , EditPreviousItem , SubmitModelCache ,
  RevertModelCache
}
 This enum describes the different hints that the delegate can give to the model and view components to make editing data in a model a comfortable experience for the user. More...
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Signals inherited from QAbstractItemDelegate
void commitData (QWidget *editor)
 This signal must be emitted when the editor widget has completed editing the data, and wants to write it back into the model.
 
void closeEditor (QWidget *editor, QAbstractItemDelegate::EndEditHint hint=NoHint)
 This signal is emitted when the user has finished editing an item using the specified editor.
 
void sizeHintChanged (const QModelIndex &)
 This signal must be emitted when the sizeHint() of index changed.
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 
- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Protected Member Functions inherited from QItemDelegate
virtual void drawDisplay (QPainter *painter, const QStyleOptionViewItem &option, const QRect &rect, const QString &text) const
 Renders the item view text within the rectangle specified by rect using the given painter and style option.
 
virtual void drawDecoration (QPainter *painter, const QStyleOptionViewItem &option, const QRect &rect, const QPixmap &pixmap) const
 Renders the decoration pixmap within the rectangle specified by rect using the given painter and style option.
 
virtual void drawFocus (QPainter *painter, const QStyleOptionViewItem &option, const QRect &rect) const
 Renders the region within the rectangle specified by rect, indicating that it has the focus, using the given painter and style option.
 
virtual void drawCheck (QPainter *painter, const QStyleOptionViewItem &option, const QRect &rect, Qt::CheckState state) const
 Renders a check indicator within the rectangle specified by rect, using the given painter and style option, using the given state.
 
void drawBackground (QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const
 s Renders the item background for the given index, using the given painter and style option.
 
void doLayout (const QStyleOptionViewItem &option, QRect *checkRect, QRect *iconRect, QRect *textRect, bool hint) const
 
QRect rect (const QStyleOptionViewItem &option, const QModelIndex &index, int role) const
 
bool editorEvent (QEvent *event, QAbstractItemModel *model, const QStyleOptionViewItem &option, const QModelIndex &index) override
 \reimp
 
QStyleOptionViewItem setOptions (const QModelIndex &index, const QStyleOptionViewItem &option) const
 
QPixmap decoration (const QStyleOptionViewItem &option, const QVariant &variant) const
 
QRect doCheck (const QStyleOptionViewItem &option, const QRect &bounding, const QVariant &variant) const
 
QRect textRectangle (QPainter *painter, const QRect &rect, const QFont &font, const QString &text) const
 
- Protected Member Functions inherited from QAbstractItemDelegate
 QAbstractItemDelegate (QObjectPrivate &, QObject *parent=nullptr)
 
- Protected Member Functions inherited from QObject
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 
- Static Protected Member Functions inherited from QItemDelegate
static QPixmap selectedPixmap (const QPixmap &pixmap, const QPalette &palette, bool enabled)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Properties inherited from QItemDelegate
bool clipping
 if the delegate should clip the paint events
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Detailed Description

Definition at line 191 of file qttreepropertybrowser.cpp.

Constructor & Destructor Documentation

◆ QtPropertyEditorDelegate() [1/2]

QtPropertyEditorDelegate::QtPropertyEditorDelegate ( QObject * parent = 0)
inline

Definition at line 195 of file qttreepropertybrowser.cpp.

◆ QtPropertyEditorDelegate() [2/2]

QtPropertyEditorDelegate::QtPropertyEditorDelegate ( QObject * parent = 0)
inline

Definition at line 195 of file qttreepropertybrowser.cpp.

Member Function Documentation

◆ closeEditor() [1/2]

void QtPropertyEditorDelegate::closeEditor ( QtProperty * property)

Definition at line 270 of file qttreepropertybrowser.cpp.

◆ closeEditor() [2/2]

void QtPropertyEditorDelegate::closeEditor ( QtProperty * property)

◆ createEditor() [1/2]

QWidget * QtPropertyEditorDelegate::createEditor ( QWidget * parent,
const QStyleOptionViewItem & option,
const QModelIndex & index ) const
overridevirtual

Returns the widget used to edit the item specified by index for editing.

The parent widget and style option are used to control how the editor widget appears.

See also
QAbstractItemDelegate::createEditor()

Reimplemented from QItemDelegate.

Definition at line 276 of file qttreepropertybrowser.cpp.

◆ createEditor() [2/2]

QWidget * QtPropertyEditorDelegate::createEditor ( QWidget * parent,
const QStyleOptionViewItem & option,
const QModelIndex & index ) const
overridevirtual

Returns the widget used to edit the item specified by index for editing.

The parent widget and style option are used to control how the editor widget appears.

See also
QAbstractItemDelegate::createEditor()

Reimplemented from QItemDelegate.

◆ editedItem() [1/2]

QTreeWidgetItem * QtPropertyEditorDelegate::editedItem ( ) const
inline

Definition at line 221 of file qttreepropertybrowser.cpp.

Referenced by QtTreePropertyBrowserPrivate::editedItem().

+ Here is the caller graph for this function:

◆ editedItem() [2/2]

QTreeWidgetItem * QtPropertyEditorDelegate::editedItem ( ) const
inline

Definition at line 221 of file qttreepropertybrowser.cpp.

◆ eventFilter() [1/2]

bool QtPropertyEditorDelegate::eventFilter ( QObject * editor,
QEvent * event )
overridevirtual

Returns true if the given editor is a valid QWidget and the given event is handled; otherwise returns false.

The following key press events are handled by default:

\list

  • \uicontrol Tab
  • \uicontrol Backtab
  • \uicontrol Enter
  • \uicontrol Return
  • \uicontrol Esc \endlist

In the case of \uicontrol Tab, \uicontrol Backtab, \uicontrol Enter and \uicontrol Return key press events, the editor's data is committed to the model and the editor is closed. If the event is a \uicontrol Tab key press the view will open an editor on the next item in the view. Likewise, if the event is a \uicontrol Backtab key press the view will open an editor on the previous item in the view.

If the event is a \uicontrol Esc key press event, the editor is closed without committing its data.

See also
commitData(), closeEditor()

Reimplemented from QItemDelegate.

Definition at line 360 of file qttreepropertybrowser.cpp.

◆ eventFilter() [2/2]

bool QtPropertyEditorDelegate::eventFilter ( QObject * editor,
QEvent * event )
overridevirtual

Returns true if the given editor is a valid QWidget and the given event is handled; otherwise returns false.

The following key press events are handled by default:

\list

  • \uicontrol Tab
  • \uicontrol Backtab
  • \uicontrol Enter
  • \uicontrol Return
  • \uicontrol Esc \endlist

In the case of \uicontrol Tab, \uicontrol Backtab, \uicontrol Enter and \uicontrol Return key press events, the editor's data is committed to the model and the editor is closed. If the event is a \uicontrol Tab key press the view will open an editor on the next item in the view. Likewise, if the event is a \uicontrol Backtab key press the view will open an editor on the previous item in the view.

If the event is a \uicontrol Esc key press event, the editor is closed without committing its data.

See also
commitData(), closeEditor()

Reimplemented from QItemDelegate.

◆ paint() [1/2]

void QtPropertyEditorDelegate::paint ( QPainter * painter,
const QStyleOptionViewItem & option,
const QModelIndex & index ) const
overridevirtual

Renders the delegate using the given painter and style option for the item specified by index.

When reimplementing this function in a subclass, you should update the area held by the option's \l{QStyleOption::rect}{rect} variable, using the option's \l{QStyleOption::state}{state} variable to determine the state of the item to be displayed, and adjust the way it is painted accordingly.

For example, a selected item may need to be displayed differently to unselected items, as shown in the following code:

painter->fillRect(option.rect, option.palette.highlight());
void fillRect(const QRectF &, const QBrush &)
Fills the given rectangle with the brush specified.
@ State_Selected
Definition qstyle.h:82
GLuint GLenum option
QPainter painter(this)
[7]

After painting, you should ensure that the painter is returned to its the state it was supplied in when this function was called. For example, it may be useful to call QPainter::save() before painting and QPainter::restore() afterwards.

See also
QStyle::State

Reimplemented from QItemDelegate.

Definition at line 309 of file qttreepropertybrowser.cpp.

References QtProperty::hasValue(), QtProperty::isModified(), QtTreePropertyBrowserPrivate::lastColumn(), and QtTreePropertyBrowserPrivate::markPropertiesWithoutValue().

+ Here is the call graph for this function:

◆ paint() [2/2]

void QtPropertyEditorDelegate::paint ( QPainter * painter,
const QStyleOptionViewItem & option,
const QModelIndex & index ) const
overridevirtual

Renders the delegate using the given painter and style option for the item specified by index.

When reimplementing this function in a subclass, you should update the area held by the option's \l{QStyleOption::rect}{rect} variable, using the option's \l{QStyleOption::state}{state} variable to determine the state of the item to be displayed, and adjust the way it is painted accordingly.

For example, a selected item may need to be displayed differently to unselected items, as shown in the following code:

painter->fillRect(option.rect, option.palette.highlight());

After painting, you should ensure that the painter is returned to its the state it was supplied in when this function was called. For example, it may be useful to call QPainter::save() before painting and QPainter::restore() afterwards.

See also
QStyle::State

Reimplemented from QItemDelegate.

◆ setEditorData() [1/2]

void QtPropertyEditorDelegate::setEditorData ( QWidget * editor,
const QModelIndex & index ) const
inlineoverridevirtual

Sets the data to be displayed and edited by the editor from the data model item specified by the model index.

The default implementation stores the data in the editor widget's \l {Qt's Property System} {user property}.

See also
QMetaProperty::isUser()

Reimplemented from QItemDelegate.

Definition at line 216 of file qttreepropertybrowser.cpp.

◆ setEditorData() [2/2]

void QtPropertyEditorDelegate::setEditorData ( QWidget * editor,
const QModelIndex & index ) const
inlineoverridevirtual

Sets the data to be displayed and edited by the editor from the data model item specified by the model index.

The default implementation stores the data in the editor widget's \l {Qt's Property System} {user property}.

See also
QMetaProperty::isUser()

Reimplemented from QItemDelegate.

Definition at line 216 of file qttreepropertybrowser.cpp.

◆ setEditorPrivate() [1/2]

void QtPropertyEditorDelegate::setEditorPrivate ( QtTreePropertyBrowserPrivate * editorPrivate)
inline

Definition at line 199 of file qttreepropertybrowser.cpp.

◆ setEditorPrivate() [2/2]

void QtPropertyEditorDelegate::setEditorPrivate ( QtTreePropertyBrowserPrivate * editorPrivate)
inline

Definition at line 199 of file qttreepropertybrowser.cpp.

◆ setModelData() [1/2]

void QtPropertyEditorDelegate::setModelData ( QWidget * editor,
QAbstractItemModel * model,
const QModelIndex & index ) const
inlineoverridevirtual

Gets data from the editor widget and stores it in the specified model at the item index.

The default implementation gets the value to be stored in the data model from the editor widget's \l {Qt's Property System} {user property}.

See also
QMetaProperty::isUser()

Reimplemented from QItemDelegate.

Definition at line 213 of file qttreepropertybrowser.cpp.

◆ setModelData() [2/2]

void QtPropertyEditorDelegate::setModelData ( QWidget * editor,
QAbstractItemModel * model,
const QModelIndex & index ) const
inlineoverridevirtual

Gets data from the editor widget and stores it in the specified model at the item index.

The default implementation gets the value to be stored in the data model from the editor widget's \l {Qt's Property System} {user property}.

See also
QMetaProperty::isUser()

Reimplemented from QItemDelegate.

Definition at line 213 of file qttreepropertybrowser.cpp.

◆ sizeHint() [1/2]

QSize QtPropertyEditorDelegate::sizeHint ( const QStyleOptionViewItem & option,
const QModelIndex & index ) const
overridevirtual

Returns the size needed by the delegate to display the item specified by index, taking into account the style information provided by option.

When reimplementing this function, note that in case of text items, QItemDelegate adds a margin (i.e. 2 * QStyle::PM_FocusFrameHMargin) to the length of the text.

Reimplemented from QItemDelegate.

Definition at line 354 of file qttreepropertybrowser.cpp.

◆ sizeHint() [2/2]

QSize QtPropertyEditorDelegate::sizeHint ( const QStyleOptionViewItem & option,
const QModelIndex & index ) const
overridevirtual

Returns the size needed by the delegate to display the item specified by index, taking into account the style information provided by option.

When reimplementing this function, note that in case of text items, QItemDelegate adds a margin (i.e. 2 * QStyle::PM_FocusFrameHMargin) to the length of the text.

Reimplemented from QItemDelegate.

◆ updateEditorGeometry() [1/2]

void QtPropertyEditorDelegate::updateEditorGeometry ( QWidget * editor,
const QStyleOptionViewItem & option,
const QModelIndex & index ) const
overridevirtual

Updates the editor for the item specified by index according to the style option given.

Reimplemented from QItemDelegate.

Definition at line 302 of file qttreepropertybrowser.cpp.

◆ updateEditorGeometry() [2/2]

void QtPropertyEditorDelegate::updateEditorGeometry ( QWidget * editor,
const QStyleOptionViewItem & option,
const QModelIndex & index ) const
overridevirtual

Updates the editor for the item specified by index according to the style option given.

Reimplemented from QItemDelegate.


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