WebBrowserPlugin Class Reference

#include <plugin.h>

Class Description

WebBrowserPlugin is a base class to implement the web browser based plugins.

The WebBrowserPlugin class is a base class that provides basic web browser functionalities.

Definition at line 93 of file plugin.h.

Inheritance diagram for WebBrowserPlugin:

Public Types
enum	NavigationPoints {   eNavNone = 0, eNavMudLife, eNavTutorials, eNavMeshUpload,   eNavStampUpload, eNavStencilUpload }
	This enum contains all the navigation points. More...
enum	FileType { eFileTypeStamps, eFileTypeStencils, eFileTypeMeshes }
	This enum contains all file types. More...

Public Member Functions
	WebBrowserPlugin (const QString name, const QString title)
virtual void	Navigate (const NavigationPoints nav)=0
	This methods allows navigation. This is usually used by the host application. More...
virtual void	Upload (const QStringList &files, const FileType fileType)=0
	This methods allows files upload. More...
virtual void	GetFileList (const FileType fileType, QFileInfoList &fileList, QString filter="")=0
	This methods displays a loading message. More...
Public Member Functions inherited from WindowPlugin
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

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)
Protected Attributes inherited from WindowPlugin
QString	m_name
QString	m_title
bool	m_addToWindowMenu
Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr
Static Protected Attributes inherited from QObject
static const QMetaObject	staticQtMetaObject
Properties inherited from QObject
QString	objectName

Member Enumeration Documentation

enum NavigationPoints

This enum contains all the navigation points.

Enumerator
eNavNone
eNavMudLife
eNavTutorials
eNavMeshUpload
eNavStampUpload
eNavStencilUpload

Definition at line 99 of file plugin.h.

    {
        eNavNone = 0,
        eNavMudLife,
        eNavTutorials,
        eNavMeshUpload,
        eNavStampUpload,
        eNavStencilUpload,
    } NavigationPoints;

enum FileType

This enum contains all file types.

Enumerator
eFileTypeStamps
eFileTypeStencils
eFileTypeMeshes

Definition at line 110 of file plugin.h.

    {
        eFileTypeStamps,
        eFileTypeStencils,
        eFileTypeMeshes,
    } FileType; 

Constructor & Destructor Documentation

WebBrowserPlugin	(	const QString	name,
		const QString	title
	)

Member Function Documentation

virtual void Navigate ( const NavigationPoints  nav )

pure virtual

This methods allows navigation. This is usually used by the host application.

virtual void Upload ( const QStringList &  files, const FileType  fileType  )

pure virtual

This methods allows files upload.

virtual void GetFileList ( const FileType  fileType, QFileInfoList &  fileList, QString  filter = ""  )

pure virtual

This methods displays a loading message.

---

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

• Mudbox/plugin.h