Development/Tutorials/Plasma/RubyApplet - Revision history

AnneW at 15:32, 15 July 2012

2012-07-15T15:32:03Z

M.agostinelli: /* Translate to new syntax highlighting */

2011-06-28T09:54:29Z

‎Translate to new syntax highlighting

Alisha at 02:47, 17 January 2010

2010-01-17T02:47:33Z

Nielsslot: Add a warning message on the top of the page indication that this tutorial doesn't work on KDE 4.2.

2009-02-09T20:53:12Z

Add a warning message on the top of the page indication that this tutorial doesn't work on KDE 4.2.

Nahy.ya.ru at 13:05, 22 September 2008

2008-09-22T13:05:02Z

Dipesh at 23:50, 13 July 2008

2008-07-13T23:50:30Z

Dipesh at 22:51, 13 July 2008

2008-07-13T22:51:49Z

Dipesh at 18:59, 13 July 2008

2008-07-13T18:59:27Z

Dipesh at 18:42, 13 July 2008

2008-07-13T18:42:22Z

Dipesh at 18:40, 13 July 2008

2008-07-13T18:40:24Z

← Older revision		Revision as of 15:32, 15 July 2012
Line 1:		Line 1:
−	~~{{Template:I18n/Language Navigation Bar\|Development/Tutorials/Plasma/RubyApplet}}~~	+

	Warning: This tutorial is outdated. It doesn't work on KDE 4.2. This article is being kept for future translation to the current way of developing a Ruby Plasma applet. If you're looking for a tutorial on how to write a Plasma applet in Ruby on KDE 4.2 and later, have a look at the [[Development/Tutorials/Plasma/Ruby/GettingStarted\|Getting Started]] tutorial.		Warning: This tutorial is outdated. It doesn't work on KDE 4.2. This article is being kept for future translation to the current way of developing a Ruby Plasma applet. If you're looking for a tutorial on how to write a Plasma applet in Ruby on KDE 4.2 and later, have a look at the [[Development/Tutorials/Plasma/Ruby/GettingStarted\|Getting Started]] tutorial.

@@ Line 19: / Line 19: @@
 For our webbrowser applet we use the [http://websvn.kde.org/trunk/KDE/kdebindings/ruby/plasma/examples/applets/webapplet/plasma-ruby-applet-web.desktop?view=markup plasma-ruby-applet-web.desktop] desktop file which looks like;
-<code>
+<syntaxhighlight lang="ini">
 [Desktop Entry]
 Name=Ruby Web Browser
@@ Line 36: / Line 36: @@
 X-KDE-PluginInfo-License=GPL
 X-KDE-PluginInfo-EnabledByDefault=true
-</code>
+</syntaxhighlight>
 The important parts within those desktop service file are the referenced X-KDE-Library which will be loaded on request and is responsible for executing our with X-KDE-PluginKeyword defined Ruby scrip file. Our applet will be known by Plasma under the unique name "plasma-ruby-web-applet".
@@ Line 46: / Line 46: @@
 The [http://websvn.kde.org/trunk/KDE/kdebindings/ruby/plasma/examples/applets/webapplet/web_applet.rb?view=markup web_applet.rb] ruby script looks like;
-<code ruby>
+<syntaxhighlight lang="ruby">
 # import the plasma-applet functionality which we need to
 # implement our own webbrowser applet.
@@ Line 121: / Line 121: @@
    end
 end
-</code>
+</syntaxhighlight>
 That was already all the code needed to implement our own webbrowser Applet using the Ruby language. The in this sample used [http://doc.trolltech.com/4.4/qtwebkit.html webbrowser] does provide additional functionality to use optional a full powered webbrowser or adopt it to your needings.
@@ Line 129: / Line 129: @@
 To install the Applet the [http://websvn.kde.org/trunk/KDE/kdebindings/ruby/plasma/examples/applets/webapplet/CMakeLists.txt?view=markup CMakeLists.txt] is used. It basically does copy the both files above to the right locations. Translated to command-line arguments it would look like;
-<code>
+<syntaxhighlight lang="bash">
 sudo cp plasma-ruby-applet-web.desktop `kde4-config --install services`
 sudo mkdir `kde4-config --install data`/plasma_ruby_web_applet/
 sudo cp web_applet.rb `kde4-config --install data`/plasma_ruby_web_applet/
-</code>
+</syntaxhighlight>
 what installs the both files to the global installation directory to make hem available for all users on your sysem. If you like to have them accessible only from within one user, then just copy those both files to the users $KDEHOME (the command "kde4-config --localprefix" should provide you a hint where that may be).
@@ Line 139: / Line 139: @@
 To take a look at your applet or test it during development, you can;
-<code>
+<syntaxhighlight lang="bash">
 kbuildsycoca4
 plasmoidviewer plasma-ruby-web-applet
-</code>
+</syntaxhighlight>
 where the kbuildsycoca4 does rebuild the desktop-cache to update changes done to the desktop file. The plasmoidviewer is a tool that allows you to start and view your applet outside of plasma.

← Older revision		Revision as of 02:47, 17 January 2010
Line 146:		Line 146:
	where the kbuildsycoca4 does rebuild the desktop-cache to update changes done to the desktop file. The plasmoidviewer is a tool that allows you to start and view your applet outside of plasma.		where the kbuildsycoca4 does rebuild the desktop-cache to update changes done to the desktop file. The plasmoidviewer is a tool that allows you to start and view your applet outside of plasma.
	[[Media:Example.ogg]]		[[Media:Example.ogg]]
		+
		+	[[Category:Ruby]]

← Older revision		Revision as of 20:53, 9 February 2009
Line 1:		Line 1:
	{{Template:I18n/Language Navigation Bar\|Development/Tutorials/Plasma/RubyApplet}}		{{Template:I18n/Language Navigation Bar\|Development/Tutorials/Plasma/RubyApplet}}
		+
		+	Warning: This tutorial is outdated. It doesn't work on KDE 4.2. This article is being kept for future translation to the current way of developing a Ruby Plasma applet. If you're looking for a tutorial on how to write a Plasma applet in Ruby on KDE 4.2 and later, have a look at the [[Development/Tutorials/Plasma/Ruby/GettingStarted\|Getting Started]] tutorial.
		+
	==Abstract==		==Abstract==

← Older revision		Revision as of 13:05, 22 September 2008
Line 1:		Line 1:
		+	{{Template:I18n/Language Navigation Bar\|Development/Tutorials/Plasma/RubyApplet}}
	==Abstract==		==Abstract==

Line 141:		Line 142:

	where the kbuildsycoca4 does rebuild the desktop-cache to update changes done to the desktop file. The plasmoidviewer is a tool that allows you to start and view your applet outside of plasma.		where the kbuildsycoca4 does rebuild the desktop-cache to update changes done to the desktop file. The plasmoidviewer is a tool that allows you to start and view your applet outside of plasma.
		+	[[Media:Example.ogg]]

@@ Line 1: / Line 1: @@
 ==Abstract==
 This tutorial shows how to create your own Plasma Widget/Applet/Plasmoid using the Ruby scripting language.
 See also:
 * [http://www.kdedevelopers.org/node/3560 Writing Plasma Applets in C# and Ruby]
 * [http://websvn.kde.org/trunk/KDE/kdebindings/ruby/plasma/examples/ Ruby and Plasma examples]
 ==The desktop file==
@@ Line 37: / Line 38: @@
 ==The Ruby Script==
-It follows the Ruby scripting code which does implement the whole functionality to display a webbrowser within the applet and to browse around using the displayed links.
+It follows the Ruby scripting code which does implement the whole functionality to display a webbrowser within the applet and to browse around those content.
-[http://websvn.kde.org/trunk/KDE/kdebindings/ruby/plasma/examples/applets/webapplet/web_applet.rb?view=markup web_applet.rb]
+The [http://websvn.kde.org/trunk/KDE/kdebindings/ruby/plasma/examples/applets/webapplet/web_applet.rb?view=markup web_applet.rb] ruby script looks like;
 <code ruby>

@@ Line 6: / Line 6: @@
 * [[Development/Tutorials/Qt4_Ruby_Tutorial|Qt4 Ruby Tutorial]]
 * [http://www.kdedevelopers.org/node/3560 Writing Plasma Applets in C# and Ruby]
 ==The desktop file==
@@ Line 25: / Line 26: @@
 X-KDE-PluginInfo-Name=plasma-ruby-web-applet
-X-KDE-PluginInfo-Version=pre0.1
+X-KDE-PluginInfo-Version=0.1
 X-KDE-PluginInfo-Category=Web
 X-KDE-PluginInfo-Depends=QtRuby
@@ Line 48: / Line 49: @@
 module PlasmaRubyWebApplet
-   # The WebApplet class does implement the Plasma::Applet.
+   # The WebApplet class does implement a Plasma::Applet.
    class WebApplet < Plasma::Applet
@@ Line 107: / Line 108: @@
      def constraintsEvent(constraints)
        if constraints.to_i & Plasma::SizeConstraint.to_i
          @page.resize(size())
        end
@@ Line 115: / Line 118: @@
 </code>
-That was already all the code needed to implement our own webbrowser Applet using the Ruby language. The in this sample used [http://doc.trolltech.com/4.4/qtwebkit.html browser] does provide for sure much more functionality.
+That was already all the code needed to implement our own webbrowser Applet using the Ruby language. The in this sample used [http://doc.trolltech.com/4.4/qtwebkit.html webbrowser] does provide additional functionality to use optional a full powered webbrowser or adopt it to your needings.
 ==Install and test the Applet==

@@ Line 1: / Line 1: @@
 ==Abstract==
-This tutorial shows how to create your own Plasmoids using the Ruby scripting language.
+This tutorial shows how to create your own Plasma Widget/Applet/Plasmoid using the Ruby scripting language.
 ==The desktop file==
@@ Line 7: / Line 11: @@
 The desktop file is the entry-point to our applet. It does define what the applet is for and how it should be loaded and handled by plasma.
-[http://websvn.kde.org/trunk/KDE/kdebindings/ruby/plasma/examples/applets/webapplet/plasma-ruby-applet-web.desktop?view=markup plasma-ruby-applet-web.desktop]
+For our webbrowser applet we use the [http://websvn.kde.org/trunk/KDE/kdebindings/ruby/plasma/examples/applets/webapplet/plasma-ruby-applet-web.desktop?view=markup plasma-ruby-applet-web.desktop] desktop file which looks like;
 <code>
@@ Line 32: / Line 36: @@
 ==The Ruby Script==
-It follows the Ruby scripting code which does implement the whole functionality to display a webbrowser within the applet and to allow to browse around.
+It follows the Ruby scripting code which does implement the whole functionality to display a webbrowser within the applet and to browse around using the displayed links.
 [http://websvn.kde.org/trunk/KDE/kdebindings/ruby/plasma/examples/applets/webapplet/web_applet.rb?view=markup web_applet.rb]
@@ Line 41: / Line 45: @@
 require 'plasma_applet'
-# we define an own module
+# We define an own module
 module PlasmaRubyWebApplet
-   # the WebApplet class does implement the Plasma::Applet
+   # The WebApplet class does implement the Plasma::Applet.
    class WebApplet < Plasma::Applet
-     # the both slots used by our applet.
+     # The both slots used by our applet.
      slots 'load(QUrl)',
            'loadFinished(bool)'
-     # constructor.
+     # Constructor for our WebApplet class.
      def initialize(parent, args)
        super
      end
-     # on initialization this method will be called.
+     # On initialization this method will be called by plasma. Here we
      def init
-       # let's start with a nice default size.
+       # Let's start with a nice default size.
        resize(600, 400)
-       # create the Browser widget which will display the content.
+       # Create the Browser widget which will display the content
        @page = Plasma::WebContent.new(self)
        @page.page = Qt::WebPage.new(@page)
@@ Line 68: / Line 75: @@
          Qt::WebSettings::LinksIncludedInFocusChain, true)
        connect(@page, SIGNAL('loadFinished(bool)'),
                self, SLOT('loadFinished(bool)'))
@@ Line 73: / Line 81: @@
                self, SLOT('load(QUrl)'))
-       # start browsing some webpage
+       # Start browsing some webpage
        @page.url = Qt::Url.new("http://dot.kde.org/")
      end
-     # this method will be called once the user clicks on a link. we
+     # This method will be called once the user clicks on a link.
-     # just load the defined url and display it.
+     # We just load the defined URL-address and let the
      def load(url)
        puts "Loading #{url.toString}"
@@ Line 84: / Line 93: @@
      end
-     # this method will be called once loading a page finished.
+     # This method will be called once loading a page finished.
      def loadFinished(success)
        puts "page loaded #{@page.page.currentFrame.url.toString}"
      end
-     # this method will be called each time a constraint changed. the
+     # This method will be called each time a constraint changed. the
      # for us most interesting constraints are;
      # * LocationConstraint if the location of the applet changed
@@ Line 105: / Line 114: @@
 end
 </code>
 ==Install and test the Applet==
-To install the applet the [http://websvn.kde.org/trunk/KDE/kdebindings/ruby/plasma/examples/applets/webapplet/CMakeLists.txt?view=markup CMakeLists.txt] is used. It basicly does copy the both files above to the right locations
+To install the Applet the [http://websvn.kde.org/trunk/KDE/kdebindings/ruby/plasma/examples/applets/webapplet/CMakeLists.txt?view=markup CMakeLists.txt] is used. It basically does copy the both files above to the right locations. Translated to command-line arguments it would look like;
 <code>
-cp plasma-ruby-applet-web.desktop `kde4-config --install services`
+sudo cp plasma-ruby-applet-web.desktop `kde4-config --install services`
-cp web_applet.rb `kde4-config --install data`/plasma_ruby_web_applet/
+sudo mkdir `kde4-config --install data`/plasma_ruby_web_applet/
 </code>
-what installs the both files for all users. If you like to have them accessible only from within one user, then just copy those both files to your $KDEHOME where the command "kde4-config --localprefix" should provide you a hint where that may be :)
+what installs the both files to the global installation directory to make hem available for all users on your sysem. If you like to have them accessible only from within one user, then just copy those both files to the users $KDEHOME (the command "kde4-config --localprefix" should provide you a hint where that may be).
-To take a look at your applet or test it during the developing, you can fire up;
+To take a look at your applet or test it during development, you can;
 <code>
@@ Line 124: / Line 136: @@
 </code>
-where the kbuildsycoca4 does rebuild the desktop-cache to update changes done at the desktop file. The plasmoidviewer is a tool that allows you to start and view your applet outside of plasma.
+where the kbuildsycoca4 does rebuild the desktop-cache to update changes done to the desktop file. The plasmoidviewer is a tool that allows you to start and view your applet outside of plasma.