vedeu 0.7.2 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12ee9a34dc28d9a2230a6e1acb69e62e8da7cd20
-  data.tar.gz: 27b92a31c6f1585f4f84e6d1de7469569e5ddfa9
+  metadata.gz: 73d956c3dee89d057e89b5e730ca5ef5a974c229
+  data.tar.gz: 769594b1a84d5f2194fa71ba56faf86c5744ea71
 SHA512:
-  metadata.gz: e24f06eb598a6776473d4f1a7364be6eca6e9c1660260093643a3a752ccd4765c66a1c9f429db439f5de99bafe2bdc64df3173bc38549e34d5df91029778f68b
-  data.tar.gz: abb7551af78cb1c8339cd678a33e0e590a74b057cf32c9f256bc77980a6b1f2b05da31fc563b86a3e79775ab6a267eb4c3ae7817669797ee072146dc18b8b890
+  metadata.gz: 7660a8daf5f90ad644122576bdffd1ff984d4b13166d253feabb510bf6c799ec92607ecd0eaf1407234606d308901129aa75c6f93e28b749f94729602698f4c8
+  data.tar.gz: 322f163dda6a068a21f84f2ec53563dc69236e5f223ca3f4c73eca803c82919db630a188485233e2bb2abc18b4d822a08676057512c9c21cbceb860fa5eb0d52

data/docs/borders.md

@@ -27,11 +27,7 @@ The interfaces of Vedeu can each have their own border.
 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)
+{include:file:docs/events/by_name/refresh_border.md}
 
 ### `:_set_border_title_`
 This event changes the title of the border of the named view to the

data/docs/cursors.md

@@ -38,28 +38,26 @@ can be specified when defining the interface.
 Each example within each interface definition is equivalent.
 
 #### Showing the cursor
+The following `cursor` statements are equivalent:
 
-    Vedeu.interface :my_interface do
+    # Vedeu.interface :my_interface do
       cursor true
-
-      # or...
-
       cursor!
+      show_cursor!
 
       # ...
-    end
+    # end
 
 #### Hiding the cursor
+The following `cursor` statements are equivalent:
 
-    Vedeu.interface :my_interface do
+    # Vedeu.interface :my_interface do
       cursor false
-
-      # or...
-
       no_cursor!
+      hide_cirsor!
 
       # ...
-    end
+    # end
 
 ### View Cursors
 The view cursor is the same as the interface cursor with the same
@@ -85,30 +83,17 @@ view is rendered, overriding the initial or current state.
     end
 
 
-## Cursor Positioning Events
-
-### `:_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 Events
 
-### `:_cursor_position_`
-To ascertain the position of a cursor in a named interface, use the
-following event (substituting 'name' for the interface name):
+{include:file:docs/events/by_name/refresh_cursor.md}
 
-    Vedeu.trigger(:_cursor_position_, name)
-
-If you want to know where the cursor is without knowing the interface
-name, you can check which interface is in focus:
+## Cursor Positioning Events
 
-    Vedeu.trigger(:_cursor_position_, Vedeu.focus)
+{include:file:docs/events/by_name/cursor_origin.md}
 
-### `:_cursor_reposition_`
-Moves the cursor to a relative position inside the interface.
+{include:file:docs/events/by_name/cursor_position.md}
 
-    Vedeu.trigger(:_cursor_reposition_, name, y, x)
+{include:file:docs/events/by_name/cursor_reposition.md}
 
 ## Cursor Movement Events
 
@@ -116,45 +101,17 @@ 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_`
-Moves the cursor one character left, unless the left-most position
-for the view or terminal is reached.
-
-    Vedeu.trigger(:_cursor_left_, name)
-    Vedeu.trigger(:_cursor_left_, Vedeu.focus)
+{include:file:docs/events/by_name/cursor_left.md}
 
-### `:_cursor_down_`
+{include:file:docs/events/by_name/cursor_down.md}
 
-    Vedeu.trigger(:_cursor_down_, name)
-    Vedeu.trigger(:_cursor_down_, Vedeu.focus)
+{include:file:docs/events/by_name/cursor_up.md}
 
-### `:_cursor_up_`
-Moves the cursor one line up, unless the top-most position for the
-view or terminal is reached.
+{include:file:docs/events/by_name/cursor_right.md}
 
-    Vedeu.trigger(:_cursor_up_, name)
-    Vedeu.trigger(:_cursor_up_, Vedeu.focus)
+{include:file:docs/events/by_name/cursor_top.md}
 
-### `:_cursor_right_`
-
-    Vedeu.trigger(:_cursor_right_, name)
-    Vedeu.trigger(:_cursor_right_, Vedeu.focus)
-
-### `:_cursor_top_`
-Moves the cursor to the top-most position for the view or terminal.
-If the view contains content, then this event will effectively scroll
-to the first line of the content.
-
-    Vedeu.trigger(:_cursor_top_, name)
-    Vedeu.trigger(:_cursor_top_, Vedeu.focus)
-
-### `:_cursor_bottom_`
-Moves the cursor to the bottom-most position for the view or terminal.
-If the view contains content, then this event will effectively scroll
-to the last line of the content.
-
-    Vedeu.trigger(:_cursor_bottom_, name)
-    Vedeu.trigger(:_cursor_bottom_, Vedeu.focus)
+{include:file:docs/events/by_name/cursor_bottom.md}
 
 ## Cursor Visibility API & Events
 
@@ -163,34 +120,8 @@ can be called at any time and affect the cursor of the named
 interface, or when a name is not given, the interface currently in
 focus.
 
-### Vedeu.hide_cursor / `:_cursor_hide_`
-Hide the cursor.
-
-    Vedeu.trigger(:_hide_cursor_, name)
-    Vedeu.trigger(:_hide_cursor_, Vedeu.focus)
-    Vedeu.trigger(:_cursor_hide_, name)
-    Vedeu.trigger(:_cursor_hide_, Vedeu.focus)
-
-    Vedeu.hide_cursor(name)
-    Vedeu.hide_cursor(Vedeu.focus)
-
-### Vedeu.show_cursor / `:_show_cursor_`
-Show the cursor.
-
-    Vedeu.trigger(:_show_cursor_, name)
-    Vedeu.trigger(:_show_cursor_, Vedeu.focus)
-    Vedeu.trigger(:_cursor_show_, name)
-    Vedeu.trigger(:_cursor_show_, Vedeu.focus)
-
-    Vedeu.show_cursor(name)
-    Vedeu.show_cursor(Vedeu.focus)
-
-### Vedeu.toggle_cursor / `:_toggle_cursor_`
-Toggle the visibility of the cursor. If hidden, then show. If shown,
-then hide.
+{include:file:docs/events/by_name/hide_cursor.md}
 
-    Vedeu.trigger(:_toggle_cursor_, name)
-    Vedeu.trigger(:_toggle_cursor_, Vedeu.focus)
+{include:file:docs/events/by_name/show_cursor.md}
 
-    Vedeu.toggle_cursor(name)
-    Vedeu.toggle_cursor(Vedeu.focus)
+{include:file:docs/events/by_name/toggle_cursor.md}

data/docs/events/application.md

@@ -2,11 +2,4 @@
 
 ## Application Events
 
-### `:_goto_`
-Call a client application controller's action with parameters.
-
-    Vedeu.trigger(:_goto_,
-                  :your_controller,
-                  :some_action,
-                  { id: 7 })
-    Vedeu.goto(:your_controller, :some_action, { id: 7 })
+{include:file:docs/events/by_name/goto.md}

data/docs/events/by_name/cleanup.md

@@ -0,0 +1,7 @@
+### `:_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.
+
+    Vedeu.trigger(:_exit_)

data/docs/events/by_name/clear.md

@@ -0,0 +1,2 @@
+### `:_clear_`
+See {Vedeu::Buffers::Terminal#clear}

data/docs/events/by_name/clear_group.md

@@ -0,0 +1,6 @@
+### `:_clear_group_`
+Clears the spaces occupied by the interfaces belonging to the named
+group.
+
+    Vedeu.trigger(:_clear_group_, name)
+    Vedeu.clear_by_group(name)

data/docs/events/by_name/clear_view.md

@@ -0,0 +1,5 @@
+### `:_clear_view_`
+Clears the named view/interface area.
+
+    Vedeu.trigger(:_clear_view_, name)
+    Vedeu.clear_by_name(name)

data/docs/events/by_name/clear_view_content.md

@@ -0,0 +1,5 @@
+### `:_clear_view_content_`
+Clears only the content of the named view/interface area.
+
+    Vedeu.trigger(:_clear_view_content_, name)
+    Vedeu.clear_content_by_name(name)

data/docs/events/by_name/command.md

@@ -0,0 +1,19 @@
+### `:_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.
+
+Will cause the triggering of the `:command` event; which you should
+define to 'do things'.
+
+    Vedeu.trigger(:_command_, command)
+
+    Vedeu.bind(:command) do
+      # ... your code here ...
+    end
+
+Alternatively, you can access commands entered using the following
+API methods: (See {Vedeu::Input::Store} for more details).
+
+    Vedeu.all_commands
+
+    Vedeu.last_command

data/docs/events/by_name/cursor_bottom.md

@@ -0,0 +1,7 @@
+### `:_cursor_bottom_`
+Moves the cursor to the bottom-most position for the view or terminal.
+If the view contains content, then this event will effectively scroll
+to the last line of the content.
+
+    Vedeu.trigger(:_cursor_bottom_, name)
+    Vedeu.trigger(:_cursor_bottom_, Vedeu.focus)

data/docs/events/by_name/cursor_down.md

@@ -0,0 +1,4 @@
+### `:_cursor_down_`
+
+    Vedeu.trigger(:_cursor_down_, name)
+    Vedeu.trigger(:_cursor_down_, Vedeu.focus)

data/docs/events/by_name/cursor_left.md

@@ -0,0 +1,6 @@
+### `:_cursor_left_`
+Moves the cursor one character left, unless the left-most position
+for the view or terminal is reached.
+
+    Vedeu.trigger(:_cursor_left_, name)
+    Vedeu.trigger(:_cursor_left_, Vedeu.focus)

data/docs/events/by_name/cursor_origin.md

@@ -0,0 +1,6 @@
+### `:_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)

data/docs/events/by_name/cursor_position.md

@@ -0,0 +1,10 @@
+### `:_cursor_position_`
+To ascertain the position of a cursor in a named interface, use the
+following event (substituting 'name' for the interface name):
+
+    Vedeu.trigger(:_cursor_position_, name)
+
+If you want to know where the cursor is without knowing the interface
+name, you can check which interface is in focus:
+
+    Vedeu.trigger(:_cursor_position_, Vedeu.focus)

data/docs/events/by_name/cursor_reposition.md

@@ -0,0 +1,4 @@
+### `:_cursor_reposition_`
+Moves the cursor to a relative position inside the interface.
+
+    Vedeu.trigger(:_cursor_reposition_, name, y, x)

data/docs/events/by_name/cursor_right.md

@@ -0,0 +1,4 @@
+### `:_cursor_right_`
+
+    Vedeu.trigger(:_cursor_right_, name)
+    Vedeu.trigger(:_cursor_right_, Vedeu.focus)

data/docs/events/by_name/cursor_top.md

@@ -0,0 +1,7 @@
+### `:_cursor_top_`
+Moves the cursor to the top-most position for the view or terminal.
+If the view contains content, then this event will effectively scroll
+to the first line of the content.
+
+    Vedeu.trigger(:_cursor_top_, name)
+    Vedeu.trigger(:_cursor_top_, Vedeu.focus)

data/docs/events/by_name/cursor_up.md

@@ -0,0 +1,6 @@
+### `:_cursor_up_`
+Moves the cursor one line up, unless the top-most position for the
+view or terminal is reached.
+
+    Vedeu.trigger(:_cursor_up_, name)
+    Vedeu.trigger(:_cursor_up_, Vedeu.focus)

data/docs/events/by_name/drb_input.md

@@ -0,0 +1,7 @@
+### `:_drb_input_`
+Triggering this event will send input to the running application as
+long as it has the DRb server running.
+
+Note: See {Vedeu::Distributed::Server#input} for parameter details.
+
+    Vedeu.trigger(:_drb_input_, data, type)

data/docs/events/by_name/drb_restart.md

@@ -0,0 +1,5 @@
+### `:_drb_restart_`
+Use the DRb server to request the client application to restart.
+
+    Vedeu.trigger(:_drb_restart_)
+    Vedeu.drb_restart

data/docs/events/by_name/drb_retrieve_output.md

@@ -0,0 +1,2 @@
+### `:_drb_retrieve_output_`
+See {Vedeu::Buffers::Terminal#output}

data/docs/events/by_name/drb_start.md

@@ -0,0 +1,5 @@
+### `:_drb_start_`
+Use the DRb server to request the client application to start.
+
+    Vedeu.trigger(:_drb_start_)
+    Vedeu.drb_start

data/docs/events/by_name/drb_status.md

@@ -0,0 +1,5 @@
+### `:_drb_status_`
+Use the DRb server to request the status of the client application.
+
+    Vedeu.trigger(:_drb_status_)
+    Vedeu.drb_status

data/docs/events/by_name/drb_stop.md

@@ -0,0 +1,5 @@
+### `:_drb_stop_`
+Use the DRb server to request the client application to stop.
+
+    Vedeu.trigger(:_drb_stop_)
+    Vedeu.drb_stop

data/docs/events/by_name/drb_store_output.md

@@ -0,0 +1,2 @@
+### `:_drb_store_output_`
+See {Vedeu::Buffers::Terminal#write}

data/docs/events/by_name/editor.md

@@ -0,0 +1,9 @@
+### `:_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)

data/docs/events/by_name/editor_delete_character.md

@@ -0,0 +1,5 @@
+### `:_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)

data/docs/events/by_name/editor_delete_line.md

@@ -0,0 +1,5 @@
+### `:_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)

data/docs/events/by_name/editor_down.md

@@ -0,0 +1,5 @@
+### `:_editor_down_`
+This event attempts to move the virtual cursor down by one
+line in the named document.
+
+    Vedeu.trigger(:_editor_down_, name)

data/docs/events/by_name/editor_execute.md

@@ -0,0 +1,3 @@
+### `:_editor_execute_`
+
+    Vedeu.trigger(:_editor_execute_, name)

data/docs/events/by_name/editor_insert_character.md

@@ -0,0 +1,7 @@
+### `:_editor_insert_character_`
+This event attempts to insert the given character in the named
+document at the current virtual cursor position.
+
+Note: 'character' is a string.
+
+    Vedeu.trigger(:_editor_insert_character_, name, character)

data/docs/events/by_name/editor_insert_line.md

@@ -0,0 +1,5 @@
+### `:_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)

data/docs/events/by_name/editor_left.md

@@ -0,0 +1,5 @@
+### `:_editor_left_`
+This event attempts to move the virtual cursor left by one
+character in the named document.
+
+    Vedeu.trigger(:_editor_left_, name)

data/docs/events/by_name/editor_right.md

@@ -0,0 +1,5 @@
+### `:_editor_right_`
+This event attempts to move the virtual cursor right by one
+character in the named document.
+
+    Vedeu.trigger(:_editor_right_, name)