#include <plugin.h>

Class 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.

Definition at line 56 of file plugin.h.

Inheritance diagram for WindowPlugin:

Public Member Functions
virtual void	Start ()=0
	This method is called when Mudbox is loaded. More...

virtual void	Stop ()=0
	This method is called when Mudbox quits. More...

virtual bool	IsEnabled ()=0
	This method returns whether the plugin is currently enabled or not. More...

virtual QWidget *	CreateWidget (QWidget *parent, QString name)=0
	This method must implement the widget creation. More...

virtual QWidget *	Widget ()=0
	This method returns a pointer to the widget. More...

virtual QString	Name ()
	This method returns the name of the plugin. More...

virtual QString	Title ()
	This method returns the title of the plugin. More...

virtual bool	AddToWindowMenu ()
	This method returns true if the plugin is added to the window menu. More...

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=0)

virtual	~QObject ()

virtual bool	event (QEvent *)

virtual bool	eventFilter (QObject , QEvent )

QString	objectName () const

void	setObjectName (const QString &name)

bool	isWidgetType () const

bool	signalsBlocked () const

bool	blockSignals (bool b)

QThread *	thread () const

void	moveToThread (QThread *thread)

int	startTimer (int interval)

void	killTimer (int id)

template<typename T >
T	findChild (const QString &aName=QString()) const

template<typename T >
QList< T >	findChildren (const QString &aName=QString()) const

template<typename T >
QList< T >	findChildren (const QRegExp &re) const

const QObjectList &	children () const

void	setParent (QObject *)

void	installEventFilter (QObject *)

void	removeEventFilter (QObject *)

bool	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=0, const QObject receiver=0, const char *member=0)

bool	disconnect (const QObject receiver, const char member=0)

void	dumpObjectTree ()

void	dumpObjectInfo ()

bool	setProperty (const char *name, const QVariant &value)

QVariant	property (const char *name) const

QList< QByteArray >	dynamicPropertyNames () const

void	setUserData (uint id, QObjectUserData *data)

QObjectUserData *	userData (uint id) const

QObject *	parent () const

bool	inherits (const char *classname) const

Protected Attributes
QString	m_name

QString	m_title

bool	m_addToWindowMenu

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()

Signals inherited from QObject
void	destroyed (QObject *=0)

Static Public Member Functions inherited from QObject
static bool	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)

static bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static uint	registerUserData ()

Protected Member Functions inherited from QObject
QObject *	sender () const

int	senderSignalIndex () const

int	receivers (const char *signal) const

virtual void	timerEvent (QTimerEvent *)

virtual void	childEvent (QChildEvent *)

virtual void	customEvent (QEvent *)

virtual void	connectNotify (const char *signal)

virtual void	disconnectNotify (const char *signal)

	QObject (QObjectPrivate &dd, QObject *parent=0)

Static Protected Attributes inherited from QObject
static const QMetaObject	staticQtMetaObject

Properties inherited from QObject
QString	objectName

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.

virtual QWidget* CreateWidget	(	QWidget *	parent,
		QString	name
	)

pure virtual

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

QString m_name

protected

Definition at line 84 of file plugin.h.

QString m_title

protected

Definition at line 85 of file plugin.h.

bool m_addToWindowMenu

protected

Definition at line 86 of file plugin.h.

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

Mudbox/plugin.h

WindowPlugin Class Reference

Class Description

Public Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

Member Data Documentation