Development/Tutorials/Plasma/QML/API - Revision history

Dvratil: Fix PlasmaCore.Theme icon sizes API docs

2013-04-18T10:14:36Z

Fix PlasmaCore.Theme icon sizes API docs

2013-04-04T14:25:25Z

Add a global plasmoid object section, as the API for it is different to the Javascript one

2013-02-20T22:29:28Z

typo--

2013-02-06T00:57:49Z

‎Signals: adding sample

2013-02-04T21:22:54Z

If all data shall appear in a DataModel, explicitly mention that the Regular Expression shall be ".*"

2012-11-26T10:35:27Z

‎Theme

2012-11-21T01:59:59Z

‎AppletContainer

2012-11-21T01:58:57Z

background hints

2012-11-21T01:40:37Z

‎ToolBox: one level down

2012-11-21T01:39:48Z

‎ToolBox

@@ Line 393: / Line 393: @@
 * Font '''desktopFont''' (read only)
 * Font '''smallestFont''' (read only)
 Each Font element has the following properties:
@@ Line 408: / Line 415: @@
 * size '''mSize''' the size, width and height of an uppercase "M" in this font (read only)
-Theme is also used to control icon sizes, with the property '''iconSize'''. it is an Object, that has the following properties:
+Theme is also used to control icon sizes, with the property '''iconSizes'''. it is an Object, that has the following properties:
 * int '''desktop''': size of icons suited for the workspace
 * int '''toolbar''': icons to be put in a ToolBar component

@@ Line 6: / Line 6: @@
 The QML ScriptEngine is based upon the Plasma JavaScript engine, making the API of the JavaScript part identical to the one of the JavaScript plasmoids engine.
 The most important API for using graphical widgets is the [http://api.kde.org/4.x-api/plasma-qml-apidocs/ Plasma QtComponents API]
@@ Line 42: / Line 40: @@
 * '''property int minimumHeight''': minum height of the plasmoid, size in pixels.
 * '''property Component compactRepresentation''': if the plasmoid is a popupapplet, the component in compactRepresentation will be used instead of the icon and will always be collapsed, regardless if it's in a panel or not.
 = Main Plasma QML Classes =

@@ Line 584: / Line 584: @@
 * QPixmapItem.Tile: the image is duplicated horizontally and vertically
 * QPixmapItem.TileVertically: the image is stretched horizontally and tiled vertically
-* QPixmapItem.TileHorizontally :e image is stretched vertically and tiled horizontally
+* QPixmapItem.TileHorizontally : the image is stretched vertically and tiled horizontally
 QImageItem defines the same values, you just need to replace QPixmapItem with QImageItem.

@@ Line 78: / Line 78: @@
 It has the following signals:
 Note that javascript/qml applies the 'on' prefix to signals. So the actual signal name in C++ which is e.g. '''newData'''(...) becomes '''onNewData'''(...).
-* '''onNewData'''(String sourceName, Plasma::DataEngine::Data data)
+* '''onNewData'''(String sourceName, Plasma::DataEngine::Data data) the local vairables are named to '''sourceName''' and '''data'''
 * '''onSourceAdded'''(String source)
 * '''onSourceRemoved'''(String source)
@@ Line 90: / Line 90: @@
 * '''onConnectedSourcesChanged'''()
 * '''onSourcesChanged'''()
 ==== Methods ====

@@ Line 148: / Line 148: @@
 * DataSource '''dataSource''': the id of an existing (and connected) DataSource
 * String '''sourceFilter''': it's a regular expression. If the DataSource is connected to more than one source, only inserts data from sources matching this filter expression in the model. To, for example, have a source watch all sources beginning with say "name:", the required regexp would be sourceFilter: "name:.*"
-* String '''keyRoleFilter''': it's a regular expression. Only data with keys that match this filter expression will be inserted in the model
+* String '''keyRoleFilter''': it's a regular expression. Only data with keys that match this filter expression will be inserted in the model. If you need all data inserted in the mode, you must explicitly request it using the regular expression ".*"
 * int '''count''' (read only): how many items are in the model

@@ Line 271: / Line 271: @@
 * real '''wordSpacing''' (read only)
 * size '''mSize''' the size, width and height of an uppercase "M" in this font (read only)
 === Svg ===

@@ Line 450: / Line 450: @@
 Properties:
 * ''Item'' '''applet''': The applet item, this property allows you to track destruction of the actual applet and update your layout.
-** ''int'' '''backgroundHints: 0 for no background, 1 for default background, 2 for translucent background
+** ''int'' '''backgroundHints''': Should the Applet be rendered on top of a background frame? 0 for no background, 1 for default background, 2 for translucent background
 * ''int'' '''minimumWidth''': The minimum width of the applet
 * ''int'' '''minimumHeight''': The minimum height of the applet

@@ Line 442: / Line 442: @@
 == Containments ==
-A Plasma Containment manages the position and manipulation of Plasmoids.
+A Plasma Containment manages the position and manipulation of Plasmoids. The declarative containment is responsible for layout of applets and can provide custom applet handles. The containment should listen to the plasmoid.immutability property. In order to lay out applets in your containment, you can use the AppletContainer class to access geometry information of applets.
 === AppletContainer ===
 The AppletContainer class provides access to the geometry and status of Plasmoids in this Containment.
 Properties:
 * ''int'' '''minimumWidth''': The minimum width of the applet
 * ''int'' '''minimumHeight''': The minimum height of the applet
@@ Line 483: / Line 488: @@
 import org.kde.plasma.containments 0.1 as PlasmaContainments
 </syntaxhighlight>
 ToolBox is only available for Containments and new in 4.10.

@@ Line 468: / Line 468: @@
 AppletContainer is only available for Plasma/Containment packages, and only if they are loaded as containment. AppletContainer is new in 4.10.
-== ToolBox ==
+=== ToolBox ===
 The ToolBox is only available through the plasmoid object, through plasmoid.toolBox(). The ToolBox is rendered as a separate item  on top of the scene covering the entire containment. It is loaded from the "org.kde.toolbox" Plasma Package, if the package is not found, no ToolBox will be loaded.
 The ToolBox provides a listmodel of actions that can be rendered using Repeaters or ListViews. The ''actions'' list property contains actions from the Corona and Containments. Examples for these actions are showing the add widget or activities interface, lock and unlock. The actions in the list change dynamically whenever the widgets are locked or unlocked.

@@ Line 477: / Line 477: @@
 ** ''QIcon'' '''icon''': The icon belonging to this action.
 ** ''String'' '''text''': The icon belonging to this action.
-** ''''trigger()''': Call trigger from your action delegate to trigger the action.
+** '''trigger()''': Call trigger from your action delegate to trigger the action.
 <syntaxhighlight lang="javascript">
 import org.kde.plasma.containments 0.1 as PlasmaContainments
-</syntaxhighlighting>
+</syntaxhighlight>
 ToolBox is only available for Containments and new in 4.10.