vedeu 0.6.68 → 0.6.69

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,31 +10,31 @@ Note: See {Vedeu::Distributed::Server#input} for parameter details.
 
     Vedeu.trigger(:_drb_input_, data, type)
 
-### `:\_drb_retrieve_output\_`
+### `:_drb_retrieve_output_`
 See {Vedeu::Buffers::Terminal#output}
 
-### `:\_drb_store_output\_`
+### `:_drb_store_output_`
 See {Vedeu::Buffers::Terminal#write}
 
-### `:\_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

@@ -7,8 +7,10 @@ Note: 'name' is a Symbol unless mentioned otherwise.
 For cursor related movement events, please refer to
 {file:docs/cursors.md} Cursors.
 
-
-### `:\_view_(up, down, left, right)\_`
+### `:_view_up_`
+### `:_view_down_`
+### `:_view_left_`
+### `:_view_right_`
 
 Please note that the name of the view is required for these events.
 
@@ -17,4 +19,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,23 +14,23 @@ will be still refreshed in memory but not shown.
 
     Vedeu.trigger(:_refresh_)
 
-### `:\_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)

data/docs/events/system.md

@@ -2,7 +2,7 @@
 
 ## System Events
 
-### `:\_cleanup\_`
+### `:_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
@@ -10,7 +10,7 @@ popular here.
 
     Vedeu.trigger(:_exit_)
 
-### `:\_command\_`
+### `:_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.
 
@@ -30,7 +30,7 @@ API methods: (See {Vedeu::Input::Store} for more details).
 
     Vedeu.last_command
 
-### `:\_editor\_`
+### `:_editor_`
 This event is called by {Vedeu::Input::Capture#read}. When
 invoked, the key will be passed to the editor for currently
 focussed view.
@@ -40,21 +40,21 @@ represented by Symbols.
 
     Vedeu.trigger(:_editor_, key)
 
-### `:\_exit\_`
+### `:_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\_`
+### `:_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\_`
+### `:_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.
 
@@ -95,7 +95,7 @@ A list of supported keypresses can be found here:
 
     Vedeu.trigger(:_keypress_, key, optional_name)
 
-### `:\_log\_`
+### `:_log_`
 When triggered with a message will cause Vedeu to log the message if
 logging is enabled in the configuration.
 
@@ -103,7 +103,7 @@ Note: 'message' is a String.
 
     Vedeu.trigger(:_log_, message)
 
-### `:\_mode_switch\_`
+### `:_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-

data/docs/events/view.md

@@ -4,14 +4,14 @@
 
 Note: 'name' is a Symbol unless mentioned otherwise.
 
-### `:\_maximise\_`
+### `:_maximise_`
 Maximising an interface.
 
     Vedeu.trigger(:_maximise_, name)
 
 See {Vedeu::Geometries::Geometry#maximise}
 
-### `:\_movement_refresh\_`
+### `:_movement_refresh_`
 When triggered, triggers additional events which aid the updating of
 the output. Used when moving an interface/view.
 
@@ -31,13 +31,13 @@ At this time, triggering this event will:
 - Refreshes the named view. This action adds the named view to the
   terminal (or output); in the new position.
 
-### `:\_resize\_`
+### `:_resize_`
 When triggered will cause Vedeu to trigger the `:_clear_` and
 `:_refresh_` events. Please see those events for their behaviour.
 
     Vedeu.trigger(:_resize_)
 
-### `:\_unmaximise\_`
+### `:_unmaximise_`
 Unmaximising an interface.
 
     Vedeu.trigger(:_unmaximise_, name)

data/docs/events/visibility.md

@@ -4,81 +4,59 @@
 
 Note: 'name' is a Symbol unless mentioned otherwise.
 
-### `:\_clear\_`
+### `:_clear_`
 See {Vedeu::Buffers::Terminal#clear}
 
-### `:\_clear_group\_`
+### `:_clear_group_`
 Clears the spaces occupied by the interfaces belonging to the named
 group.
 
     Vedeu.trigger(:_clear_group_, name)
     Vedeu.clear_by_group(name)
 
-### `:\_clear_view\_`
+### `:_clear_view_`
 Clears the named view/interface area.
 
     Vedeu.trigger(:_clear_view_, name)
     Vedeu.clear_by_name(name)
 
-### `:\_clear_view_content\_`
+### `:_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)
 
-### `:\_hide_cursor\_`
-Hide the cursor of the named interface or when a name is not given,
-the interface currently in focus.
-
-    Vedeu.trigger(:_hide_cursor_, name)
-    Vedeu.trigger(:_cursor_hide_, name)
-    Vedeu.hide_cursor(name)
-
-### `:\_hide_group\_`
+### `:_hide_group_`
 Hiding a group of interfaces.
 
     Vedeu.trigger(:_hide_group_, name)
     Vedeu.hide_group(name)
 
-### `:\_hide_interface\_`
+### `:_hide_interface_`
 Hide an interface by name.
 
     Vedeu.trigger(:_hide_interface_, name)
     Vedeu.hide_interface(name)
 
-### `:\_show_cursor\_`
-Show the cursor of the named interface or when a name is not given,
-the interface currently in focus.
-
-    Vedeu.trigger(:_show_cursor_, name)
-    Vedeu.trigger(:_cursor_show_, name)
-    Vedeu.show_cursor(name)
-
-### `:\_show_group\_`
+### `:_show_group_`
 Showing a group of interfaces.
 
     Vedeu.trigger(:_show_group_, name)
     Vedeu.show_group(name)
 
-### `:\_show_interface\_`
+### `:_show_interface_`
 Show an interface by name.
 
     Vedeu.trigger(:_show_interface_, name)
     Vedeu.show_interface(name)
 
-### `:\_toggle_cursor\_`
-Toggling a cursor.
-
-    Vedeu.trigger(:_toggle_cursor_, name)
-    Vedeu.toggle_cursor(name)
-
-### `:\_toggle_group\_`
+### `:_toggle_group_`
 Toggling a group of interfaces.
 
     Vedeu.trigger(:_toggle_group_, name)
     Vedeu.toggle_group(name)
 
-### `:\_toggle_interface\_`
+### `:_toggle_interface_`
 Toggling an interface.
 
     Vedeu.trigger(:_toggle_interface_, name)

data/docs/input.md

@@ -90,7 +90,7 @@ immediately.
 
 During the lifecycle of a Vedeu client application it may be necessary
 to switch between the different modes offered. This is handled by
-triggering the `:\_mode_switch\_` event. By default, this cycles
+triggering the `:_mode_switch_` event. By default, this cycles
 through the available modes. When an optional but valid target mode is
 given, that mode will be activated instead.
 

data/lib/vedeu/colours/background.rb

@@ -13,13 +13,13 @@ module Vedeu
       private
 
       # @return [String]
-      def named_codes
-        Vedeu::EscapeSequences::Esc.background_codes[colour]
+      def prefix
+        "\e[48;".freeze
       end
 
       # @return [String]
-      def numbered_prefix
-        "\e[48;5;".freeze
+      def named_codes
+        Vedeu::EscapeSequences::Esc.background_codes[colour]
       end
 
       # @return [Vedeu::Colours::Backgrounds]
@@ -27,11 +27,6 @@ module Vedeu
         Vedeu.background_colours
       end
 
-      # @return [String]
-      def rgb_prefix
-        "\e[48;2;%s;%s;%sm".freeze
-      end
-
     end # Background
 
   end # Colours

data/lib/vedeu/colours/foreground.rb

@@ -13,13 +13,13 @@ module Vedeu
       private
 
       # @return [String]
-      def named_codes
-        Vedeu::EscapeSequences::Esc.foreground_codes[colour]
+      def prefix
+        "\e[38;".freeze
       end
 
       # @return [String]
-      def numbered_prefix
-        "\e[38;5;".freeze
+      def named_codes
+        Vedeu::EscapeSequences::Esc.foreground_codes[colour]
       end
 
       # @return [Vedeu::Colours::Foregrounds]
@@ -27,11 +27,6 @@ module Vedeu
         Vedeu.foreground_colours
       end
 
-      # @return [String]
-      def rgb_prefix
-        "\e[38;2;%s;%s;%sm".freeze
-      end
-
     end # Foreground
 
   end # Colours