form.h

/***************************************************************************
 *   Copyright (C) 2007 by Pino Toscano <[email protected]>                     *
 *                                                                         *
 *   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 of the License, or     *
 *   (at your option) any later version.                                   *
 ***************************************************************************/

#ifndef _OKULAR_FORM_H_
#define _OKULAR_FORM_H_

#include "annotations.h"
#include "area.h"
#include "okularcore_export.h"
#include "signatureutils.h"

#include <QStringList>

#include <memory>

namespace Okular
{
class Action;
class Page;
class PagePrivate;
class FormFieldPrivate;
class FormFieldButtonPrivate;
class FormFieldTextPrivate;
class FormFieldChoicePrivate;
class FormFieldSignaturePrivate;

class OKULARCORE_EXPORT FormField
{
    friend class Page;
    friend class PagePrivate;

public:
    enum FieldType {
        FormButton,   
        FormText,     
        FormChoice,   
        FormSignature 
    };

    virtual ~FormField();

    FieldType type() const;

    virtual NormalizedRect rect() const = 0;

    virtual int id() const = 0;

    virtual QString name() const = 0;

    virtual QString uiName() const = 0;

    virtual QString fullyQualifiedName() const = 0;

    virtual bool isReadOnly() const;

    virtual void setReadOnly(bool value);

    virtual bool isVisible() const;

    virtual void setVisible(bool value);

    virtual bool isPrintable() const;

    virtual void setPrintable(bool value);

    Action *activationAction() const;

    enum AdditionalActionType {
        FieldModified,  
        FormatField,    
        ValidateField,  
        CalculateField, 
    };

    Action *additionalAction(AdditionalActionType type) const;

    /* Returns the additional action of the given @p type or @c nullptr if no action has been defined.
     *
     * This is for actions of annotation widgets associated with the FormField
     *
     * @since 1.5
     */
    Action *additionalAction(Annotation::AdditionalActionType type) const;

protected:
    FormField(FormFieldPrivate &dd);
    Q_DECLARE_PRIVATE(FormField)
    FormFieldPrivate *d_ptr;

    void setActivationAction(Action *action);
    void setAdditionalAction(AdditionalActionType type, Action *action);
    void setAdditionalAction(Annotation::AdditionalActionType type, Action *action);

private:
    Q_DISABLE_COPY(FormField)
};

class OKULARCORE_EXPORT FormFieldButton : public FormField
{
public:
    enum ButtonType {
        Push,     
        CheckBox, 
        Radio     
    };

    ~FormFieldButton() override;

    virtual ButtonType buttonType() const = 0;

    virtual QString caption() const = 0;

    virtual bool state() const = 0;

    virtual void setState(bool state);

    virtual QList<int> siblings() const = 0;

    virtual void setIcon(Okular::FormField *field);

protected:
    FormFieldButton();

private:
    Q_DECLARE_PRIVATE(FormFieldButton)
    Q_DISABLE_COPY(FormFieldButton)
};

class OKULARCORE_EXPORT FormFieldText : public FormField
{
public:
    enum TextType {
        Normal,    
        Multiline, 
        FileSelect 
    };

    ~FormFieldText() override;

    virtual TextType textType() const = 0;

    virtual QString text() const = 0;

    virtual void setText(const QString &text);

    virtual bool isPassword() const;

    virtual bool isRichText() const;

    virtual int maximumLength() const;

    virtual Qt::Alignment textAlignment() const;

    virtual bool canBeSpellChecked() const;

    virtual void setAppearanceText(const QString &text) = 0;

protected:
    FormFieldText();

private:
    Q_DECLARE_PRIVATE(FormFieldText)
    Q_DISABLE_COPY(FormFieldText)
};

class OKULARCORE_EXPORT FormFieldChoice : public FormField
{
public:
    enum ChoiceType {
        ComboBox, 
        ListBox   
    };

    ~FormFieldChoice() override;

    virtual ChoiceType choiceType() const = 0;

    virtual QStringList choices() const = 0;

    virtual bool isEditable() const;

    virtual bool multiSelect() const;

    virtual QList<int> currentChoices() const = 0;

    virtual void setCurrentChoices(const QList<int> &choices);

    virtual QString editChoice() const;

    virtual void setEditChoice(const QString &text);

    virtual Qt::Alignment textAlignment() const;

    virtual bool canBeSpellChecked() const;

    QString exportValueForChoice(const QString &choice) const;

protected:
    FormFieldChoice();

    void setExportValues(const QMap<QString, QString> &values);

private:
    Q_DECLARE_PRIVATE(FormFieldChoice)
    Q_DISABLE_COPY(FormFieldChoice)
};

class OKULARCORE_EXPORT FormFieldSignature : public FormField
{
public:
    enum SignatureType { AdbePkcs7sha1, AdbePkcs7detached, EtsiCAdESdetached, UnknownType };

    ~FormFieldSignature() override;

    virtual SignatureType signatureType() const = 0;

    virtual const SignatureInfo &signatureInfo() const = 0;

protected:
    FormFieldSignature();

private:
    Q_DECLARE_PRIVATE(FormFieldSignature)
    Q_DISABLE_COPY(FormFieldSignature)
};

}

Q_DECLARE_METATYPE(const Okular::FormFieldSignature *);

#endif