PluginItem Class Reference

class for generating plugin menu items More...

#include <PluginItems.h>

List of all members.

Public Member Functions
	PluginItem (wxFileName filename)
	constructor
const bool	IsAPIValid () const
	returns true, if plugin can run on given system and version
const wxString	GetCategory () const
	return category name
const wxFileName	GetFilename () const
	returns filename
const wxString	GetName () const
	return name from metadata
const wxString	GetDescription () const
	return description
Private Member Functions
void	ParseMetadata ()
Private Attributes
wxString	m_category
wxString	m_name
wxFileName	m_filename
wxString	m_description
bool	m_validAPI

---

Detailed Description

class for generating plugin menu items

Definition at line 35 of file PluginItems.h.

---

Constructor & Destructor Documentation

PluginItem::PluginItem (  wxFileName  filename  )

constructor Parameters: filename  filename to python script to be parsed for metadata Definition at line 68 of file PluginItems.cpp. References m_category, m_description, m_filename, m_name, m_validAPI, and ParseMetadata().

---

Member Function Documentation

const wxString PluginItem::GetCategory (   )  const

return category name Definition at line 184 of file PluginItems.cpp. Referenced by comparePluginItem(), and MainFrame::MainFrame().

const wxString PluginItem::GetDescription (   )  const

return description Definition at line 199 of file PluginItems.cpp. Referenced by MainFrame::MainFrame().

const wxFileName PluginItem::GetFilename (   )  const

returns filename Definition at line 189 of file PluginItems.cpp. Referenced by MainFrame::MainFrame().

const wxString PluginItem::GetName (   )  const

return name from metadata Definition at line 194 of file PluginItems.cpp. Referenced by comparePluginItem(), and MainFrame::MainFrame().

const bool PluginItem::IsAPIValid (   )  const

returns true, if plugin can run on given system and version Definition at line 179 of file PluginItems.cpp. Referenced by MainFrame::MainFrame().

void PluginItem::ParseMetadata (   )  [private]

Definition at line 80 of file PluginItems.cpp. References compareVersion(), m_category, m_description, m_filename, m_name, and m_validAPI. Referenced by PluginItem().

---

Member Data Documentation

wxString PluginItem::m_category [private]

Definition at line 54 of file PluginItems.h. Referenced by ParseMetadata(), and PluginItem().

wxString PluginItem::m_description [private]

Definition at line 57 of file PluginItems.h. Referenced by ParseMetadata(), and PluginItem().

wxFileName PluginItem::m_filename [private]

Definition at line 56 of file PluginItems.h. Referenced by ParseMetadata(), and PluginItem().

wxString PluginItem::m_name [private]

Definition at line 55 of file PluginItems.h. Referenced by ParseMetadata(), and PluginItem().

bool PluginItem::m_validAPI [private]

Definition at line 58 of file PluginItems.h. Referenced by ParseMetadata(), and PluginItem().

---

The documentation for this class was generated from the following files:

• hugin1/hugin/PluginItems.h
• hugin1/hugin/PluginItems.cpp

---