vedeu 0.8.31 → 0.8.32

data/docs/dsl/by_method/bottom_right.md

@@ -1,4 +1,5 @@
 ### `bottom_right`
+
 Set the character to be used to draw the bottom right corner
 of the border.
 

data/docs/dsl/by_method/bound.md

@@ -1,4 +1,5 @@
 ### Vedeu.bound?
+
 Check if an event by name has been registered.
 
     Vedeu.bound?(:some_event)

data/docs/dsl/by_method/buffers.md

@@ -1,4 +1,5 @@
 ### Vedeu.buffers
+
 Repository method. Access registered borders.
 
     Vedeu.buffers # [Vedeu::Buffers::Repository]

data/docs/dsl/by_method/caption.md

@@ -1,4 +1,5 @@
 ### `caption`
+
 If you have you are showing a bottom border, you could add a caption.
 
     Vedeu.border :border_demo do

data/docs/dsl/by_method/clear.md

@@ -1,4 +1,5 @@
 ### Vedeu.clear
+
 Clears the whole terminal space.
 
     Vedeu.clear

data/docs/dsl/by_method/clear_by_group.md

@@ -1,4 +1,5 @@
 ### Vedeu.clear_by_group
+
 Clears the group of interfaces belonging to the given name.
 
     Vedeu.trigger(:_clear_group_, name)

data/docs/dsl/by_method/clear_by_name.md

@@ -1,4 +1,5 @@
 ### Vedeu.clear_by_name
+
 Clear the interface with the given name.
 
     Vedeu.trigger(:_clear_view_, name)

data/docs/dsl/by_method/clear_content_by_name.md

@@ -1,4 +1,5 @@
 ### Vedeu.clear_content_by_name
+
 Clear the content of the interface with the given name.
 
     Vedeu.trigger(:_clear_view_content_, name)

data/docs/dsl/by_method/configuration.md

@@ -1,4 +1,5 @@
 ### Vedeu.configuration
+
 Returns the configuration singleton.
 
 Append configuration methods to access the configuration variable.

data/docs/dsl/by_method/configure.md

@@ -1,4 +1,5 @@
 ### Vedeu.configure
+
 Provides the mechanism to configure Vedeu. If the client application
 sets options, override the defaults with those.
 

data/docs/dsl/by_method/cursor.md

@@ -1,4 +1,5 @@
 ### Vedeu.cursor
+
 Fetch the cursor of the currently focussed interface/view.
 
     Vedeu.cursor

data/docs/dsl/by_method/cursors.md

@@ -1,4 +1,5 @@
 ### Vedeu.cursors
+
 Manipulate the repository of cursors.
 
     Vedeu.cursors

data/docs/dsl/by_method/debug.md

@@ -1,4 +1,5 @@
 ### Vedeu.debug
+
 Drop into a debugging session within a running client application,
 courtesy of 'pry'. Will raise an exception if 'pry' is not available.
 

data/docs/dsl/by_method/disable.md

@@ -1,4 +1,5 @@
 ### `disable!`
+
 Disable the border:
 
     Vedeu.border :border_demo do

data/docs/dsl/by_method/documents.md

@@ -1,4 +1,5 @@
 ### Vedeu.documents
+
 Repository method. Access registered documents.
 
     Vedeu.documents # [Vedeu::Editor::Repository]

data/docs/dsl/by_method/drb_restart.md

@@ -1,2 +1,3 @@
 ### Vedeu.drb_restart
+
 @todo Add more documentation.

data/docs/dsl/by_method/drb_start.md

@@ -1,2 +1,3 @@
 ### Vedeu.drb_start
+
 @todo Add more documentation.

data/docs/dsl/by_method/drb_status.md

@@ -1,2 +1,3 @@
 ### Vedeu.drb_status
+
 @todo Add more documentation.

data/docs/dsl/by_method/drb_stop.md

@@ -1,2 +1,3 @@
 ### Vedeu.drb_stop
+
 @todo Add more documentation.

data/docs/dsl/by_method/enable.md

@@ -1,4 +1,5 @@
 ### `enable!`
+
 Enable the border:
 (Borders are enabled by default when defined for an interface).
 

data/docs/dsl/by_method/esc.md

@@ -1,4 +1,5 @@
 ### Vedeu.esc
+
 Provides access to various escape sequences defined by Vedeu.
 
 #### Colour escape sequences

data/docs/dsl/by_method/events.md

@@ -1,2 +1,3 @@
 ### Vedeu.events
+
 @todo Add more documentation.

data/docs/dsl/by_method/exit.md

@@ -1,2 +1,3 @@
 ### Vedeu.exit
+
 @todo Add more documentation.

data/docs/dsl/by_method/focus.md

@@ -1,2 +1,3 @@
 ### Vedeu.focus
+
 @todo Add more documentation.

data/docs/dsl/by_method/focus_by_name.md

@@ -1,4 +1,5 @@
 ### Vedeu.focus_by_name
+
 Instruct Vedeu to focus the view with the given name.
 
 @todo Add more documentation

data/docs/dsl/by_method/focus_next.md

@@ -1,4 +1,5 @@
 ### Vedeu.focus_next
+
 Instruct Vedeu to focus the next visible view.
 
     Vedeu.focus_next

data/docs/dsl/by_method/focus_previous.md

@@ -1,4 +1,5 @@
 ### Vedeu.focus_previous
+
 Instruct Vedeu to focus the previous visible view.
 
     Vedeu.focus_previous

data/docs/dsl/by_method/focussed.md

@@ -1,2 +1,3 @@
 ### Vedeu.focussed
+
 @todo Add more documentation.

data/docs/dsl/by_method/foreground_colours.md

@@ -1,4 +1,5 @@
 ### Vedeu.foreground_colours
+
 Manipulate the repository of foreground colours.
 
     Vedeu.foreground_colours

data/docs/dsl/by_method/geometries.md

@@ -1,2 +1,3 @@
 ### Vedeu.geometries
+
 @todo Add more documentation.

data/docs/dsl/by_method/geometry.md

@@ -1,4 +1,5 @@
 ### Vedeu.geometry
+
 Specify the geometry of an interface or view with a simple DSL.
 
     # Standalone (preferred):

data/docs/dsl/by_method/goto.md

@@ -1,4 +1,5 @@
 ### Vedeu.goto
+
 Instruct Vedeu to load the client application controller action with
 parameters.
 

data/docs/dsl/by_method/group.md

@@ -1,2 +1,3 @@
 ### Vedeu.group
+
 @todo Add more documentation.

data/docs/dsl/by_method/groups.md

@@ -1,2 +1,3 @@
 ### Vedeu.group
+
 @todo Add more documentation.

data/docs/dsl/by_method/height.md

@@ -1,4 +1,5 @@
 ### Vedeu.height
+
 Returns the total height (number of rows/lines) of the current
 terminal.
 

data/docs/dsl/by_method/hide_cursor.md

@@ -1,2 +1,3 @@
 ### Vedeu.hide_cursor
+
 @todo Add more documentation.

data/docs/dsl/by_method/hide_group.md

@@ -1,2 +1,3 @@
 ### Vedeu.hide_group
+
 @todo Add more documentation.

data/docs/dsl/by_method/hide_interface.md

@@ -1,2 +1,3 @@
 ### Vedeu.hide_interface
+
 @todo Add more documentation.

data/docs/dsl/by_method/horizontal.md

@@ -1,4 +1,5 @@
 ### `horizontal`
+
 Set the character to be used to draw a horizontal part of the border.
 
     Vedeu.border :border_demo do

data/docs/dsl/by_method/interface.md

@@ -1,2 +1,3 @@
 ### Vedeu.interface
+
 @todo Add more documentation.

data/docs/dsl/by_method/interfaces.md

@@ -1,2 +1,3 @@
 ### Vedeu.interfaces
+
 @todo Add more documentation.

data/docs/dsl/by_method/keymap.md

@@ -1,2 +1,3 @@
 ### Vedeu.keymap
+
 @todo Add more documentation.

data/docs/dsl/by_method/keymaps.md

@@ -1,2 +1,3 @@
 ### Vedeu.keymaps
+
 @todo Add more documentation.

data/docs/dsl/by_method/keypress.md

@@ -1,2 +1,3 @@
 ### Vedeu.keypress
+
 @todo Add more documentation.

data/docs/dsl/by_method/last_command.md

@@ -1,4 +1,5 @@
 ### Vedeu.last_command
+
 Access the last command stored. If no commands have been entered since
 the client application started, then this will return nil.
 

data/docs/dsl/by_method/last_keypress.md

@@ -1,4 +1,5 @@
 ### Vedeu.last_keypress
+
 Access the last keypress stored. If no keys have been pressed since
 the client application started, then this will return nil.
 

data/docs/dsl/by_method/left.md

@@ -1,4 +1,5 @@
 ### `left`
+
 Enable/disable the left border.
 
     Vedeu.border :border_demo do

data/docs/dsl/by_method/left_vertical.md

@@ -1,4 +1,5 @@
 ### `left_vertical`
+
 Set the character to be used to draw the left vertical part of
 the border.
 

data/docs/dsl/by_method/log.md

@@ -1,2 +1,3 @@
 ### Vedeu.log
+
 @todo Add more documentation.

data/docs/dsl/by_method/log_stderr.md

@@ -1,4 +1,5 @@
 ### Vedeu.log_stderr
+
 Write a message to STDERR. Will also attempt to write to the log file
 if configured for later reference.
 

data/docs/dsl/by_method/log_stdout.md

@@ -1,4 +1,5 @@
 ### Vedeu.log_stdout
+
 Write a message to STDOUT. Will also attempt to write to the log file
 if configured for later reference.
 

data/docs/dsl/by_method/log_timestamp.md

@@ -1,4 +1,5 @@
 ### Vedeu.log_timestamp
+
 Returns a formatted timestamp indicating the number of seconds the
 client application has been running.
 

data/docs/dsl/by_method/menu.md

@@ -1,2 +1,3 @@
 ### Vedeu.menu
+
 @todo Add more documentation.

data/docs/dsl/by_method/menus.md

@@ -1,2 +1,3 @@
 ### Vedeu.menus
+
 @todo Add more documentation.

data/docs/dsl/by_method/profile.md

@@ -1,4 +1,5 @@
 ### Vedeu.profile
+
 Allow debugging via the creation of stack traces courtesy of
 'ruby-prof'. Will raise an exception if 'ruby-prof' is not available.
 

data/docs/dsl/by_method/ready.md

@@ -1,2 +1,3 @@
 ### Vedeu.ready
+
 @todo Add more documentation.

data/docs/dsl/by_method/refresh.md

@@ -1,4 +1,5 @@
 ### Vedeu.refresh
+
 Send the cells to the renderer and return the rendered result.
 
     Vedeu.refresh

data/docs/dsl/by_method/renderer.md

@@ -1,2 +1,3 @@
 ### Vedeu.renderer
+
 @todo Add more documentation.

data/docs/dsl/by_method/renderers.md

@@ -1,2 +1,3 @@
 ### Vedeu.renderers
+
 @todo Add more documentation.

data/docs/dsl/by_method/resize.md

@@ -1,4 +1,5 @@
 ### Vedeu.resize
+
 When the terminal emit the 'SIGWINCH' signal, Vedeu can intercept this
 and attempt to redraw the current interface with varying degrees of
 success. Can also be used to simulate a terminal resize.

data/docs/dsl/by_method/right.md

@@ -1,4 +1,5 @@
 ### `right`
+
 Enable/disable the right border.
 
     Vedeu.border :border_demo do

data/docs/dsl/by_method/right_vertical.md

@@ -1,4 +1,5 @@
 ### `right_vertical`
+
 Set the character to be used to draw the right vertical part
 of the border.
 

data/docs/dsl/by_method/show_cursor.md

@@ -1,2 +1,3 @@
 ### Vedeu.show_cursor
+
 @todo Add more documentation.

data/docs/dsl/by_method/show_group.md

@@ -1,2 +1,3 @@
 ### Vedeu.show_group
+
 @todo Add more documentation.

data/docs/dsl/by_method/show_interface.md

@@ -1,2 +1,3 @@
 ### Vedeu.show_interface
+
 @todo Add more documentation.

data/docs/dsl/by_method/timer.md

@@ -1,4 +1,5 @@
 ### Vedeu.timer
+
 Measure the execution time of the code in the given block.
 
 The optional message provided will have ' took <time>ms.' appended and

data/docs/dsl/by_method/title.md

@@ -1,4 +1,5 @@
 ### `title`
+
 If you have you are showing a top border, you could add a
 title.
 

data/docs/dsl/by_method/toggle_cursor.md

@@ -1,2 +1,3 @@
 ### Vedeu.cursor
+
 @todo Add more documentation.

data/docs/dsl/by_method/toggle_group.md

@@ -1,2 +1,3 @@
 ### Vedeu.toggle_group
+
 @todo Add more documentation.

data/docs/dsl/by_method/toggle_interface.md

@@ -1,2 +1,3 @@
 ### Vedeu.toggle_interface
+
 @todo Add more documentation.

data/docs/dsl/by_method/top.md

@@ -1,4 +1,5 @@
 ### `top`
+
 Enable/disable the top border.
 
     Vedeu.border :border_demo do

data/docs/dsl/by_method/top_horizontal.md

@@ -1,4 +1,5 @@
 ### `top_horizontal`
+
 Set the character to be used to draw the top horizontal part
 of the border.
 

data/docs/dsl/by_method/top_left.md

@@ -1,4 +1,5 @@
 ### `top_left`
+
 Set the character to be used to draw the top left corner of
 the border.