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

KDEUI

KPageModel Class Reference

A base class for a model used by KPageView. More...

#include <kpagemodel.h>

Inheritance diagram for KPageModel:
QAbstractItemModel KPageWidgetModel

List of all members.

Public Types

enum  Role { HeaderRole = Qt::UserRole + 1, WidgetRole }

Public Member Functions

 KPageModel (QObject *parent=0)
virtual ~KPageModel ()

Protected Member Functions

 KPageModel (KPageModelPrivate &dd, QObject *parent)

Protected Attributes

KPageModelPrivate *const d_ptr

Detailed Description

A base class for a model used by KPageView.

This class is an abstract base class which must be used to implement custom models for KPageView. Additional to the standard Qt::ItemDataRoles it provides the two roles

  • HeaderRole
  • WidgetRole

which are used to return a header string for a page and a QWidget pointer to the page itself.

Example:

    KPageView *view = new KPageView( this );
    KPageModel *model = new MyPageModel( this );

    view->setModel( model );
See also:
KPageView
Author:
Tobias Koenig <tokoe@kde.org>

Definition at line 56 of file kpagemodel.h.


Member Enumeration Documentation

enum KPageModel::Role

Additional roles that KPageView uses.

Enumerator:
HeaderRole 

A string to be rendered as page header.

WidgetRole 

A pointer to the page widget.

This is the widget that is shown when the item is selected.

You can make QVariant take a QWidget using

 QWidget *myWidget = new QWidget;
 QVariant v = QVariant::fromValue(myWidget);

Definition at line 65 of file kpagemodel.h.


Constructor & Destructor Documentation

KPageModel::KPageModel ( QObject *  parent = 0  )  [explicit]

Constructs a page model with the given parent.

Definition at line 29 of file kpagemodel.cpp.

KPageModel::~KPageModel (  )  [virtual]

Destroys the page model.

Definition at line 40 of file kpagemodel.cpp.

KPageModel::KPageModel ( KPageModelPrivate &  dd,
QObject *  parent 
) [protected]

Definition at line 34 of file kpagemodel.cpp.


Member Data Documentation

KPageModelPrivate* const KPageModel::d_ptr [protected]

Definition at line 95 of file kpagemodel.h.


The documentation for this class was generated from the following files:
  • kpagemodel.h
  • kpagemodel.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
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
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