ruber 0.0.1.1

data/lib/ruber/main_window/ui/output_color_widget.ui

@@ -0,0 +1,204 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>OutputColorWidget</class>
+ <widget class="QWidget" name="OutputColorWidget">
+  <property name="geometry">
+   <rect>
+    <x>0</x>
+    <y>0</y>
+    <width>392</width>
+    <height>189</height>
+   </rect>
+  </property>
+  <property name="windowTitle">
+   <string>Form</string>
+  </property>
+  <layout class="QVBoxLayout" name="verticalLayout">
+   <item>
+    <layout class="QGridLayout" name="gridLayout">
+     <item row="0" column="1">
+      <widget class="QLabel" name="label_9">
+       <property name="text">
+        <string>Default</string>
+       </property>
+       <property name="alignment">
+        <set>Qt::AlignCenter</set>
+       </property>
+      </widget>
+     </item>
+     <item row="0" column="2">
+      <widget class="QLabel" name="label_8">
+       <property name="text">
+        <string>Good</string>
+       </property>
+       <property name="alignment">
+        <set>Qt::AlignCenter</set>
+       </property>
+      </widget>
+     </item>
+     <item row="1" column="0">
+      <widget class="QLabel" name="label_7">
+       <property name="text">
+        <string>Message</string>
+       </property>
+      </widget>
+     </item>
+     <item row="1" column="1">
+      <widget class="KColorButton" name="_output_colors__message"/>
+     </item>
+     <item row="1" column="2">
+      <widget class="KColorButton" name="_output_colors__message_good"/>
+     </item>
+     <item row="1" column="3">
+      <widget class="KColorButton" name="_output_colors__message_bad"/>
+     </item>
+     <item row="0" column="3">
+      <widget class="QLabel" name="label_10">
+       <property name="text">
+        <string>Bad</string>
+       </property>
+       <property name="alignment">
+        <set>Qt::AlignCenter</set>
+       </property>
+      </widget>
+     </item>
+    </layout>
+   </item>
+   <item>
+    <widget class="Line" name="line">
+     <property name="orientation">
+      <enum>Qt::Horizontal</enum>
+     </property>
+    </widget>
+   </item>
+   <item>
+    <layout class="QGridLayout" name="gridLayout_2">
+     <item row="0" column="1">
+      <widget class="QLabel" name="label">
+       <property name="text">
+        <string>Default</string>
+       </property>
+       <property name="alignment">
+        <set>Qt::AlignCenter</set>
+       </property>
+      </widget>
+     </item>
+     <item row="0" column="2">
+      <widget class="QLabel" name="label_2">
+       <property name="text">
+        <string>Variant 1</string>
+       </property>
+       <property name="alignment">
+        <set>Qt::AlignCenter</set>
+       </property>
+      </widget>
+     </item>
+     <item row="0" column="3">
+      <widget class="QLabel" name="label_3">
+       <property name="text">
+        <string>Variant 2</string>
+       </property>
+       <property name="alignment">
+        <set>Qt::AlignCenter</set>
+       </property>
+      </widget>
+     </item>
+     <item row="1" column="0">
+      <widget class="QLabel" name="label_5">
+       <property name="text">
+        <string>Output</string>
+       </property>
+      </widget>
+     </item>
+     <item row="1" column="1">
+      <widget class="KColorButton" name="_output_colors__output"/>
+     </item>
+     <item row="1" column="2">
+      <widget class="KColorButton" name="_output_colors__output1"/>
+     </item>
+     <item row="1" column="3">
+      <widget class="KColorButton" name="_output_colors__output2"/>
+     </item>
+     <item row="2" column="0">
+      <widget class="QLabel" name="label_6">
+       <property name="text">
+        <string>Error</string>
+       </property>
+      </widget>
+     </item>
+     <item row="2" column="1">
+      <widget class="KColorButton" name="_output_colors__error"/>
+     </item>
+     <item row="2" column="2">
+      <widget class="KColorButton" name="_output_colors__error1"/>
+     </item>
+     <item row="2" column="3">
+      <widget class="KColorButton" name="_output_colors__error2"/>
+     </item>
+     <item row="3" column="0">
+      <widget class="QLabel" name="label_4">
+       <property name="text">
+        <string>Warning</string>
+       </property>
+      </widget>
+     </item>
+     <item row="3" column="1">
+      <widget class="KColorButton" name="_output_colors__warning"/>
+     </item>
+     <item row="3" column="2">
+      <widget class="KColorButton" name="_output_colors__warning1"/>
+     </item>
+     <item row="3" column="3">
+      <widget class="KColorButton" name="_output_colors__warning2"/>
+     </item>
+    </layout>
+   </item>
+   <item>
+    <spacer name="verticalSpacer">
+     <property name="orientation">
+      <enum>Qt::Vertical</enum>
+     </property>
+     <property name="sizeHint" stdset="0">
+      <size>
+       <width>20</width>
+       <height>40</height>
+      </size>
+     </property>
+    </spacer>
+   </item>
+  </layout>
+  <zorder>label</zorder>
+  <zorder>label_2</zorder>
+  <zorder>label_3</zorder>
+  <zorder>label_5</zorder>
+  <zorder>_output_colors__output</zorder>
+  <zorder>_output_colors__output1</zorder>
+  <zorder>_output_colors__output2</zorder>
+  <zorder>label_6</zorder>
+  <zorder>_output_colors__error</zorder>
+  <zorder>_output_colors__error1</zorder>
+  <zorder>_output_colors__error2</zorder>
+  <zorder>_output_colors__warning2</zorder>
+  <zorder>label_4</zorder>
+  <zorder>_output_colors__warning1</zorder>
+  <zorder>_output_colors__warning</zorder>
+  <zorder>line</zorder>
+  <zorder>_output_colors__message</zorder>
+  <zorder>_output_colors__message_bad</zorder>
+  <zorder>label_7</zorder>
+  <zorder>label_8</zorder>
+  <zorder>label_9</zorder>
+  <zorder>label_10</zorder>
+  <zorder>_output_colors__message_good</zorder>
+  <zorder>label_10</zorder>
+ </widget>
+ <customwidgets>
+  <customwidget>
+   <class>KColorButton</class>
+   <extends>QPushButton</extends>
+   <header>kcolorbutton.h</header>
+  </customwidget>
+ </customwidgets>
+ <resources/>
+ <connections/>
+</ui>

data/lib/ruber/main_window/workspace.rb

@@ -0,0 +1,442 @@
+=begin 
+    Copyright (C) 2010 by Stefano Crocco   
+    stefano.crocco@alice.it   
+  
+    This program is free software; you can redistribute it andor modify  
+    it under the terms of the GNU General Public License as published by  
+    the Free Software Foundation; either version 2 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.                          
+  
+    You should have received a copy of the GNU General Public License     
+    along with this program; if not, write to the                         
+    Free Software Foundation, Inc.,                                       
+    59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             
+=end
+
+require 'facets/enumerable/sum'
+
+module Ruber
+  
+=begin rdoc
+Widget representing the main area of Ruber's main window, containing the tool
+widgets, together with their tab bars, and the tab widget containing the views.
+
+===Tool Widgets
+The workspace provides three <i>tool widgets containers</i>, on all sides of the
+editor views except above them. The container on each side is indipendent from the
+others.
+
+A tool widget can be
+* +raised+ or +lowered+: a raised tool widget is the only one which can bee seen
+  and interact with the user. There can be only one raised tool widget for side.
+  All other tool widgets are said to be lowered.
+* +visible+ or +hidden+: while a lowered tool widget is can never be seen, the
+  opposite is not necessarily true. A raised tool widget will be visible only if
+  its container is visible, otherwise it will be hidden, too
+* +active+ or +inactive+: a tool widget is active only if it has focus, otherwise
+  it's inactive. Obviously, only visible tool widgets can be active and there can
+  be at most one active tool widget in all the workspace.
+=end
+  class Workspace < Qt::Widget
+    
+=begin rdoc
+ Class used by +ToolManager+ to display the currently selected widget. It's a
+ <tt>Qt::WidgetStack</tt> which handles the +keyPressEvent+ when the key is either 
+ Esc or Shift+Esc. In the former case, the tool widget is hidden; in the latter
+ the focus is given back to the editor.
+
+ ===TODO
+ See whether this can somehow managed using shortcuts
+=end
+    class StackedWidget < Qt::StackedWidget
+      
+      protected
+      
+=begin rdoc
+Handles the key press event. First, it calls the method of the parent class,
+then if the event hasn't been accepted, activates the editor if the key was
+<tt>Shift + Esc</tt> or hides the current tool (thus activating the editor) if
+the key was +Esc+ with no modifiers.
+=====Arguments
+_e_:: the event (<tt>Qt::KeyEvent</tt>)
+=end
+      def keyPressEvent e
+        super e
+        return if e.accepted?
+        if e.key == Qt::Key_Q and e.modifiers == Qt::ShiftModifier.to_i
+          Ruber[:main_window].activate_editor
+        elsif e.key == Qt::Key_Q and e.modifiers == Qt::NoModifier.to_i
+          Ruber[:main_window].hide_tool current_widget
+        else e.ignore
+        end
+      end
+
+    end
+    
+=begin rdoc
+Internal class used to store information about the position of a tool widget
+=end
+    ToolData = Struct.new(:side, :id)
+    
+##
+# :method: tool_raised(tool)
+# 
+# <b>Signal</b>
+# 
+# <b>Signature:</b> <tt>tool_raised(QWidget*)</tt>
+# 
+# Signal emitted when a tool widget is raised. _tool_ is the widget which
+# has been raised
+    signals 'tool_raised(QWidget*)'
+    
+##
+# :method: removing_tool(tool)
+# 
+# *Signal*
+# 
+# <b>Signature:</b> <tt>removing_tool(QWidget*)</tt>
+# 
+# Signal emitted just before the tool widget _tool_ is removed
+    signals 'removing_tool(QWidget*)'
+    
+##
+# :method: tool_shown
+# <b>Signal: <tt>tool_shown(QWidget*)</tt></b>
+# 
+# Signal emitted when a tool widget is shown programmaticaly.
+    signals 'tool_shown(QWidget*)'
+    
+    slots 'toggle_tool(int)'
+    
+=begin rdoc
+The tab widget containing the editor views
+=end
+#   attr_reader :views
+    
+=begin rdoc
+Creates a new Workspace. _parent_ is the workspace's parent widget
+=end
+    def initialize parent = nil
+      super
+      @button_bars = {}
+      @splitters = {}
+      @stacks = {}
+      @widgets = {}
+      @next_id = 0
+      @tool_sizes = {}
+      @sizes = Ruber[:config][:workspace, :tools_sizes].dup
+      create_skeleton
+    end
+    
+=begin rdoc
+Adds a tool widget to the workspace. _side_ is the side where the widget should
+be put. It can be <tt>:left</tt>, <tt>:right</tt> or <tt>:bottom</tt>. _widget_
+is the widget to add; _icon_ is the <tt>Qt::Pixmap</tt> containing the icon to
+put on the tab bar and _caption_ is the text to display on the same caption.
+
+If _widget_ had already been added as a tool widget (either on the same side or
+another side, then ArgumentError is raised).
+=end
+    def add_tool_widget side, widget, icon, caption
+      if @stacks.values.include? widget.parent
+        Kernel.raise ArgumentError, "This widget has already been added as tool widget"
+      end
+      bar = @button_bars[side]
+      id = @next_id
+      bar.append_tab icon, id, caption
+      @widgets[widget] = ToolData.new side, id
+      @stacks[side].add_widget widget
+      connect bar.tab(id), SIGNAL('clicked(int)'), self, SLOT('toggle_tool(int)')
+      @next_id += 1
+    end
+    
+=begin rdoc
+Removes a tool widget. _arg_ can be either the widget itself or its <tt>object_name</tt>,
+either as a string or as a symbol. If the widget isn't a tool widget, nothing
+happens.
+=end
+    def remove_tool_widget arg
+      widget, data = if arg.is_a? String or arg.is_a? Symbol
+        @widgets.find{|k, v| k.object_name == arg.to_s}
+      else [arg, @widgets[arg]]
+      end
+      return unless widget and data
+      emit removing_tool(widget)
+      stack = @stacks[data.side]
+      raised = stack.current_widget.equal?(widget)
+      stack.remove_widget widget
+      if stack.empty? then stack.hide
+      else raise_tool stack.current_widget
+      end
+      @button_bars[data.side].remove_tab data.id
+    end
+    
+=begin rdoc
+Raises the tool widget _tool_, which can be either the tool widget itself or its
+<tt>object_name</tt>, either as a string or symbol. If _tool_ is not a tool widget
+(or if no tool widget with that <tt>object_name</tt> exists), nothing is done. If
+_tool_ is a string or symbol and more than one tool widget exist with that <tt>object_name</tt>,
+which one is raised is undefined.
+
+<b>Note:</b> this method doesn't make the container of _tool_ visible if it's hidden
+=end
+    def raise_tool tool
+      tool, data = tool_and_data tool
+      return unless tool
+      bar = @button_bars[data.side]
+      stack = @stacks[data.side]
+      old = stack.current_widget
+      if old and old.visible?
+        store_tool_size old
+        old_data = @widgets[old]
+        bar.set_tab old_data.id, false
+      end
+      bar.set_tab data.id, true
+      if old != tool
+        stack.current_widget = tool
+        emit tool_raised(tool)
+        emit tool_shown(tool) if stack.visible?
+      end
+      resize_tool tool
+    end
+
+=begin rdoc
+Shows the tool widget _tool_. This means that _tool_ will become the current widget
+in its stack and that the stack will become visible (if it's not already visible).
+_tool_ won't receive focus, unless the previously current widget of its stack had
+focus.
+
+_tool_ can be either the tool widget itself or its <tt>object_name</tt>, either as
+string or as symbol. In the latter cases, it there's more than one tool widget with
+the same <tt>object_name</tt>, it's undefined which one will be shown.
+
+If _tool_ isn't a tool widget, nothing happens.
+=end
+    def show_tool tool
+      tool, data = tool_and_data tool
+      return unless tool
+      data = @widgets[tool]
+      stack = @stacks[data.side]
+      visible = tool.visible?
+      give_focus = stack.find_children(Qt::Widget).any?{|w| w.has_focus}
+      raise_tool tool
+      stack.show unless stack.visible?
+      emit tool_shown(tool) unless visible
+      tool.set_focus if give_focus
+    end
+    
+=begin rdoc
+Gives focus to the tool widget _tool_ (raising and showing it if necessary). _tool_
+can be either the tool widget itself or its <tt>object_name</tt> (as either a string
+or symbol). If _tool_ doesn't represent a valid tool widget, nothing happens. If
+_tool_ is a string or symbol and more than one tool widget with the same name exists,
+which one will obtain focus is undefined.
+=end
+    def activate_tool tool
+      tool, data = tool_and_data tool
+      return unless tool
+      show_tool tool unless tool.visible?
+      tool.set_focus
+    end
+    
+=begin rdoc
+<b>Slot</b>
+
+Activates the tool _tool_ if it's not visibile and hides its stack if instead it's
+visible.
+
+_tool_ can be either the tool widget itself or its <tt>object_name</tt> (as either a string
+or symbol) or the id of the tab associated with the tool widget. If _tool_ doesn't
+represent a valid tool widget, nothing happens. If
+_tool_ is a string or symbol and more than one tool widget with the same name exists,
+which one will obtain focus is undefined.
+
+<b>Note:</b> the use of the id of the tab as argument is only for internal use.
+=end
+    def toggle_tool tool
+      tool, data = tool_and_data tool
+      return unless tool
+      if !tool.visible? then activate_tool tool
+      else hide_tool tool
+      end
+    end
+    
+=begin rdoc
+Hides the stack containing the tool widget _tool_, giving focus to the active editor,
+if _tool_ is raised (that is, if it is the current widget of its stack).
+
+_tool_ can be either the tool widget itself or its <tt>object_name</tt> (as
+either a string or symbol). If _tool_ doesn't represent a valid tool widget,
+nothing happens. If _tool_ is a string or symbol and more than one tool widget
+with the same name exists, which one will be used is undefined.
+=end
+    def hide_tool tool
+      tool, data = tool_and_data tool
+      return unless tool
+      store_tool_size tool if tool.visible?
+      stack = tool.parent
+      if stack.current_widget == tool
+        @button_bars[data.side].set_tab data.id, false
+        if stack.visible?
+          stack.hide 
+          Ruber[:main_window].focus_on_editor
+        end
+      end
+    end
+
+    
+=begin rdoc
+Stores the tool widgets size in the configuration manager. It reads the sizes of
+the splitters for the tool widgets which are visible and uses the values stored
+previously for the others.
+=end
+    def store_sizes
+      @stacks.each_value do |s|
+        w = s.current_widget
+        next unless w
+        store_tool_size w if w.visible?
+      end
+      Ruber[:config][:workspace, :tools_sizes] = @sizes
+    end
+    
+=begin rdoc
+Returns a hash having all the tool widgets as keys and the side each of them is
+(<tt>:left</tt>, <tt>:right</tt>, <tt>:bottom</tt>) as values.
+=end
+    def tool_widgets
+      res = {}
+      @widgets.each_pair{|w, data| res[w] = data.side}
+      res
+    end
+    
+    def current_widget side
+      @stacks[side].current_widget
+    end
+    
+=begin
+Returns the active tool widget, or *nil* if there's no active tool widget.
+=end
+    def active_tool
+      fw = KDE::Application.focus_widget
+      if @widgets.include? fw then fw
+      else @widgets.keys.find{|w| w.find_children(Qt::Widget).include? fw}
+      end
+    end
+    
+    private
+    
+=begin rdoc
+Helper method which creates the structure of the workspace (layout, button bars,
+splitters and tab view)
+=end
+    def create_skeleton
+      self.layout = Qt::GridLayout.new self
+      layout.set_contents_margins 0,0,0,0
+      layout.vertical_spacing = 0
+      %w[left right bottom].each do |side|
+        @button_bars[side.to_sym] = 
+            KDE::MultiTabBar.new(KDE::MultiTabBar.const_get(side.capitalize), self) 
+      end
+      layout.add_widget @button_bars[:left], 0, 0
+      layout.add_widget @button_bars[:right], 0, 2
+      layout.add_widget @button_bars[:bottom], 1, 0, 1, -1
+      v = Qt::Splitter.new Qt::Vertical, self
+      h = Qt::Splitter.new Qt::Horizontal, v
+      layout.add_widget v, 0,1
+      @splitters[:vertical] = v
+      @splitters[:horizontal] = h
+      [:left, :right, :bottom].each do |s| 
+        stack = StackedWidget.new{|w| w.hide}
+        @stacks[s] = stack
+      end
+      v.add_widget h
+      v.add_widget @stacks[:bottom]
+      h.add_widget @stacks[:left]
+      @views = KDE::TabWidget.new(h){self.document_mode = true}
+      h.add_widget @views
+      h.add_widget @stacks[:right]
+    end
+    
+=begin rdoc
+Resizes the splitter where the tool widget _tool_ is so that the size of _tool_
+matches that of the last time it was used. The space needed to do so is taken
+from the editor.
+
+If no size is recorded for _tool_, nothing is done.
+=end
+    def resize_tool tool
+      data = @widgets[tool]
+      side = data.side
+      caption = @button_bars[side].tab(data.id).text
+      size = @sizes[caption] #|| 150
+      return unless size
+      case side
+      when :bottom
+        splitter = @splitters[:vertical]
+        total = splitter.sizes.sum
+        new_sizes = [[total - size, 0].max, size]
+        splitter.sizes = new_sizes
+      when :left
+        splitter = @splitters[:horizontal]
+        old_sizes = splitter.sizes
+        total = old_sizes[0..1].sum
+        new_sizes = [size, [total - size, 0].max, old_sizes[-1]]
+        splitter.sizes = new_sizes
+      when :right
+        splitter = @splitters[:horizontal]
+        old_sizes = splitter.sizes
+        total = old_sizes[1..-1].sum
+        new_sizes = [old_sizes[0], [total - size, 0].max, size]
+        splitter.sizes = new_sizes
+      end
+    end
+    
+=begin rdoc
+Stores the size of the splitter slot where the tool widget _tool_ is in the
+<tt>@sizes</tt> instance variable.
+=end
+    def store_tool_size tool
+      data = @widgets[tool]
+      side = data.side
+      caption = @button_bars[side].tab(data.id).text
+      splitter, pos = case side
+      when :bottom then [@splitters[:vertical], 1]
+      when :left then [@splitters[:horizontal], 0]
+      when :right then [@splitters[:horizontal], 2]
+      end
+      @sizes[caption] = splitter.sizes[pos]
+    end
+
+=begin rdoc
+Returns an array containing the tool widget corresponding to _arg_ and its data
+(that is, the entry in the <tt>@widgets</tt> hash corresponding to the tool widget).
+_arg_ can be:
+* the tool widget itself
+* a string or symbol containing the <tt>object_name</tt> of the widget
+* an +Integer+ containing the id of the tab associated with the tool widget.
+If a suitable tool widget can't be found (or if _arg_ is of another class), *nil*
+is returned.
+=end
+    def tool_and_data arg
+      case arg
+      when String, Symbol
+        name = arg.to_s
+        @widgets.find{|w, data| w.object_name == name} 
+      when Integer
+        @widgets.find{|w, data| data.id == arg}
+      else
+        if arg.is_a? Qt::Widget 
+          data = @widgets[arg]
+          [arg, data] if data
+        end
+      end
+    end
+    
+  end
+  
+end