KDE System Administration/PlasmaDesktopScripting - Revision history

Aseigo: /* External Configuration Files */

2013-06-05T13:07:45Z

‎External Configuration Files

Aseigo: /* Locating Applications and Paths */

2013-06-05T13:06:40Z

‎Locating Applications and Paths

Shadeslayer at 07:16, 21 February 2013

2013-02-21T07:16:59Z

Shadeslayer at 07:13, 21 February 2013

2013-02-21T07:13:08Z

Shadeslayer at 07:11, 21 February 2013

2013-02-21T07:11:18Z

Aseigo: /* Locating Applications and Paths */

2013-01-28T17:04:54Z

‎Locating Applications and Paths

Aseigo: /* Locating Applications and Paths */

2013-01-28T15:53:17Z

‎Locating Applications and Paths

Aseigo: /* Widgets */

2012-10-01T12:18:30Z

‎Widgets

Anne-Marie: /* Wallpaper Plugins */ typo

2012-05-18T11:45:37Z

‎Wallpaper Plugins: typo

Icwiener: Fix syntax highlighting.

2011-06-30T11:32:52Z

Fix syntax highlighting.

@@ Line 352: / Line 352: @@
 === External Configuration Files ===
 Access to configuration files outside of the application's appletsrc file is provided by the ConfigFile object which has the following constructors:
 * ''ConfigFile(ConfigFile other)'': creates a new ConfigFile object with the first as its parent, which automatically makes all groups of this object child groups of that parent

← Older revision		Revision as of 13:06, 5 June 2013
Line 350:		Line 350:

	The second parameter should be a specific resource to find the path to. An example might be userDataPath("data", "plasma-desktop").		The second parameter should be a specific resource to find the path to. An example might be userDataPath("data", "plasma-desktop").
		+
		+	=== External Configuration Files ===
		+	Access to configuration files outside of the application's appletsrc file is provided by the ConfigFile object which has the following constructors:
		+	* ''ConfigFile(ConfigFile other)'': creates a new ConfigFile object with the first as its parent, which automatically makes all groups of this object child groups of that parent
		+	* ''ConfigFile(string file[, string group])'': creates a new ConfigFile object for file and optionally set to group group
		+
		+	ConfigFile has the following functions:
		+	* ''writeEntry(string key, any value)'': writes value for key in the current group
		+	* ''readEntry(string key)'': returns the value of key in the current group
		+	* ''deleteEntry(key)'': deletes key in the current group
		+
		+	ConfigFile has the following read/write properties:
		+	* ''file'': the name of the configuration file. May be an absolute path or just a file name to be located automatically in the system's configuration repository.
		+	* ''group'': the name of the current group. To get to child groups, create a new ConfigFile with another ConfigFile as its parent.
		+
		+	ConfigFile has the follow read-only properties:
		+	* ''entryList'': all the keys in the current group
		+	* ''groupList'': all the child groups in the current group
		+
		+	Example usage:
		+
		+	<syntaxhighlight lang="javascript">
		+	// open the kickoffrc file
		+	var config = ConfigFile('kickoffrc');
		+	// switch to the RecentlyUsed group
		+	config.group = 'RecentlyUsed';
		+	// write an entry into it
		+	config.writeEntry('MaxApplications', 25);
		+
		+	// now put Yes=20 into RecentlyUsed/Test
		+	var config2 = ConfigFile(config, 'Test);
		+	config2.writeEntry('Yes', 20);
		+	</syntaxhighlight>

	=== Misc. Global Properties and Functions ===		=== Misc. Global Properties and Functions ===

@@ Line 95: / Line 95: @@
 var template = loadTemplate('org.kde.plasma-desktop.findWidgets')
-template.findWidgets('systemtray')
+template.findWidgets('systemtray', removeWidget)
 </syntaxhighlight>

@@ Line 84: / Line 84: @@
 template.findWidgets('systemtray')
 </syntaxhighlight>
 Since just finding the widget is not enough, you can connect a callback to do additional operations, such as removing the widget :
@@ Line 92: / Line 93: @@
    widget.remove()
+}
 var template = loadTemplate('org.kde.plasma-desktop.findWidgets')
 template.findWidgets('systemtray')

@@ Line 84: / Line 84: @@
 template.findWidgets('systemtray')
 </syntaxhighlight>
 ==== Activity templates ====

@@ Line 291: / Line 291: @@
      print (executable + " .desktop file is located here :    " + applicationPath(desktopfile))
 } else{
-     print (application + " does not exist ")
+     print (executable + " does not exist ")
+}
 </syntaxhighlight>

@@ Line 282: / Line 282: @@
 * ''boolean'' '''applicationExists(String name)''': (scripting version >= 4) searches $PATH first, then tries in the application menu system by application storage name (aka the .desktop file name), then Name= entries for apps with installed .desktop files, then GenericName= entries for same
 * ''mixed'' '''defaultApplication(String kind [, boolean storageId = false])''': (scripting version >= 4) returns the executable (or if storageId is true, then the app menu system id, e.g. its .desktop file name) of the default app. The "kind" parameter may be a well-known application type including "browser", "mailer", "filemanager", "terminal", "imClient" and "windowmanager" (or any other entry in share/apps/kcm_componentchooser/kcm_*.desktop); it may also be a mimetype (e.g. "application/pdf"). On failure, it returns false.
-* ''String'' '''applicationPath(String name)''':  (scripting version >= 4) returns the full local path to a given application or .desktop file if it exists.
+* ''String'' '''applicationPath(String name)''':  (scripting version >= 4) returns the full local path to a given application or .desktop file if it exists. Example:
 * ''String'' '''userDataPath([String type, String path])''':  (scripting version >= 4) returns the default path for user data. Called with no parameters, it returns the user's home directory. If only one string is passed in, the standard directory for that type of data in the user's home directory will be located; the following values are recognized:
 ** documents

@@ Line 224: / Line 224: @@
 Widgets may be enumerated by calling the widgetIds property on a Activity or Panel object. With a widget id in hand, a Widget object can be retrieved by calling widgetById(id) on an Activity or Panel object. New Widgets can be created with add addWidget(String) function provided by Activity and Panel objects.
 A list of all installed widget types can be retrieved the following read-only property:
 * ''Array[String]'' '''knownWidgetTypes''' (scripting version >= 2)
 A Widget object provides the following read-only properties:

@@ Line 265: / Line 265: @@
 === Wallpaper Plugins ===
-* ''Array[String => Array[String]]'' '''knownWallpaperPlugins()''': (scripting version >= 4) returns a list of all installed wallpaper plugins. They keys of the array are the wallpaper plugin names. The values are arrays containing the modes available for that wallpaper plugin. The mode array may be empty, as most wallpaper plugins only offer one mode.
+* ''Array[String => Array[String]]'' '''knownWallpaperPlugins()''': (scripting version >= 4) returns a list of all installed wallpaper plugins. The keys of the array are the wallpaper plugin names. The values are arrays containing the modes available for that wallpaper plugin. The mode array may be empty, as most wallpaper plugins only offer one mode.
 === Locating Applications and Paths ===

@@ Line 20: / Line 20: @@
 * '''on update''': when plasma-desktop is started, it will check in
-  `kde4-config --path data`/plasma-desktop/updates/
+<syntaxhighlight lang="bash">
 with a ".js" suffix for scripts that have not yet been run. If there is more than one script which has not been run yet they will be executed serially in the alphabetical order of the file names.
@@ Line 108: / Line 110: @@
 </syntaxhighlight>
-The layout itself is still created from the layout.js file as usual, but this template also shows as a precreated activity to the user thanks to the X-Plasma-ContainmentLayout-ShowAsExisting key. Additionally, it starts applications in the newly created activity using the X-Plasma-ContainmentLayout-ExecuteOnCreation key.
+The layout itself is still created from the layout.js file as usual, but this template also shows as a precreated activity to the user thanks to the <tt>X-Plasma-ContainmentLayout-ShowAsExisting</tt> key. Additionally, it starts applications in the newly created activity using the <tt>X-Plasma-ContainmentLayout-ExecuteOnCreation</tt> key.
 That key is a list of commands to execute, and it supports the following variables:
@@ Line 141: / Line 143: @@
 New Activities can be created using the Activity constructor, like this:
+<syntaxhighlight lang="javascript">
-    var activity = new Activity("folderview")
+var activity = new Activity("folderview")
 The string passed into the constructor maps to the X-KDE-PluginInfo-Name= entry
@@ Line 160: / Line 163: @@
 New Panels can be created using the Panel constructor, like this:
+<syntaxhighlight lang="javascript">
-    var panel = new Panel("dock")
+var panel = new Panel("dock")
+</syntaxhighlight>
 The string passed into the constructor maps to the X-KDE-PluginInfo-Name= entry
 in the plugin's .desktop file).
@@ Line 200: / Line 203: @@
 * '''remove()''': deletes this activity and all widgets inside of it
 * ''Widget'' '''widgetById(number id)''': returns an object representing the widget with the given id
-* ''Widget'' '''addWidget(String name)''': adds a new widget to the activity; the name maps to the X-KDE-PluginInfo-Name= entry
+* ''Widget'' '''addWidget(String name)''': adds a new widget to the activity; the name maps to the <tt>X-KDE-PluginInfo-Name=</tt> entry in the widget's .desktop file
-  in the widget's .desktop file
 * ''Widget'' '''addWidget(Widget widget)''': adds an existing widget to this activity; useful for moving widgets between Activities and Panels
 * '''showConfigurationInteface()''': shows the configuration user interface for this Activity or Panel on the screen
 * '''readConfig(String key, any default)''': (scriptingVersion >= 2) reads the value of key in the config with default for the default value
 * '''writeConfig(String key, any value)''': (scriptingVersion >= 2) sets key to value in the config
-* '''readGlobalConfig(String key, any default)''': (scriptingVersion >= 2) reads the value of key in the global config with default
+* '''readGlobalConfig(String key, any default)''': (scriptingVersion >= 2) reads the value of key in the global config with default for the default value
-  for the default value
 * '''writeGlobalConfig(String key, any value)''': (scriptingVersion >= 2) sets key to value in the global config
 * '''reloadConfig()''': (scriptingVersion >= 2) causes the Activity or Panel to reload its configuration; reaction to configuration changes made using readConfig are usually activated on script exit, but this can be triggered earlier on a per-widget basis using this method
@@ Line 248: / Line 249: @@
 * '''remove()''': deletes this widget
-* '''readConfig(String key, any default)''': reads the value of key in the config with default
+* '''readConfig(String key, any default)''': reads the value of key in the config with default for the default value
-  for the default value
 * '''writeConfig(String key, any value)''': sets key to value in the config
-* '''readGlobalConfig(String key, any default)''': (scriptingVersion >= 2) reads the value of key in the global config with default
+* '''readGlobalConfig(String key, any default)''': (scriptingVersion >= 2) reads the value of key in the global config with default for the default value
-  for the default value
 * '''writeGlobalConfig(String key, any value)''': (scriptingVersion >= 2) sets key to value in the global config
 * '''reloadConfig()''': causes the widget to reload its configuration; reaction to configuration changes made using readConfig are usually activated on script exit, but this can be triggered earlier on a per-widget basis using this method
@@ Line 466: / Line 465: @@
 ==== Add a widget to systemtray ====
 You can not add widgets to the systemtray in a similar way like you would add them to a panel or containment using addWidget. Instead, to add, manage and remove them, you need to utilize writeConfig changing the currentConfigGroup.
-<syntaxhighlight lang="bash">systray = panel.addWidget("systemtray")	// First add a systemtray to your panel
+<syntaxhighlight lang="cpp-qt">
-systray.currentConfigGroup = Array("Applets","0")		// then change the currentConfig Group
+systray = panel.addWidget("systemtray")	// First add a systemtray to your panel
-																										// to the subnode [Applets][0]. Use any number you like(?)</syntaxhighlight>
+systray.currentConfigGroup = Array("Applets","0") // then change the currentConfig Group
 Now you can “create” the plasmoid by adding a “plugin” configuration entry
-<syntaxhighlight lang="bash">systray.writeConfig("plugin","notifier")	// This will add a Device Notifier Plasmoid</syntaxhighlight>
+<syntaxhighlight lang="cpp-qt">
 You can modify the plasmoid’s configuration by using writeConfig.
-<syntaxhighlight lang="bash">systray.writeConfig("property","value")</syntaxhighlight>
+<syntaxhighlight lang="cpp-qt">
 To change back to the top configuration level and thus edit the systemtray plasmoid itself pass an empty array to currentConfigGroup.