/** @page libplasma libplasma
libplasma is the core of the Plasma desktop. It provides a framework of graphical
widgets (Plasma::Applet) that can be organised into managed groupings
(Plasma::Containment), such as a desktop or panel. It also provides a data
abstraction layer (Plasma::DataEngine) and a corresponding service interaction
layer (Plasma::Service) to make implementing widgets easier.
The Qt Graphics View
framework and the KDE
libraries provide the underpinning for libplasma. As a result, it should
work anywhere that Qt and KDE do.
Although libplasma is developed for the use of the Plasma desktop shell in
KDE 4, it is general enough to be useful in other applications.
Amarok is using it for its context
view, allowing for pluggable widgets to display and interact with the music
collection, such as "current track" and "tag cloud" widgets.
libplasma itself only provides a framework, and the widgets, containments,
data engines are all implemented as plugins. However, the framework
is designed to make implementing these plugins as easy as possible, including
providing scripting support.
Other important classes are:
- Plasma::Corona: the canvas that containments are placed on
- Plasma::View: a QWidget for displaying a containment
- Plasma::Theme: provides theming support
- Plasma::Package: provides descriptions of packages containing plugins
for libplasma
- Plasma::Svg and Plasma::FrameSvg: provides themable, cached SVGs
- Plasma::AppletScript, Plasma::DataEngineScript and
Plasma::ScriptEngine: provide scripting interfaces for plugins
The
Plasma tutorials
on TechBase provide a good introduction to writing plugins, such as widgets and
data engines, for libplasma-based applications.
@authors
Aaron Seigo \
Alessandro Diaferia \
Alex Merry \
Alexander Wiedenbruch \
Alexis Ménard \
André Duffeck \
Andrew Lake \
Artur de Souza \
Bertjan Broeksema \
Chani Armitage \
Davide Bettio \
Dan Meltzer \
Fredrik Höglund \
Ivan Cukic \
John Tapsell \
Jordi Polo \
Kevin Ottens \
Montel Laurent \
Marco Martin \
Matt Broadstone \
Petri Damsten \
Rafael Fernández López \
Riccardo Iaconelli \
Richard J. Moore \
Rob Scheepmaker \
Robert Knight \
Sebastian Kuegler \
Siraj Razick \
Zack Rusin \
@maintainers
Aaron Seigo \
@licenses
@lgpl
*/
// DOXYGEN_SET_PROJECT_NAME = Plasma
// DOXYGEN_SET_RECURSIVE = YES
// DOXYGEN_EXCLUDE_PATTERNS = *_p.h */private/* */tests/*
// vim:ts=4:sw=4:expandtab:filetype=doxygen