Plasma::AbstractToolBox Class Reference

#include <abstracttoolbox.h>

Inheritance diagram for Plasma::AbstractToolBox:

List of all members.

Public Types
enum	ToolType {   AddTool = 0, ConfigureTool = 100, ControlTool = 200, MiscTool = 300,   DestructiveTool = 400, UserToolType = DestructiveTool + 1000 }
Public Slots
void	reposition ()
void	restore (const KConfigGroup &group)
void	save (const KConfigGroup &group)
Signals
void	toggled ()
void	visibilityChanged (bool open)
Public Member Functions
	AbstractToolBox (Containment *parent)
	AbstractToolBox (QObject *parent=0, const QVariantList &args=QVariantList())
	~AbstractToolBox ()
virtual void	addTool (QAction *action)=0
virtual bool	isShowing () const =0
virtual void	removeTool (QAction *action)=0
virtual void	setShowing (const bool show)=0
Static Public Member Functions
static KPluginInfo::List	listToolBoxInfo (const QString &parentApp=QString())
static AbstractToolBox *	load (const QString &name, const QVariantList &args=QVariantList(), Plasma::Containment *containment=0)
Protected Member Functions
Containment *	containment () const
Properties
bool	showing

---

Detailed Description

Definition at line 40 of file abstracttoolbox.h.

---

Member Enumeration Documentation

enum Plasma::AbstractToolBox::ToolType

Enumerator:

AddTool
ConfigureTool
ControlTool
MiscTool
DestructiveTool
UserToolType

Definition at line 47 of file abstracttoolbox.h.

---

Constructor & Destructor Documentation

Plasma::AbstractToolBox::AbstractToolBox

(

Containment *

parent

)

[explicit]

Definition at line 41 of file abstracttoolbox.cpp.

Plasma::AbstractToolBox::AbstractToolBox	(	QObject *	parent = 0,
		const QVariantList &	args = QVariantList()
	)		[explicit]

Definition at line 47 of file abstracttoolbox.cpp.

Plasma::AbstractToolBox::~AbstractToolBox

(

)

Definition at line 56 of file abstracttoolbox.cpp.

---

Member Function Documentation

virtual void Plasma::AbstractToolBox::addTool

(

QAction *

action

)

[pure virtual]

create a toolbox tool from the given action action the action to associate the tool with

Containment * Plasma::AbstractToolBox::containment

(

)

const [protected]

Definition at line 101 of file abstracttoolbox.cpp.

virtual bool Plasma::AbstractToolBox::isShowing

(

)

const [pure virtual]

Returns:

true if the ToolBox is open and shown the actions list

KPluginInfo::List Plasma::AbstractToolBox::listToolBoxInfo

(

const QString &

parentApp = QString()

)

[static]

Returns a list of all installed ToolBox plugins.

Parameters:

parentApp

the application to filter applets on. Uses the X-KDE-ParentApp entry (if any) in the plugin info. The default value of QString() will result in a list containing only applets not specifically registered to an application.

Since:

4.6

Definition at line 81 of file abstracttoolbox.cpp.

AbstractToolBox * Plasma::AbstractToolBox::load	(	const QString &	name,
		const QVariantList &	args = QVariantList(),
		Plasma::Containment *	containment = 0
	)		[static]

Create a new AbstractToolBox, loading the proper plugin.

Parameters:

name	the plugin name
args	the plugin arguments
containment	the containment parent of the toolbox

Since:

4.6

Definition at line 61 of file abstracttoolbox.cpp.

virtual void Plasma::AbstractToolBox::removeTool

(

QAction *

action

)

[pure virtual]

remove the tool associated with this action

void Plasma::AbstractToolBox::reposition

(

)

[slot]

Inform the ToolBox it has to reposition itlself It has to be reimplemented in toolboxes that need it.

Since:

4.6

Definition at line 116 of file abstracttoolbox.cpp.

void Plasma::AbstractToolBox::restore

(

const KConfigGroup &

group

)

[slot]

Restore the ToolBox settings It has to be reimplemented in toolboxes that need it.

Since:

4.6

Definition at line 106 of file abstracttoolbox.cpp.

void Plasma::AbstractToolBox::save

(

const KConfigGroup &

group

)

[slot]

Save the ToolBox settings It has to be reimplemented in toolboxes that need it.

Since:

4.6

Definition at line 111 of file abstracttoolbox.cpp.

virtual void Plasma::AbstractToolBox::setShowing

(

const bool

show

)

[pure virtual]

Opens or closes the ToolBox.

void Plasma::AbstractToolBox::toggled

(

)

[signal]

Toolbox opened or closed.

void Plasma::AbstractToolBox::visibilityChanged

(

bool

open

)

[signal]

Toolbox opened or closed.

Parameters:

open	tells if the toolbox opened or closed

---

Property Documentation

bool Plasma::AbstractToolBox::showing [read, write]

Definition at line 44 of file abstracttoolbox.h.

---

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

• abstracttoolbox.h
• abstracttoolbox.cpp