WindowPlugin Class Reference
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.
#include <plugin.h>
Inheritance diagram for WindowPlugin:
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.
|
|
| virtual bool | AddToWindowMenu () |
| This method returns true if the plugin is
added to the window menu. |
|
Protected Attributes |
|
| QString | m_name |
| QString | m_title |
| bool | m_addToWindowMenu |
Member Function Documentation
| virtual void Start | ( | ) | [pure virtual] |
This method is called when Mudbox is loaded.
| virtual void Stop | ( | ) | [pure virtual] |
This method is called when Mudbox quits.
| virtual bool IsEnabled | ( | ) | [pure virtual] |
This method returns whether the plugin is currently enabled or not.
This method must implement the widget creation.
| virtual QWidget* Widget | ( | ) | [pure virtual] |
This method returns a pointer to the widget.
| virtual QString Name | ( | ) | [virtual] |
This method returns the name of the plugin.
| virtual QString Title | ( | ) | [virtual] |
This method returns the title of the plugin.
| virtual bool AddToWindowMenu | ( | ) | [virtual] |
This method returns true if the plugin is added to the window menu.
Member Data Documentation
bool
m_addToWindowMenu [protected] |
The documentation for this class was generated from the following file:
- Mudbox/plugin.h
