Module: Vedeu

Extended by:
Forwardable, Vedeu, API::External, API::Internal
Included in:
Vedeu
Defined in:
lib/vedeu.rb,
lib/vedeu/error.rb,
lib/vedeu/common.rb,
lib/vedeu/dsl/dsl.rb,
lib/vedeu/dsl/use.rb,
lib/vedeu/esc/esc.rb,
lib/vedeu/options.rb,
lib/vedeu/version.rb,
lib/vedeu/dsl/line.rb,
lib/vedeu/dsl/text.rb,
lib/vedeu/dsl/view.rb,
lib/vedeu/dsl/group.rb,
lib/vedeu/input/all.rb,
lib/vedeu/input/key.rb,
lib/vedeu/menus/all.rb,
lib/vedeu/menus/dsl.rb,
lib/vedeu/null/null.rb,
lib/vedeu/null/view.rb,
lib/vedeu/dsl/keymap.rb,
lib/vedeu/dsl/shared.rb,
lib/vedeu/dsl/stream.rb,
lib/vedeu/editor/all.rb,
lib/vedeu/events/all.rb,
lib/vedeu/input/keys.rb,
lib/vedeu/menus/menu.rb,
lib/vedeu/menus/null.rb,
lib/vedeu/models/row.rb,
lib/vedeu/borders/all.rb,
lib/vedeu/borders/dsl.rb,
lib/vedeu/buffers/all.rb,
lib/vedeu/colours/all.rb,
lib/vedeu/cursors/all.rb,
lib/vedeu/editor/line.rb,
lib/vedeu/esc/actions.rb,
lib/vedeu/esc/borders.rb,
lib/vedeu/esc/colours.rb,
lib/vedeu/input/input.rb,
lib/vedeu/logging/all.rb,
lib/vedeu/logging/log.rb,
lib/vedeu/models/cell.rb,
lib/vedeu/models/page.rb,
lib/vedeu/output/text.rb,
lib/vedeu/api/external.rb,
lib/vedeu/api/internal.rb,
lib/vedeu/bindings/drb.rb,
lib/vedeu/borders/null.rb,
lib/vedeu/buffers/null.rb,
lib/vedeu/editor/lines.rb,
lib/vedeu/events/event.rb,
lib/vedeu/geometry/all.rb,
lib/vedeu/geometry/dsl.rb,
lib/vedeu/input/keymap.rb,
lib/vedeu/input/mapper.rb,
lib/vedeu/models/focus.rb,
lib/vedeu/models/group.rb,
lib/vedeu/null/generic.rb,
lib/vedeu/dsl/interface.rb,
lib/vedeu/editor/cursor.rb,
lib/vedeu/editor/editor.rb,
lib/vedeu/editor/insert.rb,
lib/vedeu/geometry/area.rb,
lib/vedeu/geometry/grid.rb,
lib/vedeu/geometry/null.rb,
lib/vedeu/input/keymaps.rb,
lib/vedeu/logging/debug.rb,
lib/vedeu/logging/timer.rb,
lib/vedeu/models/escape.rb,
lib/vedeu/models/groups.rb,
lib/vedeu/output/direct.rb,
lib/vedeu/output/output.rb,
lib/vedeu/runtime/flags.rb,
lib/vedeu/runtime/traps.rb,
lib/vedeu/terminal/mode.rb,
lib/vedeu/bindings/focus.rb,
lib/vedeu/bindings/menus.rb,
lib/vedeu/borders/border.rb,
lib/vedeu/borders/render.rb,
lib/vedeu/buffers/buffer.rb,
lib/vedeu/colours/colour.rb,
lib/vedeu/cursors/cursor.rb,
lib/vedeu/editor/capture.rb,
lib/vedeu/editor/cropper.rb,
lib/vedeu/events/aliases.rb,
lib/vedeu/events/trigger.rb,
lib/vedeu/null/interface.rb,
lib/vedeu/plugins/plugin.rb,
lib/vedeu/runtime/router.rb,
lib/vedeu/templating/all.rb,
lib/vedeu/bindings/system.rb,
lib/vedeu/buffers/refresh.rb,
lib/vedeu/cursors/refresh.rb,
lib/vedeu/distributed/uri.rb,
lib/vedeu/dsl/composition.rb,
lib/vedeu/editor/document.rb,
lib/vedeu/output/viewport.rb,
lib/vedeu/output/wordwrap.rb,
lib/vedeu/plugins/plugins.rb,
lib/vedeu/refresh/refresh.rb,
lib/vedeu/terminal/buffer.rb,
lib/vedeu/application/view.rb,
lib/vedeu/bindings/refresh.rb,
lib/vedeu/dsl/presentation.rb,
lib/vedeu/editor/documents.rb,
lib/vedeu/input/translator.rb,
lib/vedeu/menus/repository.rb,
lib/vedeu/models/interface.rb,
lib/vedeu/models/views/all.rb,
lib/vedeu/output/renderers.rb,
lib/vedeu/runtime/launcher.rb,
lib/vedeu/bindings/bindings.rb,
lib/vedeu/bindings/document.rb,
lib/vedeu/bindings/movement.rb,
lib/vedeu/configuration/api.rb,
lib/vedeu/configuration/cli.rb,
lib/vedeu/events/collection.rb,
lib/vedeu/events/repository.rb,
lib/vedeu/geometry/geometry.rb,
lib/vedeu/geometry/position.rb,
lib/vedeu/models/interfaces.rb,
lib/vedeu/models/toggleable.rb,
lib/vedeu/models/views/char.rb,
lib/vedeu/models/views/line.rb,
lib/vedeu/models/views/view.rb,
lib/vedeu/output/compressor.rb,
lib/vedeu/runtime/bootstrap.rb,
lib/vedeu/runtime/main_loop.rb,
lib/vedeu/terminal/terminal.rb,
lib/vedeu/application/helper.rb,
lib/vedeu/borders/repository.rb,
lib/vedeu/buffers/repository.rb,
lib/vedeu/colours/background.rb,
lib/vedeu/colours/foreground.rb,
lib/vedeu/colours/repository.rb,
lib/vedeu/colours/translator.rb,
lib/vedeu/cursors/repository.rb,
lib/vedeu/distributed/client.rb,
lib/vedeu/distributed/server.rb,
lib/vedeu/geometry/dimension.rb,
lib/vedeu/repositories/model.rb,
lib/vedeu/repositories/store.rb,
lib/vedeu/templating/decoder.rb,
lib/vedeu/templating/encoder.rb,
lib/vedeu/templating/helpers.rb,
lib/vedeu/bindings/visibility.rb,
lib/vedeu/colours/backgrounds.rb,
lib/vedeu/colours/foregrounds.rb,
lib/vedeu/geometry/coordinate.rb,
lib/vedeu/geometry/repository.rb,
lib/vedeu/logging/mono_logger.rb,
lib/vedeu/models/views/stream.rb,
lib/vedeu/runtime/application.rb,
lib/vedeu/templating/template.rb,
lib/vedeu/bindings/application.rb,
lib/vedeu/output/renderers/file.rb,
lib/vedeu/output/renderers/html.rb,
lib/vedeu/output/renderers/json.rb,
lib/vedeu/output/renderers/null.rb,
lib/vedeu/output/renderers/text.rb,
lib/vedeu/refresh/refresh_group.rb,
lib/vedeu/application/controller.rb,
lib/vedeu/distributed/subprocess.rb,
lib/vedeu/models/views/html_char.rb,
lib/vedeu/repositories/collection.rb,
lib/vedeu/repositories/repository.rb,
lib/vedeu/models/views/composition.rb,
lib/vedeu/output/clear/named_group.rb,
lib/vedeu/templating/view_template.rb,
lib/vedeu/output/presentation/style.rb,
lib/vedeu/output/renderers/terminal.rb,
lib/vedeu/repositories/registerable.rb,
lib/vedeu/repositories/repositories.rb,
lib/vedeu/output/presentation/colour.rb,
lib/vedeu/output/presentation/styles.rb,
lib/vedeu/configuration/configuration.rb,
lib/vedeu/geometry/generic_coordinate.rb,
lib/vedeu/logging/lockless_log_device.rb,
lib/vedeu/application/application_view.rb,
lib/vedeu/distributed/test_application.rb,
lib/vedeu/output/clear/named_interface.rb,
lib/vedeu/application/application_helper.rb,
lib/vedeu/models/views/collections/chars.rb,
lib/vedeu/models/views/collections/lines.rb,
lib/vedeu/models/views/collections/streams.rb,
lib/vedeu/output/presentation/presentation.rb,
lib/vedeu/output/renderers/escape_sequence.rb,
lib/vedeu/output/renderers/renderer_options.rb,
lib/vedeu/application/application_controller.rb,
lib/vedeu/models/views/collections/view_collection.rb

Overview

Vedeu is a GUI framework for terminal/console applications written in Ruby.

Defined Under Namespace

Modules: API, ApplicationHelper, Bindings, Borders, Buffers, Clear, Colours, Common, Config, Controller, Cursors, DSL, Distributed, Editor, Error, Esc, EscapeSequences, Events, Geometry, Helper, Input, Logging, Menus, Model, Models, Null, Output, Presentation, Registerable, RendererOptions, Renderers, Repositories, Runtime, Store, Templating, Terminal, Toggleable, View, Views Classes: ApplicationController, ApplicationView, Collection, Configuration, Launcher, Options, Plugin, Plugins, Refresh, RefreshGroup, Repository, TestApplication

Constant Summary collapse

VERSION =

The current version of Vedeu.

'0.6.10'

Class Method Summary collapse

Instance Method Summary collapse

Methods included from API::External

bind, bind, bind_alias, bind_alias, border, border, bound?, bound?, clear, clear, clear_by_group, clear_by_group, clear_by_name, clear_by_name, configuration, configuration, configure, configure, cursor, cursor, drb_restart, drb_restart, drb_start, drb_start, drb_status, drb_status, drb_stop, drb_stop, exit, exit, focus, focus, focus_by_name, focus_by_name, focus_next, focus_next, focus_previous, focus_previous, focussed?, focussed?, geometry, geometry, goto, goto, group, group, height, height, hide_cursor, hide_cursor, hide_group, hide_group, hide_interface, hide_interface, interface, interface, keymap, keymap, keypress, keypress, log, log, log_stderr, log_stderr, log_stdout, log_stdout, menu, menu, render, render, renders, renders, show_cursor, show_cursor, show_group, show_group, show_interface, show_interface, toggle_cursor, toggle_cursor, toggle_group, toggle_group, toggle_interface, toggle_interface, trigger, trigger, unbind, unbind, unbind_alias, unbind_alias, views, views, width, width

Methods included from API::Internal

background_colours, background_colours, borders, borders, buffers, buffers, cursors, cursors, debug, debug, documents, documents, events, events, foreground_colours, foreground_colours, geometries, geometries, groups, groups, interfaces, interfaces, keymaps, keymaps, menus, menus, ready!, ready!, ready?, ready?, renderer, renderer, renderers, renderers, resize, resize, timer, timer

Class Method Details

.focusable ⇒ Vedeu::Models::Focus

Return the name of currently focussed interface.

Returns:



38
39
40
 
# File 'lib/vedeu.rb', line 38

def self.focusable
  @focusable ||= Vedeu::Models::Focus
end

.included(receiver) ⇒ void

This method returns an undefined value.

:nocov: When Vedeu is included within one of your classes, you should have all API methods at your disposal.

Examples:

class YourClassHere
  include Vedeu

  # ...
end

Parameters:

  • receiver (void) 


55
56
57
58
 
# File 'lib/vedeu.rb', line 55

def included(receiver)
  receiver.send(:include, Vedeu::API::External)
  receiver.extend(Vedeu::API::External)
end

Instance Method Details

#included(receiver) ⇒ void

This method returns an undefined value.

:nocov: When Vedeu is included within one of your classes, you should have all API methods at your disposal.

Examples:

class YourClassHere
  include Vedeu

  # ...
end

Parameters:

  • receiver (void) 


55
56
57
58
 
# File 'lib/vedeu.rb', line 55

def included(receiver)
  receiver.send(:include, Vedeu::API::External)
  receiver.extend(Vedeu::API::External)
end