sirens 0.0.1 → 0.1.1

data/lib/sirens/models/object_browser_model.rb

@@ -94,6 +94,10 @@ module Sirens
 
             attr_reader :key, :value
 
+            def icon()
+                Icons.icon_for(@value)
+            end
+
             def display_string()
                 return value_display_string if key.nil?
 

data/lib/views/{view.rb → abstract_view.rb}

@@ -3,15 +3,15 @@ require 'set'
 module Sirens
     ##
     # A View is the library binding to a GUI interface handle.
-    # It is not a Component but is wrapped by a PrimitiveComponent.
+    # It is not a Component but is wrapped by a Component.
     # a View takes care of handling the internals of the GUI objects such as handles, events, default initialization,
     # etc.
     #
-    # By separating the View from the PrimitiveComponent that wraps it makes the PrimitiveComponents responsibilities
+    # By separating the View from the Component that wraps it makes the Component responsibilities
     # more consistent with regular Components and it makes it easier to switch between GUI libraries
     # (say, from Gtk to Qt).
     #
-    class View
+    class AbstractView
 
         # Class methods
 
@@ -37,37 +37,21 @@ module Sirens
         # Initializes this View handles
         #
         def initialize()
-            @event_handles = Hash[]
+            super()
 
-            @main_handle = nil
-
-            initialize_handles
-
-            subscribe_to_ui_events
+            @child_views = []
+            @attributes = Hash[]
         end
 
-        ## Instantiates this view handles.
-        # A View usually has a single handle to the GUI library, but in same cases it may have more than one.
-        # For instance when adding a Scroll decorator to the actual widget.
-        #
-        def initialize_handles()
-            raise RuntimeError.new("Subclass #{self.class.name} must implement the method ::initialize_handles().")
-        end
+        # Accessing
 
-        ##
-        # Subscribes this View to the events/signals emitted by the GUI handle(s) of interest.
-        # When an event/signal is received calls the proper event_handler provided by the PrimitiveComponent,
-        # if one was given.
-        #
-        # This mechanism of event handler callbacks is more simple and lightweight than making this View to announce
-        # events using the Observer pattern, and since there is only one PrimitiveComponent wrapping each View
-        # using the Observer pattern would be unnecessary complex.
-        #
-        def subscribe_to_ui_events()
-            raise RuntimeError.new("Subclass #{self.class.name} must implement the method ::subscribe_to_ui_events().")
+        def attribute_at(key)
+            @attributes[key]
         end
 
-        # Accessing
+        def set_attribute(key, value)
+            @attributes[key] = value
+        end
 
         ##
         # Returns the main handle of this View.
@@ -75,7 +59,7 @@ module Sirens
         # Also, it is the handle that receives the style props and events by default.
         #
         def main_handle()
-            @main_handle
+            raise RuntimeError.new("Subclass #{self.class.name} must implement the method ::initialize_handles().")
         end
 
         # Styling
@@ -87,26 +71,6 @@ module Sirens
             self.class.accepted_styles
         end
 
-        ##
-        # Applies each prop in props to the actual GUI object.
-        #
-        def apply_props(props)
-            accepted_styles = self.accepted_styles
-
-            props.each_pair { |prop, value|
-                apply_prop(prop, value) if accepted_styles.include?(prop)
-            }
-        end
-
-        ##
-        # Apply the prop to the actual GUI object.
-        #
-        def apply_prop(prop, value)
-            setter = prop.to_s + '='
-
-            send(setter, value)
-        end
-
         # Styles
 
         def width=(value)
@@ -176,13 +140,15 @@ module Sirens
         # Adds a child_view.
         #
         def add_view(child_view)
-            main_handle.add(child_view.main_handle)
+            @child_views << child_view
         end
 
         ##
         # Removes a child view.
         #
         def remove_view(child_view)
+            @child_views.delete(child_view)
+
             main_handle.remove(child_view.main_handle)
         end
 

data/lib/views/button_view.rb

@@ -1,5 +1,5 @@
 module Sirens
-    class ButtonView < View
+    class ButtonView < WidgetView
 
         # Class methods
 

data/lib/views/{check_button_view.rb → checkbox_view.rb}

@@ -1,5 +1,5 @@
 module Sirens
-    class CheckButtonView < View
+    class CheckboxView < WidgetView
 
         # Class methods
 

data/lib/views/component_view.rb

@@ -0,0 +1,12 @@
+module Sirens
+    class ComponentView < AbstractView
+
+        def main_child_view()
+            @child_views.first
+        end
+
+        def main_handle()
+            main_child_view.main_handle
+        end
+    end
+end

data/lib/views/{entry_view.rb → input_text_view.rb}

@@ -1,5 +1,5 @@
 module Sirens
-    class EntryView < View
+    class InputTextView < WidgetView
 
         # Initializing
 

data/lib/views/list_view.rb

@@ -1,5 +1,5 @@
 module Sirens
-    class ListView < View
+    class ListView < WidgetView
 
         # Class methods
 
@@ -45,12 +45,16 @@ module Sirens
 
         # Building columns
 
+        def list_store_type_for(column_props)
+            return GdkPixbuf::Pixbuf if column_props.has_image_block?
+
+            String
+        end
+
         def define_columns(columns_props_array)
             @columns_props = columns_props_array
 
-            list_store_types = @columns_props
-                .collect { |each_column_props| each_column_props.fetch(:type, :text) }
-                .collect { |type| String }
+            list_store_types = @columns_props.collect { |type| list_store_type_for(type) }
 
             tree_view.set_model(Gtk::ListStore.new(*list_store_types))
 
@@ -60,12 +64,21 @@ module Sirens
         end
 
         def add_column_with_props(props)
-            column_type = props.fetch(:type, :text)
             column_index = tree_view.columns.size
 
-            renderer = Gtk::CellRendererText.new
+            col = nil
+
+            column_label = props[:label]
 
-            col = Gtk::TreeViewColumn.new(props[:label], renderer, column_type => column_index)
+            if props.has_image_block?
+                renderer = Gtk::CellRendererPixbuf.new
+
+                col = Gtk::TreeViewColumn.new(column_label, renderer, pixbuf: column_index)
+            else
+                renderer = Gtk::CellRendererText.new
+
+                col = Gtk::TreeViewColumn.new(column_label, renderer, text: column_index)
+            end
 
             tree_view.append_column(col)
         end
@@ -189,10 +202,22 @@ module Sirens
 
         def set_item_column_values(item:, iter:)
             @columns_props.each_with_index { |column, column_index|
-                iter[column_index] = column.display_text_of(item)
+                colum_value = display_data_of(item, column, column_index)
+
+                iter.set_value(column_index, colum_value)
             }
         end
 
+        def display_data_of(item, column, column_index)
+            if column.has_image_block?
+                image_file = column.display_image_of(item).to_s
+
+                return GdkPixbuf::Pixbuf.new(file: image_file, width: 16, height: 16)
+            end
+
+            column.display_text_of(item)
+        end
+
         # Querying
 
         def selection_indices()

data/lib/views/menu_view.rb

@@ -1,5 +1,5 @@
 module Sirens
-    class MenuView < View
+    class MenuView < WidgetView
 
         # Initializing
 

data/lib/views/radio_button_view.rb

@@ -1,5 +1,5 @@
 module Sirens
-    class RadioButtonView < View
+    class RadioButtonView < WidgetView
 
         # Class methods
 

data/lib/views/splitter_view.rb

@@ -0,0 +1,101 @@
+module Sirens
+    class SplitterView < WidgetView
+
+        # Initializing
+
+        def initialize(orientation:)
+            @orientation = orientation
+
+            super()
+        end
+
+        def initialize_handles()
+            @main_handle = Gtk::Paned.new(@orientation)
+        end
+
+        def subscribe_to_ui_events()
+            main_handle.signal_connect('size-allocate') { |widget, rectangle|
+                on_size_allocation(width: rectangle.width, height: rectangle.height)
+            }
+        end
+
+        ##
+        # Adds the child_component to this component.
+        #
+        def add_view(child_view)
+            @child_views << child_view
+
+            if @child_views.size <= 2
+                main_handle.add(child_view.main_handle)
+            else
+                paned = Gtk::Paned.new(@orientation)
+
+                last_child_handle = main_handle.children.last
+
+                main_handle.remove(last_child_handle)
+
+                paned.add(last_child_handle)
+                paned.add(child_view.main_handle)
+
+                main_handle.add(paned)
+            end
+        end
+
+        def is_horizontal()
+            @orientation === :horizontal
+        end
+
+        def on_size_allocation(width:, height:)
+            return if @is_first_size_allocation === false
+
+            @is_first_size_allocation = false
+
+            remaining_proportion = 1.0
+
+            current_handle = main_handle
+
+            @child_views.each_with_index do |child_view, index|
+
+                return if index === @child_views.size
+
+                return if current_handle.children.empty?
+
+                proportion = child_view.attribute_at(:splitter_proportion)
+
+                remaining_proportion = remaining_proportion - proportion
+
+                children = current_handle.children
+
+                first_child = children[0]
+
+                set_proportional_size(
+                    view_handle: first_child,
+                    width: width,
+                    height: height,
+                    proportion: proportion
+                )
+
+                return if children.size < 2
+
+                second_child = children[1]
+
+                set_proportional_size(
+                    view_handle: second_child,
+                    width: width,
+                    height: height,
+                    proportion: remaining_proportion
+                )
+
+                current_handle = second_child
+            end
+        end
+
+        def set_proportional_size(view_handle:, width:, height:, proportion:)
+            if is_horizontal
+                view_handle.set_size_request(width * proportion, height)
+            else
+                view_handle.set_size_request(width, height * proportion)
+            end
+        end
+    end
+end

data/lib/views/stack_view.rb

@@ -1,5 +1,5 @@
 module Sirens
-    class StackView < View
+    class StackView < WidgetView
 
         # Initializing
 

data/lib/views/{notebook_view.rb → tabs_view.rb}

@@ -1,5 +1,5 @@
 module Sirens
-    class NotebookView < View
+    class TabsView < WidgetView
 
         # Initializing
 

data/lib/views/text_view.rb

@@ -1,5 +1,5 @@
 module Sirens
-    class TextView < View
+    class TextView < WidgetView
         # Class methods
 
         class << self

data/lib/views/tree_view.rb

@@ -1,16 +1,9 @@
 module Sirens
-    class TreeView < View
+    class TreeView < WidgetView
 
         # Class methods
 
         class << self
-            ##
-            # Answer the laze children placeholder.
-            #
-            def placeholder()
-                @placeholder ||= '__placeholder__'
-            end
-
             ##
             # Answer the styles accepted by this view.
             #
@@ -60,14 +53,18 @@ module Sirens
 
         # Building columns
 
+        def tree_store_type_for(column_props)
+            return GdkPixbuf::Pixbuf if column_props.has_image_block?
+
+            String
+        end
+
         def define_columns(columns_props_array)
             @columns_props = columns_props_array
 
-            tree_store_types = @columns_props
-                .collect { |each_column_props| each_column_props.fetch(:type, :text) }
-                .collect { |type| String }
+            list_store_types = @columns_props.collect { |type| tree_store_type_for(type) }
 
-            tree_view.set_model(Gtk::TreeStore.new(*tree_store_types))
+            tree_view.set_model(Gtk::TreeStore.new(*list_store_types))
 
             @columns_props.each do |each_column_props|
                 add_column_with_props(each_column_props)
@@ -75,12 +72,21 @@ module Sirens
         end
 
         def add_column_with_props(props)
-            column_type = props.fetch(:type, :text)
             column_index = tree_view.columns.size
 
-            renderer = Gtk::CellRendererText.new
+            col = nil
+
+            column_label = props[:label]
+
+            if props.has_image_block?
+                renderer = Gtk::CellRendererPixbuf.new
+
+                col = Gtk::TreeViewColumn.new(column_label, renderer, pixbuf: column_index)
+            else
+                renderer = Gtk::CellRendererText.new
 
-            col = Gtk::TreeViewColumn.new(props[:label], renderer, column_type => column_index)
+                col = Gtk::TreeViewColumn.new(column_label, renderer, text: column_index)
+            end
 
             tree_view.append_column(col)
         end
@@ -193,7 +199,7 @@ module Sirens
         def on_row_expanded(iter:, tree_path:)
             child_iter = iter.first_child
 
-            return if tree_store.get_value(child_iter, 0) != self.class.placeholder
+            return if ! tree_store.get_value(child_iter, 0).nil?
 
             indices_path = tree_path.indices
 
@@ -212,6 +218,12 @@ module Sirens
             tree_store.clear
         end
 
+        def set_roots(root_items)
+            clear_items
+
+            add_items(parent_iter: nil, items: root_items, index: 0)
+        end
+
         # Adding
 
         def add_items(items:, parent_iter:, index:)
@@ -234,9 +246,7 @@ module Sirens
             children_count = get_children_at(path: indices_path).size
 
             if children_count > 0
-                placeholder = tree_store.insert(iter, 0)
-
-                placeholder[0] = self.class.placeholder
+                tree_store.insert(iter, 0)
             end
         end
 
@@ -270,10 +280,22 @@ module Sirens
 
         def set_item_column_values(item:, iter:)
             @columns_props.each_with_index { |column, column_index|
-                iter[column_index] = column.display_text_of(item)
+                colum_value = display_data_of(item, column, column_index)
+
+                iter.set_value(column_index, colum_value)
             }
         end
 
+        def display_data_of(item, column, column_index)
+            if column.has_image_block?
+                image_file = column.display_image_of(item).to_s
+
+                return GdkPixbuf::Pixbuf.new(file: image_file, width: 16, height: 16)
+            end
+
+            column.display_text_of(item)
+        end
+
         # Querying
 
         def selection_indices()