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

Plasma

Plasma Namespace Reference

Namespace for everything in libplasma. More...


Namespaces

namespace  PaintUtils

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  AppletScript
 Provides a restricted interface for scripted applets. More...
class  BusyWidget
 A widget that provides a waiting spinner. More...
class  CheckBox
 Provides a Plasma-themed checkbox. 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  Context
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
 Provides a restricted interface for scripting a DataEngine. 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  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  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  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  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  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
 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  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  View
 A QGraphicsView for a single Containment. More...
class  Wallpaper
 The base Wallpaper class. More...
class  WebView
 Provides a widget to display html content in Plasma. More...

Enumerations

enum  AspectRatioMode {
  InvalidAspectRatioMode = -1, IgnoreAspectRatio = 0, KeepAspectRatio = 1, Square = 2,
  ConstrainedSquare = 3, FixedSize = 4
}
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, ContextConstraint = 64,
  AllConstraints
}
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  PopupPlacement {
  FloatingPopup = 0, TopPosedLeftAlignedPopup, TopPosedRightAlignedPopup, LeftPosedTopAlignedPopup,
  LeftPosedBottomAlignedPopup, BottomPosedLeftAlignedPopup, BottomPosedRightAlignedPopup, RightPosedTopAlignedPopup,
  RightPosedBottomAlignedPopup
}
enum  Position {
  LeftPositioned, RightPositioned, TopPositioned, BottomPositioned,
  CenterPositioned
}
enum  ZoomDirection { ZoomIn = 0, ZoomOut = 1 }
enum  ZoomLevel { DesktopZoom = 0, GroupZoom, OverviewZoom }

Functions

qreal _k_distanceForPoint (QPointF point)
qreal _k_pointAngle (QPointF in)
QPointF _k_rotatePoint (QPointF in, qreal rotateAngle)
bool appletConfigLessThan (const KConfigGroup &c1, const KConfigGroup &c2)
bool containmentSortByPosition (const Containment *c1, const Containment *c2)
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 ()
QGraphicsView * viewFor (const QGraphicsItem *item)

Variables

const int CONFIG_SYNC_TIMEOUT = 10000
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 qreal MIN_TICK_RATE = 10
static const int MIN_TICK_RATE_INT = 10
static const int ToolName = 7001

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

enum Plasma::AspectRatioMode

Defines the aspect ratio used when scaling an applet.

Enumerator:
InvalidAspectRatioMode  Unsetted mode used for dev convenience when there is a need to store the aspectRatioMode somewhere.
IgnoreAspectRatio  The applet can be freely resized.
KeepAspectRatio  The applet keeps a fixed aspect ratio.
Square  The applet is always a square.
ConstrainedSquare  The applet is no wider (in horizontal formfactors) or no higher (in vertical ones) than a square.
FixedSize 

Definition at line 204 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 221 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  The FormFactor for an object.
ScreenConstraint  The Location of an object.
SizeConstraint  Which screen an object is on.
ImmutableConstraint  the size of the applet was changed
StartupCompletedConstraint  the immutability (locked) nature of the applet changed
ContextConstraint  application startup has completed
AllConstraints  the desktop context has changed

Definition at line 43 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 85 of file plasma.h.

enum Plasma::FlipDirection

Flip enumeration.

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

Definition at line 156 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 62 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 193 of file plasma.h.

enum Plasma::IntervalAlignment

Possible timing alignments.

Enumerator:
NoAlignment 
AlignToMinute 
AlignToHour 

Definition at line 177 of file plasma.h.

enum Plasma::ItemTypes

Enumerator:
AppletType 
LineEditType 

Definition at line 183 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 104 of file plasma.h.

enum Plasma::MarginEdge

Enumerator:
TopMargin 
BottomMargin 
LeftMargin 
RightMargin 

Definition at line 230 of file plasma.h.

enum Plasma::PopupPlacement

The popup position enumeration relatively to his attached widget.

Enumerator:
FloatingPopup  Free floating, non attached popup.
TopPosedLeftAlignedPopup  Popup positioned on the top, aligned to the left of the wigdet.
TopPosedRightAlignedPopup  Popup positioned on the top, aligned to the right of the widget.
LeftPosedTopAlignedPopup  Popup positioned on the left, aligned to the right of the wigdet.
LeftPosedBottomAlignedPopup  Popup positioned on the left, aligned to the bottom of the widget.
BottomPosedLeftAlignedPopup  Popup positioned on the bottom, aligned to the left of the wigdet.
BottomPosedRightAlignedPopup  Popup positioned on the bottom, aligned to the right of the widget.
RightPosedTopAlignedPopup  Popup positioned on the right, aligned to the top of the wigdet.
RightPosedBottomAlignedPopup  Popup positioned on the right, aligned to the bottom of the widget.

Definition at line 133 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 120 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 95 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 166 of file plasma.h.


Function Documentation

qreal Plasma::_k_distanceForPoint ( QPointF  point  ) 

Definition at line 573 of file applethandle.cpp.

qreal Plasma::_k_pointAngle ( QPointF  in  ) 

Definition at line 578 of file applethandle.cpp.

QPointF Plasma::_k_rotatePoint ( QPointF  in,
qreal  rotateAngle 
)

Definition at line 591 of file applethandle.cpp.

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

Definition at line 246 of file containment.cpp.

bool Plasma::containmentSortByPosition ( const Containment *  c1,
const Containment *  c2 
)

Definition at line 1756 of file containment.cpp.

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

Definition at line 223 of file scriptengine.cpp.

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

Definition at line 112 of file scriptengine.cpp.

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

Definition at line 191 of file applethandle.cpp.

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

Definition at line 118 of file glapplet.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  ) 

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

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

Definition at line 152 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 211 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 199 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 187 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 of the element should be oriented in

Definition at line 49 of file plasma.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 246 of file scriptengine.cpp.

qreal Plasma::scalingFactor ( ZoomLevel  level  ) 

Returns:
the scaling factor (0..1) for a ZoomLevel

Definition at line 31 of file plasma.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.

  • item the QGraphicsItem to locate a view for
    Returns:
    pointer to a view, or 0 if none was found

Definition at line 70 of file plasma.cpp.


Variable Documentation

const int Plasma::CONFIG_SYNC_TIMEOUT = 10000

Definition at line 51 of file corona.cpp.

const int Plasma::DEFAULT_WALLPAPER_HEIGHT = 1200 [static]

Definition at line 49 of file theme.cpp.

const int Plasma::DEFAULT_WALLPAPER_WIDTH = 1920 [static]

Definition at line 48 of file theme.cpp.

const char Plasma::defaultWallpaper[] = "image" [static]

Definition at line 62 of file containment.cpp.

const char Plasma::defaultWallpaperMode[] = "SingleImage" [static]

Definition at line 63 of file containment.cpp.

const qreal Plasma::MIN_TICK_RATE = 10 [static]

Definition at line 38 of file animator.cpp.

const int Plasma::MIN_TICK_RATE_INT = 10 [static]

Definition at line 37 of file animator.cpp.

const int Plasma::ToolName = 7001 [static]

Definition at line 138 of file desktoptoolbox.cpp.

Plasma

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

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.7
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