- class QItemDelegate#
The
QItemDelegate
class provides display and editing facilities for data items from a model. More…Synopsis#
Properties#
clippingᅟ
- If the delegate should clip the paint events
Methods#
def
__init__()
def
decoration()
def
doCheck()
def
drawBackground()
def
hasClipping()
def
rect()
def
setClipping()
def
setOptions()
def
textRectangle()
Virtual methods#
def
drawCheck()
def
drawDecoration()
def
drawDisplay()
def
drawFocus()
Static functions#
def
selectedPixmap()
Note
This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE
Detailed Description#
QItemDelegate
can be used to provide custom display features and editor widgets for item views based onQAbstractItemView
subclasses. Using a delegate for this purpose allows the display and editing mechanisms to be customized and developed independently from the model and view.The
QItemDelegate
class is one of the Model/View Classes and is part of Qt’s model/view framework . Note thatQStyledItemDelegate
has taken over the job of drawing Qt’s item views. We recommend the use ofQStyledItemDelegate
when creating new delegates.When displaying items from a custom model in a standard view, it is often sufficient to simply ensure that the model returns appropriate data for each of the roles that determine the appearance of items in views. The default delegate used by Qt’s standard views uses this role information to display items in most of the common forms expected by users. However, it is sometimes necessary to have even more control over the appearance of items than the default delegate can provide.
This class provides default implementations of the functions for painting item data in a view and editing data from item models. Default implementations of the
paint()
andsizeHint()
virtual functions, defined inQAbstractItemDelegate
, are provided to ensure that the delegate implements the correct basic behavior expected by views. You can reimplement these functions in subclasses to customize the appearance of items.When editing data in an item view,
QItemDelegate
provides an editor widget, which is a widget that is placed on top of the view while editing takes place. Editors are created with aQItemEditorFactory
; a default static instance provided byQItemEditorFactory
is installed on all item delegates. You can set a custom factory usingsetItemEditorFactory()
or set a new default factory withsetDefaultFactory()
. It is the data stored in the item model with the Qt::EditRole that is edited.Only the standard editing functions for widget-based delegates are reimplemented here:
createEditor()
returns the widget used to change data from the model and can be reimplemented to customize editing behavior.setEditorData()
provides the widget with data to manipulate.updateEditorGeometry()
ensures that the editor is displayed correctly with respect to the item view.setModelData()
returns updated data to the model.
The
closeEditor()
signal indicates that the user has completed editing the data, and that the editor widget can be destroyed.Standard Roles and Data Types#
The default delegate used by the standard views supplied with Qt associates each standard role (defined by Qt::ItemDataRole) with certain data types. Models that return data in these types can influence the appearance of the delegate as described in the following table.
Role
Accepted Types
Qt::BackgroundRole
QBrush (
Qt::CheckStateRole
Qt::CheckState
Qt::DecorationRole
QIcon, QPixmap and QColor
Qt::DisplayRole
QString and types with a string representation
Qt::EditRole
See
QItemEditorFactory
for detailsQt::FontRole
QFont
Qt::SizeHintRole
QSize
Qt::TextAlignmentRole
Qt::Alignment
Qt::ForegroundRole
QBrush (
If the default delegate does not allow the level of customization that you need, either for display purposes or for editing data, it is possible to subclass
QItemDelegate
to implement the desired behavior.Subclassing#
When subclassing
QItemDelegate
to create a delegate that displays items using a custom renderer, it is important to ensure that the delegate can render items suitably for all the required states; e.g. selected, disabled, checked. The documentation for thepaint()
function contains some hints to show how this can be achieved.You can provide custom editors by using a
QItemEditorFactory
. The Color Editor Factory Example shows how a custom editor can be made available to delegates with the default item editor factory. This way, there is no need to subclassQItemDelegate
. An alternative is to reimplementcreateEditor()
,setEditorData()
,setModelData()
, andupdateEditorGeometry()
. This process is described in the Model/View Programming overview documentation .QStyledItemDelegate vs. QItemDelegate#
Since Qt 4.4, there are two delegate classes:
QItemDelegate
andQStyledItemDelegate
. However, the default delegate isQStyledItemDelegate
. These two classes are independent alternatives to painting and providing editors for items in views. The difference between them is thatQStyledItemDelegate
uses the current style to paint its items. We therefore recommend usingQStyledItemDelegate
as the base class when implementing custom delegates or when working with Qt style sheets. The code required for either class should be equal unless the custom delegate needs to use the style for drawing.Note
Properties can be used directly when
from __feature__ import true_property
is used or via accessor functions otherwise.- property clippingᅟ: bool#
This property holds if the delegate should clip the paint events.
This property will set the paint clip to the size of the item. The default value is on. It is useful for cases such as when images are larger than the size of the item.
- Access functions:
Constructs an item delegate with the given
parent
.- decoration(option, variant)#
- Parameters:
option –
QStyleOptionViewItem
variant – object
- Return type:
- doCheck(option, bounding, variant)#
- Parameters:
option –
QStyleOptionViewItem
bounding –
QRect
variant – object
- Return type:
- drawBackground(painter, option, index)#
- Parameters:
painter –
QPainter
option –
QStyleOptionViewItem
index –
QModelIndex
Renders the item background for the given
index
, using the givenpainter
and styleoption
.- drawCheck(painter, option, rect, state)#
- Parameters:
painter –
QPainter
option –
QStyleOptionViewItem
rect –
QRect
state –
CheckState
Renders a check indicator within the rectangle specified by
rect
, using the givenpainter
and styleoption
, using the givenstate
.- drawDecoration(painter, option, rect, pixmap)#
- Parameters:
painter –
QPainter
option –
QStyleOptionViewItem
rect –
QRect
pixmap –
QPixmap
Renders the decoration
pixmap
within the rectangle specified byrect
using the givenpainter
and styleoption
.- drawDisplay(painter, option, rect, text)#
- Parameters:
painter –
QPainter
option –
QStyleOptionViewItem
rect –
QRect
text – str
Renders the item view
text
within the rectangle specified byrect
using the givenpainter
and styleoption
.- drawFocus(painter, option, rect)#
- Parameters:
painter –
QPainter
option –
QStyleOptionViewItem
rect –
QRect
Renders the region within the rectangle specified by
rect
, indicating that it has the focus, using the givenpainter
and styleoption
.- hasClipping()#
- Return type:
bool
Getter of property
clippingᅟ
.- itemEditorFactory()#
- Return type:
Returns the editor factory used by the item delegate. If no editor factory is set, the function will return null.
See also
- rect(option, index, role)#
- Parameters:
option –
QStyleOptionViewItem
index –
QModelIndex
role – int
- Return type:
- static selectedPixmap(pixmap, palette, enabled)#
- setClipping(clip)#
- Parameters:
clip – bool
See also
Setter of property
clippingᅟ
.- setItemEditorFactory(factory)#
- Parameters:
factory –
QItemEditorFactory
Sets the editor factory to be used by the item delegate to be the
factory
specified. If no editor factory is set, the item delegate will use the default editor factory.See also
- setOptions(index, option)#
- Parameters:
index –
QModelIndex
option –
QStyleOptionViewItem
- Return type: