Plasma Namespace Reference

Namespaces
	AnimationScriptEngine
	PaintUtils
	WindowEffects

Classes
class	AbstractDialogManager
class	AbstractRunner
class	AbstractToolBox
class	AccessAppletJob
class	AccessManager
class	Animation
class	AnimationDriver
class	Animator
class	Applet
class	AppletScript
class	AuthorizationInterface
class	AuthorizationManager
class	AuthorizationRule
class	BusyWidget
class	CheckBox
class	ClientPinRequest
class	ComboBox
class	ConfigLoader
class	Containment
class	ContainmentActions
class	ContainmentActionsPluginsConfig
class	Context
class	Corona
class	Credentials
class	DataContainer
class	DataEngine
class	DataEngineManager
class	DataEngineScript
class	DeclarativeWidget
class	Delegate
class	Dialog
class	Extender
class	ExtenderGroup
class	ExtenderItem
class	FlashingLabel
class	Frame
class	FrameSvg
class	GLApplet
class	GroupBox
class	IconWidget
class	ItemBackground
class	Label
class	LineEdit
class	Meter
class	Package
class	PackageMetadata
class	PackageStructure
struct	PlotColor
class	PluginLoader
class	PopupApplet
class	PushButton
class	QueryMatch
class	RadioButton
class	RunnerContext
class	RunnerManager
class	RunnerScript
class	RunnerSyntax
class	ScriptEngine
class	ScrollBar
class	ScrollWidget
class	Separator
class	Service
class	ServiceAccessJob
class	ServiceJob
class	SignalPlotter
class	Slider
class	SpinBox
class	Svg
class	SvgWidget
class	TabBar
class	TextBrowser
class	TextEdit
class	Theme
class	ToolButton
class	ToolTipContent
class	ToolTipManager
class	TreeView
class	VideoWidget
class	View
class	Wallpaper
class	WallpaperScript
class	WebView

Enumerations
enum	AnnouncementMethod { NoAnnouncement = 0, ZeroconfAnnouncement = 1 }
enum	AspectRatioMode {   InvalidAspectRatioMode = -1, IgnoreAspectRatio = 0, KeepAspectRatio = 1, Square = 2,   ConstrainedSquare = 3, FixedSize = 4 }
enum	CacheType { NoCache = 0, PixmapCache = 1, SvgElementsCache = 2 }
enum	ComponentType {   AppletComponent = 1, DataEngineComponent = 2, RunnerComponent = 4, AnimatorComponent = 8,   ContainmentComponent = 16, WallpaperComponent = 32, GenericComponent = 64 }
enum	Constraint {   NoConstraint = 0, FormFactorConstraint = 1, LocationConstraint = 2, ScreenConstraint = 4,   SizeConstraint = 8, ImmutableConstraint = 16, StartupCompletedConstraint = 32, ContextConstraint = 64,   PopupConstraint = 128, AllConstraints }
enum	Direction { Down = 0, Up, Left, Right }
enum	FlipDirection { NoFlip = 0, HorizontalFlip = 1, VerticalFlip = 2 }
enum	FormFactor {   Planar = 0, MediaCenter, Horizontal, Vertical,   Application }
enum	ImmutabilityType { Mutable = 1, UserImmutable = 2, SystemImmutable = 4 }
enum	IntervalAlignment { NoAlignment = 0, AlignToMinute, AlignToHour }
enum	ItemStatus {   UnknownStatus = 0, PassiveStatus = 1, ActiveStatus = 2, NeedsAttentionStatus = 3,   AcceptingInputStatus = 4 }
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	MessageButton {   ButtonNone = 0, ButtonOk = 1, ButtonYes = 2, ButtonNo = 4,   ButtonCancel = 8 }
enum	PopupPlacement {   FloatingPopup = 0, TopPosedLeftAlignedPopup, TopPosedRightAlignedPopup, LeftPosedTopAlignedPopup,   LeftPosedBottomAlignedPopup, BottomPosedLeftAlignedPopup, BottomPosedRightAlignedPopup, RightPosedTopAlignedPopup,   RightPosedBottomAlignedPopup }
enum	Position {   LeftPositioned, RightPositioned, TopPositioned, BottomPositioned,   CenterPositioned }
enum	styles { DEFAULTSTYLE, SVGSTYLE }
enum	TrustLevel {   InvalidCredentials = 0, UnknownCredentials = 1, ValidCredentials = 2, TrustedCredentials = 3,   UltimateCredentials = 4 }
enum	ZoomDirection { ZoomIn = 0, ZoomOut = 1 }
enum	ZoomLevel { DesktopZoom = 0, GroupZoom, OverviewZoom }

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

enum Plasma::AnnouncementMethod

Enumerator
NoAnnouncement	No announcements.
ZeroconfAnnouncement	Announcements via ZeroConf.

Definition at line 265 of file plasma.h.

enum Plasma::AspectRatioMode

Defines the aspect ratio used when scaling an applet.

Enumerator
InvalidAspectRatioMode	Unset 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 208 of file plasma.h.

enum Plasma::CacheType

Enumerator
NoCache
PixmapCache
SvgElementsCache

Definition at line 67 of file theme.cpp.

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.
WallpaperComponent	Plasma::Wallpaper based plugins.
GenericComponent

Definition at line 225 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	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

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

enum Plasma::FlipDirection

Flip enumeration.

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

Definition at line 160 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.
Application	The Applet lives in a plane and should be optimized to look as a full application, for the desktop or the particular device.

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

enum Plasma::IntervalAlignment

Possible timing alignments.

Enumerator
NoAlignment	No alignment.
AlignToMinute	Align to the minute.
AlignToHour	Align to the hour.

Definition at line 181 of file plasma.h.

enum Plasma::ItemStatus

Status of an applet.

Since

4.3

Enumerator
UnknownStatus	The status is unknown.
PassiveStatus	The Item is passive.
ActiveStatus	The Item is active.
NeedsAttentionStatus	The Item needs attention.
AcceptingInputStatus	The Item is accepting input.

Definition at line 256 of file plasma.h.

enum Plasma::ItemTypes

Enumerator
AppletType
LineEditType

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

enum Plasma::MarginEdge

Enumerator
TopMargin	The top margin.
BottomMargin	The bottom margin.
LeftMargin	The left margin.
RightMargin	The right margin.

Definition at line 236 of file plasma.h.

enum Plasma::MessageButton

Enumerator
ButtonNone	None.
ButtonOk	OK Button.
ButtonYes	Yes Button.
ButtonNo	No Button.
ButtonCancel	Cancel Button.

Definition at line 243 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 137 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 124 of file plasma.h.

enum Plasma::styles

Enumerator
DEFAULTSTYLE
SVGSTYLE

Definition at line 62 of file theme.cpp.

enum Plasma::TrustLevel

Enumerator
InvalidCredentials	The credentials are invalid.
UnknownCredentials	The credentials are unknown.
ValidCredentials	The credentials are valid.
TrustedCredentials	The credentials are trusted.
UltimateCredentials	The ultimate trust level applies to the credentials.

Definition at line 271 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 99 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 170 of file plasma.h.

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 201 of file corona.cpp.

bool Plasma::copyFolder	(	QString	sourcePath,
		QString	targetPath
	)

Definition at line 55 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 QScriptValue Plasma::ctor ( QScriptContext *  ctx, QScriptEngine *  eng  )

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.

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

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 90 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 KPluginInfo::List Plasma::standardInternalInfo ( const QString &  type, const QString &  category = QString()  )

static

Definition at line 368 of file pluginloader.cpp.

static QScriptValue Plasma::toString ( QScriptContext *  ctx, QScriptEngine *  eng  )

static

Definition at line 57 of file easingcurve.cpp.

static QScriptValue Plasma::type ( QScriptContext *  ctx, QScriptEngine *  eng  )

static

Definition at line 63 of file easingcurve.cpp.

static QScriptValue Plasma::valueForProgress ( QScriptContext *  ctx, QScriptEngine *  eng  )

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

const int Plasma::DEFAULT_WALLPAPER_HEIGHT = 1200

static

Definition at line 60 of file theme.cpp.

const int Plasma::DEFAULT_WALLPAPER_WIDTH = 1920

static

Definition at line 59 of file theme.cpp.

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

static

Definition at line 83 of file containment.cpp.

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

static

Definition at line 84 of file containment.cpp.

const int Plasma::MAX_FRAME_SIZE = 100000

static

Definition at line 47 of file framesvg.cpp.

const int Plasma::MAXIMUM_TEXT_LENGTH = 5000

Definition at line 47 of file tooltipcontent.cpp.

const qreal Plasma::MIN_TICK_RATE = 10

static

Definition at line 42 of file deprecated/animator.cpp.

const int Plasma::MIN_TICK_RATE_INT = 10

static

Definition at line 41 of file deprecated/animator.cpp.

PluginLoader* Plasma::s_pluginLoader = 0

static

Definition at line 41 of file pluginloader.cpp.