Cantor::PanelPlugin Class Reference

#include <panelplugin.h>

Inheritance diagram for Cantor::PanelPlugin:

Signals
void	requestRunCommand (const QString &cmd)
void	visibilityRequested ()

Public Member Functions
	PanelPlugin (QObject *parent)
	~PanelPlugin () override
QString	name ()
QWidget *	parentWidget ()
virtual Backend::Capabilities	requiredCapabilities ()
QStringList	requiredExtensions ()
Session *	session ()
void	setParentWidget (QWidget *widget)
void	setPluginInfo (const KPluginMetaData &)
void	setSession (Session *session)
virtual bool	showOnStartup ()
virtual QWidget *	widget ()=0
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Protected Member Functions
virtual void	onSessionChanged ()
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

A plugin provides some additional features for the worksheet.

Definition at line 39 of file panelplugin.h.

Constructor & Destructor Documentation

PanelPlugin::PanelPlugin

(

QObject *

parent

)

Create a new PanelPlugin.

Parameters

parent

the parent Object

See also

QObject

Definition at line 35 of file panelplugin.cpp.

PanelPlugin::~PanelPlugin ( )

override

Destructor.

Definition at line 42 of file panelplugin.cpp.

Member Function Documentation

QString PanelPlugin::name

(

)

Returns the name of the plugin.

Returns

name of the plugin

Definition at line 73 of file panelplugin.cpp.

void PanelPlugin::onSessionChanged ( )

protectedvirtual

Definition at line 89 of file panelplugin.cpp.

QWidget * PanelPlugin::parentWidget

(

)

Definition at line 52 of file panelplugin.cpp.

void Cantor::PanelPlugin::requestRunCommand ( const QString &  cmd )

signal

Backend::Capabilities PanelPlugin::requiredCapabilities ( )

virtual

Returns the capabilities, the current backend must provide to make this PanelPlugin work.

If it doesn't this PanelPlugin won't be enabled

Returns

the required capabilities

Definition at line 68 of file panelplugin.cpp.

QStringList PanelPlugin::requiredExtensions

(

)

Returns a list of all extensions, the current backend must provide to make this PanelPlugin work.

If it doesn't this PanelPlugin won't be enabled

Returns

list of required extensions

Definition at line 63 of file panelplugin.cpp.

Session * PanelPlugin::session

(

)

returns the session

Definition at line 78 of file panelplugin.cpp.

void PanelPlugin::setParentWidget

(

QWidget *

widget

)

Definition at line 47 of file panelplugin.cpp.

void PanelPlugin::setPluginInfo

(

const KPluginMetaData &

info

)

Sets the properties of this PanelPlugin according to KPluginMetaData.

Parameters

info	KPluginMetaData

Definition at line 57 of file panelplugin.cpp.

void PanelPlugin::setSession

(

Session *

session

)

sets the session this plugin operates on

Definition at line 83 of file panelplugin.cpp.

bool Cantor::PanelPlugin::showOnStartup ( )

virtual

Show on worksheet startup or not Default returns true.

Definition at line 94 of file panelplugin.cpp.

void Cantor::PanelPlugin::visibilityRequested ( )

signal

virtual QWidget* Cantor::PanelPlugin::widget ( )

pure virtual

returns the widget, provided by this plugin

Returns

the widget, provided by this plugin

---

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

• panelplugin.h
• panelplugin.cpp