vedeu 0.7.2 → 0.7.3

data/docs/events/focus.md

@@ -4,23 +4,8 @@
 
 Note: 'name' is a Symbol unless mentioned otherwise.
 
-### `:_focus_by_name_`
-When triggered with an interface name will focus that interface and
-restore the cursor position and visibility.
+{include:file:docs/events/by_name/focus_by_name.md}
 
-    Vedeu.trigger(:_focus_by_name_, name) # or
-    Vedeu.focus_by_name(name)
+{include:file:docs/events/by_name/focus_next.md}
 
-### `:_focus_next_`
-When triggered will focus the next visible interface and restore the
-cursor position and visibility.
-
-    Vedeu.trigger(:_focus_next_) # or
-    Vedeu.focus_next
-
-### `:_focus_prev_`
-When triggered will focus the previous visible interface and restore
-the cursor position and visibility.
-
-    Vedeu.trigger(:_focus_prev_) # or
-    Vedeu.focus_previous
+{include:file:docs/events/by_name/focus_prev.md}

data/docs/events/menu.md

@@ -4,56 +4,22 @@
 
 Note: 'name' is a Symbol unless mentioned otherwise.
 
-### `:_menu_bottom_`
-Makes the last menu item the current menu item.
+{include:file:docs/events/by_name/menu_bottom.md}
 
-    Vedeu.trigger(:_menu_bottom_, name)
+{include:file:docs/events/by_name/menu_current.md}
 
-### `:_menu_current_`
-Returns the current menu item.
+{include:file:docs/events/by_name/menu_deselect.md}
 
-    Vedeu.trigger(:_menu_current_, name)
+{include:file:docs/events/by_name/menu_items.md}
 
-### `:_menu_deselect_`
-Deselects all menu items.
+{include:file:docs/events/by_name/menu_next.md}
 
-    Vedeu.trigger(:_menu_deselect_, name)
+{include:file:docs/events/by_name/menu_prev.md}
 
-### `:_menu_items_`
-Returns all the menu items with respective `current` or `selected`
-boolean indicators.
+{include:file:docs/events/by_name/menu_selected.md}
 
-    Vedeu.trigger(:_menu_items_, name)
+{include:file:docs/events/by_name/menu_select.md}
 
-### `:_menu_next_`
-Makes the next menu item the current menu item, until it reaches the
-last item.
+{include:file:docs/events/by_name/menu_top.md}
 
-    Vedeu.trigger(:_menu_next_, name)
-
-### `:_menu_prev_`
-Makes the previous menu item the current menu item, until it reaches
-the first item.
-
-    Vedeu.trigger(:_menu_prev_, name)
-
-### `:_menu_selected_`
-Returns the selected menu item.
-
-    Vedeu.trigger(:_menu_selected_, name)
-
-### `:_menu_select_`
-Makes the current menu item also the selected menu item.
-
-    Vedeu.trigger(:_menu_select_, name)
-
-### `:_menu_top_`
-Makes the first menu item the current menu item.
-
-    Vedeu.trigger(:_menu_top_, name)
-
-### `:_menu_view_`
-Returns a subset of the menu items; starting at the current item to
-the last item.
-
-    Vedeu.trigger(:_menu_view_, name)
+{include:file:docs/events/by_name/menu_view.md}

data/docs/events/refresh.md

@@ -4,33 +4,14 @@
 
 Note: 'name' is a Symbol unless mentioned otherwise.
 
-### `:_refresh_`
-Refreshes all registered interfaces.
+{include:file:docs/events/by_name/refresh.md}
 
-The interfaces will be refreshed in z-index order, meaning that
-interfaces with a lower z-index will be drawn first. This means
-overlapping interfaces will be drawn as specified. Hidden interfaces
-will be still refreshed in memory but not shown.
+{include:file:docs/events/by_name/refresh_border.md}
 
-    Vedeu.trigger(:_refresh_)
+{include:file:docs/events/by_name/refresh_cursor.md}
 
-### `:_refresh_cursor_`
-Will cause the named cursor to refresh, or the cursor of the interface
-which is currently in focus.
+{include:file:docs/events/by_name/refresh_group.md}
 
-    Vedeu.trigger(:_refresh_cursor_, name)
+{include:file:docs/events/by_name/refresh_view.md}
 
-### `:_refresh_group_`
-Will cause all interfaces in the named group to refresh.
-
-    Vedeu.trigger(:_refresh_group_, name)
-
-### `:_refresh_view_`
-Will cause the named view to refresh.
-
-    Vedeu.trigger(:_refresh_view_, name)
-
-### `:_refresh_view_content_`
-Will cause only the content of the named view to refresh.
-
-    Vedeu.trigger(:_refresh_view_content_, name)
+{include:file:docs/events/by_name/refresh_view_content.md}

data/docs/events/system.md

@@ -2,111 +2,18 @@
 
 ## System Events
 
-### `:_cleanup_`
-Vedeu triggers this event when `:_exit_` is triggered. You can hook
-into this to perform a special action before the application
-terminates. Saving the user's work, session or preferences might be
-popular here.
+{include:file:docs/events/by_name/cleanup.md}
 
-    Vedeu.trigger(:_exit_)
+{include:file:docs/events/by_name/command.md}
 
-### `:_command_`
-This event is used by Vedeu internally, though you can bind to it if
-you wish. It is preferred for you to bind to `:command` though.
+{include:file:docs/events/by_name/editor.md}
 
-Will cause the triggering of the `:command` event; which you should
-define to 'do things'.
+{include:file:docs/events/by_name/exit.md}
 
-    Vedeu.trigger(:_command_, command)
+{include:file:docs/events/by_name/initialize.md}
 
-    Vedeu.bind(:command) do
-      # ... your code here ...
-    end
+{include:file:docs/events/by_name/keypress.md}
 
-Alternatively, you can access commands entered using the following
-API methods: (See {Vedeu::Input::Store} for more details).
+{include:file:docs/events/by_name/log.md}
 
-    Vedeu.all_commands
-
-    Vedeu.last_command
-
-### `:_editor_`
-This event is called by {Vedeu::Input::Capture#read}. When
-invoked, the key will be passed to the editor for currently
-focussed view.
-
-Note: 'key' is a String for alphanumeric keys and special keys are
-represented by Symbols.
-
-    Vedeu.trigger(:_editor_, key)
-
-### `:_exit_`
-When triggered, Vedeu will trigger a `:cleanup` event which you can
-define (to save files, etc) and attempt to exit.
-
-    Vedeu.trigger(:_exit_)
-    Vedeu.exit
-
-### `:_initialize_`
-Vedeu triggers this event when it is ready to enter the main loop.
-Client applications can listen for this event and perform some
-action(s), like render the first screen, interface or make a sound.
-
-    Vedeu.trigger(:_initialize_)
-
-### `:_keypress_`
-This event is used by Vedeu internally, though you can bind to it if
-you wish. It is preferred for you to bind to `:key` though.
-
-When the name is given:
-
-- The given key is passed to the named keymap. If the keymap is
-  registered, and the key has an associated action assigned, then
-  the action will be called/triggered.
-- If the keymap is not registered, the key will be passed to the
-  global keymap to be actioned, or ignored if the global keymap does
-  not have an action assigned for the key pressed.
-
-When the name is not given:
-
-- The given key is passed to the named keymap associated with the
-  interface/view currently in focus. If the key has an associated
-  action assigned, then the action will be called or triggered,
-  otherwise, the key is (as above) passed to the global keymap to be
-  processed.
-
-It is also to be noted, that a `:key` event will be triggered
-irrespective of the conditions above, you can bind to this event
-separately to 'do things'.
-
-    Vedeu.bind(:key) do
-      # ... your code here ...
-    end
-
-Alternatively, you can access keypresses entered using the following
-API methods: (See {Vedeu::Input::Store} for more details).
-
-    Vedeu.all_keypresses
-
-    Vedeu.last_keypress
-
-A list of supported keypresses can be found here:
-{Vedeu::Input::Capture}.
-
-    Vedeu.trigger(:_keypress_, key, optional_name)
-
-### `:_log_`
-When triggered with a message will cause Vedeu to log the message if
-logging is enabled in the configuration.
-
-Note: 'message' is a String.
-
-    Vedeu.trigger(:_log_, message)
-
-### `:_mode_switch_`
-When triggered, Vedeu switches between modes of the terminal. The idea
-here being that the raw mode is for single keypress actions, whilst
-fake and cooked modes allow the user to enter more elaborate commands-
-such as commands with arguments.
-
-    Vedeu.trigger(:_mode_switch_, mode)
+{include:file:docs/events/by_name/mode_switch.md}

data/docs/events/view.md

@@ -4,42 +4,10 @@
 
 Note: 'name' is a Symbol unless mentioned otherwise.
 
-### `:_maximise_`
-Maximising an interface.
+{include:file:docs/events/by_name/maximise.md}
 
-    Vedeu.trigger(:_maximise_, name)
+{include:file:docs/events/by_name/movement_refresh.md}
 
-See {Vedeu::Geometries::Geometry#maximise}
+{include:file:docs/events/by_name/resize.md}
 
-### `:_movement_refresh_`
-When triggered, triggers additional events which aid the updating of
-the output. Used when moving an interface/view.
-
-    Vedeu.trigger(:_movement_refresh_, name)
-
-At this time, triggering this event will:
-
-- Clear the entire terminal (assuming at least one renderer is the
-  default (Vedeu::Renderer::Terminal)). This action is performed when
-  moving an interface/view so that there are no 'artefacts' left
-  behind.
-- Refresh the entire terminal (as above). This means all visible
-  interfaces are re-rendered. This action is performed to ensure other
-  views currently visible are rendered in their current position.
-- Clears the named view. This action removes the named view from the
-  terminal (or output).
-- Refreshes the named view. This action adds the named view to the
-  terminal (or output); in the new position.
-
-### `:_resize_`
-When triggered will cause Vedeu to trigger the `:_clear_` and
-`:_refresh_` events. Please see those events for their behaviour.
-
-    Vedeu.trigger(:_resize_)
-
-### `:_unmaximise_`
-Unmaximising an interface.
-
-    Vedeu.trigger(:_unmaximise_, name)
-
-See {Vedeu::Geometries::Geometry#unmaximise}
+{include:file:docs/events/by_name/unmaximise.md}

data/docs/events/visibility.md

@@ -4,60 +4,22 @@
 
 Note: 'name' is a Symbol unless mentioned otherwise.
 
-### `:_clear_`
-See {Vedeu::Buffers::Terminal#clear}
+{include:file:docs/events/by_name/clear.md}
 
-### `:_clear_group_`
-Clears the spaces occupied by the interfaces belonging to the named
-group.
+{include:file:docs/events/by_name/clear_group.md}
 
-    Vedeu.trigger(:_clear_group_, name)
-    Vedeu.clear_by_group(name)
+{include:file:docs/events/by_name/clear_view.md}
 
-### `:_clear_view_`
-Clears the named view/interface area.
+{include:file:docs/events/by_name/clear_view_content.md}
 
-    Vedeu.trigger(:_clear_view_, name)
-    Vedeu.clear_by_name(name)
+{include:file:docs/events/by_name/hide_group.md}
 
-### `:_clear_view_content_`
-Clears only the content of the named view/interface area.
+{include:file:docs/events/by_name/hide_interface.md}
 
-    Vedeu.trigger(:_clear_view_content_, name)
-    Vedeu.clear_content_by_name(name)
+{include:file:docs/events/by_name/show_group.md}
 
-### `:_hide_group_`
-Hiding a group of interfaces.
+{include:file:docs/events/by_name/show_interface.md}
 
-    Vedeu.trigger(:_hide_group_, name)
-    Vedeu.hide_group(name)
+{include:file:docs/events/by_name/toggle_group.md}
 
-### `:_hide_interface_`
-Hide an interface by name.
-
-    Vedeu.trigger(:_hide_interface_, name)
-    Vedeu.hide_interface(name)
-
-### `:_show_group_`
-Showing a group of interfaces.
-
-    Vedeu.trigger(:_show_group_, name)
-    Vedeu.show_group(name)
-
-### `:_show_interface_`
-Show an interface by name.
-
-    Vedeu.trigger(:_show_interface_, name)
-    Vedeu.show_interface(name)
-
-### `:_toggle_group_`
-Toggling a group of interfaces.
-
-    Vedeu.trigger(:_toggle_group_, name)
-    Vedeu.toggle_group(name)
-
-### `:_toggle_interface_`
-Toggling an interface.
-
-    Vedeu.trigger(:_toggle_interface_, name)
-    Vedeu.toggle_interface(name)
+{include:file:docs/events/by_name/toggle_interface.md}

data/lib/vedeu/borders/border.rb

@@ -21,20 +21,20 @@ module Vedeu
       include Vedeu::Repositories::Model
       include Vedeu::Presentation
 
-      # @!attribute [rw] bottom_left
+      # @!attribute [w] bottom_left
       # @return [String] The character to be used for the bottom left
       #   border if enabled.
-      attr_accessor :bottom_left
+      attr_writer :bottom_left
 
-      # @!attribute [rw] bottom_right
+      # @!attribute [w] bottom_right
       # @return [String] The character to be used for the bottom right
       #   border if enabled.
-      attr_accessor :bottom_right
+      attr_writer :bottom_right
 
-      # @!attribute [rw] bottom_horizontal
+      # @!attribute [w] bottom_horizontal
       # @return [String] The character to be used for the bottom
       #   horizontal border if enabled.
-      attr_accessor :bottom_horizontal
+      attr_writer :bottom_horizontal
 
       # @!attribute [rw] caption
       # @return [String] An optional caption for when the bottom
@@ -75,35 +75,35 @@ module Vedeu
       #   to be shown.
       attr_accessor :title
 
-      # @!attribute [rw] top_left
+      # @!attribute [w] top_left
       # @return [String] The character to be used for the top left
       #   border if enabled.
-      attr_accessor :top_left
+      attr_writer :top_left
 
-      # @!attribute [rw] top_right
+      # @!attribute [w] top_right
       # @return [String] The character to be used for the top right
       #   border if enabled.
-      attr_accessor :top_right
+      attr_writer :top_right
 
-      # @!attribute [rw] top_horizontal
+      # @!attribute [w] top_horizontal
       # @return [String] The character to be used for the top
       #   horizontal border if enabled.
-      attr_accessor :top_horizontal
+      attr_writer :top_horizontal
 
       # @!attribute [rw] vertical
       # @return [String] The character to be used for the vertical
       #   side border.
       attr_accessor :vertical
 
-      # @!attribute [rw] left_vertical
+      # @!attribute [w] left_vertical
       # @return [String] The character to be used for the left
       #   vertical side border.
-      attr_accessor :left_vertical
+      attr_writer :left_vertical
 
-      # @!attribute [rw] right_vertical
+      # @!attribute [w] right_vertical
       # @return [String] The character to be used for the right
       #   vertical side border.
-      attr_accessor :right_vertical
+      attr_writer :right_vertical
 
       # @!attribute [r] name
       # @return [String|Symbol] Associates the border with the
@@ -115,7 +115,7 @@ module Vedeu
       #   view associated with this border.
       attr_reader :parent
 
-      # @!attribute [r] enabled
+      # @!attribute [rw] enabled
       # @return [Boolean] Determines whether this border should be
       #   rendered.
       attr_accessor :enabled
@@ -126,17 +126,21 @@ module Vedeu
       # @param attributes [Hash<Symbol => Boolean|Hash|NilClass|
       #   String|Symbol|Vedeu::Borders::Repository|
       #   Vedeu::Presentation::Style>]
-      # @option attributes bottom_left [String] The bottom left border
-      #   character.
-      # @option attributes bottom_right [String] The bottom right
-      #   border character.
+      # @option attributes bottom_left [String]
+      #   The bottom left border character.
+      # @option attributes bottom_right [String]
+      #   The bottom right border character.
       # @option attributes colour [Hash]
       # @option attributes enabled [Boolean] Indicate whether the
       #   border is to be shown for this interface.
-      # @option attributes horizontal [String] The horizontal border
-      #   character.
+      # @option attributes horizontal [String]
+      #   The horizontal border character.
+      # @option attributes left_vertical [String]
+      #   The left vertical border character.
       # @option attributes name [String|Symbol] The name of the
       #   interface to which this border relates.
+      # @option attributes right_vertical [String]
+      #   The right vertical border character.
       # @option attributes style [Vedeu::Presentation::Style]
       # @option attributes show_bottom [Boolean] Indicate whether the
       #   bottom border is to be shown.
@@ -150,12 +154,14 @@ module Vedeu
       #   the top border is to be shown.
       # @option attributes caption [String] An optional caption for
       #   when the bottom border is to be shown.
-      # @option attributes top_left [String] The top left border
-      #   character.
-      # @option attributes top_right [String] The top right border
-      #   character.
-      # @option attributes vertical [String] The vertical border
-      #   character.
+      # @option attributes top_horizontal [String]
+      #   The top horizontal border character.
+      # @option attributes top_left [String]
+      #   The top left border character.
+      # @option attributes top_right [String]
+      #   The top right border character.
+      # @option attributes vertical [String]
+      #   The vertical border character.
       # @return [Vedeu::Borders::Border]
       def initialize(attributes = {})
         defaults.merge!(attributes).each do |key, value|
@@ -167,28 +173,28 @@ module Vedeu
       #   Vedeu::Borders::Repository|Vedeu::Presentation::Style>]
       def attributes
         {
-          bottom_horizontal: @bottom_horizontal,
-          bottom_left:       @bottom_left,
-          bottom_right:      @bottom_right,
+          bottom_horizontal: bottom_horizontal,
+          bottom_left:       bottom_left,
+          bottom_right:      bottom_right,
           caption:           @caption,
           client:            @client,
           colour:            @colour,
           enabled:           @enabled,
           horizontal:        @horizontal,
-          left_vertical:     @left_vertical,
+          left_vertical:     left_vertical,
           name:              @name,
           parent:            @parent,
           repository:        @repository,
-          right_vertical:    @right_vertical,
+          right_vertical:    right_vertical,
           show_bottom:       @show_bottom,
           show_left:         @show_left,
           show_right:        @show_right,
           show_top:          @show_top,
           style:             @style,
           title:             @title,
-          top_horizontal:    @top_horizontal,
-          top_left:          @top_left,
-          top_right:         @top_right,
+          top_horizontal:    top_horizontal,
+          top_left:          top_left,
+          top_right:         top_right,
           vertical:          @vertical,
         }
       end
@@ -205,8 +211,82 @@ module Vedeu
         Vedeu::Borders::DSL.new(self, client)
       end
 
+      # Return the client application configured left vertical cell
+      # character, or the default if not set.
+      #
+      # @return [Vedeu::Cells::LeftVertical]
+      def left_vertical
+        @left_vertical ||= Vedeu::Cells::LeftVertical.new(cell_attributes)
+      end
+
+      # Return the client application configured right vertical cell
+      # character, or the default if not set.
+      #
+      # @return [Vedeu::Cells::RightVertical]
+      def right_vertical
+        @right_vertical ||= Vedeu::Cells::RightVertical.new(cell_attributes)
+      end
+
+      # Return the client application configured top horizontal cell
+      # character, or the default if not set.
+      #
+      # @return [Vedeu::Cells::TopHorizontal]
+      def top_horizontal
+        @top_horizontal ||= Vedeu::Cells::TopHorizontal.new(cell_attributes)
+      end
+
+      # Return the client application configured top left cell
+      # character, or the default if not set.
+      #
+      # @return [Vedeu::Cells::TopLeft]
+      def top_left
+        @top_left ||= Vedeu::Cells::TopLeft.new(cell_attributes)
+      end
+
+      # Return the client application configured top right cell
+      # character, or the default if not set.
+      #
+      # @return [Vedeu::Cells::TopRight]
+      def top_right
+        @top_right ||= Vedeu::Cells::TopRight.new(cell_attributes)
+      end
+
+      # Return the client application configured bottom horizontal
+      # cell character, or the default if not set.
+      #
+      # @return [Vedeu::Cells::BottomHorizontal]
+      def bottom_horizontal
+        @bottom_horizontal ||= Vedeu::Cells::BottomHorizontal
+                                 .new(cell_attributes)
+      end
+
+      # Return the client application configured bottom left cell
+      # character, or the default if not set.
+      #
+      # @return [Vedeu::Cells::BottomLeft]
+      def bottom_left
+        @bottom_left ||= Vedeu::Cells::BottomLeft.new(cell_attributes)
+      end
+
+      # Return the client application configured bottom right cell
+      # character, or the default if not set.
+      #
+      # @return [Vedeu::Cells::BottomRight]
+      def bottom_right
+        @bottom_right ||= Vedeu::Cells::BottomRight.new(cell_attributes)
+      end
+
       private
 
+      # @return [Hash<Symbol => void>]
+      def cell_attributes
+        {
+          colour: @colour,
+          name:   @name,
+          style:  @style,
+        }
+      end
+
       # The default values for a new instance of this class.
       #
       # @return [Hash<Symbol => Boolean|Hash|NilClass|String|Symbol|