QItemEditorCreatorBase

Detailed Description

The PySide.QtGui.QItemEditorCreatorBase class provides an abstract base class that must be subclassed when implementing new item editor creators.

PySide.QtGui.QItemEditorCreatorBase objects are specialized widget factories that provide editor widgets for one particular PySide.QtCore.QVariant data type. They are used by PySide.QtGui.QItemEditorFactory to create editors for PySide.QtGui.QItemDelegate s. Creator bases must be registered with QItemEditorFactory.registerEditor() .

An editor should provide a user property for the data it edits. QItemDelagates can then access the property using Qt’s meta-object system to set and retrieve the editing data. A property is set as the user property with the USER keyword:

Q_PROPERTY(QColor color READ color WRITE setColor USER true)

If the editor does not provide a user property, it must return the name of the property from PySide.QtGui.QItemEditorCreatorBase.valuePropertyName() ; delegates will then use the name to access the property. If a user property exists, item delegates will not call PySide.QtGui.QItemEditorCreatorBase.valuePropertyName() .

QStandardItemEditorCreator is a convenience template class that can be used to register widgets without the need to subclass PySide.QtGui.QItemEditorCreatorBase .

See also

QStandardItemEditorCreator PySide.QtGui.QItemEditorFactory Model/View Programming Color Editor Factory Example

class PySide.QtGui.QItemEditorCreatorBase

PySide.QtGui.QItemEditorCreatorBase.createWidget(parent)

Parameters:parent – PySide.QtGui.QWidget Return type:PySide.QtGui.QWidget

Returns an editor widget with the given parent .

When implementing this function in subclasses of this class, you must construct and return new editor widgets with the parent widget specified.

PySide.QtGui.QItemEditorCreatorBase.valuePropertyName()

Return type:PySide.QtCore.QByteArray

Returns the name of the property used to get and set values in the creator’s editor widgets.

When implementing this function in subclasses, you must ensure that the editor widget’s property specified by this function can accept the type the creator is registered for. For example, a creator which constructs PySide.QtGui.QCheckBox widgets to edit boolean values would return the PySide.QtGui.QCheckBox.checkable() property name from this function, and must be registered in the item editor factory for the QVariant.Bool type.

Note: Since Qt 4.2 the item delegates query the user property of widgets, and only call this function if the widget has no user property. You can override this behavior by reimplementing QAbstractItemDelegate.setModelData() and QAbstractItemDelegate.setEditorData() .

See also

QMetaObject.userProperty() QItemEditorFactory.registerEditor()