mudbox::Plugin Struct Reference

#include <plugin.h>

Detailed Description

This class holds all the information Mudbox needs about a plugin.

Normally you do not create instances of this class directly. Instead, in your plug-in class you use the MB_PLUGIN macro like this:

    MB_PLUGIN( "<Plugin Name>", "<Brief Description>", "<Author's Name>", "<Related URL (if any)>", <pointer to initializer function> );

The initializer function must be a static method that takes no arguments and returns void. If there is no initializer plugin for the class, this parameter can be NULL.


Public Types
typedef void	initializer (void)
Public Member Functions
	Plugin (void)
	Null constructor.
	Plugin (const QString &sName, const QString &sDescription, const QString &sAuthor, const QString &sURL, const QString &sCompileTime, initializer *fFunc=0)
	Constructor. Use MB_PLUGIN macro instead.
Public Attributes
QString	m_sName
	The name of the plug-in.
QString	m_sDescription
	A brief description of what it does.
QString	m_sAuthor
	The name of the plug-in's author.
QString	m_sURL
	A URL that contains information related to the plug-in (if any).
QString	m_sCompileTime
	The date and time that the plugin was loaded (generated automatically).
QString	m_sPluginFolder
	The path of the folder that the plug-in was loaded from (set at load time).
initializer *	m_pInitializer
	A pointer to the initializer funtion of the plug-in.

Member Typedef Documentation

typedef void mudbox::Plugin::initializer(void)

Constructor & Destructor Documentation

mudbox::Plugin::Plugin ( void ) [inline]

Null constructor.

00039 {};

mudbox::Plugin::Plugin	(	const QString &	sName,
		const QString &	sDescription,
		const QString &	sAuthor,
		const QString &	sURL,
		const QString &	sCompileTime,
		initializer *	fFunc = `0`
	)