kpagedialog.h

Go to the documentation of this file.

/*
 *  This file is part of the KDE Libraries
 *  Copyright (C) 1999-2001 Mirko Boehm (mirko@kde.org) and
 *                          Espen Sand (espen@kde.org)
 *                          Holger Freyther <freyther@kde.org>
 *                2005-2006 Olivier Goffart <ogoffart at kde.org>
 *                     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 KPAGEDIALOG_H
#define KPAGEDIALOG_H

#include <kdialog.h>
#include <kpagewidget.h>

class KPageDialogPrivate;

class KDEUI_EXPORT KPageDialog : public KDialog
{
  Q_OBJECT
    Q_DECLARE_PRIVATE(KPageDialog)

  public:

    enum FaceType
    {
      Auto   = KPageView::Auto,
      Plain  = KPageView::Plain,
      List   = KPageView::List,
      Tree   = KPageView::Tree,
      Tabbed = KPageView::Tabbed
    };

  public:
    explicit KPageDialog( QWidget *parent = 0, Qt::WindowFlags flags = 0 );

    ~KPageDialog();

    void setFaceType( FaceType faceType );

    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 );

    void setCurrentPage( KPageWidgetItem *item );

    KPageWidgetItem* currentPage() const;

  Q_SIGNALS:
    void currentPageChanged( KPageWidgetItem *current, KPageWidgetItem *before );

    void pageRemoved( KPageWidgetItem *page );

  protected:
    KPageDialog(KPageWidget *widget, QWidget *parent, Qt::WindowFlags flags = 0);
    KPageDialog(KPageDialogPrivate &dd, KPageWidget *widget, QWidget *parent, Qt::WindowFlags flags = 0);

    KPageWidget *pageWidget();

    const KPageWidget *pageWidget() const;

    void setPageWidget(KPageWidget *widget);

};

#endif