ruber 0.0.5 → 0.0.7

data/lib/ruber/main_window/plugin.yaml

@@ -28,17 +28,20 @@ config_options:
   v_splitter: {key: Vertical splitter, type: string list, default: "['80', '20']"}
  workspace:
   tools_sizes: {default: {}}
+  close_buttons: {default: 'true', type: bool}
 config_widgets:
  - {caption: General, pixmap: configure, class: Ruber::MainWindowSettingsWidget}
  - {caption: Colors, pixmap: fill-color, class: Ruber::OutputColorWidget}
+ - {caption: Workspace, pixmap: workspace.png, class: Ruber::MainWindow::WorkspaceSettingsWidget}
 actions:
  file_new: {standard_action: open_new, slot: new_file()}
  file_open: {standard_action: open, slot: open_file()}
  file_open_recent: {standard_action: open_recent, signal: urlSelected(KUrl), slot: open_recent_file(KUrl)}
  file-save_all: {text: Save &All, icon: document-save-all, slot: save_all()}
  file_close: {standard_action: close, slot: close_current_editor()}
- file-close_all: {text: Clos&e All, slot: close_all_views()}
- file-close_other: {text: Close All O&ther, slot: close_other_views()}
+ file-close_tab: {text: Close Current &Tab, slot: close_tab(), state: current_document}
+ file-close_all: {text: Clos&e All, slot: close_all_views(), state: current_document}
+ file-close_other: {text: Close All O&ther, slot: close_other_views(), state: current_document}
  file_quit: {standard_action: quit, receiver: 'Ruber[:app]', slot: closeAllWindows()}
  go_back: {standard_action: back, slot: previous_document(), shortcut: Alt+Left}
  go_forward: {standard_action: forward, slot: next_document(), shortcut: Alt+Right}
@@ -55,4 +58,11 @@ actions:
  options-choose_plugins: {text: C&hoose Plugins..., icon: preferences-plugin, slot: choose_plugins()}
  options_configure: {standard_action: preferences, slot: preferences()}
  configure_document: {text: Configure &Document, icon: configure, slot: configure_document(), state: current_document}
- help_user_manual: {text: Ruber User &Manual, icon: help-contents, slot: show_user_manual()}
+ help_user_manual: {text: Ruber User &Manual, icon: help-contents, slot: show_user_manual()}
+ window-split_horizontally: {text: Split Horizontally, slot: split_horizontally(), shortcut: Ctrl+Shift+T, state: current_document}
+ window-split_vertically: {text: Split Vertically, slot: split_vertically(), shortcut: Ctrl+Shift+L, state: current_document}
+ window-switch_to_new_document: {text: Switch to New File, slot: switch_to_new_document(), state: current_document}
+ window-switch_to_file: {text: Switch to Open File, slot: switch_to_file(), state: current_document}
+ window-switch_to_recent_file: {signal: urlSelected(KUrl), slot: switch_to_recent_file(KUrl), class: KDE::RecentFilesAction, text: Switch to Recent File, state: current_document}
+extensions:
+ ruber_default_document: {class: Ruber::Application::DefaultDocumentExtension, scope: document, place: all}

data/lib/ruber/main_window/save_modified_files_dlg.rb

@@ -71,7 +71,7 @@ module Ruber
       end
 
       cancel = KDE::StandardGuiItem.cancel
-      cancel.text = KDE::i18n "&Abort saving"
+      cancel.text = KDE::i18n "&Abort"
       set_button_gui_item Cancel, cancel
     end
 

data/lib/ruber/main_window/ui/choose_plugins_widget.rb

@@ -1,7 +1,7 @@
 =begin
 ** Form generated from reading ui file 'choose_plugins_widget.ui'
 **
-** Created: ven ott 29 17:39:04 2010
+** Created: mar nov 16 11:52:49 2010
 **      by: Qt User Interface Compiler version 4.7.0
 **
 ** WARNING! All changes made in this file will be lost when recompiling ui file!

data/lib/ruber/main_window/ui/main_window_settings_widget.rb

@@ -1,7 +1,7 @@
 =begin
 ** Form generated from reading ui file 'main_window_settings_widget.ui'
 **
-** Created: ven ott 29 17:39:04 2010
+** Created: mar nov 16 11:52:49 2010
 **      by: Qt User Interface Compiler version 4.7.0
 **
 ** WARNING! All changes made in this file will be lost when recompiling ui file!

data/lib/ruber/main_window/ui/new_project_widget.rb

@@ -1,7 +1,7 @@
 =begin
 ** Form generated from reading ui file 'new_project_widget.ui'
 **
-** Created: ven ott 29 17:39:04 2010
+** Created: mar nov 16 11:52:48 2010
 **      by: Qt User Interface Compiler version 4.7.0
 **
 ** WARNING! All changes made in this file will be lost when recompiling ui file!

data/lib/ruber/main_window/ui/open_file_in_project_dlg.rb

@@ -1,7 +1,7 @@
 =begin
 ** Form generated from reading ui file 'open_file_in_project_dlg.ui'
 **
-** Created: ven ott 29 17:39:04 2010
+** Created: mar nov 16 11:52:49 2010
 **      by: Qt User Interface Compiler version 4.7.0
 **
 ** WARNING! All changes made in this file will be lost when recompiling ui file!

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

@@ -1,7 +1,7 @@
 =begin
 ** Form generated from reading ui file 'output_color_widget.ui'
 **
-** Created: ven ott 29 17:39:04 2010
+** Created: mar nov 16 11:52:49 2010
 **      by: Qt User Interface Compiler version 4.7.0
 **
 ** WARNING! All changes made in this file will be lost when recompiling ui file!

data/lib/ruber/main_window/ui/workspace_settings_widget.rb

@@ -0,0 +1,51 @@
+=begin
+** Form generated from reading ui file 'workspace_settings_widget.ui'
+**
+** Created: mar gen 11 14:57:22 2011
+**      by: Qt User Interface Compiler version 4.7.1
+**
+** WARNING! All changes made in this file will be lost when recompiling ui file!
+=end
+
+class Ui_WorkspaceSettingsWidgetBase
+    attr_reader :verticalLayout
+    attr_reader :_workspace__close_buttons
+
+    def setupUi(workspaceSettingsWidgetBase)
+    if workspaceSettingsWidgetBase.objectName.nil?
+        workspaceSettingsWidgetBase.objectName = "workspaceSettingsWidgetBase"
+    end
+    workspaceSettingsWidgetBase.resize(400, 35)
+    @verticalLayout = Qt::VBoxLayout.new(workspaceSettingsWidgetBase)
+    @verticalLayout.objectName = "verticalLayout"
+    @_workspace__close_buttons = Qt::CheckBox.new(workspaceSettingsWidgetBase)
+    @_workspace__close_buttons.objectName = "_workspace__close_buttons"
+
+    @verticalLayout.addWidget(@_workspace__close_buttons)
+
+
+    retranslateUi(workspaceSettingsWidgetBase)
+
+    Qt::MetaObject.connectSlotsByName(workspaceSettingsWidgetBase)
+    end # setupUi
+
+    def setup_ui(workspaceSettingsWidgetBase)
+        setupUi(workspaceSettingsWidgetBase)
+    end
+
+    def retranslateUi(workspaceSettingsWidgetBase)
+    workspaceSettingsWidgetBase.windowTitle = Qt::Application.translate("WorkspaceSettingsWidgetBase", "Form", nil, Qt::Application::UnicodeUTF8)
+    @_workspace__close_buttons.text = Qt::Application.translate("WorkspaceSettingsWidgetBase", "&Display close buttons on tabs", nil, Qt::Application::UnicodeUTF8)
+    end # retranslateUi
+
+    def retranslate_ui(workspaceSettingsWidgetBase)
+        retranslateUi(workspaceSettingsWidgetBase)
+    end
+
+end
+
+module Ui
+    class WorkspaceSettingsWidgetBase < Ui_WorkspaceSettingsWidgetBase
+    end
+end  # module Ui
+

data/lib/ruber/main_window/ui/workspace_settings_widget.ui

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>WorkspaceSettingsWidgetBase</class>
+ <widget class="QWidget" name="WorkspaceSettingsWidgetBase">
+  <property name="geometry">
+   <rect>
+    <x>0</x>
+    <y>0</y>
+    <width>400</width>
+    <height>35</height>
+   </rect>
+  </property>
+  <property name="windowTitle">
+   <string>Form</string>
+  </property>
+  <layout class="QVBoxLayout" name="verticalLayout">
+   <item>
+    <widget class="QCheckBox" name="_workspace__close_buttons">
+     <property name="text">
+      <string>&amp;Display close buttons on tabs</string>
+     </property>
+    </widget>
+   </item>
+  </layout>
+ </widget>
+ <resources/>
+ <connections/>
+</ui>

data/lib/ruber/main_window/view_manager.rb

@@ -0,0 +1,418 @@
+=begin 
+    Copyright (C) 2010,2011 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 'ruber/main_window/hint_solver'
+require 'ruber/pane'
+
+module Ruber
+  
+  class MainWindow
+    
+=begin rdoc
+Class which manages the views in the tab widget
+
+It takes care of activating a view when it gets focus, removing a tab when the
+last view in it is closed, and so on.
+
+@note this class is only for internal use by {MainWindow}. Its API is likely to
+  change and the whole class may disappear in the future. So, *do not* use it outside
+  of {MainWindow}
+=end
+    class ViewManager < Qt::Object
+      
+=begin rdoc
+@return [KDE::PartManager] the part manager which manages the document parts
+=end
+      attr_reader :part_manager
+      
+=begin rdoc
+@return [EditorView,nil] the active editor (that is, the editor whose GUI is merged
+  with the main window GUI) or *nil* if no main window exists
+=end
+      attr_reader :active_editor
+      
+=begin rdoc
+@return [Array<EditorView>] a list of all the editors in all tabs, in activation
+  order, from more recently activated to less recently activated
+=end
+      attr_reader :activation_order
+      
+=begin rdoc
+@return [Boolean] whether to automatically activate an editor when it is created
+=end
+      attr_accessor :auto_activate_editors
+      
+=begin rdoc
+Signal emitted whenever an editor is created
+@param [EditorView] editor the newly created editor
+=end
+      signals 'view_created(QWidget*)'
+      
+=begin rdoc
+Signal emitted whenever the active editor changes
+
+This signal is emitted _after_ the editor has become active
+@param [EditorView,nil] editor the editor which become active or *nil* if no editor
+  become active
+=end
+      signals 'active_editor_changed(QWidget*)'
+
+=begin rdoc
+@param [KDE::TabWidget] tabs the tab widget used by the main window
+@param [Ruber::MainWindow] parent the main window
+=end
+      def initialize tabs, parent
+        super parent
+        @tabs = tabs
+        @focus_editors = []
+        @part_manager = KParts::PartManager.new parent, self
+        @activation_order = []
+        @active_editor = nil
+        @solver = MainWindow::HintSolver.new @tabs, @part_manager, @activation_order
+        @auto_activate_editors = true
+        connect @tabs, SIGNAL('currentChanged(int)'), self, SLOT('current_tab_changed(int)')
+      end
+      
+=begin rdoc
+Returns an editor associated with the given document, creating it if needed
+
+It works as {MainWindow#editor_for!}.
+
+_hints_ may contain the same values as in {MainWindow#editor_for!}. It may also
+contain another value, @:close_starting_document@
+@param [Document] doc the document to retrieve an editor for
+@param hints (see MainWindow#editor_for!)
+@option hints [Boolean] :close_starting_document (false) if given, specifies that
+  the default document created by ruber at startup exists and it's in the first
+  tab. If a new view is created in a new tab, this document is closed
+@return [EditorView] the view to use for the document
+=end
+      def editor_for doc, hints
+        editor = @solver.find_editor doc, hints
+        if !editor and hints[:create_if_needed]
+          editor = create_editor doc
+          if hints[:show]
+            @activation_order << editor
+            view = @solver.place_editor hints
+            if view 
+              dir = Qt.const_get hints[:split].to_s.capitalize
+              view.parent.split view, editor, dir
+            else 
+              if hints[:close_starting_document]
+                if @tabs.count == 1 and @tabs.widget(0).single_view?
+                  doc_to_close = @tabs.widget(0).view.document
+                end
+              end
+              add_tab editor, doc.icon, doc.document_name
+              doc_to_close.close if doc_to_close
+            end
+            editor.parent.label = label_for_editor editor
+          end
+        end
+        editor
+      end
+      
+=begin rdoc
+Makes the given editor active
+
+Besides merging the editor's GUI with the main window's, this method also deactivates
+the previously active editor, updates the activation order, activates the document
+associated with the new active editor, updates the tab where the new editor is
+and emits the {#active_editor_changed} signal.
+
+Nothing is done if the given editor was already active
+@param [EditorView] editor the editor to activate
+@return [EditorView] the new active editor
+=end
+      def make_editor_active editor
+        return if editor and @active_editor == editor
+        deactivate_editor @active_editor
+        @active_editor = editor
+        if editor
+          parent.gui_factory.add_client editor.send(:internal)
+          @activation_order.delete editor
+          @activation_order.insert 0, editor
+          editor_tab = tab(editor)
+          tab_idx = @tabs.index_of editor_tab 
+          @focus_editors[tab_idx] = editor
+          update_tab editor_tab
+          editor.document.activate
+        end
+        emit active_editor_changed @active_editor
+        @active_editor
+      end
+      
+=begin rdoc
+Deactivates the given editor
+
+To deactivate the editor, its GUI is removed from the main window's and the corresponding
+document is deactivated.
+
+If the given editor wasn't the active one, nothing is done
+@param [EditorView] view the editor to deactivate
+@return [nil]
+=end
+      def deactivate_editor view
+        return unless @active_editor and view == @active_editor
+        @active_editor.document.deactivate
+        parent.gui_factory.remove_client view.send(:internal)
+        @active_editor = nil
+        nil
+      end
+
+=begin rdoc
+Executes a block without automatically activating editors
+
+Usually, whenever a tab becomes active, one of the editors it contains becomes
+active. Sometimes, you don't want this to happen (for example, when opening multiple
+documents in sequence). To do so, do what you need from a block passed to this method.
+
+After the block has been executed, the last activated method in the current tab
+becomes active.
+
+@yield the block to call without automatically activating editors
+@return [Object] the value returned by the block
+=end
+      def without_activating
+        begin
+          @auto_activate_editors = false
+          yield
+        ensure
+          @auto_activate_editors = true
+          if @tabs.current_index < 0 then make_editor_active nil
+          else make_editor_active @focus_editors[@tabs.current_index]
+          end
+        end
+      end
+      
+=begin rdoc
+The toplevel pane corresponding to the given index or widget
+
+@overload tab idx
+  @param [Integer] idx the index of the tab
+  @return [Pane] the toplevel pane in the tab number _idx_
+@overload tab editor
+  @param [EditorView] editor the editor to retrieve the pane for
+  @return [Pane,nil] the toplevel pane containing the given editor or *nil* if the
+    view isn't contained in a pane
+@overload tab pane
+  @param [Pane] pane the pane to retrieve the toplevel pane for
+  @return [Pane, nil] the toplevel pane containing the given pane or *nil* if the
+    pane isn't contained in another pane
+=end
+      def tab arg
+        if arg.is_a? Integer then @tabs.widget arg
+        else
+          pane = arg.is_a?(Pane) ? arg : arg.parent
+          return unless pane
+          pane = pane.parent_pane while pane.parent_pane
+          pane
+        end
+      end
+      
+=begin rdoc
+Whether the given view is a focus editor
+
+@overload focus_editor? editor
+  Whether the given view is the focus editor for any tab
+  @param [EditorView] editor the view to test
+  @return [Boolean] *true* if there's a tab which has _editor_ as focus editor and
+    *false* otherwise
+@overload focus_editor? editor, tab
+  Whether the given view is the focus editor for the given tab
+  @param [EditorView] editor the view to test
+  @param [Pane,Integer] tab the tab the view must be focus editor for. If a {Pane}
+    it must be the toplevel pane of the tab; if an @Integer@, it must be the index
+    of the pane to test
+  @note this method doesn't test whether _tab_ actually is a toplevel pane
+  @return [Boolean] *true* if _editor_ is the focus widget for _tab_ and
+    *false* otherwise
+=end
+      def focus_editor? editor, tab = nil
+        if tab 
+          tab = @tabs.index_of(tab) unless tab.is_a? Integer
+          @focus_editors[tab] == editor
+        else @focus_editors.any?{|k, v| v == editor}
+        end
+      end
+      
+=begin rdoc
+The label to use for an editor
+
+@param [EditorView] ed the editor to return the label for
+@return [String] the text to show below the given editor
+=end
+      def label_for_editor ed
+        url = ed.document.url
+        if url.valid? then url.local_file? ? url.path : url.pretty_url
+        else ed.document.document_name
+        end
+      end
+      
+      private
+      
+=begin rdoc
+Creates an editor for a document
+
+@param [Document] doc the document to create the editor for
+@return [EditorView] the new editor for the document
+=end
+      def create_editor doc
+        editor = doc.create_view
+        connect editor, SIGNAL('focus_in(QWidget*)'), self, SLOT('focus_in_view(QWidget*)')
+        connect editor, SIGNAL('closing(QWidget*)'), self, SLOT('view_closing(QWidget*)')
+        editor
+      end
+      
+=begin rdoc
+Adds a new tab to the tab widget
+
+The tab is created with a view inserted in it and is assigned an icon an a label
+@param [EditorView] view the view to insert in the new pane
+@param [Qt::Icon] icon the icon to associate with the new tab
+@param [String] label the label to use for the new tab
+@return [Pane] the pane corresponding to the new tab
+=end
+      def add_tab view, icon, label
+        new_tab = Pane.new(view)
+        idx = @tabs.add_tab new_tab, icon, label
+        @focus_editors[idx] = view
+        connect new_tab, SIGNAL('closing_last_view(QWidget*)'), self, SLOT('remove_tab(QWidget*)')
+        connect new_tab, SIGNAL('pane_split(QWidget*, QWidget*, QWidget*)'), self, SLOT('update_tab(QWidget*)')
+        connect new_tab, SIGNAL('removing_view(QWidget*, QWidget*)'), self, SLOT('update_tab(QWidget*)')
+        connect new_tab, SIGNAL('view_replaced(QWidget*, QWidget*, QWidget*)'), self, SLOT('update_tab(QWidget*)')
+        new_tab
+      end
+      
+=begin rdoc
+Removes the tab corresponding to the given toplevel pane
+
+@param [Pane] pane the toplevel pane whose tab should be removed
+@return [nil]
+=end
+      def remove_tab pane
+        idx = @tabs.index_of pane
+        if idx
+          @focus_editors.delete_at idx
+          @tabs.remove_tab idx 
+        end
+        nil
+      end
+      slots 'remove_tab(QWidget*)'
+
+=begin rdoc
+Slot called whenever a view receives focus
+
+The views is activated, unless it was already active
+@param [EditorView] view the view which received focus
+@return [nil]
+=end
+      def focus_in_view view
+        if view != @active_editor
+          make_editor_active view
+        end
+        nil
+      end
+      slots 'focus_in_view(QWidget*)'
+      
+=begin rdoc
+Slot called whenever a view is closed
+
+It deactivates the view (if it was active) and preforms some cleanup.
+@param [EditorView] view the view which is being closed
+@return [nil]
+=end
+      def view_closing view
+        @activation_order.delete view
+        disconnect view, SIGNAL('focus_in(QWidget*)'), self, SLOT('focus_in_view(QWidget*)')
+        deactivate_editor view
+        nil
+      end
+      slots 'view_closing(QWidget*)'
+      
+=begin rdoc
+Slot called whenever the current tab changes
+
+Unless called from within a {#without_activating} block, it activates and gives focus
+to the view in the new current tab which last got focus.
+
+If called from within a {#without_activating} block, or if there's no current tab,
+all editors are deactivated
+@param [Integer] idx the index of the current tab
+@return [nil]
+=end
+      def current_tab_changed idx
+        if idx > -1
+          @focus_editors[idx] ||= @tabs.widget(idx).to_a[0]
+          ed = @focus_editors[idx]
+          if @auto_activate_editors then ed.set_focus
+          else make_editor_active nil
+          end
+        else
+          make_editor_active nil
+        end
+        nil
+      end
+      slots 'current_tab_changed(int)'
+      
+=begin rdoc
+Updates the tab containing the given toplevel pane
+
+Updating the tab means changing its icon, its label, its tooltip and the label
+associated with each of the editors it contains
+@param [Pane] pane the toplevel pane contained in the pane to update
+@return [nil]
+=end
+      def update_tab pane
+        idx = @tabs.index_of tab(pane)
+        return if idx < 0
+        doc = @focus_editors[idx].document
+        @tabs.set_tab_text idx, doc.document_name
+        @tabs.set_tab_icon idx, doc.icon
+        pane.each_pane{|pn| pn.label = label_for_editor(pn.view) if pn.single_view?}
+        update_tool_tip idx
+        nil
+      end
+      slots 'update_tab(QWidget*)'
+      
+=begin rdoc
+Updates the tooltip for the given tab
+
+A pane's tooltip contains the list of the documents associated with the views in
+the tab, separated by newlines.
+
+@param [Integer] idx the index of the tab whose tooltip should be updated
+@param [Array<EditorView>] ignore a list of views which shouldn't be considered
+  when creating the tool tip. This is necessary because, when a view is closed,
+  this method is called _before_ the view is removed from the pane, so the document
+  associated with it would be included in the tooltip if it weren't specified here
+@return [nil]
+=end
+      def update_tool_tip idx, *ignore
+        docs = @tabs.widget(idx).reject{|v| ignore.include? v}.map{|v| v.document.document_name}.uniq
+        @tabs.set_tab_tool_tip idx, docs.join("\n")
+        nil
+      end
+      
+    end
+    
+  end
+  
+end