1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

     4 ** All rights reserved.

     5 ** Contact: Nokia Corporation (qt-info@nokia.com)

     6 **

     7 ** This file is part of the Qt Designer of the Qt Toolkit.

     8 **

     9 ** $QT_BEGIN_LICENSE:LGPL$

    10 ** No Commercial Usage

    11 ** This file contains pre-release code and may not be distributed.

    12 ** You may use this file in accordance with the terms and conditions

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    15 **

    16 ** GNU Lesser General Public License Usage

    17 ** Alternatively, this file may be used under the terms of the GNU Lesser

    18 ** General Public License version 2.1 as published by the Free Software

    19 ** Foundation and appearing in the file LICENSE.LGPL included in the

    20 ** packaging of this file.  Please review the following information to

    21 ** ensure the GNU Lesser General Public License version 2.1 requirements

    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

    23 **

    24 ** In addition, as a special exception, Nokia gives you certain additional

    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception

    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

    27 **

    28 ** If you have questions regarding the use of this file, please contact

    29 ** Nokia at qt-info@nokia.com.

    30 **

    31 **

    32 **

    33 **

    34 **

    35 **

    36 **

    37 **

    38 ** $QT_END_LICENSE$

    39 **

    40 ****************************************************************************/

    41 

    42 #ifndef ABSTRACTWIDGETBOX_H

    43 #define ABSTRACTWIDGETBOX_H

    44 

    45 #include <QtDesigner/sdk_global.h>

    46 

    47 #include <QtCore/QMetaType>

    48 #include <QtGui/QWidget>

    49 #include <QtGui/QIcon>

    50 

    51 QT_BEGIN_HEADER

    52 

    53 QT_BEGIN_NAMESPACE

    54 

    55 class DomUI;

    56 class QDesignerDnDItemInterface;

    57 

    58 class QDESIGNER_SDK_EXPORT QDesignerWidgetBoxInterface : public QWidget

    59 {

    60     Q_OBJECT

    61 public:

    62     class Widget {

    63     public:

    64         enum Type { Default, Custom };

    65         Widget(const QString &aname = QString(), const QString &xml = QString(),

    66                 const QString &icon_name = QString(), Type atype = Default)

    67             : m_name(aname), m_xml(xml), m_icon_name(icon_name), m_type(atype) {}

    68         QString name() const { return m_name; }

    69         void setName(const QString &aname) { m_name = aname; }

    70         QString domXml() const { return m_xml; }

    71         void setDomXml(const QString &xml) { m_xml = xml; }

    72         QString iconName() const { return m_icon_name; }

    73         void setIconName(const QString &icon_name) { m_icon_name = icon_name; }

    74         Type type() const { return m_type; }

    75         void setType(Type atype) { m_type = atype; }

    76 

    77         bool isNull() const { return m_name.isEmpty(); }

    78 

    79     private:

    80         QString m_name;

    81         QString m_xml;

    82         QString m_icon_name;

    83         Type m_type;

    84     };

    85     typedef QList<Widget> WidgetList;

    86 

    87     class Category {

    88     public:

    89         enum Type { Default, Scratchpad };

    90 

    91         Category(const QString &aname = QString(), Type atype = Default)

    92             : m_name(aname), m_type(atype) {}

    93 

    94         QString name() const { return m_name; }

    95         void setName(const QString &aname) { m_name = aname; }

    96         int widgetCount() const { return m_widget_list.size(); }

    97         Widget widget(int idx) const { return m_widget_list.at(idx); }

    98         void removeWidget(int idx) { m_widget_list.removeAt(idx); }

    99         void addWidget(const Widget &awidget) { m_widget_list.append(awidget); }

   100         Type type() const { return m_type; }

   101         void setType(Type atype) { m_type = atype; }

   102 

   103         bool isNull() const { return m_name.isEmpty(); }

   104 

   105     private:

   106         QString m_name;

   107         Type m_type;

   108         QList<Widget> m_widget_list;

   109     };

   110     typedef QList<Category> CategoryList;

   111 

   112     QDesignerWidgetBoxInterface(QWidget *parent = 0, Qt::WindowFlags flags = 0);

   113     virtual ~QDesignerWidgetBoxInterface();

   114 

   115     virtual int categoryCount() const = 0;

   116     virtual Category category(int cat_idx) const = 0;

   117     virtual void addCategory(const Category &cat) = 0;

   118     virtual void removeCategory(int cat_idx) = 0;

   119 

   120     virtual int widgetCount(int cat_idx) const = 0;

   121     virtual Widget widget(int cat_idx, int wgt_idx) const = 0;

   122     virtual void addWidget(int cat_idx, const Widget &wgt) = 0;

   123     virtual void removeWidget(int cat_idx, int wgt_idx) = 0;

   124 

   125     int findOrInsertCategory(const QString &categoryName);

   126 

   127     virtual void dropWidgets(const QList<QDesignerDnDItemInterface*> &item_list,

   128                                 const QPoint &global_mouse_pos) = 0;

   129 

   130     virtual void setFileName(const QString &file_name) = 0;

   131     virtual QString fileName() const = 0;

   132     virtual bool load() = 0;

   133     virtual bool save() = 0;

   134 };

   135 

   136 QT_END_NAMESPACE

   137 

   138 Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QDesignerWidgetBoxInterface::Widget))

   139 

   140 QT_END_HEADER

   141 

   142 #endif // ABSTRACTWIDGETBOX_H