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

Neverendingo: Text replace - "`" to ""`


2011-06-29T21:07:47Z
Text replace - "<code javascript="javascript">" to "<syntaxhighlight lang="javascript">"

				
				
				
				
			
			← Older revision
			Revision as of 21:07, 29 June 2011
			
Line 31:
Line 31:
  The Simplified JavaScript API is powered by Qt's QtScript system which provides access to a full featured ECMA Script interpreter. If it works in ECMA Script, it will work in a Simplified JavaScript Plasmoid. As an interesting implementation note, QtScript uses the high performance ECMA Script interpreter from WebKit and shares this code with QtWebKit.     The Simplified JavaScript API is powered by Qt's QtScript system which provides access to a full featured ECMA Script interpreter. If it works in ECMA Script, it will work in a Simplified JavaScript Plasmoid. As an interesting implementation note, QtScript uses the high performance ECMA Script interpreter from WebKit and shares this code with QtWebKit.  
    
− On top of the ECMA Script language, QtScript provides Qt integration features. Probably the most useful one in this context is the use of signals and slots which is Qt's callback mechanism. Signals may be emitted in QtScript by calling the signal method in question, a signal can be connected to a slot by using the connect() method (and disconnected with disconnect()) and any function defined in the Plasmoid may be used as a slot. For example: <code javascript="javascript"> + On top of the ECMA Script language, QtScript provides Qt integration features. Probably the most useful one in this context is the use of signals and slots which is Qt's callback mechanism. Signals may be emitted in QtScript by calling the signal method in question, a signal can be connected to a slot by using the connect() method (and disconnected with disconnect()) and any function defined in the Plasmoid may be used as a slot. For example: <syntaxhighlight lang="javascript">
  function onClick()   function onClick()
  {   {

`Neverendingo: Text replace - "`" to ""

2011-06-29T20:53:48Z

Text replace - "</code>" to "</syntaxhighlight>"

Neverendingo: Text replace - "`" to ""`


2011-06-29T20:45:09Z
Text replace - "<code>" to "<syntaxhighlight lang="text">"

				
				
				
				
			
			← Older revision
			Revision as of 20:45, 29 June 2011
			
Line 49:
Line 49:
  </code> This will print out:     </code> This will print out:  
    
− <code> + <syntaxhighlight lang="text">
  We got clicked!   We got clicked!
  First click!   First click!



Aseigo at 12:37, 24 June 2011
2011-06-24T12:37:53Z


				
				
				
				
			
			← Older revision
			Revision as of 12:37, 24 June 2011
			
Line 3:
Line 3:
  This document provides an overview/reference of the Simplified JavaScript API for Plasmoids. The "Simplified" refers to the fact that it isn't a full binding to all of Qt or KDE's libraries, but a highly focused set of bindings designed to make writing Plasmoids fast and easy, while remaining powerful.   This document provides an overview/reference of the Simplified JavaScript API for Plasmoids. The "Simplified" refers to the fact that it isn't a full binding to all of Qt or KDE's libraries, but a highly focused set of bindings designed to make writing Plasmoids fast and easy, while remaining powerful.
    
− The API in this documentation covers the JavaScript API as it appears in the KDE Software Compilation as of version 4.4, unless otherwise noted. This API ships as part of the KDE Base Runtime package, so can be relied on being there by any application that is Powered By KDE. + The API in this documentation covers the JavaScript API as it appears in the KDE Software Compilation as of version 4.4 and higher. Changes between versions are noted in the documentation, including when new API functionality was introduced. This API ships as part of the KDE Base Runtime package, so can be relied on being there by any application that is Powered By KDE.
  +  
  + = Examples and Tutorials =
  +  
  + Tutorials can be found [[Development/Tutorials/Plasma|in the Plasma tutorials area here on Techbase]] and full, functioning examples can be found in the [https://projects.kde.org/projects/kde/kdeexamples KDE Examples] repository in the {{path|plasma/javascript}} folder.
  +  
  + = Using QML =
  +  
  + Starting with the KDE Platform 4.7 release, the Plasma team recommends writing your Plasmoids with [http://qt.nokia.com/qtquick/ QtQuick] technologies with the [http://techbase.kde.org/Development/Tutorials/Plasma#QML_Plasmoids Plasma QML integration API].
  +  
  + The QML API uses the same API as the Simplified JavaScript API with the exception of User Interface Elements, Animations and Events which are provided instead by QML itself.
  +  
  + The benefits of writing your Plasmoid with QML can include faster development with more sophisticated results visually and in its usability as well as much better performance when run in a QML-only Plasma shell such as Plasma Active.
    
  = What Is A Simplified JavaScript Plasmoid?  =   = What Is A Simplified JavaScript Plasmoid?  =



Aseigo: /* API */
2011-06-24T12:25:20Z
‎API

				
				
				
				
			
			← Older revision
			Revision as of 12:25, 24 June 2011
			
Line 60:
Line 60:
  * [[../API-Misc|Utility API and Objects]]   * [[../API-Misc|Utility API and Objects]]
  * [[../API-Extensions|Extensions]]   * [[../API-Extensions|Extensions]]
− ** [[../API-FileDialog|FileDialog]] + ** [[../API-FileDialog|File Dialog]]
− ** [[../API-LocalIO|Local IO|]] + ** [[../API-LocalIO|Local IO]]
  ** [[../API-NetworkIO|Network IO]]   ** [[../API-NetworkIO|Network IO]]
  ** [[../API-HTTP|HTTP]]   ** [[../API-HTTP|HTTP]]
  ** [[../API-LaunchApp|Launching Applications]]   ** [[../API-LaunchApp|Launching Applications]]
  * [[../API-Addons|Custom Addons (Plugins) in Javascript]]   * [[../API-Addons|Custom Addons (Plugins) in Javascript]]



Aseigo at 12:21, 24 June 2011
2011-06-24T12:21:08Z

Show changes


Aseigo at 12:10, 24 June 2011
2011-06-24T12:10:54Z

Show changes


Aseigo at 12:02, 24 June 2011
2011-06-24T12:02:51Z

Show changes


Aseigo: /* Extensions */
2011-05-27T09:39:36Z
‎Extensions

				
				
				
				
			
			← Older revision
			Revision as of 09:39, 27 May 2011
			
Line 1,549:
Line 1,549:
  * ''IOJob'' '''getUrl(Url url)''': attempts to fetch the file using an IOJob   * ''IOJob'' '''getUrl(Url url)''': attempts to fetch the file using an IOJob
  * ''IOJob'' '''getUrl(String url)''': attempts to fetch the file using an IOJob   * ''IOJob'' '''getUrl(String url)''': attempts to fetch the file using an IOJob
  + * ''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
  + ** music
  + ** video
  + ** downloads
  + ** pictures
  + ** autostart
  + ** desktop (should be considered deprecated for Plasma workspaces)
  + 
  + If a second string is passed in, it is considered a request for a specific path and the following types are recognized:
  + ** apps - Applications menu (.desktop files).
  + ** autostart - Autostart directories (both XDG and kde-specific)
  + ** cache - Cached information (e.g. favicons, web-pages)
  + ** cgi - CGIs to run from kdehelp.
  + ** config - Configuration files.
  + ** data - Where applications store data.
  + ** emoticons - Emoticons themes
  + ** exe - Executables in $prefix/bin. findExe() for a function that takes $PATH into account.
  + ** html - HTML documentation.
  + ** icon - Icons, see KIconLoader.
  + ** kcfg - KConfigXT config files.
  + ** lib - Libraries.
  + ** locale - Translation files for KLocale.
  + ** mime - Mime types defined by KDE-specific .desktop files.
  + ** module - Module (dynamically loaded library).
  + ** qtplugins - Qt plugins (dynamically loaded objects for Qt)
  + ** services - Services.
  + ** servicetypes - Service types.
  + ** sound - Application sounds.
  + ** templates - Templates for the "Create new file" functionality.
  + ** wallpaper - Wallpapers.
  + ** tmp - Temporary files (specific for both current host and current user)
  + ** socket - UNIX Sockets (specific for both current host and current user)
  + ** xdgconf-menu - Freedesktop.org standard location for menu layout (.menu) files.
  + ** xdgdata-apps - Freedesktop.org standard location for application desktop files.
  + ** xdgdata-dirs - Freedesktop.org standard location for menu descriptions (.directory files).
  + ** xdgdata-mime - Freedesktop.org standard location for MIME type definitions.
  + ** xdgdata-icon - Freedesktop.org standard location for icons.
  + ** xdgdata-pixmap - Gnome-compatibility location for pixmaps.
  + 
  + The second parameter should be a specific resource to find the path to. An example might be userDataPath("data", "plasma-desktop").
    
  === NetworkIO ===     === NetworkIO ===  
Line 1,572:
Line 1,613:
  * ''bool'' '''runCommand(string exe[, array args])''' <br>Runs the executable with the given arguments. Returns true on success, false on failure.   * ''bool'' '''runCommand(string exe[, array args])''' <br>Runs the executable with the given arguments. Returns true on success, false on failure.
  * ''bool'' '''openUrl([string|Url] url)''': <br>Opens the url in the default application (or asks the user if there is no default application for the file). The url parameter may be either a string or a Url. Returns true on success, false on failure.   * ''bool'' '''openUrl([string|Url] url)''': <br>Opens the url in the default application (or asks the user if there is no default application for the file). The url parameter may be either a string or a Url. Returns true on success, false on failure.
  + * ''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.



Nwoki: /* Geometry */
2011-05-24T19:05:59Z
‎Geometry

				
				
				
				
			
			← Older revision
			Revision as of 19:05, 24 May 2011
			
Line 206:
Line 206:
  * '''setPreferredSize(width, height)'''   * '''setPreferredSize(width, height)'''
  * '''setBackgroundHints(background)''' - use '''NoBackground''' as value if you want to remove the default plasmoid background box.   * '''setBackgroundHints(background)''' - use '''NoBackground''' as value if you want to remove the default plasmoid background box.
  + * '''popupIcon(QIcon("some icon"))''' - set icon to show when the plasmoid is added to the taskbar. NOTE if the plasmoid is made in QML, you MUST specify a default size for the main Item. This size will be used for the plasmoid when added to the taskbar
    
  === Painting and Layout  ===   === Painting and Layout  ===

@@ Line 47: / Line 47: @@
 button.clicked.connect(onFirstClick)
 button.clicked()
-</code> This will print out:
+</syntaxhighlight> This will print out:
 <syntaxhighlight lang="text">
 We got clicked!
 First click!
-</code>
+</syntaxhighlight>
 on the console when the Plasmoid starts, and the "We got clicked!" again whenever the button is clicked by the user.

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

Neverendingo: Text replace - "" to ""

Neverendingo: Text replace - "" to ""

Neverendingo: Text replace - "" to ""

Aseigo at 12:37, 24 June 2011

Aseigo: /* API */

Aseigo at 12:21, 24 June 2011

Aseigo at 12:10, 24 June 2011

Aseigo at 12:02, 24 June 2011

Aseigo: /* Extensions */

Nwoki: /* Geometry */

Neverendingo: Text replace - "`" to ""`

`Neverendingo: Text replace - "`" to ""

Neverendingo: Text replace - "`" to ""`