form.h

Go to the documentation of this file.

/***************************************************************************
 * form.h
 * This file is part of the KDE project
 * copyright (C)2006-2007 by Sebastian Sauer (mail@dipe.org)
 *
 * This program 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 program 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 program; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 ***************************************************************************/

#ifndef KROSS_FORM_H
#define KROSS_FORM_H

#include <QtGui/QWidget>
#include <QtCore/QUrl>
#include <QtGui/QListWidget>

#include <kpagedialog.h>
#include <kassistantdialog.h>
//#include <kfilewidget.h>

namespace Kross {

    class FormListView : public QListWidget
    {
            Q_OBJECT
        public:
            explicit FormListView(QWidget* parent);
            virtual ~FormListView();
        public Q_SLOTS:
            void clear();
            void remove(int index);
            void addItem(const QString& text);
            int count();
            int current();
            void setCurrent(int row);
            QString text(int row);
    };

    class FormFileWidget : public QWidget
    {
            Q_OBJECT
            Q_ENUMS(Mode)

        public:
            FormFileWidget(QWidget* parent, const QString& startDirOrVariable);
            virtual ~FormFileWidget();

            enum Mode { Other = 0, Opening, Saving };

        public Q_SLOTS:

            void setMode(const QString& mode);

            QString currentFilter() const;

            void setFilter(const QString &filter);

            QString currentMimeFilter() const;

            void setMimeFilter(const QStringList& filter);

            QString selectedFile() const;

            //QStringList selectedFiles() const { return KFileDialog::selectedFiles(); }
            //QString selectedUrl() const { return KFileDialog::selectedUrl().toLocalFile(); }

        Q_SIGNALS:

            void fileSelected(const QString& file);

            void fileHighlighted(const QString&);

            void selectionChanged();

            void filterChanged(const QString& filter);

        private Q_SLOTS:
            void slotFileSelected(const QString&);

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

    class FormProgressDialog : public KPageDialog
    {
            Q_OBJECT
        public:
            FormProgressDialog(const QString& caption, const QString& labelText);
            virtual ~FormProgressDialog();
            virtual void done(int r);
        public Q_SLOTS:
            void setValue(int progress);
            void setRange(int minimum, int maximum);
            void setText(const QString& text);
            void addText(const QString& text);
            int exec();
            int exec_loop() { return exec(); }
            bool isCanceled();
        Q_SIGNALS:
            void canceled();
        private:
            class Private;
            Private* const d;
    };

    class FormDialog: public KPageDialog
    {
            Q_OBJECT

        public:
            FormDialog(const QString& caption);
            virtual ~FormDialog();

        public Q_SLOTS:

            bool setButtons(const QString& buttons);

            bool setButtonText(const QString& button, const QString& text);

            bool setFaceType(const QString& facetype);

            QString currentPage() const;

            bool setCurrentPage(const QString& name);

            QWidget* page(const QString& name) const;

            QWidget* addPage(const QString& name, const QString& header = QString(), const QString& iconname = QString());

            void setMainWidget(QWidget *newMainWidget);

            int exec() { return KDialog::exec(); }

            int exec_loop() { return exec(); }

            QString result();

        private Q_SLOTS:
            virtual void slotButtonClicked(int button);
            void slotCurrentPageChanged(KPageWidgetItem* current);

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


    class FormAssistant: public KAssistantDialog
    {
            Q_OBJECT
            Q_ENUMS(AssistantButtonCode)
        public:
            enum AssistantButtonCode
            {
                None    = 0x00000000,
                Help    = 0x00000001,
                Default = 0x00000002,
                Cancel  = 0x00000020,
                Finish  = 0x00001000,
                Next    = 0x00002000,
                Back    = 0x00004000,
                NoDefault = 0x00008000
            };
            Q_DECLARE_FLAGS(AssistantButtonCodes, AssistantButtonCode)

        public:
            FormAssistant(const QString& caption);
            virtual ~FormAssistant();

        public Q_SLOTS:

            void showHelpButton(bool);

            QString currentPage() const;

            bool setCurrentPage(const QString& name);

            QWidget* page(const QString& name) const;

            QWidget* addPage(const QString& name, const QString& header = QString(), const QString& iconname = QString());

            bool isAppropriate (const QString& name) const;
            void setAppropriate (const QString& name, bool appropriate);
            bool isValid (const QString& name) const;
            void setValid (const QString& name, bool enable);

            int exec() { return KDialog::exec(); }

            int exec_loop() { return exec(); }

            QString result();

            void back();
            void next();

        private Q_SLOTS:
            virtual void slotButtonClicked(int button);
            void slotCurrentPageChanged(KPageWidgetItem* current);

        signals:
            void nextClicked();
            void backClicked();

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


    class FormModule: public QObject
    {
            Q_OBJECT

        public:
            explicit FormModule();
            virtual ~FormModule();

        public Q_SLOTS:

            QWidget* activeModalWidget();

            QWidget* activeWindow();


            QString tr(const QString& str);

            QString tr(const QString& str,const QString& comment);


            QString showMessageBox(const QString& dialogtype, const QString& caption, const QString& message, const QString& details = QString());

            QWidget* showProgressDialog(const QString& caption, const QString& labelText);

            QWidget* createDialog(const QString& caption);

            QWidget* createAssistant(const QString& caption);

            QObject* createLayout(QWidget* parent, const QString& layout);

            QWidget* createWidget(const QString& className);

            QWidget* createWidget(QWidget* parent, const QString& className, const QString& name = QString());

            QWidget* createWidgetFromUI(QWidget* parent, const QString& xml);

            QWidget* createWidgetFromUIFile(QWidget* parent, const QString& filename);

            QWidget* createFileWidget(QWidget* parent, const QString& startDirOrVariable = QString());

            QWidget* createListView(QWidget* parent);

            QObject* loadPart(QWidget* parent, const QString& name, const QUrl& url = QUrl());

            QAction* createAction(QObject* parent);

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

#endif