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)

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