kpagewidgetmodel.h

Go to the documentation of this file.

/*
    This file is part of the KDE Libraries

    Copyright (C) 2006 Tobias Koenig (tokoe@kde.org)

    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.
*/

#ifndef KPAGEWIDGETMODEL_H
#define KPAGEWIDGETMODEL_H

#include "kpagemodel.h"

class QWidget;

class KIcon;

class KDEUI_EXPORT KPageWidgetItem : public QObject
{
  Q_OBJECT
  Q_PROPERTY( QString name READ name WRITE setName )
  Q_PROPERTY( QString header READ header WRITE setHeader )
  Q_PROPERTY( KIcon icon READ icon WRITE setIcon )
  Q_PROPERTY( bool checkable READ isCheckable WRITE setCheckable )
  Q_PROPERTY( bool checked READ isChecked WRITE setChecked )
    Q_PROPERTY(bool enabled READ isEnabled WRITE setEnabled)

  public:
    KPageWidgetItem( QWidget *widget );

    KPageWidgetItem( QWidget *widget, const QString &name );

    ~KPageWidgetItem();

    QWidget* widget() const;

    void setName( const QString &name );

    QString name() const;

    void setHeader( const QString &header );

    QString header() const;

    void setIcon( const KIcon &icon );

    KIcon icon() const;

    void setCheckable( bool checkable );

    bool isCheckable() const;

    bool isChecked() const;

    bool isEnabled() const;

    public Q_SLOTS:
        void setEnabled(bool);

        void setChecked( bool checked );

  Q_SIGNALS:
    void changed();

    void toggled( bool checked );

  private:
    class Private;
    Private* const d;
};

class KPageWidgetModelPrivate;

class KDEUI_EXPORT KPageWidgetModel : public KPageModel
{
  Q_OBJECT
    Q_DECLARE_PRIVATE(KPageWidgetModel)

  public:
    explicit KPageWidgetModel( QObject *parent = 0 );

    ~KPageWidgetModel();

    KPageWidgetItem* addPage( QWidget *widget, const QString &name );

    void addPage( KPageWidgetItem *item );

    KPageWidgetItem* insertPage( KPageWidgetItem *before, QWidget *widget, const QString &name );

    void insertPage( KPageWidgetItem *before, KPageWidgetItem *item );

    KPageWidgetItem* addSubPage( KPageWidgetItem *parent, QWidget *widget, const QString &name );

    void addSubPage( KPageWidgetItem *parent, KPageWidgetItem *item );

    void removePage( KPageWidgetItem *item );

    virtual int columnCount( const QModelIndex &parent = QModelIndex() ) const;
    virtual QVariant data( const QModelIndex &index, int role = Qt::DisplayRole ) const;
    virtual bool setData( const QModelIndex &index, const QVariant &value, int role = Qt::EditRole );
    virtual Qt::ItemFlags flags( const QModelIndex &index ) const;
    virtual QModelIndex index( int row, int column, const QModelIndex &parent = QModelIndex() ) const;
    virtual QModelIndex parent( const QModelIndex &index ) const;
    virtual int rowCount( const QModelIndex &parent = QModelIndex() ) const;

    KPageWidgetItem *item(const QModelIndex &index) const;

    QModelIndex index( const KPageWidgetItem *item ) const;

  Q_SIGNALS:
    void toggled( KPageWidgetItem *page, bool checked );

  private:
        Q_PRIVATE_SLOT(d_func(), void _k_itemChanged())
        Q_PRIVATE_SLOT(d_func(), void _k_itemToggled(bool))
};

#endif