Module: Vedeu

Extended by:
API
Defined in:
lib/vedeu.rb,
lib/vedeu/api/api.rb,
lib/vedeu/api/line.rb,
lib/vedeu/api/menu.rb,
lib/vedeu/launcher.rb,
lib/vedeu/api/keymap.rb,
lib/vedeu/api/stream.rb,
lib/vedeu/api/defined.rb,
lib/vedeu/api/helpers.rb,
lib/vedeu/application.rb,
lib/vedeu/input/input.rb,
lib/vedeu/models/line.rb,
lib/vedeu/output/view.rb,
lib/vedeu/support/esc.rb,
lib/vedeu/support/log.rb,
lib/vedeu/models/style.rb,
lib/vedeu/output/clear.rb,
lib/vedeu/support/grid.rb,
lib/vedeu/support/menu.rb,
lib/vedeu/api/interface.rb,
lib/vedeu/models/colour.rb,
lib/vedeu/models/cursor.rb,
lib/vedeu/models/keymap.rb,
lib/vedeu/models/stream.rb,
lib/vedeu/output/render.rb,
lib/vedeu/support/event.rb,
lib/vedeu/support/trace.rb,
lib/vedeu/output/refresh.rb,
lib/vedeu/support/common.rb,
lib/vedeu/api/composition.rb,
lib/vedeu/models/geometry.rb,
lib/vedeu/models/interface.rb,
lib/vedeu/support/position.rb,
lib/vedeu/support/terminal.rb,
lib/vedeu/configuration/api.rb,
lib/vedeu/configuration/cli.rb,
lib/vedeu/output/compositor.rb,
lib/vedeu/support/registrar.rb,
lib/vedeu/models/composition.rb,
lib/vedeu/repositories/focus.rb,
lib/vedeu/repositories/menus.rb,
lib/vedeu/support/exceptions.rb,
lib/vedeu/support/repository.rb,
lib/vedeu/repositories/events.rb,
lib/vedeu/repositories/groups.rb,
lib/vedeu/repositories/buffers.rb,
lib/vedeu/repositories/cursors.rb,
lib/vedeu/repositories/keymaps.rb,
lib/vedeu/repositories/interfaces.rb,
lib/vedeu/support/keymap_validator.rb,
lib/vedeu/configuration/configuration.rb,
lib/vedeu/models/attributes/coercions.rb,
lib/vedeu/models/attributes/background.rb,
lib/vedeu/models/attributes/foreground.rb,
lib/vedeu/models/attributes/presentation.rb,
lib/vedeu/models/attributes/colour_translator.rb

Overview

Fixnum

Defined Under Namespace

Modules: API, Buffers, Coercions, Common, Configuration, Cursors, Esc, Events, Focus, Groups, Interfaces, Keymaps, Menus, Presentation, Refresh, Repository, Terminal Classes: Application, Background, Clear, Colour, ColourTranslator, Composition, Compositor, Cursor, Event, Foreground, Geometry, Grid, Input, Interface, Keymap, KeymapValidator, Launcher, Line, Log, Menu, MonoLogger, Position, Registrar, Render, Stream, Style, Trace, View

Constant Summary collapse

BufferNotFound =

Raised when Vedeu attempts to access a named buffer that does not exist.

Class.new(StandardError)
CursorNotFound =

Raised when a cursor cannot be found by name.

Class.new(StandardError)
GroupNotFound =

Raised when trying to access a group of interfaces which do not exist by this name.

Class.new(StandardError)
InterfaceNotFound =

Raised when an interface cannot be found by name.

Class.new(StandardError)
InvalidSyntax =

Raised when Vedeu attempts to parse a API#view or API#interface and encounters a problem.

Class.new(StandardError)
KeyInUse =

Raised when attempting to assign a key which is already in use.

Class.new(StandardError)

Class.new(StandardError)
MissingRequired =

Raised when the attributes argument to Registrar does not contain a required key or the value to that key is nil or empty.

Class.new(StandardError)
ModeSwitch =

Raised intentionally when the client application wishes to switch between cooked and raw (or vice versa) terminal modes. Vedeu is hard-wired to use the ‘Escape` key to trigger this change for the time being.

Class.new(StandardError)
NoInterfacesDefined =

Raised when attempting to reach the currently in focus interface, when no interfaces have been defined yet.

Class.new(StandardError)
NotImplemented =

Raised to remind me (or client application developers) that the subclass implements the functionality sought.

Class.new(StandardError)
OutOfRange =

Raised when trying to access an interface column less than 1 or greater than 12. Vedeu is hard-wired to a 12-column layout for the time being.

Class.new(StandardError)

Class Method Summary collapse

Methods included from API

configure, defined, event, focus, height, interface, keypress, keys, log, menu, render, resize, trigger, unevent, use, view, views, width

Class Method Details

.included(receiver) ⇒ Object

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

Examples:

class YourClassHere
  include Vedeu
  ...



13
14
15
16
 
# File 'lib/vedeu.rb', line 13

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