vedeu 0.7.2 → 0.7.3

data/docs/events/by_name/editor_up.md

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

data/docs/events/by_name/exit.md

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

data/docs/events/by_name/focus_by_name.md

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

data/docs/events/by_name/focus_next.md

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

data/docs/events/by_name/focus_prev.md

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

data/docs/events/by_name/goto.md

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

data/docs/events/by_name/hide_cursor.md

@@ -0,0 +1,10 @@
+### Vedeu.hide_cursor / `:_hide_cursor_`
+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)

data/docs/events/by_name/hide_group.md

@@ -0,0 +1,5 @@
+### `:_hide_group_`
+Hiding a group of interfaces.
+
+    Vedeu.trigger(:_hide_group_, name)
+    Vedeu.hide_group(name)

data/docs/events/by_name/hide_interface.md

@@ -0,0 +1,5 @@
+### `:_hide_interface_`
+Hide an interface by name.
+
+    Vedeu.trigger(:_hide_interface_, name)
+    Vedeu.hide_interface(name)

data/docs/events/by_name/initialize.md

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

data/docs/events/by_name/keypress.md

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

data/docs/events/by_name/log.md

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

data/docs/events/by_name/maximise.md

@@ -0,0 +1,6 @@
+### `:_maximise_`
+Maximising an interface.
+
+    Vedeu.trigger(:_maximise_, name)
+
+See {Vedeu::Geometries::Geometry#maximise}

data/docs/events/by_name/menu_bottom.md

@@ -0,0 +1,4 @@
+### `:_menu_bottom_`
+Makes the last menu item the current menu item.
+
+    Vedeu.trigger(:_menu_bottom_, name)

data/docs/events/by_name/menu_current.md

@@ -0,0 +1,4 @@
+### `:_menu_current_`
+Returns the current menu item.
+
+    Vedeu.trigger(:_menu_current_, name)

data/docs/events/by_name/menu_deselect.md

@@ -0,0 +1,4 @@
+### `:_menu_deselect_`
+Deselects all menu items.
+
+    Vedeu.trigger(:_menu_deselect_, name)

data/docs/events/by_name/menu_items.md

@@ -0,0 +1,5 @@
+### `:_menu_items_`
+Returns all the menu items with respective `current` or `selected`
+boolean indicators.
+
+    Vedeu.trigger(:_menu_items_, name)

data/docs/events/by_name/menu_next.md

@@ -0,0 +1,5 @@
+### `:_menu_next_`
+Makes the next menu item the current menu item, until it reaches the
+last item.
+
+    Vedeu.trigger(:_menu_next_, name)

data/docs/events/by_name/menu_prev.md

@@ -0,0 +1,5 @@
+### `:_menu_prev_`
+Makes the previous menu item the current menu item, until it reaches
+the first item.
+
+    Vedeu.trigger(:_menu_prev_, name)

data/docs/events/by_name/menu_select.md

@@ -0,0 +1,4 @@
+### `:_menu_select_`
+Makes the current menu item also the selected menu item.
+
+    Vedeu.trigger(:_menu_select_, name)

data/docs/events/by_name/menu_selected.md

@@ -0,0 +1,4 @@
+### `:_menu_selected_`
+Returns the selected menu item.
+
+    Vedeu.trigger(:_menu_selected_, name)

data/docs/events/by_name/menu_top.md

@@ -0,0 +1,4 @@
+### `:_menu_top_`
+Makes the first menu item the current menu item.
+
+    Vedeu.trigger(:_menu_top_, name)

data/docs/events/by_name/menu_view.md

@@ -0,0 +1,5 @@
+### `:_menu_view_`
+Returns a subset of the menu items; starting at the current item to
+the last item.
+
+    Vedeu.trigger(:_menu_view_, name)

data/docs/events/by_name/mode_switch.md

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

data/docs/events/by_name/movement_refresh.md

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

data/docs/events/by_name/refresh.md

@@ -0,0 +1,9 @@
+### `:_refresh_`
+Refreshes all registered interfaces.
+
+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.
+
+    Vedeu.trigger(:_refresh_)

data/docs/events/by_name/refresh_border.md

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

data/docs/events/by_name/refresh_cursor.md

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

data/docs/events/by_name/refresh_group.md

@@ -0,0 +1,4 @@
+### `:_refresh_group_`
+Will cause all interfaces in the named group to refresh.
+
+    Vedeu.trigger(:_refresh_group_, name)

data/docs/events/by_name/refresh_view.md

@@ -0,0 +1,4 @@
+### `:_refresh_view_`
+Will cause the named view to refresh.
+
+    Vedeu.trigger(:_refresh_view_, name)

data/docs/events/by_name/refresh_view_content.md

@@ -0,0 +1,4 @@
+### `:_refresh_view_content_`
+Will cause only the content of the named view to refresh.
+
+    Vedeu.trigger(:_refresh_view_content_, name)

data/docs/events/by_name/resize.md

@@ -0,0 +1,5 @@
+### `:_resize_`
+When triggered will cause Vedeu to trigger the `:_clear_` and
+`:_refresh_` events. Please see those events for their behaviour.
+
+    Vedeu.trigger(:_resize_)

data/docs/events/by_name/show_cursor.md

@@ -0,0 +1,10 @@
+### 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)

data/docs/events/by_name/show_group.md

@@ -0,0 +1,5 @@
+### `:_show_group_`
+Showing a group of interfaces.
+
+    Vedeu.trigger(:_show_group_, name)
+    Vedeu.show_group(name)

data/docs/events/by_name/show_interface.md

@@ -0,0 +1,5 @@
+### `:_show_interface_`
+Show an interface by name.
+
+    Vedeu.trigger(:_show_interface_, name)
+    Vedeu.show_interface(name)

data/docs/events/by_name/toggle_cursor.md

@@ -0,0 +1,9 @@
+### Vedeu.toggle_cursor / `:_toggle_cursor_`
+Toggle the visibility of the cursor. If hidden, then show. If shown,
+then hide.
+
+    Vedeu.trigger(:_toggle_cursor_, name)
+    Vedeu.trigger(:_toggle_cursor_, Vedeu.focus)
+
+    Vedeu.toggle_cursor(name)
+    Vedeu.toggle_cursor(Vedeu.focus)

data/docs/events/by_name/toggle_group.md

@@ -0,0 +1,5 @@
+### `:_toggle_group_`
+Toggling a group of interfaces.
+
+    Vedeu.trigger(:_toggle_group_, name)
+    Vedeu.toggle_group(name)

data/docs/events/by_name/toggle_interface.md

@@ -0,0 +1,5 @@
+### `:_toggle_interface_`
+Toggling an interface.
+
+    Vedeu.trigger(:_toggle_interface_, name)
+    Vedeu.toggle_interface(name)

data/docs/events/by_name/unmaximise.md

@@ -0,0 +1,6 @@
+### `:_unmaximise_`
+Unmaximising an interface.
+
+    Vedeu.trigger(:_unmaximise_, name)
+
+See {Vedeu::Geometries::Geometry#unmaximise}

data/docs/events/document.md

@@ -4,56 +4,20 @@
 
 Note: 'name' is a Symbol unless mentioned otherwise.
 
-### `:_editor_execute_`
+{include:file:docs/events/by_name/editor_execute.md}
 
-    Vedeu.trigger(:_editor_execute_, name)
+{include:file:docs/events/by_name/editor_delete_character.md}
 
-### `:_editor_delete_character_`
-This event attempts to delete the character in the named
-document at the current virtual cursor position.
+{include:file:docs/events/by_name/editor_delete_line.md}
 
-    Vedeu.trigger(:_editor_delete_character_, name)
+{include:file:docs/events/by_name/editor_down.md}
 
-### `:_editor_delete_line_`
-This event attempts to delete the line in the named document
-at the current virtual cursor position.
+{include:file:docs/events/by_name/editor_insert_character.md}
 
-    Vedeu.trigger(:_editor_delete_line_, name)
+{include:file:docs/events/by_name/editor_insert_line.md}
 
-### `:_editor_down_`
-This event attempts to move the virtual cursor down by one
-line in the named document.
+{include:file:docs/events/by_name/editor_left.md}
 
-    Vedeu.trigger(:_editor_down_, name)
+{include:file:docs/events/by_name/editor_right.md}
 
-### `:_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)
-
-### `:_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_`
-This event attempts to move the virtual cursor left by one
-character in the named document.
-
-    Vedeu.trigger(:_editor_left_, name)
-
-### `:_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_`
-This event attempts to move the virtual cursor up by one line
-in the named document.
-
-    Vedeu.trigger(:_editor_up_, name)
+{include:file:docs/events/by_name/editor_up.md}

data/docs/events/drb.md

@@ -2,40 +2,16 @@
 
 ## DRB Events
 
-### `:_drb_input_`
-Triggering this event will send input to the running application as
-long as it has the DRb server running.
+{include:file:docs/events/by_name/drb_input.md}
 
-Note: See {Vedeu::Distributed::Server#input} for parameter details.
+{include:file:docs/events/by_name/drb_retrieve_output.md}
 
-    Vedeu.trigger(:_drb_input_, data, type)
+{include:file:docs/events/by_name/drb_store_output.md}
 
-### `:_drb_retrieve_output_`
-See {Vedeu::Buffers::Terminal#output}
+{include:file:docs/events/by_name/drb_restart.md}
 
-### `:_drb_store_output_`
-See {Vedeu::Buffers::Terminal#write}
+{include:file:docs/events/by_name/drb_start.md}
 
-### `:_drb_restart_`
-Use the DRb server to request the client application to restart.
+{include:file:docs/events/by_name/drb_status.md}
 
-    Vedeu.trigger(:_drb_restart_)
-    Vedeu.drb_restart
-
-### `:_drb_start_`
-Use the DRb server to request the client application to start.
-
-    Vedeu.trigger(:_drb_start_)
-    Vedeu.drb_start
-
-### `:_drb_status_`
-Use the DRb server to request the status of the client application.
-
-    Vedeu.trigger(:_drb_status_)
-    Vedeu.drb_status
-
-### `:_drb_stop_`
-Use the DRb server to request the client application to stop.
-
-    Vedeu.trigger(:_drb_stop_)
-    Vedeu.drb_stop
+{include:file:docs/events/by_name/drb_stop.md}