Development/Tutorials/SuperKaramba - Revision history

Neverendingo: Text replace - "" to ""

2011-06-29T20:56:35Z

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

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


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

				
				
				
				
			
			← Older revision
			Revision as of 20:46, 29 June 2011
			
Line 178:
Line 178:
    
  The first line is the shebang that causes Unix-like operating systems to execute the script file using the SuperKaramba interpreter. You are then able to start the karamba script with;   The first line is the shebang that causes Unix-like operating systems to execute the script file using the SuperKaramba interpreter. You are then able to start the karamba script with;
− <code> + <syntaxhighlight lang="text">
  chmod 755 myKaramba.py   chmod 755 myKaramba.py
  ./myKaramba.py   ./myKaramba.py
Line 595:
Line 595:
    
  And here is the shortest version that needs only one single line of text. Just put following line into a SuperKaramba theme file;   And here is the shortest version that needs only one single line of text. Just put following line into a SuperKaramba theme file;
− <code> + <syntaxhighlight lang="text">
  text x=0 y=0 sensor=plasma engine="time" source="Local" format="%Date %Time" poperties="reportSeconds:true,someOtherIntProperty:815"   text x=0 y=0 sensor=plasma engine="time" source="Local" format="%Date %Time" poperties="reportSeconds:true,someOtherIntProperty:815"
  </code>   </code>



Neverendingo: Text replace - "" to ""

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

				
				
				
				
			
			← Older revision
			Revision as of 20:43, 29 June 2011
			
Line 192:
Line 192:
  theme written in Ruby. The theme just displays the current time in a RichText widget.   theme written in Ruby. The theme just displays the current time in a RichText widget.
    
− <code ruby> + <syntaxhighlight lang="ruby">
  require 'karamba'   require 'karamba'
    
Line 469:
Line 469:
  The following sample script written in Ruby demonstrates that you are able to use [http://rubyforge.org/projects/korundum/ QtRuby/Korundum] within your Ruby scripts.   The following sample script written in Ruby demonstrates that you are able to use [http://rubyforge.org/projects/korundum/ QtRuby/Korundum] within your Ruby scripts.
    
− <code ruby> + <syntaxhighlight lang="ruby">
  require 'karamba'   require 'karamba'
  require 'Qt'   require 'Qt'



Neverendingo: Text replace - "" to ""

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

				
				
				
				
			
			← Older revision
			Revision as of 20:39, 29 June 2011
			
Line 144:
Line 144:
    
  You DO NOT need to compile your scripting code. SuperKaramba will do that automatically and tell you about any errors. In fact, you can't run your .py or .rb file directly in regular python because it doesn't know anything about the karamba.* functions. Those functions only exist inside of SuperKaramba's Python and Ruby interpreters. But you are for sure able to just use SuperKaramba as your interpreter direct from within the commandline. Just start SuperKaramba with something like:   You DO NOT need to compile your scripting code. SuperKaramba will do that automatically and tell you about any errors. In fact, you can't run your .py or .rb file directly in regular python because it doesn't know anything about the karamba.* functions. Those functions only exist inside of SuperKaramba's Python and Ruby interpreters. But you are for sure able to just use SuperKaramba as your interpreter direct from within the commandline. Just start SuperKaramba with something like:
− <code bash> + <syntaxhighlight lang="bash">
  superkaramba ./coolbar.theme   superkaramba ./coolbar.theme
  </code>   </code>



Neverendingo: Text replace - "" to ""

2011-06-29T20:35:54Z
Text replace - "<code javascript>" to "<syntaxhighlight lang="javascript">"

				
				
				
				
			
			← Older revision
			Revision as of 20:35, 29 June 2011
			
Line 238:
Line 238:
    
  There we have the currentTime() function that returns the current time as string. That function is used within the initWidget() and the widgetUpdated() functions to display the current time within a textwidget.   There we have the currentTime() function that returns the current time as string. That function is used within the initWidget() and the widgetUpdated() functions to display the current time within a textwidget.
− <code javascript> + <syntaxhighlight lang="javascript">
  var text = 0;   var text = 0;
    



Neverendingo: Text replace - "" to ""

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

				
				
				
				
			
			← Older revision
			Revision as of 20:34, 29 June 2011
			
Line 99:
Line 99:
  Now, lets open up your coolbar.py (or coolbar.rb or whatever you named it to) scripting file. Look for the event callback that reacts to mouse movement. If you chose Python as your prefered scripting language, it may look like this:   Now, lets open up your coolbar.py (or coolbar.rb or whatever you named it to) scripting file. Look for the event callback that reacts to mouse movement. If you chose Python as your prefered scripting language, it may look like this:
    
− <code python> + <syntaxhighlight lang="python">
  #This gets called everytime our widget is clicked.   #This gets called everytime our widget is clicked.
  #Notes   #Notes
Line 128:
Line 128:
    
  Here is how the callback might look after you add some code to it:   Here is how the callback might look after you add some code to it:
− <code python> + <syntaxhighlight lang="python">
  def widgetMouseMoved(widget, x, y, button):   def widgetMouseMoved(widget, x, y, button):
       myText = karamba.getThemeText(widget, "mouseText")        myText = karamba.getThemeText(widget, "mouseText")
Line 172:
Line 172:
  As described at the Python Enhancement Proposal [http://www.python.org/peps/pep-0263.html Defining Python Source Code Encodings] it is recommed to start a python script file with following both lines:   As described at the Python Enhancement Proposal [http://www.python.org/peps/pep-0263.html Defining Python Source Code Encodings] it is recommed to start a python script file with following both lines:
    
− <code python> + <syntaxhighlight lang="python">
  #!/usr/bin/env superkaramba   #!/usr/bin/env superkaramba
  # coding: utf-8   # coding: utf-8
Line 213:
Line 213:
  Let's take a look at another theme. The [http://websvn.kde.org/trunk/KDE/kdeutils/superkaramba/examples/text/text.py?view=markup text.py] theme written in Python just displays some text widgets. We take this as example to create our own script, that does the same as the [http://websvn.kde.org/trunk/KDE/kdeutils/superkaramba/examples/rubyclock/clock.rb?view=markup clock.rb] above, that is to display the current time within a text widget.   Let's take a look at another theme. The [http://websvn.kde.org/trunk/KDE/kdeutils/superkaramba/examples/text/text.py?view=markup text.py] theme written in Python just displays some text widgets. We take this as example to create our own script, that does the same as the [http://websvn.kde.org/trunk/KDE/kdeutils/superkaramba/examples/rubyclock/clock.rb?view=markup clock.rb] above, that is to display the current time within a text widget.
    
− <code python> + <syntaxhighlight lang="python">
  import karamba, time   import karamba, time
    
Line 272:
Line 272:
  The following sample Python script demonstrates how to display a messagebox.   The following sample Python script demonstrates how to display a messagebox.
    
− <code python> + <syntaxhighlight lang="python">
  import karamba, Kross   import karamba, Kross
    
Line 285:
Line 285:
  While the next sample Python script displays a dialog with an embedded "Open File" widget.   While the next sample Python script displays a dialog with an embedded "Open File" widget.
    
− <code python> + <syntaxhighlight lang="python">
  import karamba, Kross   import karamba, Kross
    
Line 304:
Line 304:
  For sure you are also able to use those handy UI-files the QtDesigner produces like demonstrated on the sample below.   For sure you are also able to use those handy UI-files the QtDesigner produces like demonstrated on the sample below.
    
− <code python> + <syntaxhighlight lang="python">
  import karamba, os, Kross   import karamba, os, Kross
    
Line 326:
Line 326:
  The following python sample code, which is also available as [http://websvn.kde.org/trunk/KDE/kdeutils/superkaramba/examples/WebBrowser/webbrowser.py?view=markup webbrowser.py], demonstrates this by embedding a full webbrowser into your Karamba by using the [[Projects/SuperKaramba/API#CanvasWidget|CanvasWidget]] functionality.   The following python sample code, which is also available as [http://websvn.kde.org/trunk/KDE/kdeutils/superkaramba/examples/WebBrowser/webbrowser.py?view=markup webbrowser.py], demonstrates this by embedding a full webbrowser into your Karamba by using the [[Projects/SuperKaramba/API#CanvasWidget|CanvasWidget]] functionality.
    
− <code python> + <syntaxhighlight lang="python">
  #!/usr/bin/env superkaramba   #!/usr/bin/env superkaramba
  # coding: utf-8   # coding: utf-8
Line 374:
Line 374:
  While the sample is written in Python, the other supported backends like Ruby are able to access the whole same rich API.   While the sample is written in Python, the other supported backends like Ruby are able to access the whole same rich API.
    
− <code python> + <syntaxhighlight lang="python">
  import karamba, Kross   import karamba, Kross
    
Line 424:
Line 424:
  The following python script shows how to use [http://www.riverbankcomputing.co.uk/pyqt/ PyQt] which provides the nice Qt-API pythonized. The sample just displays a "hello world" dialog if you click on the widget.   The following python script shows how to use [http://www.riverbankcomputing.co.uk/pyqt/ PyQt] which provides the nice Qt-API pythonized. The sample just displays a "hello world" dialog if you click on the widget.
    
− <code python> + <syntaxhighlight lang="python">
  import karamba   import karamba
  from PyQt4 import QtCore, QtGui   from PyQt4 import QtCore, QtGui
Line 449:
Line 449:
  You are also able to use the default toolkit Python comes with, that is TkInter. The following sample just displays a TkInter "hello world" dialog if you click on the widget.   You are also able to use the default toolkit Python comes with, that is TkInter. The following sample just displays a TkInter "hello world" dialog if you click on the widget.
    
− <code python> + <syntaxhighlight lang="python">
  import karamba   import karamba
  from Tkinter import *   from Tkinter import *
Line 496:
Line 496:
  The following sample script written in Python just prints a list with services available via [http://dbus.freedesktop.org/ D-Bus];   The following sample script written in Python just prints a list with services available via [http://dbus.freedesktop.org/ D-Bus];
    
− <code python> + <syntaxhighlight lang="python">
  import karamba, dbus   import karamba, dbus
    
Line 516:
Line 516:
  The following Python script uses [http://dbus.freedesktop.org/ D-Bus] to display a list with all the devices accessible with [http://www.freedesktop.org/wiki/Software/hal HAL];   The following Python script uses [http://dbus.freedesktop.org/ D-Bus] to display a list with all the devices accessible with [http://www.freedesktop.org/wiki/Software/hal HAL];
    
− <code python> + <syntaxhighlight lang="python">
  import karamba, dbus   import karamba, dbus
    
Line 557:
Line 557:
  Following Python sample demonstrates usage of the Plasma::DataEngine functionality by using the TimeEngine to display the current local time.   Following Python sample demonstrates usage of the Plasma::DataEngine functionality by using the TimeEngine to display the current local time.
    
− <code python> + <syntaxhighlight lang="python">
  import karamba   import karamba
  def initWidget(widget):   def initWidget(widget):
Line 569:
Line 569:
  You are also able to provide an own handle that defines what should be done if the Plasma::DataEngine has new or updated data for an widget or a meter.   You are also able to provide an own handle that defines what should be done if the Plasma::DataEngine has new or updated data for an widget or a meter.
    
− <code python> + <syntaxhighlight lang="python">
  # Import the SuperKaramba module.   # Import the SuperKaramba module.
  import karamba   import karamba
Line 605:
Line 605:
  Now lets take a more detailed look at a longer sample that uses SuperKaramba and the PlasmaApplet module. While the sample above runs in all cases, the following sample does not cause the used PlasmaApplet module will be only available if SuperKaramba is running as Plasma Applet. If you are running SuperKaramba as standalone application this wan't work (is there interest for this? - but both ways provide the same rich API functionality to work with Plasma::DataEngine's anyway).   Now lets take a more detailed look at a longer sample that uses SuperKaramba and the PlasmaApplet module. While the sample above runs in all cases, the following sample does not cause the used PlasmaApplet module will be only available if SuperKaramba is running as Plasma Applet. If you are running SuperKaramba as standalone application this wan't work (is there interest for this? - but both ways provide the same rich API functionality to work with Plasma::DataEngine's anyway).
    
− <code python> + <syntaxhighlight lang="python">
  # Import the needed modules.   # Import the needed modules.
  import karamba, PlasmaApplet   import karamba, PlasmaApplet
Line 656:
Line 656:
  Following does the same as the sample above but connects the time Plasma::DataEngine with a meter-widget of SuperKaramba. The script will run once and compared to the sample above it's not needed to provide a widgetUpdated function but SuperKaramba will take care of updating the meter if the time Plasma::DataEngine provides new/updated data.   Following does the same as the sample above but connects the time Plasma::DataEngine with a meter-widget of SuperKaramba. The script will run once and compared to the sample above it's not needed to provide a widgetUpdated function but SuperKaramba will take care of updating the meter if the time Plasma::DataEngine provides new/updated data.
    
− <code python> + <syntaxhighlight lang="python">
  # Import the needed modules.   # Import the needed modules.
  import karamba, PlasmaApplet   import karamba, PlasmaApplet



Dipesh: /* Plasma */
2008-03-04T07:53:53Z
‎Plasma

				
				
				
				
			
			← Older revision
			Revision as of 07:53, 4 March 2008
			
Line 547:
Line 547:
  See also...   See also...
  * [[Projects/Plasma|Plasma Project]]   * [[Projects/Plasma|Plasma Project]]
  + * [http://kross.dipe.org/skapplet.png screenshot]
  + * [http://kross.dipe.org/skapplet.mpeg screencast], 2.4MB, mpeg4
  * [http://www.kdedevelopers.org/node/2907 SuperKaramba and Plasma, Part 2]   * [http://www.kdedevelopers.org/node/2907 SuperKaramba and Plasma, Part 2]
  * [http://www.kdedevelopers.org/node/3305 SuperKaramba and Plasma Packages]   * [http://www.kdedevelopers.org/node/3305 SuperKaramba and Plasma Packages]





Dipesh: /* SuperKaramba and Plasma */
2008-03-04T07:53:26Z
‎SuperKaramba and Plasma

				
				
				
				
			
			← Older revision
			Revision as of 07:53, 4 March 2008
			
Line 162:
Line 162:
  SuperKaramba runs as standalonea-application - just run the program "superkaramba" - as well as [[Projects/Plasma|Plasma]] Applet embedded into the Plasma Workspace. Also SuperKaramba provides full and transparent access to the Plasma::DataEngine's with it's sensor functionality.   SuperKaramba runs as standalonea-application - just run the program "superkaramba" - as well as [[Projects/Plasma|Plasma]] Applet embedded into the Plasma Workspace. Also SuperKaramba provides full and transparent access to the Plasma::DataEngine's with it's sensor functionality.
    
− * [http://kross.dipe.org/skapplet.png screenshot] + See also the [[Development/Tutorials/SuperKaramba#Plasma|Plasma script samples]] section.
− * [http://kross.dipe.org/skapplet.mpeg screencast], 2.4MB, mpeg4 + 
− * [http://www.kdedevelopers.org/node/3305 SuperKaramba and Plasma Packages] + 
− * [[Development/Tutorials/SuperKaramba#Plasma|Plasma script samples]] + 
    
  ===Scripting Interpreter Backends===   ===Scripting Interpreter Backends===



Dipesh at 07:52, 4 March 2008
2008-03-04T07:52:22Z


				
				
				
				
			
			← Older revision
			Revision as of 07:52, 4 March 2008
			
Line 551:
Line 551:
  * [[Projects/Plasma|Plasma Project]]   * [[Projects/Plasma|Plasma Project]]
  * [http://www.kdedevelopers.org/node/2907 SuperKaramba and Plasma, Part 2]   * [http://www.kdedevelopers.org/node/2907 SuperKaramba and Plasma, Part 2]
  + * [http://www.kdedevelopers.org/node/3305 SuperKaramba and Plasma Packages]
  * [http://websvn.kde.org/trunk/KDE/kdeutils/superkaramba/examples/plasmaAppletClock/ AppletClock sample]   * [http://websvn.kde.org/trunk/KDE/kdeutils/superkaramba/examples/plasmaAppletClock/ AppletClock sample]
    



Dipesh: /* PlasmaApplet */
2008-03-04T07:50:22Z
‎PlasmaApplet

				
				
				
				
			
			← Older revision
			Revision as of 07:50, 4 March 2008
			
Line 599:
Line 599:
  </code>   </code>
    
− ====PlasmaApplet====  
    
− Now follows a short sample that offers a pure Plasma implementation to display the current local time.  
−  
− <code python>  
− # Import the PlasmaApplet module.  
− import PlasmaApplet  
− # Create a TimeEngine  
− engine = PlasmaApplet.dataEngine("time")  
− # Update each second.  
− engine.setProperty("reportSeconds", True)  
− # Create a Plasma LineEdit widget.  
− widget = PlasmaApplet.widget("LineEdit")  
− # Connect widget with the engine.  
− engine.connectSource("Local", widget)  
− </code>  
    
  ====Plasma and SuperKaramba====   ====Plasma and SuperKaramba====

← Older revision		Revision as of 07:50, 4 March 2008
Line 599:		Line 599:
	</code>		</code>

−	~~====PlasmaApplet====~~

−	~~Now follows a short sample that offers a pure Plasma implementation to display the current local time.~~
−
−	~~<code python>~~
−	~~# Import the PlasmaApplet module.~~
−	~~import PlasmaApplet~~
−	~~# Create a TimeEngine~~
−	~~engine = PlasmaApplet.dataEngine("time")~~
−	~~# Update each second.~~
−	~~engine.setProperty("reportSeconds", True)~~
−	~~# Create a Plasma LineEdit widget.~~
−	~~widget = PlasmaApplet.widget("LineEdit")~~
−	~~# Connect widget with the engine.~~
−	~~engine.connectSource("Local", widget)~~
−	~~</code>~~

	====Plasma and SuperKaramba====		====Plasma and SuperKaramba====