vedeu 0.8.31 → 0.8.32

Sign up to get free protection for your applications and to get access to all the features.
Files changed (269) hide show
  1. checksums.yaml +4 -4
  2. data/docs/configuration/compression.md +1 -0
  3. data/docs/configuration/cooked.md +1 -1
  4. data/docs/configuration/debug.md +1 -0
  5. data/docs/configuration/drb.md +1 -0
  6. data/docs/configuration/drb_height.md +4 -0
  7. data/docs/configuration/drb_host.md +4 -0
  8. data/docs/configuration/drb_port.md +4 -0
  9. data/docs/configuration/drb_width.md +4 -0
  10. data/docs/configuration/fake.md +4 -0
  11. data/docs/configuration/height.md +3 -0
  12. data/docs/configuration/interactive.md +5 -0
  13. data/docs/configuration/log.md +4 -0
  14. data/docs/configuration/log_except.md +4 -0
  15. data/docs/configuration/log_only.md +4 -0
  16. data/docs/configuration/mouse.md +6 -0
  17. data/docs/configuration/profile.md +5 -0
  18. data/docs/configuration/raw.md +4 -0
  19. data/docs/configuration/renderer.md +4 -0
  20. data/docs/configuration/root.md +4 -0
  21. data/docs/configuration/run_once.md +4 -0
  22. data/docs/configuration/standalone.md +7 -6
  23. data/docs/configuration/stderr.md +4 -0
  24. data/docs/configuration/stdin.md +4 -0
  25. data/docs/configuration/stdout.md +4 -0
  26. data/docs/configuration/terminal_mode.md +3 -0
  27. data/docs/configuration/threaded.md +10 -0
  28. data/docs/configuration/width.md +4 -0
  29. data/docs/dsl/by_method/add_command.md +1 -0
  30. data/docs/dsl/by_method/add_keypress.md +1 -0
  31. data/docs/dsl/by_method/all_commands.md +1 -0
  32. data/docs/dsl/by_method/all_keypresses.md +1 -0
  33. data/docs/dsl/by_method/background_colours.md +1 -0
  34. data/docs/dsl/by_method/bind.md +1 -0
  35. data/docs/dsl/by_method/bind_alias.md +1 -0
  36. data/docs/dsl/by_method/borders.md +1 -0
  37. data/docs/dsl/by_method/bottom.md +1 -0
  38. data/docs/dsl/by_method/bottom_horizontal.md +1 -0
  39. data/docs/dsl/by_method/bottom_left.md +1 -0
  40. data/docs/dsl/by_method/bottom_right.md +1 -0
  41. data/docs/dsl/by_method/bound.md +1 -0
  42. data/docs/dsl/by_method/buffers.md +1 -0
  43. data/docs/dsl/by_method/caption.md +1 -0
  44. data/docs/dsl/by_method/clear.md +1 -0
  45. data/docs/dsl/by_method/clear_by_group.md +1 -0
  46. data/docs/dsl/by_method/clear_by_name.md +1 -0
  47. data/docs/dsl/by_method/clear_content_by_name.md +1 -0
  48. data/docs/dsl/by_method/configuration.md +1 -0
  49. data/docs/dsl/by_method/configure.md +1 -0
  50. data/docs/dsl/by_method/cursor.md +1 -0
  51. data/docs/dsl/by_method/cursors.md +1 -0
  52. data/docs/dsl/by_method/debug.md +1 -0
  53. data/docs/dsl/by_method/disable.md +1 -0
  54. data/docs/dsl/by_method/documents.md +1 -0
  55. data/docs/dsl/by_method/drb_restart.md +1 -0
  56. data/docs/dsl/by_method/drb_start.md +1 -0
  57. data/docs/dsl/by_method/drb_status.md +1 -0
  58. data/docs/dsl/by_method/drb_stop.md +1 -0
  59. data/docs/dsl/by_method/enable.md +1 -0
  60. data/docs/dsl/by_method/esc.md +1 -0
  61. data/docs/dsl/by_method/events.md +1 -0
  62. data/docs/dsl/by_method/exit.md +1 -0
  63. data/docs/dsl/by_method/focus.md +1 -0
  64. data/docs/dsl/by_method/focus_by_name.md +1 -0
  65. data/docs/dsl/by_method/focus_next.md +1 -0
  66. data/docs/dsl/by_method/focus_previous.md +1 -0
  67. data/docs/dsl/by_method/focussed.md +1 -0
  68. data/docs/dsl/by_method/foreground_colours.md +1 -0
  69. data/docs/dsl/by_method/geometries.md +1 -0
  70. data/docs/dsl/by_method/geometry.md +1 -0
  71. data/docs/dsl/by_method/goto.md +1 -0
  72. data/docs/dsl/by_method/group.md +1 -0
  73. data/docs/dsl/by_method/groups.md +1 -0
  74. data/docs/dsl/by_method/height.md +1 -0
  75. data/docs/dsl/by_method/hide_cursor.md +1 -0
  76. data/docs/dsl/by_method/hide_group.md +1 -0
  77. data/docs/dsl/by_method/hide_interface.md +1 -0
  78. data/docs/dsl/by_method/horizontal.md +1 -0
  79. data/docs/dsl/by_method/interface.md +1 -0
  80. data/docs/dsl/by_method/interfaces.md +1 -0
  81. data/docs/dsl/by_method/keymap.md +1 -0
  82. data/docs/dsl/by_method/keymaps.md +1 -0
  83. data/docs/dsl/by_method/keypress.md +1 -0
  84. data/docs/dsl/by_method/last_command.md +1 -0
  85. data/docs/dsl/by_method/last_keypress.md +1 -0
  86. data/docs/dsl/by_method/left.md +1 -0
  87. data/docs/dsl/by_method/left_vertical.md +1 -0
  88. data/docs/dsl/by_method/log.md +1 -0
  89. data/docs/dsl/by_method/log_stderr.md +1 -0
  90. data/docs/dsl/by_method/log_stdout.md +1 -0
  91. data/docs/dsl/by_method/log_timestamp.md +1 -0
  92. data/docs/dsl/by_method/menu.md +1 -0
  93. data/docs/dsl/by_method/menus.md +1 -0
  94. data/docs/dsl/by_method/profile.md +1 -0
  95. data/docs/dsl/by_method/ready.md +1 -0
  96. data/docs/dsl/by_method/refresh.md +1 -0
  97. data/docs/dsl/by_method/renderer.md +1 -0
  98. data/docs/dsl/by_method/renderers.md +1 -0
  99. data/docs/dsl/by_method/resize.md +1 -0
  100. data/docs/dsl/by_method/right.md +1 -0
  101. data/docs/dsl/by_method/right_vertical.md +1 -0
  102. data/docs/dsl/by_method/show_cursor.md +1 -0
  103. data/docs/dsl/by_method/show_group.md +1 -0
  104. data/docs/dsl/by_method/show_interface.md +1 -0
  105. data/docs/dsl/by_method/timer.md +1 -0
  106. data/docs/dsl/by_method/title.md +1 -0
  107. data/docs/dsl/by_method/toggle_cursor.md +1 -0
  108. data/docs/dsl/by_method/toggle_group.md +1 -0
  109. data/docs/dsl/by_method/toggle_interface.md +1 -0
  110. data/docs/dsl/by_method/top.md +1 -0
  111. data/docs/dsl/by_method/top_horizontal.md +1 -0
  112. data/docs/dsl/by_method/top_left.md +1 -0
  113. data/docs/dsl/by_method/top_right.md +1 -0
  114. data/docs/dsl/by_method/trigger.md +1 -0
  115. data/docs/dsl/by_method/unbind.md +1 -0
  116. data/docs/dsl/by_method/unbind_alias.md +1 -0
  117. data/docs/dsl/by_method/vertical.md +1 -0
  118. data/docs/dsl/by_method/view/repositories.md +1 -0
  119. data/docs/dsl/by_method/width.md +1 -0
  120. data/docs/dsl/by_method/write.md +1 -0
  121. data/docs/events/by_name/cleanup.md +1 -0
  122. data/docs/events/by_name/clear.md +1 -0
  123. data/docs/events/by_name/clear_group.md +1 -0
  124. data/docs/events/by_name/clear_view.md +1 -0
  125. data/docs/events/by_name/clear_view_content.md +1 -0
  126. data/docs/events/by_name/command.md +1 -0
  127. data/docs/events/by_name/cursor_bottom.md +1 -0
  128. data/docs/events/by_name/cursor_down.md +1 -0
  129. data/docs/events/by_name/cursor_left.md +1 -0
  130. data/docs/events/by_name/cursor_origin.md +1 -0
  131. data/docs/events/by_name/cursor_position.md +1 -0
  132. data/docs/events/by_name/cursor_reposition.md +1 -0
  133. data/docs/events/by_name/cursor_right.md +1 -0
  134. data/docs/events/by_name/cursor_top.md +1 -0
  135. data/docs/events/by_name/cursor_up.md +1 -0
  136. data/docs/events/by_name/drb_input.md +1 -0
  137. data/docs/events/by_name/drb_restart.md +1 -0
  138. data/docs/events/by_name/drb_retrieve_output.md +1 -0
  139. data/docs/events/by_name/drb_start.md +1 -0
  140. data/docs/events/by_name/drb_status.md +1 -0
  141. data/docs/events/by_name/drb_stop.md +1 -0
  142. data/docs/events/by_name/drb_store_output.md +1 -0
  143. data/docs/events/by_name/editor.md +1 -0
  144. data/docs/events/by_name/editor_delete_character.md +1 -0
  145. data/docs/events/by_name/editor_delete_line.md +1 -0
  146. data/docs/events/by_name/editor_down.md +1 -0
  147. data/docs/events/by_name/editor_insert_character.md +1 -0
  148. data/docs/events/by_name/editor_insert_line.md +1 -0
  149. data/docs/events/by_name/editor_left.md +1 -0
  150. data/docs/events/by_name/editor_right.md +1 -0
  151. data/docs/events/by_name/editor_up.md +1 -0
  152. data/docs/events/by_name/exit.md +1 -0
  153. data/docs/events/by_name/focus_by_name.md +1 -0
  154. data/docs/events/by_name/focus_next.md +1 -0
  155. data/docs/events/by_name/focus_prev.md +1 -0
  156. data/docs/events/by_name/goto.md +1 -0
  157. data/docs/events/by_name/hide_cursor.md +1 -0
  158. data/docs/events/by_name/hide_group.md +1 -0
  159. data/docs/events/by_name/hide_interface.md +1 -0
  160. data/docs/events/by_name/initialize.md +1 -0
  161. data/docs/events/by_name/keypress.md +1 -0
  162. data/docs/events/by_name/log.md +1 -0
  163. data/docs/events/by_name/maximise.md +1 -0
  164. data/docs/events/by_name/menu_bottom.md +1 -0
  165. data/docs/events/by_name/menu_current.md +1 -0
  166. data/docs/events/by_name/menu_deselect.md +1 -0
  167. data/docs/events/by_name/menu_items.md +1 -0
  168. data/docs/events/by_name/menu_next.md +1 -0
  169. data/docs/events/by_name/menu_prev.md +1 -0
  170. data/docs/events/by_name/menu_select.md +1 -0
  171. data/docs/events/by_name/menu_selected.md +1 -0
  172. data/docs/events/by_name/menu_top.md +1 -0
  173. data/docs/events/by_name/menu_view.md +1 -0
  174. data/docs/events/by_name/mode_switch.md +1 -0
  175. data/docs/events/by_name/movement_refresh.md +1 -0
  176. data/docs/events/by_name/refresh.md +1 -0
  177. data/docs/events/by_name/refresh_border.md +1 -0
  178. data/docs/events/by_name/refresh_cursor.md +1 -0
  179. data/docs/events/by_name/refresh_group.md +1 -0
  180. data/docs/events/by_name/refresh_view.md +1 -0
  181. data/docs/events/by_name/refresh_view_content.md +1 -0
  182. data/docs/events/by_name/resize.md +1 -0
  183. data/docs/events/by_name/set_border_caption.md +1 -0
  184. data/docs/events/by_name/set_border_title.md +1 -0
  185. data/docs/events/by_name/show_cursor.md +1 -0
  186. data/docs/events/by_name/show_group.md +1 -0
  187. data/docs/events/by_name/show_interface.md +1 -0
  188. data/docs/events/by_name/toggle_cursor.md +1 -0
  189. data/docs/events/by_name/toggle_group.md +1 -0
  190. data/docs/events/by_name/toggle_interface.md +1 -0
  191. data/docs/events/by_name/unmaximise.md +1 -0
  192. data/docs/events/by_name/view_down.md +1 -0
  193. data/docs/events/by_name/view_left.md +1 -0
  194. data/docs/events/by_name/view_right.md +1 -0
  195. data/docs/events/by_name/view_up.md +1 -0
  196. data/examples/dsl_alignment.rb +1 -1
  197. data/examples/dsl_colours.rb +1 -1
  198. data/examples/dsl_demo_groups.rb +1 -1
  199. data/examples/dsl_editor.rb +1 -1
  200. data/examples/dsl_hello_worlds.rb +1 -1
  201. data/examples/dsl_horizontal_alignment.rb +4 -3
  202. data/examples/dsl_menus.rb +1 -1
  203. data/examples/dsl_vertical_alignment.rb +4 -3
  204. data/examples/views/empty_template.rb +1 -1
  205. data/examples/views/full_screen.rb +1 -1
  206. data/examples/views/misc_view.rb +1 -1
  207. data/examples/views/wordwrap.rb +1 -1
  208. data/integrations/342_streams.rb +1 -1
  209. data/integrations/dsl_app_001.rb +1 -1
  210. data/integrations/dsl_app_002.rb +1 -1
  211. data/integrations/dsl_app_003.rb +1 -1
  212. data/integrations/dsl_app_004.rb +1 -1
  213. data/integrations/dsl_app_005.rb +1 -1
  214. data/integrations/dsl_app_006.rb +1 -1
  215. data/integrations/dsl_app_007.rb +1 -1
  216. data/integrations/dsl_app_008.rb +1 -1
  217. data/integrations/dsl_app_009.rb +1 -1
  218. data/integrations/dsl_app_010.rb +1 -1
  219. data/integrations/dsl_app_011.rb +1 -1
  220. data/integrations/dsl_app_012.rb +1 -1
  221. data/integrations/dsl_app_013.rb +1 -1
  222. data/integrations/dsl_app_014.rb +1 -1
  223. data/integrations/dsl_app_015.rb +1 -1
  224. data/integrations/dsl_app_016.rb +1 -1
  225. data/integrations/dsl_app_017.rb +1 -1
  226. data/integrations/dsl_app_018.rb +1 -1
  227. data/integrations/dsl_app_019.rb +1 -1
  228. data/integrations/dsl_app_020.rb +1 -1
  229. data/integrations/dsl_app_021.rb +1 -1
  230. data/integrations/dsl_app_022.rb +1 -1
  231. data/integrations/dsl_app_030.rb +1 -1
  232. data/integrations/dsl_app_031.rb +1 -1
  233. data/integrations/dsl_app_040.rb +1 -1
  234. data/integrations/dsl_app_041.rb +1 -1
  235. data/integrations/dsl_app_042.rb +1 -1
  236. data/integrations/dsl_app_border_001.rb +1 -1
  237. data/integrations/dsl_app_border_002.rb +1 -1
  238. data/integrations/dsl_app_border_003.rb +1 -1
  239. data/integrations/dsl_app_border_004.rb +1 -1
  240. data/integrations/dsl_app_border_005.rb +1 -1
  241. data/integrations/dsl_app_border_006.rb +1 -1
  242. data/integrations/dsl_app_border_007.rb +1 -1
  243. data/integrations/dsl_app_border_008.rb +1 -1
  244. data/integrations/dsl_app_border_009.rb +1 -1
  245. data/integrations/dsl_app_border_010.rb +1 -1
  246. data/integrations/dsl_app_border_011.rb +1 -1
  247. data/integrations/dsl_app_border_012.rb +1 -1
  248. data/integrations/dsl_app_geometry_001.rb +1 -1
  249. data/integrations/dsl_app_geometry_002.rb +1 -1
  250. data/integrations/dsl_app_geometry_003.rb +1 -1
  251. data/integrations/dsl_app_geometry_004.rb +1 -1
  252. data/integrations/dsl_app_geometry_005.rb +16 -7
  253. data/integrations/expected/dsl_app_geometry_005.out +1 -1
  254. data/lib/vedeu/borders/refresh.rb +1 -1
  255. data/lib/vedeu/output/compressor.rb +1 -19
  256. data/lib/vedeu/output/compressors/all.rb +1 -0
  257. data/lib/vedeu/output/compressors/character.rb +6 -11
  258. data/lib/vedeu/output/compressors/empty.rb +56 -0
  259. data/lib/vedeu/output/compressors/simple.rb +10 -23
  260. data/lib/vedeu/version.rb +1 -1
  261. data/test/lib/vedeu/output/compressors/character_test.rb +5 -5
  262. data/test/lib/vedeu/output/compressors/empty_test.rb +38 -0
  263. data/test/lib/vedeu/output/compressors/simple_test.rb +4 -6
  264. data/test/support/examples/focus_app.rb +1 -1
  265. data/test/support/examples/hello_world.rb +1 -1
  266. data/test/support/examples/material_colours_app.rb +1 -1
  267. data/test/support/examples/view_templates_app/view_templates_app.rb +1 -1
  268. data/test/test_helper.rb +1 -1
  269. metadata +5 -2
@@ -1,4 +1,5 @@
1
1
  ### `top_right`
2
+
2
3
  Set the character to be used to draw the top right corner of
3
4
  the border.
4
5
 
@@ -1,2 +1,3 @@
1
1
  ### Vedeu.trigger
2
+
2
3
  @todo Add more documentation.
@@ -1,4 +1,5 @@
1
1
  ### Vedeu.unbind
2
+
2
3
  Unbind events from a named handler.
3
4
 
4
5
  Removes all events associated with the given name.
@@ -1,4 +1,5 @@
1
1
  ### Vedeu.unbind_alias
2
+
2
3
  Remove an alias by name. The alias name group is destroyed, but events
3
4
  stored within this alias are not.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `vertical`
2
+
2
3
  Set the character to be used to draw a vertical part of the border.
3
4
 
4
5
  Vedeu.border :border_demo do
@@ -1,4 +1,5 @@
1
1
  ### Vedeu.repositories
2
+
2
3
  Returns an array of all repositories registered with Vedeu.
3
4
 
4
5
  Vedeu.repositories
@@ -1,4 +1,5 @@
1
1
  ### Vedeu.width
2
+
2
3
  Returns the total width (number of columns/characters) of the
3
4
  current terminal.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### Vedeu.write
2
+
2
3
  This allows the direct writing to the terminal, unencumbered by the
3
4
  framework.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `:_cleanup_`
2
+
2
3
  Vedeu triggers this event when `:_exit_` is triggered. You can hook
3
4
  into this to perform a special action before the application
4
5
  terminates. Saving the user's work, session or preferences might be
@@ -1,2 +1,3 @@
1
1
  ### `:_clear_`
2
+
2
3
  See {Vedeu::Buffers::Terminal#clear}
@@ -1,4 +1,5 @@
1
1
  ### `:_clear_group_`
2
+
2
3
  Clears the spaces occupied by the interfaces belonging to the named
3
4
  group.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `:_clear_view_`
2
+
2
3
  Clears the named view/interface area.
3
4
 
4
5
  Vedeu.trigger(:_clear_view_, name)
@@ -1,4 +1,5 @@
1
1
  ### `:_clear_view_content_`
2
+
2
3
  Clears only the content of the named view/interface area.
3
4
 
4
5
  Vedeu.trigger(:_clear_view_content_, name)
@@ -1,4 +1,5 @@
1
1
  ### `:_command_`
2
+
2
3
  This event is used by Vedeu internally, though you can bind to it if
3
4
  you wish. It is preferred for you to bind to `:command` though.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `:_cursor_bottom_`
2
+
2
3
  Moves the cursor to the bottom-most position for the view or terminal.
3
4
  If the view contains content, then this event will effectively scroll
4
5
  to the last line of the content.
@@ -1,4 +1,5 @@
1
1
  ### `:_cursor_down_`
2
+
2
3
  Moves the cursor one line down, unless the bottom-most position for
3
4
  the view or terminal is reached.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `:_cursor_left_`
2
+
2
3
  Moves the cursor one character left, unless the left-most position
3
4
  for the view or terminal is reached.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `:_cursor_origin_`
2
+
2
3
  This event moves the cursor to the interface origin; the top left
3
4
  corner of the named interface.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `:_cursor_position_`
2
+
2
3
  To ascertain the position of a cursor in a named interface, use the
3
4
  following event (substituting 'name' for the interface name):
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `:_cursor_reposition_`
2
+
2
3
  Moves the cursor to a relative position inside the interface.
3
4
 
4
5
  Vedeu.trigger(:_cursor_reposition_, name, y, x)
@@ -1,4 +1,5 @@
1
1
  ### `:_cursor_right_`
2
+
2
3
  Moves the cursor one character to the right, unless the right-most
3
4
  position for the view or terminal is reached.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `:_cursor_top_`
2
+
2
3
  Moves the cursor to the top-most position for the view or terminal.
3
4
  If the view contains content, then this event will effectively scroll
4
5
  to the first line of the content.
@@ -1,4 +1,5 @@
1
1
  ### `:_cursor_up_`
2
+
2
3
  Moves the cursor one line up, unless the top-most position for the
3
4
  view or terminal is reached.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `:_drb_input_`
2
+
2
3
  Triggering this event will send input to the running application as
3
4
  long as it has the DRb server running.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `:_drb_restart_`
2
+
2
3
  Use the DRb server to request the client application to restart.
3
4
 
4
5
  Vedeu.trigger(:_drb_restart_)
@@ -1,2 +1,3 @@
1
1
  ### `:_drb_retrieve_output_`
2
+
2
3
  See {Vedeu::Buffers::Terminal#output}
@@ -1,4 +1,5 @@
1
1
  ### `:_drb_start_`
2
+
2
3
  Use the DRb server to request the client application to start.
3
4
 
4
5
  Vedeu.trigger(:_drb_start_)
@@ -1,4 +1,5 @@
1
1
  ### `:_drb_status_`
2
+
2
3
  Use the DRb server to request the status of the client application.
3
4
 
4
5
  Vedeu.trigger(:_drb_status_)
@@ -1,4 +1,5 @@
1
1
  ### `:_drb_stop_`
2
+
2
3
  Use the DRb server to request the client application to stop.
3
4
 
4
5
  Vedeu.trigger(:_drb_stop_)
@@ -1,2 +1,3 @@
1
1
  ### `:_drb_store_output_`
2
+
2
3
  See {Vedeu::Buffers::Terminal#write}
@@ -1,4 +1,5 @@
1
1
  ### `:_editor_`
2
+
2
3
  This event is called by {Vedeu::Input::Capture#read}. When
3
4
  invoked, the key will be passed to the editor for currently
4
5
  focussed view.
@@ -1,4 +1,5 @@
1
1
  ### `:_editor_delete_character_`
2
+
2
3
  This event attempts to delete the character in the named
3
4
  document at the current virtual cursor position.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `:_editor_delete_line_`
2
+
2
3
  This event attempts to delete the line in the named document
3
4
  at the current virtual cursor position.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `:_editor_down_`
2
+
2
3
  This event attempts to move the virtual cursor down by one
3
4
  line in the named document.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `:_editor_insert_character_`
2
+
2
3
  This event attempts to insert the given character in the named
3
4
  document at the current virtual cursor position.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `:_editor_insert_line_`
2
+
2
3
  This event attempts to insert a new line in the named document
3
4
  at the current virtual cursor position.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `:_editor_left_`
2
+
2
3
  This event attempts to move the virtual cursor left by one
3
4
  character in the named document.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `:_editor_right_`
2
+
2
3
  This event attempts to move the virtual cursor right by one
3
4
  character in the named document.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `:_editor_up_`
2
+
2
3
  This event attempts to move the virtual cursor up by one line
3
4
  in the named document.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `:_exit_`
2
+
2
3
  When triggered, Vedeu will trigger a `:cleanup` event which you can
3
4
  define (to save files, etc) and attempt to exit.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `:_focus_by_name_`
2
+
2
3
  When triggered with an interface name will focus that interface and
3
4
  restore the cursor position and visibility.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `:_focus_next_`
2
+
2
3
  When triggered will focus the next visible interface and restore the
3
4
  cursor position and visibility.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `:_focus_prev_`
2
+
2
3
  When triggered will focus the previous visible interface and restore
3
4
  the cursor position and visibility.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `:_goto_`
2
+
2
3
  Call a client application controller's action with parameters.
3
4
 
4
5
  Vedeu.trigger(:_goto_,
@@ -1,4 +1,5 @@
1
1
  ### Vedeu.hide_cursor / `:_hide_cursor_`
2
+
2
3
  Hide a named cursor, or without a name, the cursor of the currently
3
4
  focussed interface.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `:_hide_group_`
2
+
2
3
  Hiding a group of interfaces.
3
4
 
4
5
  Vedeu.trigger(:_hide_group_, name)
@@ -1,4 +1,5 @@
1
1
  ### `:_hide_interface_`
2
+
2
3
  Hide an interface by name.
3
4
 
4
5
  Vedeu.trigger(:_hide_interface_, name)
@@ -1,4 +1,5 @@
1
1
  ### `:_initialize_`
2
+
2
3
  Vedeu triggers this event when it is ready to enter the main loop.
3
4
  Client applications can listen for this event and perform some
4
5
  action(s), like render the first screen, interface or make a sound.
@@ -1,4 +1,5 @@
1
1
  ### `:_keypress_`
2
+
2
3
  This event is used by Vedeu internally, though you can bind to it if
3
4
  you wish. It is preferred for you to bind to `:key` though.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `:_log_`
2
+
2
3
  When triggered with a message will cause Vedeu to log the message if
3
4
  logging is enabled in the configuration.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `:_maximise_`
2
+
2
3
  Will maximise the named interface geometry. This means it will occupy
3
4
  all of the available space on the terminal window.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `:_menu_bottom_`
2
+
2
3
  Makes the last menu item the current menu item.
3
4
 
4
5
  Vedeu.trigger(:_menu_bottom_, name)
@@ -1,4 +1,5 @@
1
1
  ### `:_menu_current_`
2
+
2
3
  Returns the current menu item.
3
4
 
4
5
  Vedeu.trigger(:_menu_current_, name)
@@ -1,4 +1,5 @@
1
1
  ### `:_menu_deselect_`
2
+
2
3
  Deselects all menu items.
3
4
 
4
5
  Vedeu.trigger(:_menu_deselect_, name)
@@ -1,4 +1,5 @@
1
1
  ### `:_menu_items_`
2
+
2
3
  Returns all the menu items with respective `current` or `selected`
3
4
  boolean indicators.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `:_menu_next_`
2
+
2
3
  Makes the next menu item the current menu item, until it reaches the
3
4
  last item.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `:_menu_prev_`
2
+
2
3
  Makes the previous menu item the current menu item, until it reaches
3
4
  the first item.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `:_menu_select_`
2
+
2
3
  Makes the current menu item also the selected menu item.
3
4
 
4
5
  Vedeu.trigger(:_menu_select_, name)
@@ -1,4 +1,5 @@
1
1
  ### `:_menu_selected_`
2
+
2
3
  Returns the selected menu item.
3
4
 
4
5
  Vedeu.trigger(:_menu_selected_, name)
@@ -1,4 +1,5 @@
1
1
  ### `:_menu_top_`
2
+
2
3
  Makes the first menu item the current menu item.
3
4
 
4
5
  Vedeu.trigger(:_menu_top_, name)
@@ -1,4 +1,5 @@
1
1
  ### `:_menu_view_`
2
+
2
3
  Returns a subset of the menu items; starting at the current item to
3
4
  the last item.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `:_mode_switch_`
2
+
2
3
  When triggered, Vedeu switches between modes of the terminal. The idea
3
4
  here being that the raw mode is for single keypress actions, whilst
4
5
  fake and cooked modes allow the user to enter more elaborate commands-
@@ -1,4 +1,5 @@
1
1
  ### `:_movement_refresh_`
2
+
2
3
  When triggered, triggers additional events which aid the updating of
3
4
  the output. Used when moving an interface/view.
4
5
 
@@ -1,4 +1,5 @@
1
1
  ### `:_refresh_`
2
+
2
3
  Refreshes all registered interfaces.
3
4
 
4
5
  The interfaces will be refreshed in z-index order, meaning that
@@ -1,4 +1,5 @@
1
1
  ### `:_refresh_border_`
2
+
2
3
  This event refreshes the border of the named view.
3
4
 
4
5
  - If a name is not given, then the currently focussed view will be
@@ -1,4 +1,5 @@
1
1
  ### `:_refresh_cursor_`
2
+
2
3
  Will cause the named cursor to refresh, or the cursor of the interface
3
4
  which is currently in focus.
4
5