Merge lp:~eduardo-mucelli/cairo-dock-plug-ins-extras/demo_ruby into lp:~cairo-dock-team/cairo-dock-plug-ins-extras/third-party

[Eduardo Mucelli Rezende Oliveira]

New applet demo_ruby

A applet for demonstration of Ruby Dbus and Cairo-Dock interaction.

[Matthieu Baerts (matttbe)]

review: Disapprove (duplicated branch)

=== modified file 'RubyBattery/RubyBattery'
--- RubyBattery/RubyBattery	2010-03-25 01:38:53 +0000
+++ RubyBattery/RubyBattery	2010-03-26 15:07:19 +0000
@@ -56,7 +56,7 @@
 	MenuShowCharge 	= 1
 	MenuShowAlert 	= 2
 
-	DialogActiveTime = 5
+	DialogActiveTime = 5																# dialog windows will keep opened this value in seconds
 
 	def initialize (applet, conf)
 		@icon = applet
@@ -83,6 +83,7 @@
 
 	def set_initial_graphic_configurations
 		@icon.SetLabel(@conf.params['Icon']['name'])
+		p "GAUGE #{@conf.params['Configuration']['theme']}"
 		@icon.AddDataRenderer("gauge", 1, @conf.params['Configuration']['theme'])		# o padrao é Ruby-Battery
 	end
 
@@ -159,12 +160,12 @@
 	def retrieve_battery_information
 		raw_info = ""
 		raw_temperature = ""
-		IO.popen("acpi -t") { |f|
+		IO.popen("acpi -b") { |f|														# charge and status in its raw form
 			raw_info = f.first.chomp.strip.split(':').last.strip.split(',')
+		}
+		IO.popen("acpi -t") {|f|														# temperature in its raw form
 			raw_temperature = f.readlines.last.chomp.strip.split(',').last.strip
 		}
-		# o raw_info tem [status, carga] quando a bateria esta ligada e [status, carga, mensagem] quando desligada "Discharging"
-		# remove-se o valor "mensagem" e mantem-se pegando o primeiro e o ultimo elemento
 		if raw_info.first == "Discharging" || raw_info.first == "Charging"
 			raw_info.delete raw_info.last
 		end

=== modified file 'RubyBattery/RubyBattery.conf'
--- RubyBattery/RubyBattery.conf	2010-03-25 01:38:53 +0000
+++ RubyBattery/RubyBattery.conf	2010-03-26 15:07:19 +0000
@@ -91,5 +91,5 @@
 [Configuration]
 
 #h+[/usr/share/cairo-dock/gauges;gauges;gauges] Choose one of the available themes :/
-# Remember that there is a gauge made to this applet, Ruby-Batter. Read the README file.
+# Remember that there is a gauge made to this applet, Ruby-Battery. Read the README file.
 theme = Battery

=== modified file 'RubyBattery/auto-load.conf'
--- RubyBattery/auto-load.conf	2010-03-25 01:38:53 +0000
+++ RubyBattery/auto-load.conf	2010-03-26 15:07:19 +0000
@@ -10,4 +10,4 @@
 category = 2
 
 # Version of the applet; change it everytime you change something in the config file. Don't forget to update the version both in this file and in the config file.
-version = 0.0.1
+version = 0.0.2

=== added directory 'demos/demo_ruby'
=== added file 'demos/demo_ruby/README'
--- demos/demo_ruby/README	1970-01-01 00:00:00 +0000
+++ demos/demo_ruby/README	2010-03-26 15:07:19 +0000
@@ -0,0 +1,19 @@
+In order to use this applet, it is necessary to install Ruby, Rubygems and the gems rbus and parseconfig.
+
+# Installation process (Debian/Ubuntu)
+
+* Ruby: (sudo) apt-get install ruby1.8-dev ruby1.8 ri1.8 rdoc1.8 irb1.8 libreadline-ruby1.8 libruby1.8 rubygems1.8 acpi
+* Gem Rbus: (sudo) gem install rbus
+* Gem parseconfig: (sudo) gem install parseconfig
+(if you don't have Rubygems: Instructions are neatly described in http://rubygems.org/pages/download)
+
+# Tips
+
+When running Cairo-Dock through terminal, for example, cairo-dock -c, check if any message regarding execution permission is being shown. If so, set execution permission to the applet, chmod a+x 755 demo_ruby
+
+# Contact me
+
+Any doubt, suggestion or anything else, except asking for some money, I would be pleased to received a message from you.
+
+Author: Eduardo Mucelli Rezende Oliveira
+E-mail: [e-mail] or [e-mail]

=== added file 'demos/demo_ruby/auto-load.conf'
--- demos/demo_ruby/auto-load.conf	1970-01-01 00:00:00 +0000
+++ demos/demo_ruby/auto-load.conf	2010-03-26 15:07:19 +0000
@@ -0,0 +1,13 @@
+[Register]
+
+# Author of the applet
+author = Eduardo Mucelli Rezende Oliveira
+
+# A short description of the applet and how to use it.
+description = This is a distant applet\nIt simulates a counter:\n Scroll up/down to increase/decrease the counter,\n Click/middle-click to increase/decrease the counter by 10\n Drop some text to set it as the label.
+
+# Category of the applet : 2 = accessory, 3 = Desktop, 4 = Controler
+category = 2
+
+# Version of the applet; change it everytime you change something in the config file. Don't forget to update the version both in this file and in the config file.
+version = 0.0.1

=== added file 'demos/demo_ruby/demo_ruby'
--- demos/demo_ruby/demo_ruby	1970-01-01 00:00:00 +0000
+++ demos/demo_ruby/demo_ruby	2010-03-26 15:07:19 +0000
@@ -0,0 +1,183 @@
+#!/usr/bin/ruby
+
+# This is a part of the external demo_ruby applet for Cairo-Dock
+#
+# Author: Eduardo Mucelli Rezende Oliveira
+# E-mail: [e-mail] or [e-mail]
+#
+# This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+
+# This very simple applet features a counter from 0 to max_value. It displays the counter on the icon with a gauge and a quick info.
+# Scroll on the icon increase or decrease the counter
+# The menu offers the possibility to set some default value
+# Left click on the icon will set a random value
+# Middle click on the icon will raise a dialog asking you to set the value you want
+# If you drop some text on the icon, it will be used as the icon's label
+# Be aware to the messages, they are very wise :-)
+
+require 'rubygems'
+require 'rbus'
+require 'parseconfig'
+
+applet_name = File.basename(Dir.getwd)						 							# nome do applet, neste caso é demo_ruby
+applet_path = "/org/cairodock/CairoDock/#{applet_name}"  	 							# path where our object is stored on the bus
+
+bus = RBus.session_bus
+applet_object = bus.get_object('org.cairodock.CairoDock', applet_path)					# the main icon object
+applet_object.interface!('org.cairodock.CairoDock.applet')								# get the services available to the main icon
+
+applet_sub_icons_object = bus.get_object("org.cairodock.CairoDock", "#{applet_path}/sub_icons")
+applet_sub_icons_object.interface!("org.cairodock.CairoDock.subapplet")  				# list of icons contained in our sub-dock, or in our desklet
+
+conf_file = "#{Dir.getwd}/#{applet_name}.conf"											# configuration file does not need to be verified
+conf = ParseConfig.new(conf_file)
+
+class String
+	def to_b																			# string to boolean
+	    ["true", "1", "T", "t"].include?(self.downcase)
+    end
+end
+
+class Applet
+	attr_accessor :counter, :configuration
+	def initialize (applet, applet_sub_icons, conf)
+		@icon = applet
+		@sub_icons = applet_sub_icons
+		@conf = conf
+		self.counter = 0
+		self.configuration = get_configuration_parameters
+	end
+	def start
+		@icon.ShowDialog("I'm connected to Cairo-Dock !", 4)  							# show a dialog with this message for 4 seconds
+		@icon.SetQuickInfo("#{self.counter}")			  								# write the counter value on the icon
+		@icon.AddDataRenderer("gauge", 1, self.configuration['theme'])  				# set 1 gauge with the theme read in config
+		@icon.RenderValues([Float(self.counter)/self.configuration['max_value']])  		# draw the gauge with an initial value
+		
+		@sub_icons.AddSubIcons(["icon 1", "firefox-3.0", "id1", "icon 3", "thunderbird", "id3", "icon 4", "nautilus", "id4"])	
+		@sub_icons.RemoveSubIcon("id2") 												# remove the 2nd icon of our sub-dock
+		@sub_icons.SetQuickInfo("1", "id1")  											# write the ID on each icon of the sub-dock
+		@sub_icons.SetQuickInfo("3", "id3")
+		@sub_icons.SetQuickInfo("4", "id4")
+		get_user_actions
+	end
+	def get_configuration_parameters
+		c = {}
+		c['max_value'] = @conf.params['Configuration']['max value'].to_i
+		c['theme'] = @conf.params['Configuration']['theme']
+		c['yes_no'] = @conf.params['Configuration']['yesno'].to_b
+		c
+	end
+	def get_user_actions
+		@icon.connect!(:on_click) do |param|
+			action_on_click
+		end
+		@icon.connect!(:on_build_menu) do |param|										# when user right-clicks on our applet (which builds the menu)
+			action_on_build_menu														
+		end
+		@icon.connect!(:on_menu_select) do |menu_id|									# when the user selected some menu build on build_menu action
+			action_on_menu_select menu_id
+		end
+		@icon.connect!(:on_scroll) do |scroll_direction|								# when the user scroll the mouse up or down on the icon
+			action_on_scroll scroll_direction											# scroll down param = false, scroll up param = true
+		end
+		@icon.connect!(:on_drop_data) do |dropped_date|									# something was dragged n dropped into the icon
+			action_on_drop_data dropped_date
+		end
+		@icon.connect!(:on_middle_click) do |param|
+			action_on_middle_click
+		end
+		@icon.connect!(:on_answer) do |answer|											# answer from some Ask* method
+			action_on_answer answer
+		end
+		@icon.connect!(:on_stop_module) do |param|
+			action_on_stop  															# DBus plug-in or applet deactivated, or Cairo-Dock stopped
+		end
+		@sub_icons.connect!(:on_click_sub_icon) do |state, icon_id|
+			action_on_click_sub_icon state, icon_id											# when the user left-clicks on a sub-icon
+		end
+	end
+
+	# callbacks on the main icon
+	def action_on_click
+		p "[+] roger, right-click"
+		render_counter (rand self.configuration['max_value'])
+	end
+	def action_on_middle_click
+		p "[+] yes sir, middle-click received"
+		@icon.AskValue("Set the value you want", self.counter, self.configuration['max_value'])
+	end
+	def action_on_build_menu
+		p "[+] let's build the menu"
+		@icon.PopulateMenu(["set min value", "set medium value", "set max value"])
+	end
+	def action_on_menu_select param
+		p "[+] let me guess, somebody chose the menu identified by the ID #{param}"
+		if param == 0
+			render_counter 0
+		elsif param == 1
+			render_counter self.configuration['max_value']/2
+		else
+			render_counter self.configuration['max_value']
+		end
+	end
+	def action_on_scroll scroll_up
+		p "[+] is there anybody out there scrolling #{scroll_up ? "up" : "down"} on my icon ?"
+		if scroll_up
+			count = [self.configuration['max_value'], self.counter + 1].min
+		else
+			count = [0, self.counter - 1].max
+		end
+		render_counter count
+	end
+	def action_on_drop_data dropped_data
+		print "[+] ops, someone let #{dropped_data} fall into my icon"
+		@icon.SetLabel(dropped_data)
+	end
+	def action_on_answer answer
+		p "[+] answer: #{answer}"
+		render_counter answer
+	end
+
+	# callbacks on the applet
+	def action_on_stop
+		p "[+] bye bye"
+		exit
+	end
+	def action_on_reload config_has_changed
+		p "[+] our module was reloaded, welcome back!"
+		if config_has_changed
+			p "[+] and our config has been changed"
+			self.configuration = get_configuration_parameters
+			@icon.AddDataRenderer("gauge", 1, myApplet.config['theme'])
+			@icon.RenderValues([Float(self.counter)/self.configuration['max_value']])
+			@sub_icons.RemoveSubIcon("any")
+			@sub_icons.AddSubIcons(["icon 1", "firefox-3.0", "id1", "icon 2", "natilus", "id2", "icon 3", "thunderbird", "id3"]) 
+		else
+			p "[-] but the config is the same"
+		end
+	end
+	
+	# callbacks on the sub-icons
+	def action_on_click_sub_icon state, icon_id
+		p "[+] something tells me that you clicked on the icon #{icon_id}"
+	end
+
+	def render_counter cont
+		self.counter = cont																# equivalent to the set_count method in demo_python
+		percent = Float(self.counter) / self.configuration['max_value']
+		@icon.RenderValues([percent])
+		@icon.SetQuickInfo("#{self.counter.to_i}")
+	end
+end
+
+applet = Applet.new applet_object, applet_sub_icons_object, conf
+applet.start
+RBus.mainloop

=== added file 'demos/demo_ruby/demo_ruby.conf'
--- demos/demo_ruby/demo_ruby.conf	1970-01-01 00:00:00 +0000
+++ demos/demo_ruby/demo_ruby.conf	2010-03-26 15:07:19 +0000
@@ -0,0 +1,101 @@
+#!en;0.0.2
+
+#[gtk-about]
+[Icon]
+#j+[0;128] Desired icon size for this applet
+#{Set to 0 to use the default applet size}
+icon size = 0;0
+
+#s Name of the icon as it will appear in its label in the dock :
+name = Dbus Applet
+
+#S+ Image's filename :
+#{Let empty to use the default one.}
+icon = 
+
+#d Name of the dock it belongs to:
+dock name = 
+
+order=
+
+#F[Applet's Handbook]
+frame_hand=
+#A
+handbook=demo_ruby
+
+#[gtk-convert]
+[Desklet]
+
+#j+[48;512] Desklet's dimension (width x height) :
+#{Depending on your WindowManager, you can resize it with ALT + middle_click or ALT + left_click for exemple.}
+size = 164;96
+
+#i[-2048;2048] Desklet's position (x ; y) :
+#{Depending on your WindowManager, you can move it with ALT + left_click}
+x position=0
+#i[-2048;2048] ...
+y position=0
+
+#b Is detached from the dock ?
+initially detached=false
+#l[Normal;Keep above;Keep below;On Widget Layer;Reserve space] Accessibility :
+#{for CompizFusion's "widget layer", set behaviour in Compiz to: (class=Cairo-dock & type=utility)}
+accessibility=0
+#b Should be visible on all desktops ?
+sticky=true
+
+#b Lock position ?
+#{If locked, the desklet can't be moved by simply dragging it with the left mouse button. Of course you can still move it with ALT + left_click.}
+locked = false
+
+#I[-180;180] Rotation :
+#{in degrees.}
+rotation = 0
+
+use size=
+
+#F[Decorations;gtk-orientation-portrait]
+frame_deco=
+
+#o+ Choose a decoration theme for this desklet :
+#{Choose the 'personnal' one to define your own decorations below.}
+decorations = default
+
+#v
+sep_deco =
+
+#S+ Background image :
+#{It's an image that will be displayed below the drawings, like a frame for exemple. Let empty to not use any.}
+bg desklet =
+#e+[0;1] Background tansparency :
+bg alpha = 1
+#i+[0;256] Left offset :
+#{in pixels. Use this to adjust the left position of the drawings.}
+left offset = 0
+#i+[0;256] Top offset :
+#{in pixels. Use this to adjust the top position of the drawings.}
+top offset = 0
+#i+[0;256] Right offset :
+#{in pixels. Use this to adjust the right position of the drawings.}
+right offset = 0
+#i+[0;256] Bottom offset :
+#{in pixels. Use this to adjust the bottom position of the drawings.}
+bottom offset = 0
+#S+ Foreground image :
+#{It's an image that will be displayed above the drawings, like a reflect for exemple. Let empty to not use any.}
+fg desklet =
+#e+[0;1] Foreground tansparency :
+fg alpha = 1
+
+#[gtk-preferences]
+[Configuration]
+
+#h+[/usr/share/cairo-dock/gauges;gauges;gauges] Choose one of the available themes :/
+theme = Turbo-night
+
+#i[10;100] Max value :
+max value = 100
+
+#b Yes / No  ?
+yesno = false
+

=== added file 'demos/demo_ruby/icon'
Binary files demos/demo_ruby/icon	1970-01-01 00:00:00 +0000 and demos/demo_ruby/icon	2010-03-26 15:07:19 +0000 differ