Cantor::Assistant Class Reference

#include <assistant.h>

Inheritance diagram for Cantor::Assistant:

Signals
void	requested ()

Public Member Functions
	Assistant (QObject *parent)
	~Assistant ()
Backend *	backend ()
QString	icon ()
virtual void	initActions ()=0
QString	name ()
QStringList	requiredExtensions ()
virtual QStringList	run (QWidget *parent)=0
void	setBackend (Backend *backend)
void	setPluginInfo (KPluginInfo info)
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

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)
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)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

An Assistant is a dialog for simplifying common tasks, like integrating, solving, or running scripts To perform their task, they rely on one or more Extensions, to translate to the backends specific syntax.

See also

Extension

Definition at line 40 of file assistant.h.

Constructor & Destructor Documentation

Assistant::Assistant

(

QObject *

parent

)

Create a new assistant.

Parameters

parent

the parent Object

See also

QObject

Definition at line 33 of file assistant.cpp.

Assistant::~Assistant

(

)

Destructor.

Definition at line 39 of file assistant.cpp.

Member Function Documentation

Backend * Assistant::backend

(

)

Returns the backend, this assistant operates on.

Returns

backend, this assistant operates on

Definition at line 72 of file assistant.cpp.

QString Assistant::icon

(

)

Returns the icon, this Assistant is using.

Returns

icon, this Assistant is using

Definition at line 62 of file assistant.cpp.

virtual void Cantor::Assistant::initActions ( )

pure virtual

initialize the needed KActions/integrate into the menu bars

QString Assistant::name

(

)

Returns the name of the assistant.

Returns

name of the assistant

Definition at line 67 of file assistant.cpp.

void Cantor::Assistant::requested ( )

signal

signal emitted, if the user has requested this Assistant to run e.g.

by clicking on its action in the menu

QStringList Assistant::requiredExtensions

(

)

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

If it doesn't this Assistant won't be shown in the Menu

Returns

list of required extensions

Definition at line 57 of file assistant.cpp.

virtual QStringList Cantor::Assistant::run ( QWidget *  parent )

pure virtual

shows the assistants dialog or gui it offers, and returns a list of commands to be run, to achieve the desired effect

Parameters

parent

the parent widget, each created Widget should use

void Assistant::setBackend

(

Cantor::Backend *

backend

)

Sets the backend, this Assistant operates on.

Parameters

backend

the new backend

Definition at line 44 of file assistant.cpp.

void Assistant::setPluginInfo

(

KPluginInfo

info

)

Sets the properties of this Assistant accodring to KPluginInfo.

Parameters

info	KPluginInfo

Definition at line 49 of file assistant.cpp.

---

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

• assistant.h
• assistant.cpp