• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDEUI

KWidgetItemDelegate Class Reference

This class allows to create item delegates embedding simple widgets to interact with items. More...

#include <kwidgetitemdelegate.h>

Inheritance diagram for KWidgetItemDelegate:

Inheritance graph
[legend]

List of all members.


Public Member Functions

QPersistentModelIndex focusedIndex () const
QAbstractItemView * itemView () const
 KWidgetItemDelegate (QAbstractItemView *itemView, QObject *parent=0)
virtual ~KWidgetItemDelegate ()

Protected Member Functions

QList< QEvent::Type > blockedEventTypes (QWidget *widget) const
virtual QList< QWidget * > createItemWidgets () const =0
KDE_DEPRECATED void paintWidgets (QPainter *painter, const QStyleOptionViewItem &option, const QPersistentModelIndex &index) const
void setBlockedEventTypes (QWidget *widget, QList< QEvent::Type > types) const
virtual void updateItemWidgets (const QList< QWidget * > widgets, const QStyleOptionViewItem &option, const QPersistentModelIndex &index) const =0

Detailed Description

This class allows to create item delegates embedding simple widgets to interact with items.

For instance you can add push buttons, line edits, etc. to your delegate and use them to modify the state of your model.

Since:
4.1

Definition at line 48 of file kwidgetitemdelegate.h.


Constructor & Destructor Documentation

KWidgetItemDelegate::KWidgetItemDelegate ( QAbstractItemView *  itemView,
QObject *  parent = 0 
) [explicit]

Creates a new ItemDelegate to be used with a given itemview.

This file is part of the KDE project Copyright (C) 2007-2008 Rafael Fernández López <ereslibre@kde.org> Copyright (C) 2008 Kevin Ottens <ervin@kde.org>.

Parameters:
itemView the item view the new delegate will monitor
parent the parent of this delegate
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License for more details.

You should have received a copy of the GNU Library General Public License along with this library; see the file COPYING.LIB. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. Private class that helps to provide binary compatibility between releases.

For internal use only.

Definition at line 152 of file kwidgetitemdelegate.cpp.

KWidgetItemDelegate::~KWidgetItemDelegate (  )  [virtual]

Destroys an ItemDelegate.

Definition at line 167 of file kwidgetitemdelegate.cpp.


Member Function Documentation

QList< QEvent::Type > KWidgetItemDelegate::blockedEventTypes ( QWidget *  widget  )  const [protected]

Retrieves the list of blocked event types for the given widget.

Parameters:
widget the specified widget.
Returns:
the list of blocked event types, can be empty if no events are blocked.

Definition at line 238 of file kwidgetitemdelegate.cpp.

virtual QList<QWidget*> KWidgetItemDelegate::createItemWidgets (  )  const [protected, pure virtual]

Creates the list of widgets needed for an item.

Note:
No initialization of the widgets is supposed to happen here. The widgets will be initialized based on needs for a given item.

If you want to connect some widget signals to any slot, you should do it here.

Returns:
the list of newly created widgets which will be used to interact with an item.
See also:
updateItemWidgets()

QPersistentModelIndex KWidgetItemDelegate::focusedIndex (  )  const

Retrieves the currently focused index.

An invalid index if none is focused.

Returns:
the current focused index, or QPersistentModelIndex() if none is focused.

Definition at line 177 of file kwidgetitemdelegate.cpp.

QAbstractItemView * KWidgetItemDelegate::itemView (  )  const

Retrieves the item view this delegate is monitoring.

Returns:
the item view this delegate is monitoring

Definition at line 172 of file kwidgetitemdelegate.cpp.

void KWidgetItemDelegate::paintWidgets ( QPainter *  painter,
const QStyleOptionViewItem &  option,
const QPersistentModelIndex &  index 
) const [protected]

Paint the widgets of the item.

This method is meant to be used in the paint() method of your item delegate implementation.

Parameters:
painter the painter the widgets will be painted on.
option the current set of style options for the view.
index the model index of the item currently painted.
Warning:
since 4.2 this method is not longer needed to be called. All widgets will kept updated without the need of calling paintWidgets() in your paint() event. For the widgets of a certain index to be updated your model has to emit dataChanged() on the indexes that want to be updated.

Definition at line 183 of file kwidgetitemdelegate.cpp.

void KWidgetItemDelegate::setBlockedEventTypes ( QWidget *  widget,
QList< QEvent::Type >  types 
) const [protected]

Sets the list of event types that a widget will block.

Blocked events are not passed to the view. This way you can prevent an item from being selected when a button is clicked for instance.

Parameters:
widget the widget which must block events
types the list of event types the widget must block

Definition at line 233 of file kwidgetitemdelegate.cpp.

virtual void KWidgetItemDelegate::updateItemWidgets ( const QList< QWidget * >  widgets,
const QStyleOptionViewItem &  option,
const QPersistentModelIndex &  index 
) const [protected, pure virtual]

Updates a list of widgets for its use inside of the delegate (painting or event handling).

Note:
All the positioning and sizing should be done in item coordinates.
Warning:
Do not make widget connections in here, since this method will be called very regularly.
Parameters:
widgets the widgets to update
option the current set of style options for the view.
index the model index of the item currently manipulated.


The documentation for this class was generated from the following files:
  • kwidgetitemdelegate.h
  • kwidgetitemdelegate.cpp

KDEUI

Skip menu "KDEUI"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal