qt_gui_cpp: plugin_descriptor.h Source File

Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 2011, Dirk Thomas, TU Darmstadt
00003  * All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions
00007  * are met:
00008  *
00009  *   * Redistributions of source code must retain the above copyright
00010  *     notice, this list of conditions and the following disclaimer.
00011  *   * Redistributions in binary form must reproduce the above
00012  *     copyright notice, this list of conditions and the following
00013  *     disclaimer in the documentation and/or other materials provided
00014  *     with the distribution.
00015  *   * Neither the name of the TU Darmstadt nor the names of its
00016  *     contributors may be used to endorse or promote products derived
00017  *     from this software without specific prior written permission.
00018  *
00019  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00020  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00021  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00022  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
00023  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00024  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00025  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00026  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00027  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00028  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00029  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00030  * POSSIBILITY OF SUCH DAMAGE.
00031  */
00032 
00033 #ifndef qt_gui_cpp__PluginDescriptor_H
00034 #define qt_gui_cpp__PluginDescriptor_H
00035 
00036 #include <QMap>
00037 #include <QString>
00038 #include <QVector>
00039 
00040 namespace qt_gui_cpp
00041 {
00042 
00043 class PluginDescriptor
00044 {
00045 
00046 public:
00047 
00048   PluginDescriptor(const QString& plugin_id, const QMap<QString, QString>& attributes = (QMap<QString, QString>()));
00049 
00050   const QString& pluginId() const;
00051 
00052   const QMap<QString, QString>& attributes() const;
00053 
00054   QMap<QString, QString>& attributes();
00055 
00056   const QMap<QString, QString>& actionAttributes() const;
00057 
00058   void setActionAttributes(const QString& label, const QString& statustip = QString(), const QString& icon = QString(), const QString& icontype = QString());
00059 
00060   int countGroups() const;
00061 
00062   QMap<QString, QString> group(int index) const;
00063 
00064   void addGroupAttributes(const QString& label, const QString& statustip = QString(), const QString& icon = QString(), const QString& icontype = QString());
00065 
00066   QMap<QString, QString> toDictionary() const;
00067 
00068 protected:
00069 
00070   QString plugin_id_;
00071 
00072   QMap<QString, QString> attributes_;
00073 
00074   QMap<QString, QString> action_attributes_;
00075 
00076   QVector<QMap<QString, QString> > groups_;
00077 
00078 };
00079 
00080 } // namespace
00081 
00082 #endif // qt_gui_cpp__PluginDescriptor_H