Development/Tutorials/Plasma/PythonRunner - Revision history

Hein: /* The metadata.desktop file */

2011-12-30T02:48:09Z

‎The metadata.desktop file

Hein: /* Code */ Missing colon.

2011-12-30T02:48:02Z

‎Code: Missing colon.

Hein: Consistent runner naming.

2011-12-30T02:47:43Z

Consistent runner naming.

Neverendingo: Text replace - "" to ""

2011-06-29T20:54:19Z

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

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


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

				
				
				
				
			
			← Older revision
			Revision as of 20:37, 29 June 2011
			
Line 18:
Line 18:
  First, edit the metadata.desktop file so that it looks similar to this:   First, edit the metadata.desktop file so that it looks similar to this:
    
− <code ini> + <syntaxhighlight lang="ini">
    [Desktop Entry]     [Desktop Entry]
  Name=Msgbox runner   Name=Msgbox runner



Neverendingo: Text replace - "" to ""

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

				
				
				
				
			
			← Older revision
			Revision as of 20:34, 29 June 2011
			
Line 42:
Line 42:
  The runner is a python class, and additionally you must provide a method for Plasma to create an instance.   The runner is a python class, and additionally you must provide a method for Plasma to create an instance.
    
− <code python> + <syntaxhighlight lang="python">
    from PyKDE4 import plasmascript     from PyKDE4 import plasmascript
  from PyKDE4.plasma import Plasma   from PyKDE4.plasma import Plasma



Bhards: /* The metadata.desktop file */
2011-04-26T02:01:23Z
‎The metadata.desktop file

				
				
				
				
			
			← Older revision
			Revision as of 02:01, 26 April 2011
			
Line 16:
Line 16:
  == The metadata.desktop file ==   == The metadata.desktop file ==
    
− First, edit the metadata.desktop file, to look simlar to this: + First, edit the metadata.desktop file so that it looks similar to this:
    
  <code ini>   <code ini>
Line 36:
Line 36:
  </code>   </code>
    
− The last line is not strictly nessecary, but convenient. Notice the ServiceType, which differs from other Plasma objects. + The last line is not strictly necessary, but convenient. Note that ServiceTypes value is different from other Plasma objects.
    
  == Code ==   == Code ==



Andersl: bit more text, use "hello world", clarify
2011-03-12T20:28:58Z
bit more text, use "hello world", clarify

				
				
				
				
			
			← Older revision
			Revision as of 20:28, 12 March 2011
			
Line 1:
Line 1:
− In this example, we're going to be writing a sample KRunner plugin, that will just display the entered text in a messagebox. Then we'll test it and finally package it up for distribution. + In this example, we're going to be writing a sample KRunner plugin, that will just display the entered text in a messagebox. It is also demonstrated how to use a keyword, and how to add help to krunner. 
  +  
  + After creating the plugin, we'll test it and finally package it up for distribution.
    
  = Building =   = Building =
Line 48:
Line 50:
    
       def init(self)        def init(self)
  +         # called upon creation to let us run any intialization
           # tell the user how to use this runner            # tell the user how to use this runner
           self.addSyntax(Plasma.RunnerSyntax("msg :q:", "Display :q: in a messagebox"))            self.addSyntax(Plasma.RunnerSyntax("msg :q:", "Display :q: in a messagebox"))
Line 62:
Line 65:
                return                 return
    
−          # ignore less than 3 characters +          # ignore less than 3 characters (in addition to the keyword)
           if q.length < 7:            if q.length < 7:
               return                return
Line 85:
Line 88:
    
  def CreateRunner(parent):   def CreateRunner(parent):
  +     # called by krunner, must simply return an instance of the runner object
       return MsgBoxRunner(parent)        return MsgBoxRunner(parent)
  </code>   </code>
Line 94:
Line 98:
  = Test the plugin =   = Test the plugin =
    
− Now you should be ready to test the plugin, to install it, simply run + Now you should be ready to test the plugin, to install it, simply run (given the plugin is in directory "runner_msgbox")
    
−   $ plasmapkg --type runner --install <directory> +   $ plasmapkg --type runner --install runner_msgbox
    
− Now press ALT + F2 and type 'something', and you should see the command "Message 'something' in the match list, and if you run it, a messagebox should show, telling you "something" + Now press ALT + F2 and type 'msg hello world', and you should see the command "Message 'hello world' in the match list, and if you run it, a messagebox should show, greeting "hello world"
    
  I have learned that krunner should be restarted between updates, so if you change your script and reinstall it, restart krunner:   I have learned that krunner should be restarted between updates, so if you change your script and reinstall it, restart krunner:
    
−   $ plasmapkg --type runner --upgrade <directory> +   $ plasmapkg --type runner --upgrade runner_msgbox
    $ kquitapp krunner     $ kquitapp krunner
    $ # wait a moment     $ # wait a moment



Andersl: /* Distributing the plugin */
2011-03-12T20:08:46Z
‎Distributing the plugin

				
				
				
				
			
			← Older revision
			Revision as of 20:08, 12 March 2011
			
Line 111:
Line 111:
  Should you want to distribute your plugin, it is practical to pack it in a zip file that users can download:   Should you want to distribute your plugin, it is practical to pack it in a zip file that users can download:
    
−   $ zip -r msgbox_runner msgbox_runner +   $ zip -r runner_msgbox runner_msgbox
    
  The zip archive can be installed with plasmapkg, just as the directory:   The zip archive can be installed with plasmapkg, just as the directory:
    
−   $ plasmapkg -t runner -i mypackage.zip +   $ plasmapkg -t runner -i runner_msgbox.zip
    
  That's all, happy coding :-)   That's all, happy coding :-)



Andersl: /* Distributing the plugin */ fix zip syntax
2011-03-12T20:07:26Z
‎Distributing the plugin:  fix zip syntax

				
				
				
				
			
			← Older revision
			Revision as of 20:07, 12 March 2011
			
Line 111:
Line 111:
  Should you want to distribute your plugin, it is practical to pack it in a zip file that users can download:   Should you want to distribute your plugin, it is practical to pack it in a zip file that users can download:
    
−   $ zip <directory> +   $ zip -r msgbox_runner msgbox_runner
    
  The zip archive can be installed with plasmapkg, just as the directory:   The zip archive can be installed with plasmapkg, just as the directory:

@@ Line 34: / Line 34: @@
 X-KDE-PluginInfo-License=LGPLv3
 X-KDE-PluginInfo-EnabledByDefault=true
-</code>
+</syntaxhighlight>
 The last line is not strictly necessary, but convenient. Note that ServiceTypes value is different from other Plasma objects.
@@ Line 90: / Line 90: @@
      # called by krunner, must simply return an instance of the runner object
      return MsgBoxRunner(parent)
-</code>
+</syntaxhighlight>
 It is as simple as that. Note that the CreateRunner function must be present, and return an instance of your runner class.