vedeu 0.6.32 → 0.6.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2fc9f2ae69352f9b6c21d8d8607082bb988cff48
-  data.tar.gz: 9a0d1207af8e078b58cccadab420b3465e00b816
+  metadata.gz: b2d162793e93e4fa86ae8aa3de42eebb420dfe04
+  data.tar.gz: f85ce22f4ae5e77674fb833f8424236a89980ccc
 SHA512:
-  metadata.gz: 2a17c83991be48b4ccbee939f304a72e3e4f2401c2793782b469403ae9386020bb2e36b0afdec9b5c42471045b9262a1c9e23a6ee50c3d6812506ee638480c3e
-  data.tar.gz: c7149fbd4b90a7d5eb4e2fecabcafca828cb4805b76c86b369441f37db3b91b3e7077988c7cda7bcde08ef5f5f9ec4c9baf0afdb3c4968a8e257b0a490dda6aa
+  metadata.gz: 9d43739fa7157c31b80664ef5745d9ba27321b876aa35eae85ddd1dd45f77a89d0d27386bfc50e699979cb4c21783432afab585fe7312b01f08da0916af9f12e
+  data.tar.gz: b05c10e2f4903031809a462cd4257952fd925f5b8bc0a4dc84880f704b5e82b255510624cddde9828edf4d4c4eb729397d3cada44143ab03a0cb3a965d6ec752

data/.yardopts

@@ -3,10 +3,10 @@
 --embed-mixins
 -
 docs/api.md
-docs/border.md
+docs/borders.md
 docs/buffer.md
 docs/configuration.md
-docs/cursor.md
+docs/cursors.md
 docs/dsl.md
 docs/events.md
 docs/geometry.md

data/README.md

@@ -53,8 +53,8 @@ here is some documentation for the various aspects of Vedeu:
 - [Views](http://rubydoc.info/gems/vedeu/file/docs/view.md)
 - [Buffers](http://rubydoc.info/gems/vedeu/file/docs/buffer.md)
 - [Geometry](http://rubydoc.info/gems/vedeu/file/docs/geometry.md)
-- [Borders](http://rubydoc.info/gems/vedeu/file/docs/border.md)
-- [Cursors](http://rubydoc.info/gems/vedeu/file/docs/cursor.md)
+- [Borders](http://rubydoc.info/gems/vedeu/file/docs/borders.md)
+- [Cursors](http://rubydoc.info/gems/vedeu/file/docs/cursors.md)
 - [Keymaps](http://rubydoc.info/gems/vedeu/file/docs/keymaps.md)
 - [Events](http://rubydoc.info/gems/vedeu/file/docs/events.md)
 - [Configuration](http://rubydoc.info/gems/vedeu/file/docs/configuration.md)

data/Rakefile

@@ -16,10 +16,10 @@ YARD::Rake::YardocTask.new(:yard) do |task|
     'lib/**/*.rb',
     '-',
     'docs/api.md',
-    'docs/border.md',
+    'docs/borders.md',
     'docs/buffer.md',
     'docs/configuration.md',
-    'docs/cursor.md',
+    'docs/cursors.md',
     'docs/dsl.md',
     'docs/events.md',
     'docs/geometry.md',

data/docs/borders.md

@@ -0,0 +1,62 @@
+# @title Vedeu Borders
+# Vedeu Borders
+
+The interfaces of Vedeu can each have their own border.
+
+- It has a name. This name associates it with an
+  {file:docs/interface.md Interface}.
+- Each of its corners, the horizontal, and the vertical character can
+  be defined as different characters.
+- It can have a foreground and a background and style, independent of
+  the interface to which it belongs.
+- Each of the sides of the border can be shown or hidden
+  independently.
+- The border itself can be enabled and disabled (shown/hidden) as
+  required.
+- The border can have a title, which is displayed on the top side.
+- It can also have a caption, which is displayed on the bottom side.
+- The sides of the border will use:
+  - The first (top) line of the geometry.
+  - The last (bottom) line of the geometry.
+  - The first character (left) of the geometry.
+  - The last character (right) of the geometry.
+- The border can be refreshed independently of the interface.
+
+## Border Events
+
+Note: 'name' is a Symbol unless mentioned otherwise, and can be
+substituted for `Vedeu.focus` to use the interface currently in focus.
+
+### `:\_refresh_border\_`
+This event refreshes the border of the named view, unless the view
+does not have a border, or the border is not enabled.
+
+    Vedeu.trigger(:_refresh_border_, name)
+
+### `:\_set_border_title\_`
+This event changes the title of the border of the named view to the
+value given.
+
+    Vedeu.trigger(:_set_border_title_, name, title)
+
+- The title must be a string or nil.
+- If the title is an empty string or nil, then the title will not be
+  shown, and an existing title will be removed.
+- If the name is nil, then the view currently focussed will be used.
+- When triggering this event, the border will automatically be
+  refreshed, unless the view does not have a border, or the border is
+  not enabled, or the top border is set not to be shown.
+
+### `:\_set_border_caption\_`
+This event changes the caption of the border of the named view to the
+value given.
+
+    Vedeu.trigger(:_set_border_caption_, name, caption)
+
+- The caption must be a string or nil.
+- If the caption is an empty string or nil, then the caption will not
+  be shown, and an existing caption will be removed.
+- If the name is nil, then the view currently focussed will be used.
+- When triggering this event, the border will automatically be
+  refreshed, unless the view does not have a border, or the border is
+  not enabled, or the bottom border is set not to be shown.

data/docs/{cursor.md → cursors.md}

@@ -27,14 +27,14 @@ conveniently after the interface itself.
 Note: 'name' is a Symbol unless mentioned otherwise, and can be
 substituted for 'Vedeu.focus' to use the interface currently in focus.
 
-### :\_cursor_origin_
+### `:\_cursor_origin\_`
 This event moves the cursor to the interface origin; the top left
 corner of the named interface.
 
     Vedeu.trigger(:_cursor_origin_, name)
     Vedeu.trigger(:_cursor_reset_, name)
 
-### :\_cursor_position_
+### `:\_cursor_position\_`
 To ascertain the position of a cursor in a named interface, use the
 following event (substituting 'name' for the interface name):
 
@@ -45,7 +45,7 @@ name, you can check which interface is in focus:
 
     Vedeu.trigger(:_cursor_position_, Vedeu.focus)
 
-### :\_cursor_reposition_
+### `:\_cursor_reposition\_`
 Moves the cursor to a relative position inside the interface.
 
     Vedeu.trigger(:_cursor_reposition_, name, y, x)
@@ -56,22 +56,22 @@ Adjusts the position of the named cursor or view in the direction
 specified. If 'name' is unknown, using 'Vedeu.focus' will use the
 interface currently in focus.
 
-### :\_cursor_left_
+### `:\_cursor_left\_`
 
     Vedeu.trigger(:_cursor_left_, name)
     Vedeu.trigger(:_cursor_left_, Vedeu.focus)
 
-### :\_cursor_down_
+### `:\_cursor_down\_`
 
     Vedeu.trigger(:_cursor_down_, name)
     Vedeu.trigger(:_cursor_down_, Vedeu.focus)
 
-### :\_cursor_up_
+### `:\_cursor_up\_`
 
     Vedeu.trigger(:_cursor_up_, name)
     Vedeu.trigger(:_cursor_up_, Vedeu.focus)
 
-### :\_cursor_right_
+### `:\_cursor_right\_`
 
     Vedeu.trigger(:_cursor_right_, name)
     Vedeu.trigger(:_cursor_right_, Vedeu.focus)

data/docs/events/application.md

@@ -2,7 +2,7 @@
 
 ## Application Events
 
-### :\_goto_
+### `:\_goto\_`
 Call a client application controller's action with parameters.
 
     Vedeu.trigger(:_goto_,

data/docs/events/document.md

@@ -4,29 +4,29 @@
 
 Note: 'name' is a Symbol unless mentioned otherwise.
 
-### :\_editor_execute_
+### `:\_editor_execute\_`
 
     Vedeu.trigger(:_editor_execute_, name)
 
-### :\_editor_delete_character_
+### `:\_editor_delete_character\_`
 This event attempts to delete the character in the named
 document at the current virtual cursor position.
 
     Vedeu.trigger(:_editor_delete_character_, name)
 
-### :\_editor_delete_line_
+### `:\_editor_delete_line\_`
 This event attempts to delete the line in the named document
 at the current virtual cursor position.
 
     Vedeu.trigger(:_editor_delete_line_, name)
 
-### :\_editor_down_
+### `:\_editor_down\_`
 This event attempts to move the virtual cursor down by one
 line in the named document.
 
     Vedeu.trigger(:_editor_down_, name)
 
-### :\_editor_insert_character_
+### `:\_editor_insert_character\_`
 This event attempts to insert the given character in the named
 document at the current virtual cursor position.
 
@@ -34,25 +34,25 @@ Note: 'character' is a string.
 
     Vedeu.trigger(:_editor_insert_character_, name, character)
 
-### :\_editor_insert_line_
+### `:\_editor_insert_line\_`
 This event attempts to insert a new line in the named document
 at the current virtual cursor position.
 
     Vedeu.trigger(:_editor_insert_line_, name)
 
-### :\_editor_left_
+### `:\_editor_left\_`
 This event attempts to move the virtual cursor left by one
 character in the named document.
 
     Vedeu.trigger(:_editor_left_, name)
 
-### :\_editor_right_
+### `:\_editor_right\_`
 This event attempts to move the virtual cursor right by one
 character in the named document.
 
     Vedeu.trigger(:_editor_right_, name)
 
-### :\_editor_up_
+### `:\_editor_up\_`
 This event attempts to move the virtual cursor up by one line
 in the named document.
 

data/docs/events/drb.md

@@ -2,7 +2,7 @@
 
 ## DRB Events
 
-### :\_drb_input_
+### `:\_drb_input\_`
 Triggering this event will send input to the running application as
 long as it has the DRb server running.
 
@@ -10,11 +10,11 @@ Note: See {Vedeu::Distributed::Server#input} for parameter details.
 
     Vedeu.trigger(:_drb_input_, data, type)
 
-### :\_drb_retrieve_output_
+### `:\_drb_retrieve_output\_`
 
     Vedeu.trigger(:_drb_retrieve_output_)
 
-### :\_drb_store_output_
+### `:\_drb_store_output\_`
 Triggering this event with 'data' will push data into the running
 application's virtual buffer.
 
@@ -22,25 +22,25 @@ Note: See {Vedeu::Terminal::Buffer#write} for parameter details.
 
     Vedeu.trigger(:_drb_store_output_, data)
 
-### :\_drb_restart_
+### `:\_drb_restart\_`
 Use the DRb server to request the client application to restart.
 
     Vedeu.trigger(:_drb_restart_)
     Vedeu.drb_restart
 
-### :\_drb_start_
+### `:\_drb_start\_`
 Use the DRb server to request the client application to start.
 
     Vedeu.trigger(:_drb_start_)
     Vedeu.drb_start
 
-### :\_drb_status_
+### `:\_drb_status\_`
 Use the DRb server to request the status of the client application.
 
     Vedeu.trigger(:_drb_status_)
     Vedeu.drb_status
 
-### :\_drb_stop_
+### `:\_drb_stop\_`
 Use the DRb server to request the client application to stop.
 
     Vedeu.trigger(:_drb_stop_)

data/docs/events/focus.md

@@ -4,21 +4,21 @@
 
 Note: 'name' is a Symbol unless mentioned otherwise.
 
-### :\_focus_by_name_
+### `:\_focus_by_name\_`
 When triggered with an interface name will focus that interface and
 restore the cursor position and visibility.
 
     Vedeu.trigger(:_focus_by_name_, name) # or
     Vedeu.focus_by_name(name)
 
-### :\_focus_next_
+### `:\_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_
+### `:\_focus_prev\_`
 When triggered will focus the previous visible interface and restore
 the cursor position and visibility.
 

data/docs/events/menu.md

@@ -4,55 +4,55 @@
 
 Note: 'name' is a Symbol unless mentioned otherwise.
 
-### :\_menu_bottom_
+### `:\_menu_bottom\_`
 Makes the last menu item the current menu item.
 
     Vedeu.trigger(:_menu_bottom_, name)
 
-### :\_menu_current_
+### `:\_menu_current\_`
 Returns the current menu item.
 
     Vedeu.trigger(:_menu_current_, name)
 
-### :\_menu_deselect_
+### `:\_menu_deselect\_`
 Deselects all menu items.
 
     Vedeu.trigger(:_menu_deselect_, name)
 
-### :\_menu_items_
+### `:\_menu_items\_`
 Returns all the menu items with respective `current` or `selected`
 boolean indicators.
 
     Vedeu.trigger(:_menu_items_, name)
 
-### :\_menu_next_
+### `:\_menu_next\_`
 Makes the next menu item the current menu item, until it reaches the
 last item.
 
     Vedeu.trigger(:_menu_next_, name)
 
-### :\_menu_prev_
+### `:\_menu_prev\_`
 Makes the previous menu item the current menu item, until it reaches
 the first item.
 
     Vedeu.trigger(:_menu_prev_, name)
 
-### :\_menu_selected_
+### `:\_menu_selected\_`
 Returns the selected menu item.
 
     Vedeu.trigger(:_menu_selected_, name)
 
-### :\_menu_select_
+### `:\_menu_select\_`
 Makes the current menu item also the selected menu item.
 
     Vedeu.trigger(:_menu_select_, name)
 
-### :\_menu_top_
+### `:\_menu_top\_`
 Makes the first menu item the current menu item.
 
     Vedeu.trigger(:_menu_top_, name)
 
-### :\_menu_view_
+### `:\_menu_view\_`
 Returns a subset of the menu items; starting at the current item to
 the last item.
 

data/docs/events/movement.md

@@ -5,10 +5,10 @@
 Note: 'name' is a Symbol unless mentioned otherwise.
 
 For cursor related movement events, please refer to
-{file:docs/cursor.md} Cursors.
+{file:docs/cursors.md} Cursors.
 
 
-### :\_view_(up, down, left, right)_
+### `:\_view_(up, down, left, right)\_`
 
 Please note that the name of the view is required for these events.
 
@@ -17,4 +17,4 @@ Please note that the name of the view is required for these events.
     Vedeu.trigger(:_view_right_, name)
     Vedeu.trigger(:_view_up_, name)
 
-Each of the :\_view_* events has an alias, :\_geometry_* if you prefer.
+Each of the `:\_view\_*` events has an alias, `:\_geometry\_*` if you prefer.

data/docs/events/refresh.md

@@ -4,7 +4,7 @@
 
 Note: 'name' is a Symbol unless mentioned otherwise.
 
-### :\_refresh_
+### `:\_refresh\_`
 Refreshes all registered interfaces.
 
 The interfaces will be refreshed in z-index order, meaning that
@@ -14,28 +14,23 @@ will be still refreshed in memory but not shown.
 
     Vedeu.trigger(:_refresh_)
 
-### :\_refresh_border_
-Will cause the named border to refresh.
-
-    Vedeu.trigger(:_refresh_border_, name)
-
-### :\_refresh_cursor_
+### `:\_refresh_cursor\_`
 Will cause the named cursor to refresh, or the cursor of the interface
 which is currently in focus.
 
     Vedeu.trigger(:_refresh_cursor_, name)
 
-### :\_refresh_group_
+### `:\_refresh_group\_`
 Will cause all interfaces in the named group to refresh.
 
     Vedeu.trigger(:_refresh_group_, name)
 
-### :\_refresh_view_
+### `:\_refresh_view\_`
 Will cause the named view to refresh.
 
     Vedeu.trigger(:_refresh_view_, name)
 
-### :\_refresh_view_content_
+### `:\_refresh_view_content\_`
 Will cause only the content of the named view to refresh.
 
     Vedeu.trigger(:_refresh_view_content_, name)