[f96f56]: src / hugin1 / hugin / PluginItems.h Maximize Restore History

Download this file

PluginItems.h    78 lines (71 with data), 2.2 kB

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
// -*- c-basic-offset: 4 -*-
/** @file PluginItems.h
*
* @brief Reading python plugins metadata
*
* @author Y. Levy, T. Modes
*
*/
/*
* This 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.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU General Public
* License along with this software; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
*/
#ifndef PLUGINITEMS_H
#define PLUGINITEMS_H
#include <wx/string.h>
#include <wx/filename.h>
#include <list>
/** class for generating plugin menu items */
class PluginItem
{
public:
enum PluginType
{
DefaultPlugin,
ImagePlugin,
StackPlugin,
ControlpointPlugin
};
/** constructor
* @param filename filename to python script to be parsed for metadata
*/
PluginItem(wxFileName filename);
/** returns true, if plugin can run on given system and version */
const bool IsAPIValid() const;
/** return category name */
const wxString GetCategory() const;
/** returns filename */
const wxFileName GetFilename() const;
/** return name from metadata */
const wxString GetName() const;
/** return description */
const wxString GetDescription() const;
/** return plugin type */
const PluginType GetPluginType() const;
private:
void ParseMetadata();
/** determines the plugin type from the category */
void CheckCategory();
wxString m_category;
wxString m_name;
wxFileName m_filename;
wxString m_description;
PluginType m_type;
bool m_validAPI;
};
typedef std::list<PluginItem> PluginItems;
/** compares 2 plugin with category and name */
bool comparePluginItem(PluginItem item1,PluginItem item2);
#endif // PLUGINITEMS_H