kprefsdialog.h

Go to the documentation of this file.

/*
  This file is part of libkdepim.

  Copyright (c) 2001-2003 Cornelius Schumacher <schumacher@kde.org>
  Copyright (C) 2003-2004 Reinhold Kainhofer <reinhold@kainhofer.com>
  Copyright (C) 2005,2008,2011 Allen Winter <winter@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 KDEPIM_KPREFSDIALOG_H
#define KDEPIM_KPREFSDIALOG_H

#include "kdepim_export.h"

#define KDE3_SUPPORT
#include <KCModule>
#undef KDE3_SUPPORT
#include <KConfigSkeleton>
#include <KFile>
#include <KLineEdit>
#include <KPageDialog>

#include <QVariantList>

class KColorButton;
class KComboBox;
class KComponentData;
class KDateComboBox;
class KTimeComboBox;
class KUrlRequester;

class QCheckBox;
class QLabel;
class QSpinBox;
class QTimeEdit;
class QButtonGroup;
class QGroupBox;

namespace KPIM {

class KDEPIM_EXPORT KPrefsWid : public QObject
{
  Q_OBJECT
  public:
    virtual void readConfig() = 0;
    virtual void writeConfig() = 0;

    virtual QList<QWidget *> widgets() const;

  Q_SIGNALS:
    void changed();
};

class KDEPIM_EXPORT KPrefsWidBool : public KPrefsWid
{
  public:
    explicit KPrefsWidBool( KConfigSkeleton::ItemBool *item, QWidget *parent = 0 );

    QCheckBox *checkBox();

    void readConfig();
    void writeConfig();

    QList<QWidget *> widgets() const;

  private:
    KConfigSkeleton::ItemBool *mItem;

    QCheckBox *mCheck;
};

class KDEPIM_EXPORT KPrefsWidInt : public KPrefsWid
{
  public:
    explicit KPrefsWidInt( KConfigSkeleton::ItemInt *item, QWidget *parent = 0 );

    QLabel *label();

    QSpinBox *spinBox();

    void readConfig();
    void writeConfig();

    QList<QWidget *> widgets() const;

  private:
    KConfigSkeleton::ItemInt *mItem;

    QLabel *mLabel;
    QSpinBox *mSpin;
};

class KDEPIM_EXPORT KPrefsWidTime : public KPrefsWid
{
  public:
    explicit KPrefsWidTime( KConfigSkeleton::ItemDateTime *item, QWidget *parent = 0 );

    QLabel *label();

    KTimeComboBox *timeEdit();

    void readConfig();
    void writeConfig();

  private:
    KConfigSkeleton::ItemDateTime *mItem;

    QLabel *mLabel;
    KTimeComboBox *mTimeEdit;
};

class KDEPIM_EXPORT KPrefsWidDuration : public KPrefsWid
{
  public:
    explicit KPrefsWidDuration( KConfigSkeleton::ItemDateTime *item, const QString &format, QWidget *parent = 0 );

    QLabel *label();
    QTimeEdit *timeEdit();

    void readConfig();
    void writeConfig();

  private:
    KConfigSkeleton::ItemDateTime *mItem;

    QLabel *mLabel;
    QTimeEdit *mTimeEdit;
};

class KDEPIM_EXPORT KPrefsWidDate : public KPrefsWid
{
  public:
    explicit KPrefsWidDate( KConfigSkeleton::ItemDateTime *item, QWidget *parent = 0 );

    QLabel *label();

    KDateComboBox *dateEdit();

    void readConfig();
    void writeConfig();

  private:
    KConfigSkeleton::ItemDateTime *mItem;

    QLabel *mLabel;
    KDateComboBox *mDateEdit;
};

class KDEPIM_EXPORT KPrefsWidColor : public KPrefsWid
{
  Q_OBJECT
  public:
    explicit KPrefsWidColor( KConfigSkeleton::ItemColor *item, QWidget *parent = 0 );

    ~KPrefsWidColor();

    QLabel *label();
    KColorButton *button();

    void readConfig();
    void writeConfig();

  private:
    KConfigSkeleton::ItemColor *mItem;

    QLabel *mLabel;
    KColorButton *mButton;
};

class KDEPIM_EXPORT KPrefsWidFont : public KPrefsWid
{
  Q_OBJECT
  public:
    explicit KPrefsWidFont( KConfigSkeleton::ItemFont *item,
                            QWidget *parent = 0, const QString &sampleText = QString() );
    ~KPrefsWidFont();

    QLabel *label();

    QFrame *preview();

    QPushButton *button();

    void readConfig();
    void writeConfig();

  protected Q_SLOTS:
    void selectFont();

  private:
    KConfigSkeleton::ItemFont *mItem;

    QLabel *mLabel;
    QLabel *mPreview;
    QPushButton *mButton;
};

class KDEPIM_EXPORT KPrefsWidRadios : public KPrefsWid
{
  public:
    explicit KPrefsWidRadios( KConfigSkeleton::ItemEnum *item, QWidget *parent = 0 );
    virtual ~KPrefsWidRadios();

    void addRadio( int value,
                   const QString &text,
                   const QString &toolTip = QString(),
                   const QString &whatsThis = QString() );

    QGroupBox *groupBox() const;

    void readConfig();
    void writeConfig();

    QList<QWidget *> widgets() const;

  private:
    KConfigSkeleton::ItemEnum *mItem;

    QGroupBox *mBox;
    QButtonGroup *mGroup;
};

class KDE_EXPORT KPrefsWidCombo : public KPrefsWid
{
  public:
    explicit KPrefsWidCombo( KConfigSkeleton::ItemEnum *item, QWidget *parent );
    virtual ~KPrefsWidCombo();

    void readConfig();
    void writeConfig();

    KComboBox *comboBox();
    QList<QWidget *> widgets() const;

  private:
    KConfigSkeleton::ItemEnum *mItem;
    KComboBox *mCombo;
};

class KDEPIM_EXPORT KPrefsWidString : public KPrefsWid
{
  public:
    explicit KPrefsWidString( KConfigSkeleton::ItemString *item,
                              QWidget *parent = 0,
                              KLineEdit::EchoMode echomode=KLineEdit::Normal );
    virtual ~KPrefsWidString();

    QLabel *label();
    KLineEdit *lineEdit();

    void readConfig();
    void writeConfig();

    QList<QWidget *> widgets() const;

  private:
    KConfigSkeleton::ItemString *mItem;

    QLabel *mLabel;
    KLineEdit *mEdit;
};

class KDEPIM_EXPORT KPrefsWidPath : public KPrefsWid
{
  public:
    explicit KPrefsWidPath( KConfigSkeleton::ItemPath *item,
                            QWidget *parent = 0,
                            const QString &filter = QString(),
                            KFile::Modes = KFile::File );

    virtual ~KPrefsWidPath();

    QLabel *label();

    KUrlRequester *urlRequester();

    void readConfig();
    void writeConfig();

    QList<QWidget *> widgets() const;

  private:
    KConfigSkeleton::ItemPath *mItem;

    QLabel *mLabel;
    KUrlRequester *mURLRequester;
};

class KDEPIM_EXPORT KPrefsWidManager
{
  public:
    explicit KPrefsWidManager( KConfigSkeleton *prefs );

    virtual ~KPrefsWidManager();

    KConfigSkeleton *prefs() const { return mPrefs; }

    virtual void addWid( KPrefsWid * );

    KPrefsWidBool *addWidBool( KConfigSkeleton::ItemBool *item,
                               QWidget *parent = 0 );

    KPrefsWidInt *addWidInt( KConfigSkeleton::ItemInt *item,
                             QWidget *parent = 0 );

    KPrefsWidDate *addWidDate( KConfigSkeleton::ItemDateTime *item,
                               QWidget *parent = 0 );

    KPrefsWidTime *addWidTime( KConfigSkeleton::ItemDateTime *item,
                               QWidget *parent = 0 );

    KPrefsWidDuration *addWidDuration( KConfigSkeleton::ItemDateTime *item,
                                       const QString &format,
                                       QWidget *parent = 0 );

    KPrefsWidColor *addWidColor( KConfigSkeleton::ItemColor *item,
                                 QWidget *parent = 0 );

    KPrefsWidRadios *addWidRadios( KConfigSkeleton::ItemEnum *item,
                                   QWidget *parent = 0 );

    KPrefsWidCombo *addWidCombo( KConfigSkeleton::ItemEnum *item,
                                 QWidget *parent = 0 );

    KPrefsWidString *addWidString( KConfigSkeleton::ItemString *item,
                                   QWidget *parent = 0 );

    KPrefsWidPath *addWidPath ( KConfigSkeleton::ItemPath *item,
                                QWidget *parent = 0,
                                const QString &filter = QString(),
                                KFile::Modes mode = KFile::File );

    KPrefsWidString *addWidPassword ( KConfigSkeleton::ItemString *item,
                                      QWidget *parent = 0 );

    KPrefsWidFont *addWidFont( KConfigSkeleton::ItemFont *item,
                               QWidget *parent = 0,
                               const QString &sampleText = QString() );

    void setWidDefaults();

    void readWidConfig();

    void writeWidConfig();

  private:
    KConfigSkeleton *mPrefs;

    QList<KPrefsWid*> mPrefsWids;
};

class KDEPIM_EXPORT KPrefsDialog : public KPageDialog, public KPrefsWidManager
{
  Q_OBJECT
  public:
    explicit KPrefsDialog( KConfigSkeleton *prefs, QWidget *parent = 0,
                           bool modal = false );

    virtual ~KPrefsDialog();

    void autoCreate();

  public Q_SLOTS:
    void setDefaults();

    void readConfig();

    void writeConfig();

  Q_SIGNALS:
    void configChanged();

  protected Q_SLOTS:
    void slotApply();

    void slotOk();

    void slotDefault();

  protected:
    virtual void usrReadConfig() {}
    virtual void usrWriteConfig() {}
};

class KDEPIM_EXPORT KPrefsModule : public KCModule, public KPrefsWidManager
{
  Q_OBJECT
  public:
    KPrefsModule( KConfigSkeleton *, const KComponentData &instance,
                  QWidget *parent=0, const QVariantList &args=QVariantList() );

    virtual void addWid( KPrefsWid * );

    void load();
    void save();
    void defaults();

  protected Q_SLOTS:
    void slotWidChanged();

  protected:
    virtual void usrReadConfig() {}
    virtual void usrWriteConfig() {}
};

}

#endif