Module: Vedeu::API

Extended by:

Forwardable

Included in:

Vedeu

Defined in:

lib/vedeu/api.rb

Overview

Provides the API to Vedeu. Methods therein, and classes belonging to this module expose Vedeu’s core functionality.

These methods are used in a variety of ways, sometimes in combination:

# with parameters
Vedeu.method_name(*params)

# with a block
Vedeu.method_name(*params) do
  # ...
end

# with other methods
Vedeu.method_name.other_method

Class Method Summary

• .background_colours ⇒ Object
• .bind ⇒ Object
• .border ⇒ Object
• .borders ⇒ Object
• .buffers ⇒ Object
• .canvas ⇒ Object
• .configuration ⇒ Object
• .configure ⇒ Object
• .cursor ⇒ Object
• .cursors ⇒ Object
• .events ⇒ Object
• .focus ⇒ Object
• .focus_by_name ⇒ Object
• .focus_next ⇒ Object
• .focus_previous ⇒ Object
• .focussed? ⇒ Object
• .foreground_colours ⇒ Object
• .geometries ⇒ Object
• .geometry ⇒ Object
• .group ⇒ Object
• .groups ⇒ Object
• .height ⇒ Object
• .interface ⇒ Object
• .interfaces ⇒ Object
• .keymap ⇒ Object
• .keymaps ⇒ Object
• .keypress ⇒ Object
• .log ⇒ Object
• .menu ⇒ Object
• .menus ⇒ Object
• .renderer ⇒ Object
• .renderers ⇒ Object
• .renders ⇒ Object
• .resize ⇒ Object
• .trigger ⇒ Object
• .unbind ⇒ Object
• .views ⇒ Object
• .width ⇒ Object

Instance Method Summary

• #background_colours ⇒ Object private
• #bind ⇒ Object private
• #border ⇒ Object private
• #borders ⇒ Object private
• #buffers ⇒ Object private
• #canvas ⇒ Object private
• #configuration ⇒ Object private
• #configure ⇒ Object private
• #cursor ⇒ Object private
• #cursors ⇒ Object private
• #events ⇒ Object private
• #focus ⇒ Object private
• #focus_by_name ⇒ Object private
• #focus_next ⇒ Object private
• #focus_previous ⇒ Object private
• #focussed? ⇒ Object private
• #foreground_colours ⇒ Object private
• #geometries ⇒ Object private
• #geometry ⇒ Object private
• #group ⇒ Object private
• #groups ⇒ Object private
• #height ⇒ Object private
• #interface ⇒ Object private
• #interfaces ⇒ Object private
• #keymap ⇒ Object private
• #keymaps ⇒ Object private
• #keypress ⇒ Object private
• #log ⇒ Object private
• #menu ⇒ Object private
• #menus ⇒ Object private
• #renderer ⇒ Object private
• #renderers ⇒ Object private
• #renders ⇒ Object private
• #resize ⇒ Object private
• #trigger ⇒ Object private
• #unbind ⇒ Object private
• #views ⇒ Object private
• #width ⇒ Object private

Class Method Details

.background_colours ⇒ Object

See Also:

• BackgroundColours.background_colours

# File 'lib/vedeu/api.rb', line 41

def_delegators Vedeu::BackgroundColours, :background_colours

.bind ⇒ Object

See Also:

• Event.bind

# File 'lib/vedeu/api.rb', line 95

def_delegators Vedeu::Event, :bind, :unbind

.border ⇒ Object

See Also:

• DSL::Border.border

# File 'lib/vedeu/api.rb', line 69

def_delegators Vedeu::DSL::Border, :border

.borders ⇒ Object

See Also:

• Borders.borders

# File 'lib/vedeu/api.rb', line 45

def_delegators Vedeu::Borders, :borders

.buffers ⇒ Object

See Also:

• Buffers.buffers

# File 'lib/vedeu/api.rb', line 49

def_delegators Vedeu::Buffers, :buffers

.canvas ⇒ Object

See Also:

• Canvas.canvas

# File 'lib/vedeu/api.rb', line 53

def_delegators Vedeu::Canvas, :canvas

.configuration ⇒ Object

See Also:

• Configuration.configuration

# File 'lib/vedeu/api.rb', line 59

def_delegators Vedeu::Configuration, :configure, :configuration

.configure ⇒ Object

See Also:

• Configuration.configure

# File 'lib/vedeu/api.rb', line 59

def_delegators Vedeu::Configuration, :configure, :configuration

.cursor ⇒ Object

See Also:

• Cursors.cursor

# File 'lib/vedeu/api.rb', line 65

def_delegators Vedeu::Cursors, :cursor, :cursors

.cursors ⇒ Object

See Also:

• Cursors.cursors

# File 'lib/vedeu/api.rb', line 65

def_delegators Vedeu::Cursors, :cursor, :cursors

.events ⇒ Object

See Also:

• EventsRepository.events

# File 'lib/vedeu/api.rb', line 99

def_delegators Vedeu::EventsRepository, :events

.focus ⇒ Object

See Also:

• Focus#focus

# File 'lib/vedeu/api.rb', line 111

def_delegators Vedeu::Focus, :focus, :focus_by_name, :focussed?,
:focus_next, :focus_previous

.focus_by_name ⇒ Object

See Also:

• Focus#focus_by_name

# File 'lib/vedeu/api.rb', line 111

def_delegators Vedeu::Focus, :focus, :focus_by_name, :focussed?,
:focus_next, :focus_previous

.focus_next ⇒ Object

See Also:

• Focus#focus_next

# File 'lib/vedeu/api.rb', line 111

def_delegators Vedeu::Focus, :focus, :focus_by_name, :focussed?,
:focus_next, :focus_previous

.focus_previous ⇒ Object

See Also:

• Focus#focus_previous

# File 'lib/vedeu/api.rb', line 111

def_delegators Vedeu::Focus, :focus, :focus_by_name, :focussed?,
:focus_next, :focus_previous

.focussed? ⇒ Object

See Also:

• Focus#focussed?

# File 'lib/vedeu/api.rb', line 111

def_delegators Vedeu::Focus, :focus, :focus_by_name, :focussed?,
:focus_next, :focus_previous

.foreground_colours ⇒ Object

See Also:

• ForegroundColours.foreground_colours

# File 'lib/vedeu/api.rb', line 116

def_delegators Vedeu::ForegroundColours, :foreground_colours

.geometries ⇒ Object

See Also:

• Geometries.geometries

# File 'lib/vedeu/api.rb', line 120

def_delegators Vedeu::Geometries, :geometries

.geometry ⇒ Object

See Also:

• DSL::Geometry.geometry

# File 'lib/vedeu/api.rb', line 73

def_delegators Vedeu::DSL::Geometry, :geometry

.group ⇒ Object

See Also:

• DSL::Group.group

# File 'lib/vedeu/api.rb', line 77

def_delegators Vedeu::DSL::Group, :group

.groups ⇒ Object

See Also:

• Groups.groups

# File 'lib/vedeu/api.rb', line 124

def_delegators Vedeu::Groups, :groups

.height ⇒ Object

See Also:

• Terminal#height

# File 'lib/vedeu/api.rb', line 162

def_delegators Vedeu::Terminal, :height, :width, :resize

.interface ⇒ Object

See Also:

• DSL::View.interface

# File 'lib/vedeu/api.rb', line 89

def_delegators Vedeu::DSL::View, :interface, :renders, :views

.interfaces ⇒ Object

See Also:

• InterfacesRepository.interfaces

# File 'lib/vedeu/api.rb', line 128

def_delegators Vedeu::InterfacesRepository, :interfaces

.keymap ⇒ Object

See Also:

• DSL::Keymap.keymap

# File 'lib/vedeu/api.rb', line 81

def_delegators Vedeu::DSL::Keymap, :keymap

.keymaps ⇒ Object

See Also:

• Keymaps.keymaps

# File 'lib/vedeu/api.rb', line 132

def_delegators Vedeu::Keymaps, :keymaps

.keypress ⇒ Object

See Also:

• Mapper.keypress

# File 'lib/vedeu/api.rb', line 140

def_delegators Vedeu::Mapper, :keypress

.log ⇒ Object

See Also:

• Log.log

# File 'lib/vedeu/api.rb', line 136

def_delegators Vedeu::Log, :log

.menu ⇒ Object

See Also:

• Menu.menu

# File 'lib/vedeu/api.rb', line 144

def_delegators Vedeu::Menu, :menu

.menus ⇒ Object

See Also:

• Menus.menus

# File 'lib/vedeu/api.rb', line 148

def_delegators Vedeu::Menus, :menus

.renderer ⇒ Object

See Also:

• Renderers#renderer

# File 'lib/vedeu/api.rb', line 154

def_delegators Vedeu::Renderers, :renderer, :renderers

.renderers ⇒ Object

See Also:

• Renderers#renderers

# File 'lib/vedeu/api.rb', line 154

def_delegators Vedeu::Renderers, :renderer, :renderers

.renders ⇒ Object

See Also:

• DSL::View.renders

# File 'lib/vedeu/api.rb', line 89

def_delegators Vedeu::DSL::View, :interface, :renders, :views

.resize ⇒ Object

See Also:

• Terminal#resize

# File 'lib/vedeu/api.rb', line 162

def_delegators Vedeu::Terminal, :height, :width, :resize

.trigger ⇒ Object

See Also:

• Trigger.trigger

# File 'lib/vedeu/api.rb', line 166

def_delegators Vedeu::Trigger, :trigger

.unbind ⇒ Object

See Also:

• Event.unbind

# File 'lib/vedeu/api.rb', line 95

def_delegators Vedeu::Event, :bind, :unbind

.views ⇒ Object

See Also:

• DSL::View.views

# File 'lib/vedeu/api.rb', line 89

def_delegators Vedeu::DSL::View, :interface, :renders, :views

.width ⇒ Object

See Also:

• Terminal#width

# File 'lib/vedeu/api.rb', line 162

def_delegators Vedeu::Terminal, :height, :width, :resize

Instance Method Details

#background_colours ⇒ Object (private)

See Also:

• BackgroundColours.background_colours

# File 'lib/vedeu/api.rb', line 41

def_delegators Vedeu::BackgroundColours, :background_colours

#bind ⇒ Object (private)

See Also:

• Event.bind

# File 'lib/vedeu/api.rb', line 95

def_delegators Vedeu::Event, :bind, :unbind

#border ⇒ Object (private)

See Also:

• DSL::Border.border

# File 'lib/vedeu/api.rb', line 69

def_delegators Vedeu::DSL::Border, :border

#borders ⇒ Object (private)

See Also:

• Borders.borders

# File 'lib/vedeu/api.rb', line 45

def_delegators Vedeu::Borders, :borders

#buffers ⇒ Object (private)

See Also:

• Buffers.buffers

# File 'lib/vedeu/api.rb', line 49

def_delegators Vedeu::Buffers, :buffers

#canvas ⇒ Object (private)

See Also:

• Canvas.canvas

# File 'lib/vedeu/api.rb', line 53

def_delegators Vedeu::Canvas, :canvas

#configuration ⇒ Object (private)

See Also:

• Configuration.configuration

# File 'lib/vedeu/api.rb', line 59

def_delegators Vedeu::Configuration, :configure, :configuration

#configure ⇒ Object (private)

See Also:

• Configuration.configure

# File 'lib/vedeu/api.rb', line 59

def_delegators Vedeu::Configuration, :configure, :configuration

#cursor ⇒ Object (private)

See Also:

• Cursors.cursor

# File 'lib/vedeu/api.rb', line 65

def_delegators Vedeu::Cursors, :cursor, :cursors

#cursors ⇒ Object (private)

See Also:

• Cursors.cursors

# File 'lib/vedeu/api.rb', line 65

def_delegators Vedeu::Cursors, :cursor, :cursors

#events ⇒ Object (private)

See Also:

• EventsRepository.events

# File 'lib/vedeu/api.rb', line 99

def_delegators Vedeu::EventsRepository, :events

#focus ⇒ Object (private)

See Also:

• Focus#focus

# File 'lib/vedeu/api.rb', line 111

def_delegators Vedeu::Focus, :focus, :focus_by_name, :focussed?,
:focus_next, :focus_previous

#focus_by_name ⇒ Object (private)

See Also:

• Focus#focus_by_name

# File 'lib/vedeu/api.rb', line 111

def_delegators Vedeu::Focus, :focus, :focus_by_name, :focussed?,
:focus_next, :focus_previous

#focus_next ⇒ Object (private)

See Also:

• Focus#focus_next

# File 'lib/vedeu/api.rb', line 111

def_delegators Vedeu::Focus, :focus, :focus_by_name, :focussed?,
:focus_next, :focus_previous

#focus_previous ⇒ Object (private)

See Also:

• Focus#focus_previous

# File 'lib/vedeu/api.rb', line 111

def_delegators Vedeu::Focus, :focus, :focus_by_name, :focussed?,
:focus_next, :focus_previous

#focussed? ⇒ Object (private)

See Also:

• Focus#focussed?

# File 'lib/vedeu/api.rb', line 111

def_delegators Vedeu::Focus, :focus, :focus_by_name, :focussed?,
:focus_next, :focus_previous

#foreground_colours ⇒ Object (private)

See Also:

• ForegroundColours.foreground_colours

# File 'lib/vedeu/api.rb', line 116

def_delegators Vedeu::ForegroundColours, :foreground_colours

#geometries ⇒ Object (private)

See Also:

• Geometries.geometries

# File 'lib/vedeu/api.rb', line 120

def_delegators Vedeu::Geometries, :geometries

#geometry ⇒ Object (private)

See Also:

• DSL::Geometry.geometry

# File 'lib/vedeu/api.rb', line 73

def_delegators Vedeu::DSL::Geometry, :geometry

#group ⇒ Object (private)

See Also:

• DSL::Group.group

# File 'lib/vedeu/api.rb', line 77

def_delegators Vedeu::DSL::Group, :group

#groups ⇒ Object (private)

See Also:

• Groups.groups

# File 'lib/vedeu/api.rb', line 124

def_delegators Vedeu::Groups, :groups

#height ⇒ Object (private)

See Also:

• Terminal#height

# File 'lib/vedeu/api.rb', line 162

def_delegators Vedeu::Terminal, :height, :width, :resize

#interface ⇒ Object (private)

See Also:

• DSL::View.interface

# File 'lib/vedeu/api.rb', line 89

def_delegators Vedeu::DSL::View, :interface, :renders, :views

#interfaces ⇒ Object (private)

See Also:

• InterfacesRepository.interfaces

# File 'lib/vedeu/api.rb', line 128

def_delegators Vedeu::InterfacesRepository, :interfaces

#keymap ⇒ Object (private)

See Also:

• DSL::Keymap.keymap

# File 'lib/vedeu/api.rb', line 81

def_delegators Vedeu::DSL::Keymap, :keymap

#keymaps ⇒ Object (private)

See Also:

• Keymaps.keymaps

# File 'lib/vedeu/api.rb', line 132

def_delegators Vedeu::Keymaps, :keymaps

#keypress ⇒ Object (private)

See Also:

• Mapper.keypress

# File 'lib/vedeu/api.rb', line 140

def_delegators Vedeu::Mapper, :keypress

#log ⇒ Object (private)

See Also:

• Log.log

# File 'lib/vedeu/api.rb', line 136

def_delegators Vedeu::Log, :log

#menu ⇒ Object (private)

See Also:

• Menu.menu

# File 'lib/vedeu/api.rb', line 144

def_delegators Vedeu::Menu, :menu

#menus ⇒ Object (private)

See Also:

• Menus.menus

# File 'lib/vedeu/api.rb', line 148

def_delegators Vedeu::Menus, :menus

#renderer ⇒ Object (private)

See Also:

• Renderers#renderer

# File 'lib/vedeu/api.rb', line 154

def_delegators Vedeu::Renderers, :renderer, :renderers

#renderers ⇒ Object (private)

See Also:

• Renderers#renderers

# File 'lib/vedeu/api.rb', line 154

def_delegators Vedeu::Renderers, :renderer, :renderers

#renders ⇒ Object (private)

See Also:

• DSL::View.renders

# File 'lib/vedeu/api.rb', line 89

def_delegators Vedeu::DSL::View, :interface, :renders, :views

#resize ⇒ Object (private)

See Also:

• Terminal#resize

# File 'lib/vedeu/api.rb', line 162

def_delegators Vedeu::Terminal, :height, :width, :resize

#trigger ⇒ Object (private)

See Also:

• Trigger.trigger

# File 'lib/vedeu/api.rb', line 166

def_delegators Vedeu::Trigger, :trigger

#unbind ⇒ Object (private)

See Also:

• Event.unbind

# File 'lib/vedeu/api.rb', line 95

def_delegators Vedeu::Event, :bind, :unbind

#views ⇒ Object (private)

See Also:

• DSL::View.views

# File 'lib/vedeu/api.rb', line 89

def_delegators Vedeu::DSL::View, :interface, :renders, :views

#width ⇒ Object (private)

See Also:

• Terminal#width

# File 'lib/vedeu/api.rb', line 162

def_delegators Vedeu::Terminal, :height, :width, :resize