• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

Plasma

  • Plasma
  • AbstractToolBox
Public Types | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | Properties | List of all members
Plasma::AbstractToolBox Class Referenceabstract

#include <abstracttoolbox.h>

Inheritance diagram for Plasma::AbstractToolBox:
QGraphicsWidget

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

◆ ToolType

enum Plasma::AbstractToolBox::ToolType
Enumerator
AddTool 
ConfigureTool 
ControlTool 
MiscTool 
DestructiveTool 
UserToolType 

Definition at line 47 of file abstracttoolbox.h.

Constructor & Destructor Documentation

◆ AbstractToolBox() [1/2]

Plasma::AbstractToolBox::AbstractToolBox ( Containment *  parent)
explicit

Definition at line 39 of file abstracttoolbox.cpp.

◆ AbstractToolBox() [2/2]

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

Definition at line 45 of file abstracttoolbox.cpp.

◆ ~AbstractToolBox()

Plasma::AbstractToolBox::~AbstractToolBox ( )

Definition at line 54 of file abstracttoolbox.cpp.

Member Function Documentation

◆ addTool()

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()

Containment * Plasma::AbstractToolBox::containment ( ) const
protected

Definition at line 96 of file abstracttoolbox.cpp.

◆ isShowing()

virtual bool Plasma::AbstractToolBox::isShowing ( ) const
pure virtual
Returns
true if the ToolBox is open and shown the actions list

◆ listToolBoxInfo()

KPluginInfo::List Plasma::AbstractToolBox::listToolBoxInfo ( const QString &  parentApp = QString())
static

Returns a list of all installed ToolBox plugins.

Parameters
parentAppthe 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 76 of file abstracttoolbox.cpp.

◆ load()

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
namethe plugin name
argsthe plugin arguments
containmentthe containment parent of the toolbox
Since
4.6

Definition at line 59 of file abstracttoolbox.cpp.

◆ removeTool()

virtual void Plasma::AbstractToolBox::removeTool ( QAction *  action)
pure virtual

remove the tool associated with this action

◆ reposition

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 111 of file abstracttoolbox.cpp.

◆ restore

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 101 of file abstracttoolbox.cpp.

◆ save

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 106 of file abstracttoolbox.cpp.

◆ setShowing()

virtual void Plasma::AbstractToolBox::setShowing ( const bool  show)
pure virtual

Opens or closes the ToolBox.

◆ toggled

void Plasma::AbstractToolBox::toggled ( )
signal

Toolbox opened or closed.

◆ visibilityChanged

void Plasma::AbstractToolBox::visibilityChanged ( bool  open)
signal

Toolbox opened or closed.

Parameters
opentells if the toolbox opened or closed

Property Documentation

◆ showing

bool Plasma::AbstractToolBox::showing
readwrite

Definition at line 1 of file abstracttoolbox.h.


The documentation for this class was generated from the following files:
  • abstracttoolbox.h
  • abstracttoolbox.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Plasma

Skip menu "Plasma"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal