plugin.h

Go to the documentation of this file.

#ifndef PLUGIN_H_
#define PLUGIN_H_

#include <QString>
#include <QHash>
#include <QList>
#include <QLocale>

class QPoint;
class QEvent;
class QMenu;

class CAMainWin;
class CADocument;

class CAPluginAction;

class CAPlugin {
        public:
                CAPlugin();
                CAPlugin(QString name, QString author, QString version, QString date, QString dirName, QString homeUrl, QString updateUrl);
                ~CAPlugin();
                
                bool action(QString onAction, CAMainWin *mainWin=0, CADocument *document=0, QEvent *evt=0, QPoint *coords=0);
                
                bool callAction(CAPluginAction *action, CAMainWin *mainWin=0, CADocument *document=0, QEvent *evt=0, QPoint *coords=0, QString filename="");
                
                void addAction(CAPluginAction *action);
                void addMenu(QString name, QMenu* menu) { _menuMap[name] = menu; }
                
                void setEnabled(bool enabled) { _enabled = enabled; }
                bool isEnabled() { return _enabled; }
                
                QString name() { return _name; }
                QString author() { return _author; }
                QString version() { return _version; }
                QString date() { return _date; }
                QString dirName() { return _dirName; }
                QString homeUrl() { return _homeUrl; }
                QString updateUrl() { return _updateUrl; }
                QString description(QString lang) { return _descMap[lang]; }
                QString localDescription() { if (_descMap.contains(QLocale::system().name())) return description(QLocale::system().name()); else return description(""); }
                QMenu *menu(QString menuName) { return _menuMap[menuName]; }
                
                void setName(QString name) { _name = name; }
                void setDescription(QString desc, QString lang=QString("")) { _descMap[lang]=desc; }
                void setAuthor(QString author) { _author = author; }
                void setVersion(QString version) { _version = version; }
                void setDate(QString date) { _date = date; }
                void setDirName(QString dirName) { _dirName = dirName; }
                void setHomeUrl(QString homeUrl) { _homeUrl = homeUrl; }
                void setUpdateUrl(QString updateUrl) { _updateUrl = updateUrl; }
                
                QList<QString> actionList() { return _actionMap.keys(); }

        private:
                QString _name;
                QHash<QString, QString> _descMap;                   
                QString _author;
                QString _version;
                QString _date;
                QString _dirName;                                   
                QString _homeUrl;
                QString _updateUrl;
                bool _enabled;
                
                QMultiHash< QString, CAPluginAction* > _actionMap;  
                QHash< QString, QMenu* > _menuMap;                  
};
#endif /*PLUGIN_H_*/