mudbox::WindowPlugin Class Reference

#include <plugin.h>

Inheritance diagram for mudbox::WindowPlugin:

Detailed Description

WindowPlugin is an interface to implement window based plugins.

When a window based plugin inherits from this class, it will be automatically added as a Window menu item and also in the New Tab contextual menu.


Public Member Functions
virtual void	Start ()=0
	This method is called when Mudbox is loaded.
virtual void	Stop ()=0
	This method is called when Mudbox quits.
virtual bool	IsEnabled ()=0
	This method returns whether the plugin is currently enabled or not.
virtual QWidget *	CreateWidget (QWidget *parent, QString name)=0
	This method must implement the widget creation.
virtual QWidget *	Widget ()=0
	This method returns a pointer to the widget.
virtual QString	Name ()
	This method returns the name of the plugin.
virtual QString	Title ()
	This method returns the title of the plugin.
Protected Attributes
QString	m_name
QString	m_title

virtual void mudbox::WindowPlugin::Start ( ) [pure virtual]

This method is called when Mudbox is loaded.

virtual void mudbox::WindowPlugin::Stop ( ) [pure virtual]

This method is called when Mudbox quits.

virtual bool mudbox::WindowPlugin::IsEnabled ( ) [pure virtual]

This method returns whether the plugin is currently enabled or not.

virtual QWidget* mudbox::WindowPlugin::CreateWidget	(	QWidget *	parent,
		QString	name
	)	`[pure virtual]`

This method must implement the widget creation.

virtual QWidget* mudbox::WindowPlugin::Widget ( ) [pure virtual]

This method returns a pointer to the widget.

virtual QString mudbox::WindowPlugin::Name ( ) [virtual]

This method returns the name of the plugin.

virtual QString mudbox::WindowPlugin::Title ( ) [virtual]

This method returns the title of the plugin.