iformfield.h

Go to the documentation of this file.

/**********************************************************************
 * LeechCraft - modular cross-platform feature rich internet client.
 * Copyright (C) 2006-2014  Georg Rudoy
 *
 * Boost Software License - Version 1.0 - August 17th, 2003
 *
 * Permission is hereby granted, free of charge, to any person or organization
 * obtaining a copy of the software and accompanying documentation covered by
 * this license (the "Software") to use, reproduce, display, distribute,
 * execute, and transmit the Software, and to prepare derivative works of the
 * Software, and to permit third-parties to whom the Software is furnished to
 * do so, all subject to the following:
 *
 * The copyright notices in the Software and this entire statement, including
 * the above license grant, this restriction and the following disclaimer,
 * must be included in all copies of the Software, in whole or in part, and
 * all derivative works of the Software, unless such copies or derivative
 * works are solely in the form of machine-executable object code generated by
 * a source language processor.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
 * SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
 * FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 **********************************************************************/
 
#pragma once
 
#include <memory>
#include <QtPlugin>
 
class QRectF;
 
namespace LC
{
namespace Monocle
{
    enum class FormType
    {
        Text,
 
        Choice,
 
        Button
    };
 
    class IFormField
    {
    public:
        virtual ~IFormField () {}
 
        virtual FormType GetType () const = 0;
 
        virtual int GetID () const = 0;
 
        virtual QString GetName () const = 0;
 
        virtual QRectF GetRect () const = 0;
 
        virtual Qt::Alignment GetAlignment () const = 0;
    };
 
    typedef std::shared_ptr<IFormField> IFormField_ptr;
 
    class IFormFieldText
    {
    public:
        enum class Type
        {
            SingleLine,
 
            Multiline,
 
            File
        };
 
        virtual ~IFormFieldText () {}
 
        virtual QString GetText () const = 0;
 
        virtual void SetText (const QString& text) = 0;
 
        virtual Type GetTextType () const = 0;
 
        virtual int GetMaximumLength () const = 0;
 
        virtual bool IsPassword () const = 0;
 
        virtual bool IsRichText () const = 0;
    };
 
    class IFormFieldChoice
    {
    public:
        enum class Type
        {
            Combobox,
 
            ListBox
        };
 
        virtual ~IFormFieldChoice () {}
 
        virtual Type GetChoiceType () const = 0;
 
        virtual QStringList GetAllChoices () const = 0;
 
        virtual QList<int> GetCurrentChoices () const = 0;
 
        virtual void SetCurrentChoices (const QList<int>& choices) = 0;
 
        virtual QString GetEditChoice () const = 0;
 
        virtual void SetEditChoice (const QString& choice) = 0;
 
        virtual bool IsEditable () const = 0;
    };
 
    class IFormFieldButton
    {
    public:
        virtual ~IFormFieldButton () {}
 
        enum class Type
        {
            Pushbutton,
 
            Checkbox,
 
            Radiobutton
        };
 
        virtual Type GetButtonType () const = 0;
 
        virtual QString GetCaption () const = 0;
 
        virtual bool IsChecked () const = 0;
 
        virtual void SetChecked (bool state) = 0;
 
        virtual QList<int> GetButtonGroup () const = 0;
 
        virtual void HandleActivated () = 0;
    };
}
}
 
Q_DECLARE_INTERFACE (LC::Monocle::IFormField,
        "org.LeechCraft.Monocle.IFormField/1.0")
Q_DECLARE_INTERFACE (LC::Monocle::IFormFieldText,
        "org.LeechCraft.Monocle.IFormFieldText/1.0")
Q_DECLARE_INTERFACE (LC::Monocle::IFormFieldChoice,
        "org.LeechCraft.Monocle.IFormFieldChoice/1.0")
Q_DECLARE_INTERFACE (LC::Monocle::IFormFieldButton,
        "org.LeechCraft.Monocle.IFormFieldButton/1.0")