poppler-form.h

/* poppler-form.h: qt4 interface to poppler
 * Copyright (C) 2007-2008, Pino Toscano <pino@kde.org>
 * Copyright (C) 2008, 2011, Albert Astals Cid <aacid@kde.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
 */

#ifndef _POPPLER_QT4_FORM_H_
#define _POPPLER_QT4_FORM_H_

#include <QtCore/QRectF>
#include <QtCore/QStringList>
#include "poppler-export.h"

class Page;
class FormWidget;
class FormWidgetButton;
class FormWidgetText;
class FormWidgetChoice;

namespace Poppler {

    class DocumentData;
    class Link;

    class FormFieldData;
    class POPPLER_QT4_EXPORT FormField {
    public:

        enum FormType {
            FormButton,    
            FormText,      
            FormChoice,    
            FormSignature  
        };

        virtual ~FormField();

        virtual FormType type() const = 0;

        QRectF rect() const;

        int id() const;

        QString name() const;
        
        QString fullyQualifiedName() const;

        QString uiName() const;

        bool isReadOnly() const;

        bool isVisible() const;

        Link* activationAction() const;

    protected:
        FormField(FormFieldData &dd);

        FormFieldData *m_formData;

    private:
        Q_DISABLE_COPY(FormField)
    };

    class POPPLER_QT4_EXPORT FormFieldButton : public FormField {
    public:

        enum ButtonType
        {
            Push,          
            CheckBox,      
            Radio          
        };

        FormFieldButton(DocumentData *doc, ::Page *p, ::FormWidgetButton *w);
        virtual ~FormFieldButton();

        virtual FormType type() const;

        ButtonType buttonType() const;

        QString caption() const;

        bool state() const;

        void setState( bool state );

        QList<int> siblings() const;

    private:
        Q_DISABLE_COPY(FormFieldButton)
    };

    class POPPLER_QT4_EXPORT FormFieldText : public FormField {
    public:

        enum TextType {
            Normal,        
            Multiline,     
            FileSelect     
        };

        FormFieldText(DocumentData *doc, ::Page *p, ::FormWidgetText *w);
        virtual ~FormFieldText();

        virtual FormType type() const;

        TextType textType() const;

        QString text() const;

        void setText( const QString& text );

        bool isPassword() const;

        bool isRichText() const;

        int maximumLength() const;

        Qt::Alignment textAlignment() const;

        bool canBeSpellChecked() const;

    private:
        Q_DISABLE_COPY(FormFieldText)
    };

    class POPPLER_QT4_EXPORT FormFieldChoice : public FormField {
    public:

        enum ChoiceType {
            ComboBox,     
            ListBox       
        };

        FormFieldChoice(DocumentData *doc, ::Page *p, ::FormWidgetChoice *w);
        virtual ~FormFieldChoice();

        virtual FormType type() const;

        ChoiceType choiceType() const;

        QStringList choices() const;

        bool isEditable() const;

        bool multiSelect() const;

        QList<int> currentChoices() const;

        void setCurrentChoices( const QList<int> &choice );

        Qt::Alignment textAlignment() const;

        bool canBeSpellChecked() const;

    private:
        Q_DISABLE_COPY(FormFieldChoice)
    };

}

#endif