Development/Tutorials/Plasma/PythonPlasmoid - Revision history

Neverendingo: Text replace - "" to ""

2011-06-29T20:54:19Z

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

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


2011-06-29T20:37:03Z
Text replace - "<code ini>" to "<syntaxhighlight lang="ini">"

				
				
				
				
			
			← Older revision
			Revision as of 20:37, 29 June 2011
			
Line 19:
Line 19:
  metadata.desktop contains the plasmoid's metadata such as its name, author, and scripting engine.   metadata.desktop contains the plasmoid's metadata such as its name, author, and scripting engine.
    
− <code ini> + <syntaxhighlight lang="ini">
    [Desktop Entry]     [Desktop Entry]
    #Encoding of this file     #Encoding of this file



Neverendingo: Text replace - "" to ""

2011-06-29T20:34:34Z
Text replace - "<code python>" to "<syntaxhighlight lang="python">"

				
				
				
				
			
			← Older revision
			Revision as of 20:34, 29 June 2011
			
Line 55:
Line 55:
    
  The first thing you do in a python file of course is import your dependencies:   The first thing you do in a python file of course is import your dependencies:
− <code python> + <syntaxhighlight lang="python">
    # -*- coding: utf-8 -*-     # -*- coding: utf-8 -*-
    from PyQt4.QtCore import *     from PyQt4.QtCore import *
Line 65:
Line 65:
  The last import contains the bridge between your python code and the underlying C++ API. If you were writing this in C++, you'd inherit the Plasma::Applet class. It isn't as straightforward in Python though. There is some python wrapper code (in /usr/lib/python2.5/site-packages/PyKDE4/plasmascript.py) that needs to work some magic so your python script can access protected Plasma::Applet members.   The last import contains the bridge between your python code and the underlying C++ API. If you were writing this in C++, you'd inherit the Plasma::Applet class. It isn't as straightforward in Python though. There is some python wrapper code (in /usr/lib/python2.5/site-packages/PyKDE4/plasmascript.py) that needs to work some magic so your python script can access protected Plasma::Applet members.
    
− <code python> + <syntaxhighlight lang="python">
  # Continued from above   # Continued from above
    
Line 91:
Line 91:
    
  ===Connecting to the engine===   ===Connecting to the engine===
− <code python> + <syntaxhighlight lang="python">
  # Continued from above   # Continued from above
    
Line 106:
Line 106:
  ===Reading updates===   ===Reading updates===
    
− <code python> + <syntaxhighlight lang="python">
  # Continued from above   # Continued from above
    
Line 127:
Line 127:
  Two simple lines accomplish this:   Two simple lines accomplish this:
    
− <code python> + <syntaxhighlight lang="python">
    def CreateApplet(parent):     def CreateApplet(parent):
        return PowerChart(parent)         return PowerChart(parent)
Line 141:
Line 141:
  For reference, here is the complete source of main.py:   For reference, here is the complete source of main.py:
    
− <code python> + <syntaxhighlight lang="python">
    # -*- coding: utf-8 -*-     # -*- coding: utf-8 -*-
    from PyQt4.QtCore import *     from PyQt4.QtCore import *



Kitamozihr: Added space before else: self.engine...
2010-02-05T12:16:26Z
Added space before else: self.engine...

				
				
				
				
			
			← Older revision
			Revision as of 12:16, 5 February 2010
			
Line 170:
Line 170:
               print("you don't appear to have a battery.")                print("you don't appear to have a battery.")
               [self.chart.addSample([v]) for v in [1,  2,  3,  1]]                [self.chart.addSample([v]) for v in [1,  2,  3,  1]]
−         else: +          else:
               self.engine.connectSource(battery, self)                self.engine.connectSource(battery, self)
           



FranklinHyde: plasmoidviewer objects to semicolon comment characters in desktop file
2009-11-17T19:03:24Z
plasmoidviewer objects to semicolon comment characters in desktop file

				
				
				
				
			
			← Older revision
			Revision as of 19:03, 17 November 2009
			
Line 21:
Line 21:
  <code ini>   <code ini>
    [Desktop Entry]     [Desktop Entry]
−   ;Encoding of this file +   #Encoding of this file
    Encoding=UTF-8     Encoding=UTF-8
−   ;The name to be shown in the 'Add Widgets' dialog +   #The name to be shown in the 'Add Widgets' dialog
    Name=Battery Graph     Name=Battery Graph
−   ;Tells KDE this is provides the 'Plasma applet'   +   #Tells KDE this is provides the 'Plasma applet'  
    ServiceTypes=Plasma/Applet     ServiceTypes=Plasma/Applet
−   ;Tells KDE this is a service of sorts +   #Tells KDE this is a service of sorts
    Type=Service     Type=Service
−   ;The icon to show in the 'Add Widgets' dialog +   #The icon to show in the 'Add Widgets' dialog
    Icon=battery     Icon=battery
−   ;The language your plugin is written in +   #The language your plugin is written in
    X-Plasma-API=python     X-Plasma-API=python
−   ;The main entrypoint for your plasmoid +   #The main entrypoint for your plasmoid
    X-Plasma-MainScript=code/main.py     X-Plasma-MainScript=code/main.py
    
Line 39:
Line 39:
    X-KDE-PluginInfo-Author=John Doe     X-KDE-PluginInfo-Author=John Doe
    X-KDE-PluginInfo-Email=j.doe@example.com     X-KDE-PluginInfo-Email=j.doe@example.com
−   ;The internal name of the plasmoid. Your plasmoid gets installed into ~/.kde/share/apps/plasma/<Name>/ +   #The internal name of the plasmoid. Your plasmoid gets installed into ~/.kde/share/apps/plasma/<Name>/
    X-KDE-PluginInfo-Name=powerchart     X-KDE-PluginInfo-Name=powerchart
    X-KDE-PluginInfo-Version=pre0.1     X-KDE-PluginInfo-Version=pre0.1
Line 46:
Line 46:
    X-KDE-PluginInfo-Depends=     X-KDE-PluginInfo-Depends=
    X-KDE-PluginInfo-License=GPL     X-KDE-PluginInfo-License=GPL
−   ;Tells KDE if this plasmoid should be available by default, or if the user needs to jump through hoops to enable it. +   #Tells KDE if this plasmoid should be available by default, or if the user needs to jump through hoops to enable it.
    X-KDE-PluginInfo-EnabledByDefault=true     X-KDE-PluginInfo-EnabledByDefault=true
  </code>   </code>



Jriddell: fix ServiceType line
2009-08-31T19:56:31Z
fix ServiceType line

				
				
				
				
			
			← Older revision
			Revision as of 19:56, 31 August 2009
			
Line 26:
Line 26:
    Name=Battery Graph     Name=Battery Graph
    ;Tells KDE this is provides the 'Plasma applet'       ;Tells KDE this is provides the 'Plasma applet'  
−   ServiceTypes=Plasma/Appletservice +   ServiceTypes=Plasma/Applet
    ;Tells KDE this is a service of sorts     ;Tells KDE this is a service of sorts
    Type=Service     Type=Service





Tampakrap at 12:36, 14 August 2009
2009-08-14T12:36:56Z


				
				
				
				
			
			← Older revision
			Revision as of 12:36, 14 August 2009
			
Line 21:
Line 21:
  <code ini>   <code ini>
    [Desktop Entry]     [Desktop Entry]
−   Encoding=UTF-8 ;Encoding of this file +   ;Encoding of this file
−   Name=Battery Graph ;The name to be shown in the 'Add Widgets' dialog +   Encoding=UTF-8
−   ServiceTypes=Plasma/Applet ;Tells KDE this is provides the 'Plasma applet' service +  ;The name to be shown in the 'Add Widgets' dialog
−   Type=Service ;Tells KDE this is a service of sorts +   Name=Battery Graph
−   Icon=battery ;The icon to show in the 'Add Widgets' dialog +  ;Tells KDE this is provides the 'Plasma applet'  
−   X-Plasma-API=python ;The language your plugin is written in +   ServiceTypes=Plasma/Appletservice
−   X-Plasma-MainScript=code/main.py ;The main entrypoint for your plasmoid +  ;Tells KDE this is a service of sorts
  +   Type=Service
  +  ;The icon to show in the 'Add Widgets' dialog
  +   Icon=battery
  +  ;The language your plugin is written in
  +   X-Plasma-API=python
  +  ;The main entrypoint for your plasmoid
  +  X-Plasma-MainScript=code/main.py
  +  
           
    X-KDE-PluginInfo-Author=John Doe     X-KDE-PluginInfo-Author=John Doe
    X-KDE-PluginInfo-Email=j.doe@example.com     X-KDE-PluginInfo-Email=j.doe@example.com
−   X-KDE-PluginInfo-Name=powerchart ;The internal name of the plasmoid. Your plasmoid gets installed into ~/.kde/share/apps/plasma/<Name>/ +   ;The internal name of the plasmoid. Your plasmoid gets installed into ~/.kde/share/apps/plasma/<Name>/
  +  X-KDE-PluginInfo-Name=powerchart
    X-KDE-PluginInfo-Version=pre0.1     X-KDE-PluginInfo-Version=pre0.1
    X-KDE-PluginInfo-Website=http://plasma.kde.org/     X-KDE-PluginInfo-Website=http://plasma.kde.org/
Line 37:
Line 46:
    X-KDE-PluginInfo-Depends=     X-KDE-PluginInfo-Depends=
    X-KDE-PluginInfo-License=GPL     X-KDE-PluginInfo-License=GPL
−   X-KDE-PluginInfo-EnabledByDefault=true ;Tells KDE if this plasmoid should be available by default, or if the user needs to jump through hoops to enable it. +   ;Tells KDE if this plasmoid should be available by default, or if the user needs to jump through hoops to enable it.
  +  X-KDE-PluginInfo-EnabledByDefault=true
  </code>   </code>
    



Tampakrap at 03:28, 20 July 2009
2009-07-20T03:28:23Z


				
				
				
				
			
			← Older revision
			Revision as of 03:28, 20 July 2009
			
Line 124:
Line 124:
  =Packaging=   =Packaging=
    
− Plasma packages are zip files that adhere to the expected directory structure explained at the start of this tutorial. You can call your file anything you want, but a good naming scheme is <Name>-<Version>.plasmoid eg powerchart-pre0.1.plasmoid. Remember while creating it, that the root of the package structure explained earlier means the root of the zip file. + Plasma packages are zip files that adhere to the expected directory structure explained at the start of this tutorial ([[Development/Tutorials/Plasma/Python/GettingStarted#Packaging.2C_installing_.26_running|link]]). You can call your file anything you want, but a good naming scheme is <Name>-<Version>.plasmoid eg powerchart-pre0.1.plasmoid. Remember while creating it, that the root of the package structure explained earlier means the root of the zip file.
    
  Create it, install it, and add it to your desktop. Makes you feel proud, huh?   Create it, install it, and add it to your desktop. Makes you feel proud, huh?



Gatoatigrado at 02:52, 20 July 2009
2009-07-20T02:52:22Z


				
				
				
				
			
			← Older revision
			Revision as of 02:52, 20 July 2009
			
Line 1:
Line 1:
  In this example, we're going to be writing a plasmoid that shows your laptop's battery charge in a neat graph as time goes by. Then we'll package it up and install it.   In this example, we're going to be writing a plasmoid that shows your laptop's battery charge in a neat graph as time goes by. Then we'll package it up and install it.
    
− =Building= + = Building =
  First and foremost, make sure you have [[Getting Started/Build/KDE4/Python Support|Python support enabled]].   First and foremost, make sure you have [[Getting Started/Build/KDE4/Python Support|Python support enabled]].
    
Line 13:
Line 13:
  **** main.py - The plugin's code. You can change this in metadata.desktop.   **** main.py - The plugin's code. You can change this in metadata.desktop.
    
− ==metadata.desktop== + To run it, try
  +  plasmoidviewer [root of the package]
  +  
  + == metadata.desktop ==
  metadata.desktop contains the plasmoid's metadata such as its name, author, and scripting engine.   metadata.desktop contains the plasmoid's metadata such as its name, author, and scripting engine.
    
Line 154:
Line 157:
            battery = self.engine.query('IS Battery').values()[0].toString()             battery = self.engine.query('IS Battery').values()[0].toString()
            print "Connecting to battery %s"%battery             print "Connecting to battery %s"%battery
−           self.engine.connectSource(battery, self) +           if not battery:
  +             print("you don't appear to have a battery.")
  +             [self.chart.addSample([v]) for v in [1,  2,  3,  1]]
  +         else:
  +             self.engine.connectSource(battery, self)
           
        @pyqtSignature("dataUpdated(const QString &, const Plasma::DataEngine::Data &)")         @pyqtSignature("dataUpdated(const QString &, const Plasma::DataEngine::Data &)")



Tampakrap: fix incorrect "it's"
2009-05-12T22:09:59Z
fix incorrect "it's"

				
				
				
				
			
			← Older revision
			Revision as of 22:09, 12 May 2009
			
Line 14:
Line 14:
    
  ==metadata.desktop==   ==metadata.desktop==
− metadata.desktop contains the plasmoid's metadata such as it's name, author, and scripting engine. + metadata.desktop contains the plasmoid's metadata such as its name, author, and scripting engine.
    
  <code ini>   <code ini>

@@ Line 48: / Line 48: @@
   #Tells KDE if this plasmoid should be available by default, or if the user needs to jump through hoops to enable it.
   X-KDE-PluginInfo-EnabledByDefault=true
-</code>
+</syntaxhighlight>
 Once you have that, you can start hacking away.
@@ Line 61: / Line 61: @@
   from PyKDE4.plasma import Plasma
   from PyKDE4 import plasmascript
-</code>
+</syntaxhighlight>
 The last import contains the bridge between your python code and the underlying C++ API. If you were writing this in C++, you'd inherit the Plasma::Applet class. It isn't as straightforward in Python though. There is some python wrapper code (in /usr/lib/python2.5/site-packages/PyKDE4/plasmascript.py) that needs to work some magic so your python script can access protected Plasma::Applet members.
@@ Line 82: / Line 82: @@
           self.chart.setTitle("Battery Charge")
           self.connectToEngine()
-</code>
+</syntaxhighlight>
 The init() method is where you should put the majority of your initialization code such as creating widgets and loading data engines.
@@ Line 99: / Line 99: @@
           print "Connecting to battery %s"%battery
           self.engine.connectSource(battery, self)
-</code>
+</syntaxhighlight>
 As mentioned earlier, the plasmascript module contains some magic bridge code that lets you access protected members while python thinks you're outside the Applet class. With the odd exception of self.applet, everything else works like normal.
@@ Line 115: / Line 115: @@
           samples = [charge,]
           self.chart.addSample(samples)
-</code>
+</syntaxhighlight>
 A problem with mixing Python with Qt's signals is the lack of type safety. To get around this, you need to manually declare the dataUpdated slot's signature with the pyqtSignature decorator. Another problem is the use of QStrings. It makes things take a little more typing but it doesn't add a whole lot more effort.
@@ Line 130: / Line 130: @@
   def CreateApplet(parent):
       return PowerChart(parent)
-</code>
+</syntaxhighlight>
 =Packaging=
@@ Line 182: / Line 182: @@
   def CreateApplet(parent):
       return PowerChart(parent)
-</code>
+</syntaxhighlight>
 Happy hacking!