PluginItem Class Reference

class for generating plugin menu items More...

#include <PluginItems.h>

Public Member Functions
	PluginItem (wxFileName filename)
	constructor More...
const bool	IsAPIValid () const
	returns true, if plugin can run on given system and version More...
const wxString	GetCategory () const
	return category name More...
const wxFileName	GetFilename () const
	returns filename More...
const wxString	GetName () const
	return name from metadata More...
const wxString	GetDescription () const
	return description More...

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 )

explicit

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.

References m_category.

Referenced by comparePluginItem(), and MainFrame::MainFrame().

const wxString PluginItem::GetDescription

(

)

const

return description

Definition at line 199 of file PluginItems.cpp.

References m_description.

Referenced by MainFrame::MainFrame().

const wxFileName PluginItem::GetFilename

(

)

const

returns filename

Definition at line 189 of file PluginItems.cpp.

References m_filename.

Referenced by MainFrame::MainFrame().

const wxString PluginItem::GetName

(

)

const

return name from metadata

Definition at line 194 of file PluginItems.cpp.

References m_name.

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.

References m_validAPI.

Referenced by MainFrame::MainFrame().

void PluginItem::ParseMetadata ( )

private

Definition at line 80 of file PluginItems.cpp.

References compareVersion(), celeste::line, 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 GetCategory(), ParseMetadata(), and PluginItem().

wxString PluginItem::m_description

private

Definition at line 57 of file PluginItems.h.

Referenced by GetDescription(), ParseMetadata(), and PluginItem().

wxFileName PluginItem::m_filename

private

Definition at line 56 of file PluginItems.h.

Referenced by GetFilename(), ParseMetadata(), and PluginItem().

wxString PluginItem::m_name

private

Definition at line 55 of file PluginItems.h.

Referenced by GetName(), ParseMetadata(), and PluginItem().

bool PluginItem::m_validAPI

private

Definition at line 58 of file PluginItems.h.

Referenced by IsAPIValid(), ParseMetadata(), and PluginItem().

---

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

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