Plasma
Namespaces | |
namespace | AnimationScriptEngine |
namespace | PaintUtils |
namespace | WindowEffects |
Classes | |
class | AbstractDialogManager |
The AbstractDialogManager class shows the dialogs shown by applets and the rest of the shell. More... | |
class | AbstractRunner |
An abstract base class for Plasma Runner plugins. More... | |
class | AbstractToolBox |
class | AccessAppletJob |
This class is used for asynchronously accessing an applet published on a remote system. More... | |
class | AccessManager |
Allows access to remote Plasma::Applet classes. More... | |
class | Animation |
Abstract representation of a single animation. More... | |
class | AnimationDriver |
class | Animator |
A system for applying effects to Plasma elements. More... | |
class | Applet |
The base Applet class. More... | |
class | AppletScript |
Provides a restricted interface for scripted applets. More... | |
class | AuthorizationInterface |
Allows authorization of access to plasma services. More... | |
class | AuthorizationManager |
Allows authorization of access to plasma services. More... | |
class | AuthorizationRule |
Defines a rule indicating whether or not a certain service can be accessed by a certain machine. More... | |
class | BusyWidget |
A widget that provides a waiting spinner. More... | |
class | CheckBox |
Provides a Plasma-themed checkbox. More... | |
class | ClientPinRequest |
describes an outgoing connection. More... | |
class | ComboBox |
Provides a Plasma-themed combo box. More... | |
class | ConfigLoader |
class | Containment |
The base class for plugins that provide backgrounds and applet grouping containers. More... | |
class | ContainmentActions |
The base ContainmentActions class. More... | |
class | ContainmentActionsPluginsConfig |
A class that holds a map of triggers to plugin names. More... | |
class | Context |
class | Corona |
A QGraphicsScene for Plasma::Applets. More... | |
class | Credentials |
This class encapsules someone's identity. More... | |
class | DataContainer |
A set of data exported via a DataEngine. More... | |
class | DataEngine |
Data provider for plasmoids (Plasma plugins) More... | |
class | DataEngineManager |
DataEngine loader and life time manager. More... | |
class | DataEngineScript |
Provides a restricted interface for scripting a DataEngine. More... | |
class | DeclarativeWidget |
A widget that contains an entire QML context, with its own declarative engine. More... | |
class | Delegate |
Item delegate for rendering items in Plasma menus implemented with item views. More... | |
class | Dialog |
A dialog that uses the Plasma style. More... | |
class | Extender |
Extends applets to allow detachable parts. More... | |
class | ExtenderGroup |
Allows for grouping of extender items. More... | |
class | ExtenderItem |
Provides detachable items for an Extender. More... | |
class | FlashingLabel |
Provides flashing text or icons inside Plasma. More... | |
class | Frame |
A widget that provides a simple frame. More... | |
class | FrameSvg |
Provides an SVG with borders. More... | |
class | GLApplet |
Plasma Applet that is fully rendered using OpengGL. More... | |
class | GroupBox |
Provides a plasma-themed QGroupBox. More... | |
class | IconWidget |
class | ItemBackground |
class | Label |
Provides a plasma-themed QLabel. More... | |
class | LineEdit |
Provides a plasma-themed KLineEdit. More... | |
class | Meter |
Provides generic meter widget for Plasma. More... | |
class | Package |
object representing an installed Plasmagik package More... | |
class | PackageMetadata |
Provides metadata for a Package. More... | |
class | PackageStructure |
A description of the expected file structure of a given package type. More... | |
struct | PlotColor |
class | PluginLoader |
This is an abstract base class which defines an interface to which Plasma's Applet Loading logic can communicate with a parent application. More... | |
class | PopupApplet |
Allows applets to automatically 'collapse' into an icon when put in an panel, and is a convenient base class for any applet that wishes to use extenders. More... | |
class | PushButton |
Provides a plasma-themed KPushButton. More... | |
class | QueryMatch |
A match returned by an AbstractRunner in response to a given RunnerContext. More... | |
class | RadioButton |
Provides a plasma-themed QRadioButton. More... | |
class | RunnerContext |
The RunnerContext class provides information related to a search, including the search term, metadata on the search term and collected matches. More... | |
class | RunnerManager |
The RunnerManager class decides what installed runners are runnable, and their ratings. More... | |
class | RunnerScript |
Provides a restricted interface for scripting a runner. More... | |
class | RunnerSyntax |
class | ScriptEngine |
The base class for scripting interfaces to be used in loading plasmoids of a given language. More... | |
class | ScrollBar |
Provides a plasma-themed QScrollBar. More... | |
class | ScrollWidget |
A container of widgets that can have scrollbars. More... | |
class | Separator |
class | Service |
This class provides a generic API for write access to settings or services. More... | |
class | ServiceAccessJob |
This class is used for asynchronously accessing a job published on a remote system. More... | |
class | ServiceJob |
This class provides jobs for use with Plasma::Service. More... | |
class | SignalPlotter |
Provides a signal plotter for plasma. More... | |
class | Slider |
Provides a plasma-themed QSlider. More... | |
class | SpinBox |
Provides a plasma-themed KIntSpinBox. More... | |
class | Svg |
A theme aware image-centric SVG class. More... | |
class | SvgWidget |
class | TabBar |
A tab bar widget, to be used for tabbed interfaces. More... | |
class | TextBrowser |
Provides a plasma-themed KTextBrowser. More... | |
class | TextEdit |
Provides a plasma-themed KTextEdit. More... | |
class | Theme |
Interface to the Plasma theme. More... | |
class | ToolButton |
Provides a plasma-themed QToolButton. More... | |
class | ToolTipContent |
class | ToolTipManager |
Manages tooltips for QGraphicsWidgets in Plasma. More... | |
class | TreeView |
Provides a plasma-themed QTreeView. More... | |
class | VideoWidget |
a Video playing widget via Phonon, it encloses the Phonon::MediaObject and Phonon::AudioOutput too More... | |
class | View |
A QGraphicsView for a single Containment. More... | |
class | Wallpaper |
The base Wallpaper class. More... | |
class | WallpaperScript |
Provides a restricted interface for scripting a Wallpaper. More... | |
class | WebView |
Provides a widget to display html content in Plasma. More... |
Functions | |
QList< QAction * > | actionsFromMenu (QMenu *menu, const QString &prefix=QString(), QObject *parent=0) |
bool | appletConfigLessThan (const KConfigGroup &c1, const KConfigGroup &c2) |
QScriptValue | constructEasingCurveClass (QScriptEngine *engine) |
bool | containmentSortByPosition (const Containment *c1, const Containment *c2) |
bool | copyFolder (QString sourcePath, QString targetPath) |
bool | correctLastComponentCase (const QString &path, QString &correctCasePath, const bool mustBeDir) |
bool | correctPathCase (const QString &path, QString &corrected) |
static QScriptValue | ctor (QScriptContext *ctx, QScriptEngine *eng) |
PackageStructure::Ptr | defaultPackageStructure (ComponentType type) |
KService::List | engineOffers (const QString &language, ComponentType type) |
static QPainterPath | headerPath (const QRectF &r, int roundness, int headerHeight=10) |
bool | isNonSceneEvent (QEvent *event) |
bool | isPluginVersionCompatible (unsigned int version) |
QStringList | knownLanguages (ComponentTypes types) |
ScriptEngine * | loadEngine (const QString &language, ComponentType type, QObject *parent) |
AppletScript * | loadScriptEngine (const QString &language, Applet *applet) |
DataEngineScript * | loadScriptEngine (const QString &language, DataEngine *dataEngine) |
RunnerScript * | loadScriptEngine (const QString &language, AbstractRunner *runner) |
WallpaperScript * | loadScriptEngine (const QString &language, Wallpaper *wallpaper) |
Direction | locationToDirection (Location location) |
Direction | locationToInverseDirection (Location location) |
QDataStream & | operator<< (QDataStream &, const Credentials &) |
QDataStream & | operator>> (QDataStream &in, Credentials &myObj) |
PackageStructure::Ptr | packageStructure (const QString &language, ComponentType type) |
bool | removeFolder (QString folderPath) |
qreal | scalingFactor (ZoomLevel level) |
QPointF | scenePosFromEvent (QEvent *event) |
QPoint | screenPosFromEvent (QEvent *event) |
static KPluginInfo::List | standardInternalInfo (const QString &type, const QString &category=QString()) |
static QScriptValue | toString (QScriptContext *ctx, QScriptEngine *eng) |
static QScriptValue | type (QScriptContext *ctx, QScriptEngine *eng) |
static QScriptValue | valueForProgress (QScriptContext *ctx, QScriptEngine *eng) |
unsigned int | version () |
unsigned int | versionMajor () |
unsigned int | versionMinor () |
unsigned int | versionRelease () |
const char * | versionString () |
QGraphicsView * | viewFor (const QGraphicsItem *item) |
Variables | |
static const int | DEFAULT_WALLPAPER_HEIGHT = 1200 |
static const int | DEFAULT_WALLPAPER_WIDTH = 1920 |
static const char | defaultWallpaper [] = "image" |
static const char | defaultWallpaperMode [] = "SingleImage" |
static const int | MAX_FRAME_SIZE = 100000 |
const int | MAXIMUM_TEXT_LENGTH = 5000 |
static const qreal | MIN_TICK_RATE = 10 |
static const int | MIN_TICK_RATE_INT = 10 |
static PluginLoader * | s_pluginLoader = 0 |
Detailed Description
Namespace for everything in libplasma.
This provides the content for a tooltip.
Normally you will want to set at least the mainText
and subText
.
Enumeration Type Documentation
Defines the aspect ratio used when scaling an applet.
- Enumerator:
enum Plasma::CacheType |
The ComonentType enumeration refers to the various types of components, or plugins, supported by plasma.
- Enumerator:
AppletComponent Plasma::Applet based plugins.
DataEngineComponent Plasma::DataEngine based plugins.
RunnerComponent Plasma::AbstractRunner based plugsin.
AnimatorComponent Plasma::Animator based plugins.
ContainmentComponent Plasma::Containment based plugins.
WallpaperComponent Plasma::Wallpaper based plugins.
GenericComponent
enum Plasma::Constraint |
The Constraint enumeration lists the various constraints that Plasma objects have managed for them and which they may wish to react to, for instance in Applet::constraintsUpdated.
- Enumerator:
NoConstraint No constraint; never passed in to Applet::constraintsEvent on its own.
FormFactorConstraint The FormFactor for an object.
LocationConstraint The Location of an object.
ScreenConstraint Which screen an object is on.
SizeConstraint the size of the applet was changed
ImmutableConstraint the immutability (locked) nature of the applet changed
StartupCompletedConstraint application startup has completed
ContextConstraint the context (e.g.
activity) has changed
PopupConstraint the position of the popup needs to be recalculated
AllConstraints
enum Plasma::Direction |
The Direction enumeration describes in which direction, relative to the Applet (and its managing container), popup menus, expanders, balloons, message boxes, arrows and other such visually associated widgets should appear in.
This is usually the oposite of the Location.
enum Plasma::FormFactor |
The FormFactor enumeration describes how a Plasma::Applet should arrange itself.
The value is derived from the container managing the Applet (e.g. in Plasma, a Corona on the desktop or on a panel).
- Enumerator:
Planar The applet lives in a plane and has two degrees of freedom to grow.
Optimize for desktop, laptop or tablet usage: a high resolution screen 1-3 feet distant from the viewer.
MediaCenter As with Planar, the applet lives in a plane but the interface should be optimized for medium-to-high resolution screens that are 5-15 feet distant from the viewer.
Sometimes referred to as a "ten foot interface".
Horizontal The applet is constrained vertically, but can expand horizontally.
Vertical The applet is constrained horizontally, but can expand vertically.
Application The Applet lives in a plane and should be optimized to look as a full application, for the desktop or the particular device.
Defines the immutability of items like applets, corona and containments they can be free to modify, locked down by the user or locked down by the system (e.g.
kiosk setups).
enum Plasma::ItemStatus |
enum Plasma::ItemTypes |
enum Plasma::Location |
The Location enumeration describes where on screen an element, such as an Applet or its managing container, is positioned on the screen.
- Enumerator:
enum Plasma::MarginEdge |
The popup position enumeration relatively to his attached widget.
- Enumerator:
enum Plasma::Position |
enum Plasma::styles |
enum Plasma::TrustLevel |
enum Plasma::ZoomLevel |
Zoom levels that Plasma is aware of...
Function Documentation
QList< QAction * > Plasma::actionsFromMenu | ( | QMenu * | menu, |
const QString & | prefix = QString() , |
||
QObject * | parent = 0 |
||
) |
Returns a list of all actions in the given QMenu This method flattens the hierarchy of the menu by prefixing the text of all actions in a submenu with the submenu title.
- Parameters:
-
menu the QMenu storing the actions prefix text to display before the text of all actions in the menu parent QObject to be passed as parent of all the actions in the list
- Since:
- 4.4
Definition at line 112 of file plasma.cpp.
bool Plasma::appletConfigLessThan | ( | const KConfigGroup & | c1, |
const KConfigGroup & | c2 | ||
) |
Definition at line 277 of file containment.cpp.
QScriptValue Plasma::constructEasingCurveClass | ( | QScriptEngine * | engine | ) |
Definition at line 97 of file easingcurve.cpp.
bool Plasma::containmentSortByPosition | ( | const Containment * | c1, |
const Containment * | c2 | ||
) |
Definition at line 198 of file corona.cpp.
bool Plasma::copyFolder | ( | QString | sourcePath, |
QString | targetPath | ||
) |
Definition at line 58 of file package.cpp.
bool Plasma::correctLastComponentCase | ( | const QString & | path, |
QString & | correctCasePath, | ||
const bool | mustBeDir | ||
) |
Definition at line 61 of file runnercontext.cpp.
bool Plasma::correctPathCase | ( | const QString & | path, |
QString & | corrected | ||
) |
Definition at line 110 of file runnercontext.cpp.
|
static |
Definition at line 42 of file easingcurve.cpp.
PackageStructure::Ptr Plasma::defaultPackageStructure | ( | ComponentType | type | ) |
Definition at line 254 of file scriptengine.cpp.
KService::List Plasma::engineOffers | ( | const QString & | language, |
ComponentType | type | ||
) |
Definition at line 122 of file scriptengine.cpp.
|
inlinestatic |
Definition at line 118 of file glapplet.cpp.
bool Plasma::isNonSceneEvent | ( | QEvent * | event | ) |
Definition at line 343 of file containmentactions.cpp.
bool Plasma::isPluginVersionCompatible | ( | unsigned int | version | ) |
Verifies that a plugin is compatible with plasma.
Definition at line 51 of file version.cpp.
QStringList Plasma::knownLanguages | ( | ComponentTypes | types | ) |
- Parameters:
-
types a set of ComponentTypes flags for which to look up the language support for
- Returns:
- a list of all supported languages for the given type(s).
Definition at line 67 of file scriptengine.cpp.
ScriptEngine* Plasma::loadEngine | ( | const QString & | language, |
ComponentType | type, | ||
QObject * | parent | ||
) |
Definition at line 165 of file scriptengine.cpp.
AppletScript * Plasma::loadScriptEngine | ( | const QString & | language, |
Applet * | applet | ||
) |
Loads an Applet script engine for the given language.
- Parameters:
-
language the language to load for applet the Plasma::Applet for this script
- Returns:
- pointer to the AppletScript or 0 on failure; the caller is responsible for the return object which will be parented to the Applet
Definition at line 206 of file scriptengine.cpp.
DataEngineScript * Plasma::loadScriptEngine | ( | const QString & | language, |
DataEngine * | dataEngine | ||
) |
Loads an DataEngine script engine for the given language.
- Parameters:
-
language the language to load for dataEngine the Plasma::DataEngine for this script;
- Returns:
- pointer to the DataEngineScript or 0 on failure; the caller is responsible for the return object which will be parented to the DataEngine
Definition at line 218 of file scriptengine.cpp.
RunnerScript * Plasma::loadScriptEngine | ( | const QString & | language, |
AbstractRunner * | runner | ||
) |
Loads an Applet script engine for the given language.
- Parameters:
-
language the language to load for runner the Plasma::AbstractRunner for this script
- Returns:
- pointer to the RunnerScript or 0 on failure; the caller is responsible for the return object which will be parented to the AbstractRunner
Definition at line 230 of file scriptengine.cpp.
WallpaperScript * Plasma::loadScriptEngine | ( | const QString & | language, |
Wallpaper * | wallpaper | ||
) |
Loads an Wallpaper script engine for the given language.
- Parameters:
-
language the language to load for runner the Plasma::Wallpaper for this script
- Returns:
- pointer to the RunnerScript or 0 on failure; the caller is responsible for the return object which will be parented to the Wallpaper
Definition at line 242 of file scriptengine.cpp.
Direction Plasma::locationToDirection | ( | Location | location | ) |
Converts a location to a direction.
Handy for figuring out which way to send a popup based on location or to point arrows and other directional items.
- Parameters:
-
location the location of the container the element will appear in
- Returns:
- the visual direction the element should be oriented in
Definition at line 51 of file plasma.cpp.
Direction Plasma::locationToInverseDirection | ( | Location | location | ) |
Converts a location to the direction facing it.
Handy for figuring out which way to collapse a popup or to point arrows at the item itself.
- Parameters:
-
location the location of the container the element will appear in
- Returns:
- the visual direction the element should be oriented in
Definition at line 72 of file plasma.cpp.
QDataStream & Plasma::operator<< | ( | QDataStream & | out, |
const Credentials & | myObj | ||
) |
Streaming operators for sending/storing identities.
Definition at line 238 of file credentials.cpp.
QDataStream & Plasma::operator>> | ( | QDataStream & | in, |
Credentials & | myObj | ||
) |
Definition at line 262 of file credentials.cpp.
PackageStructure::Ptr Plasma::packageStructure | ( | const QString & | language, |
ComponentType | type | ||
) |
Loads an appropriate PackageStructure for the given language and type.
- Parameters:
-
language the language to load the PackageStructure for type the component type
- Returns:
- a guarded PackageStructure pointer
Definition at line 274 of file scriptengine.cpp.
bool Plasma::removeFolder | ( | QString | folderPath | ) |
Definition at line 93 of file package.cpp.
qreal Plasma::scalingFactor | ( | ZoomLevel | level | ) |
- Returns:
- the scaling factor (0..1) for a ZoomLevel
Definition at line 33 of file plasma.cpp.
QPointF Plasma::scenePosFromEvent | ( | QEvent * | event | ) |
Definition at line 322 of file containmentactions.cpp.
QPoint Plasma::screenPosFromEvent | ( | QEvent * | event | ) |
Definition at line 301 of file containmentactions.cpp.
|
static |
Definition at line 368 of file pluginloader.cpp.
|
static |
Definition at line 57 of file easingcurve.cpp.
|
static |
Definition at line 63 of file easingcurve.cpp.
|
static |
Definition at line 87 of file easingcurve.cpp.
unsigned int Plasma::version | ( | ) |
The runtime version of libplasma.
Definition at line 26 of file version.cpp.
unsigned int Plasma::versionMajor | ( | ) |
The runtime major version of libplasma.
Definition at line 31 of file version.cpp.
unsigned int Plasma::versionMinor | ( | ) |
The runtime major version of libplasma.
Definition at line 36 of file version.cpp.
unsigned int Plasma::versionRelease | ( | ) |
The runtime major version of libplasma.
Definition at line 41 of file version.cpp.
const char * Plasma::versionString | ( | ) |
The runtime version string of libplasma.
Definition at line 46 of file version.cpp.
QGraphicsView * Plasma::viewFor | ( | const QGraphicsItem * | item | ) |
Returns the most appropriate QGraphicsView for the item.
- Parameters:
-
item the QGraphicsItem to locate a view for
- Returns:
- pointer to a view, or 0 if none was found
Definition at line 93 of file plasma.cpp.
Variable Documentation
|
static |
Definition at line 83 of file containment.cpp.
|
static |
Definition at line 84 of file containment.cpp.
|
static |
Definition at line 47 of file framesvg.cpp.
const int Plasma::MAXIMUM_TEXT_LENGTH = 5000 |
Definition at line 47 of file tooltipcontent.cpp.
|
static |
Definition at line 42 of file deprecated/animator.cpp.
|
static |
Definition at line 41 of file deprecated/animator.cpp.
|
static |
Definition at line 41 of file pluginloader.cpp.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Tue Jul 16 2013 17:48:42 by doxygen 1.8.1.1 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.