• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • API Reference
  • Sitemap
  • Contact Us
 

libplasma

Plasma Namespace Reference


Detailed Description

A KConfigSkeleton that populates itself based on KConfigXT XML.

This class provides a generic Icon for the Plasma desktop.

Namespace for everything in libplasma.

This class allows one to ship an XML file and reconstitute it into a KConfigSkeleton object at runtime. Common usage might look like this:

 QFile file(xmlFilePath);
 Plasma::ConfigXml appletConfig(configFilePath, &file);

Alternatively, any QIODevice may be used in place of QFile in the example above.

Currently the following data types are supported:

  • bools
  • colors
  • datetimes
  • enumerations
  • fonts
  • ints
  • passwords
  • paths
  • strings
  • stringlists
  • uints
  • urls
  • doubles
  • int lists
  • longlongs
  • path lists
  • points
  • rects
  • sizes
  • ulonglongs
  • url lists
An icon, in this sense, is not restricted to just an image, but can also contain text. Currently, the Icon class is primarily used for desktop items, but is designed to be used anywhere an icon is needed in an applet.

Author:
Siraj Razick <siraj@kde.org>

Matt Broadstone <mbroadst@gmail.com>


Classes

class  AbstractRunner
 An abstract base class for Plasma Runner plugins. More...
class  AnimationDriver
class  Animator
 A system for applying effects to Plasma elements. More...
class  Applet
 The base Applet class. More...
class  AppletBrowser
class  AppletBrowserWidget
class  AppletScript
class  BorderLayout
 A layout which lays one item per border (left, top, bottom, right) and one item in center. More...
class  CheckBox
class  ComboBox
class  ConfigXml
class  Containment
 The base class for plugins that provide backgrounds and applet grouping containers. More...
class  Corona
 A QGraphicsScene for Plasma::Applets. 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
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  Flash
 Class that allows to flash text or icons inside plasma. More...
class  GLApplet
 Plasma Applet that is fully rendered using OpengGL. More...
class  GroupBox
class  Icon
class  Label
class  LineEdit
class  Meter
 This class provides generic meter widget for the Plasma desktop. More...
class  Package
class  PackageMetadata
class  PackageStructure
 A description of the expected file structure of a given package type. More...
class  PanelSvg
struct  PlotColor
class  PushButton
class  QueryMatch
 A match returned by an AbstractRunner in response to a given RunnerContext. More...
class  RadioButton
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
class  ScriptEngine
 The base class for scripting interfaces to be used in loading plasmoids of a given language. More...
class  Service
 This class provides a generic API for write access to settings or services. More...
class  ServiceJob
 This class provides jobs for use with Plasma::Service. More...
class  SignalPlotter
class  Svg
 A theme aware image-centric SVG class. More...
class  TextEdit
class  Theme
 Interface to the Plasma theme. More...
struct  ToolTipData
class  UiLoader
 Dynamically create plasma Widgets and Layouts. More...
class  View
 A QGraphicsView for Plasma::Applets. More...
class  WebContent
class  Widget
 Base class for all Widgets in Plasma. More...

Namespaces

namespace  PaintUtils

Enumerations

enum  AspectRatioMode { IgnoreAspectRatio = 0, KeepAspectRatio = 1, Square = 2, ConstrainedSquare = 3 }
enum  ComponentType {
  AppletComponent = 1, DataEngineComponent = 2, RunnerComponent = 4, AnimatorComponent = 8,
  ContainmentComponent = 16
}
enum  Constraint {
  NoConstraint = 0, FormFactorConstraint = 1, LocationConstraint = 2, ScreenConstraint = 4,
  SizeConstraint = 8, ImmutableConstraint = 16, StartupCompletedConstraint = 32, AllConstraints = FormFactorConstraint | LocationConstraint | ScreenConstraint | SizeConstraint | ImmutableConstraint
}
enum  Direction { Down = 0, Up, Left, Right }
enum  FlipDirection { NoFlip = 0, HorizontalFlip = 1, VerticalFlip = 2 }
enum  FormFactor { Planar = 0, MediaCenter, Horizontal, Vertical }
enum  ImmutabilityType { Mutable = 1, UserImmutable = 2, SystemImmutable = 4 }
enum  IntervalAlignment { NoAlignment = 0, AlignToMinute, AlignToHour }
enum  ItemTypes { AppletType = QGraphicsItem::UserType + 1, LineEditType = QGraphicsItem::UserType + 2 }
enum  Location {
  Floating = 0, Desktop, FullScreen, TopEdge,
  BottomEdge, LeftEdge, RightEdge
}
enum  MarginEdge { TopMargin = 0, BottomMargin, LeftMargin, RightMargin }
enum  Position {
  LeftPositioned, RightPositioned, TopPositioned, BottomPositioned,
  CenterPositioned
}
enum  ZoomDirection { ZoomIn = 0, ZoomOut = 1 }
enum  ZoomLevel { DesktopZoom = 0, GroupZoom, OverviewZoom }

Functions

qreal _k_angleForPoints (const QPointF &center, const QPointF &pt1, const QPointF &pt2)
qreal _k_distanceForPoint (QPointF point)
bool appletConfigLessThan (const KConfigGroup &c1, const KConfigGroup &c2)
< Name >::< Name > QGraphicsWidget d (new< Name >Private)
PackageStructure::Ptr defaultPackageStructure (ComponentType type)
KService::List engineOffers (const QString &language, ComponentType type)
QPainterPath handleRect (const QRectF &rect, int radius, bool onRight)
static QPainterPath headerPath (const QRectF &r, int roundness, int headerHeight=10)
bool isPluginVersionCompatible (unsigned int version)
QStringList knownLanguages (ComponentTypes types)
ScriptEngine * loadEngine (const QString &language, ComponentType type, QObject *parent)
RunnerScript * loadScriptEngine (const QString &language, AbstractRunner *runner)
DataEngineScript * loadScriptEngine (const QString &language, DataEngine *dataEngine)
AppletScript * loadScriptEngine (const QString &language, Applet *applet)
Direction locationToDirection (Location location)
PackageStructure::Ptr packageStructure (const QString &language, ComponentType type)
qreal scalingFactor (ZoomLevel level)
unsigned int version ()
unsigned int versionMajor ()
unsigned int versionMinor ()
unsigned int versionRelease ()
const char * versionString ()

Variables

const int CONFIG_SYNC_TIMEOUT = 30000
static const int DEFAULT_WALLPAPER_HEIGHT = 1200
static const int DEFAULT_WALLPAPER_WIDTH = 1920
static const qreal MIN_TICK_RATE = 40
static const int MIN_TICK_RATE_INT = 40
< Name >::< Name >
QGraphicsWidget * 
parent
static const int ToolName = 7001

Enumeration Type Documentation

enum Plasma::AspectRatioMode

Defines the aspect ratio used when scaling an applet.

Enumerator:
IgnoreAspectRatio  The applet can be freely resized.
KeepAspectRatio  The applet keeps a fixed aspect ratio.
Square  The applet is always a square.
ConstrainedSquare 

Definition at line 158 of file plasma.h.

enum Plasma::ComponentType

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.

Definition at line 168 of file plasma.h.

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 
FormFactorConstraint 
LocationConstraint 
ScreenConstraint 
SizeConstraint 
ImmutableConstraint 
StartupCompletedConstraint 
AllConstraints 

Definition at line 39 of file plasma.h.

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.

Enumerator:
Down  Display downards.
Up  Display upwards.
Left  Display to the left.
Right  Display to the right.

Definition at line 77 of file plasma.h.

enum Plasma::FlipDirection

Flip enumeration.

Enumerator:
NoFlip  Do not flip.
HorizontalFlip  Flip horizontally.
VerticalFlip  Flip vertically.

Definition at line 119 of file plasma.h.

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.

Definition at line 55 of file plasma.h.

enum Plasma::ImmutabilityType

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)

Enumerator:
Mutable  The item can be modified in any way.
UserImmutable  The user has requested a lock down, and can undo the lock down at any time.
SystemImmutable  the item is locked down by the system, the user can't unlock it

Definition at line 149 of file plasma.h.

enum Plasma::IntervalAlignment

Possible timing alignments.

Enumerator:
NoAlignment 
AlignToMinute 
AlignToHour 

Definition at line 136 of file plasma.h.

enum Plasma::ItemTypes

Enumerator:
AppletType 
LineEditType 

Definition at line 141 of file plasma.h.

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:
Floating  Free floating.

Neither geometry or z-ordering is described precisely by this value.

Desktop  On the planar desktop layer, extending across the full screen from edge to edge.
FullScreen  Full screen.
TopEdge  Along the top of the screen.
BottomEdge  Along the bottom of the screen.
LeftEdge  Along the left side of the screen.
RightEdge  Along the right side of the screen.

Definition at line 94 of file plasma.h.

enum Plasma::MarginEdge

Enumerator:
TopMargin 
BottomMargin 
LeftMargin 
RightMargin 

Definition at line 176 of file plasma.h.

enum Plasma::Position

The position enumeration.

Enumerator:
LeftPositioned  Positioned left.
RightPositioned  Positioned right.
TopPositioned  Positioned top.
BottomPositioned  Positioned bottom.
CenterPositioned  Positioned in the center.

Definition at line 109 of file plasma.h.

enum Plasma::ZoomDirection

The direction of a zoom action.

Enumerator:
ZoomIn  Zoom in one step.
ZoomOut  Zoom out one step.

Definition at line 86 of file plasma.h.

enum Plasma::ZoomLevel

Zoom levels that Plasma is aware of.

..

Enumerator:
DesktopZoom  Normal desktop usage, plasmoids are painted normally and have full interaction.
GroupZoom  Plasmoids are shown as icons in visual groups; drag and drop and limited context menu interaction only.
OverviewZoom  Groups become icons themselves.

Definition at line 128 of file plasma.h.


Function Documentation

qreal Plasma::_k_angleForPoints ( const QPointF &  center,
const QPointF &  pt1,
const QPointF &  pt2 
)

Definition at line 468 of file applethandle.cpp.

qreal Plasma::_k_distanceForPoint ( QPointF  point  ) 

Definition at line 463 of file applethandle.cpp.

bool Plasma::appletConfigLessThan ( const KConfigGroup &  c1,
const KConfigGroup &  c2 
)

Definition at line 209 of file containment.cpp.

<Name> ::<Name> QGraphicsWidget Plasma::d ( new< Name >  Private  ) 

Type constraints

Definition at line 75 of file template.cpp.

PackageStructure::Ptr Plasma::defaultPackageStructure ( ComponentType  type  ) 

Definition at line 217 of file scriptengine.cpp.

KService::List Plasma::engineOffers ( const QString &  language,
ComponentType  type 
)

Definition at line 110 of file scriptengine.cpp.

QPainterPath Plasma::handleRect ( const QRectF &  rect,
int  radius,
bool  onRight 
)

Definition at line 169 of file applethandle.cpp.

static QPainterPath Plasma::headerPath ( const QRectF &  r,
int  roundness,
int  headerHeight = 10 
) [inline, static]

Definition at line 117 of file glapplet.cpp.

PLASMA_EXPORT bool Plasma::isPluginVersionCompatible ( unsigned int  version  ) 

Verifies that a plugin is compatible with plasma.

Definition at line 51 of file version.cpp.

PLASMA_EXPORT QStringList Plasma::knownLanguages ( ComponentTypes  types  ) 

  • 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 64 of file scriptengine.cpp.

ScriptEngine* Plasma::loadEngine ( const QString &  language,
ComponentType  type,
QObject *  parent 
)

Definition at line 150 of file scriptengine.cpp.

PLASMA_EXPORT 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 206 of file scriptengine.cpp.

PLASMA_EXPORT 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 195 of file scriptengine.cpp.

PLASMA_EXPORT 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 184 of file scriptengine.cpp.

PLASMA_EXPORT 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 the visual direction of the element should be oriented in

Definition at line 43 of file plasma.cpp.

PLASMA_EXPORT PackageStructure::Ptr Plasma::packageStructure ( const QString &  language,
ComponentType  type 
)

Loads an appropriate PackageStructure for the given language and type.

Parameters:
langauge the language to load the PackageStructure for
type the component type
Returns:
a guarded PackageStructure pointer

Definition at line 240 of file scriptengine.cpp.

PLASMA_EXPORT qreal Plasma::scalingFactor ( ZoomLevel  level  ) 

Returns:
the scaling factor (0.

.1) for a ZoomLevel

Definition at line 25 of file plasma.cpp.

PLASMA_EXPORT unsigned int Plasma::version (  ) 

The runtime version of libplasma.

Definition at line 26 of file version.cpp.

PLASMA_EXPORT unsigned int Plasma::versionMajor (  ) 

The runtime major version of libplasma.

Definition at line 31 of file version.cpp.

PLASMA_EXPORT unsigned int Plasma::versionMinor (  ) 

The runtime major version of libplasma.

Definition at line 36 of file version.cpp.

PLASMA_EXPORT unsigned int Plasma::versionRelease (  ) 

The runtime major version of libplasma.

Definition at line 41 of file version.cpp.

PLASMA_EXPORT const char * Plasma::versionString (  ) 

The runtime version string of libplasma.

Definition at line 46 of file version.cpp.


Variable Documentation

const int Plasma::CONFIG_SYNC_TIMEOUT = 30000

Definition at line 44 of file corona.cpp.

const int Plasma::DEFAULT_WALLPAPER_HEIGHT = 1200 [static]

Definition at line 46 of file theme.cpp.

const int Plasma::DEFAULT_WALLPAPER_WIDTH = 1920 [static]

Definition at line 45 of file theme.cpp.

const qreal Plasma::MIN_TICK_RATE = 40 [static]

Definition at line 37 of file animator.cpp.

const int Plasma::MIN_TICK_RATE_INT = 40 [static]

Definition at line 36 of file animator.cpp.

<Name> ::<Name> QGraphicsWidget* Plasma::parent

Definition at line 71 of file template.cpp.

static const int Plasma::ToolName = 7001 [static]

Definition at line 78 of file desktoptoolbox.cpp.

libplasma

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

API Reference

Skip menu "API Reference"
  • KWin
  •   KWin Libraries
  • Libraries
  •   libkworkspace
  •   libplasma
  •   libsolidcontrol
  •   libtaskmanager
  • Plasma
  •   Animators
  •   Applets
  •   Engines
  • Solid Modules
Generated for API Reference by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal