Module: Vedeu::API::External

Extended by:

Forwardable

Included in:

Vedeu

Defined in:

lib/vedeu/api/external.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

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

Instance Method Summary

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

Class Method Details

.bind ⇒ Object

See Also:

• Events::Event.bind

# File 'lib/vedeu/api/external.rb', line 83

def_delegators Vedeu::Events::Event, :bind, :bound?, :unbind

.bind_alias ⇒ Object

See Also:

• Events::Aliases#bind_alias

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

def_delegators Vedeu::Events::Aliases, :bind_alias, :unbind_alias

.border ⇒ Object

See Also:

• Borders::DSL.border

# File 'lib/vedeu/api/external.rb', line 51

def_delegators Vedeu::Borders::DSL, :border

.bound? ⇒ Object

See Also:

• Events::Event.bound?

# File 'lib/vedeu/api/external.rb', line 83

def_delegators Vedeu::Events::Event, :bind, :bound?, :unbind

.clear ⇒ Object

See Also:

• Terminal#clear

# File 'lib/vedeu/api/external.rb', line 142

def_delegators Vedeu::Terminal, :clear

.clear_by_group ⇒ Object

See Also:

• Clear::NamedGroup.render

# File 'lib/vedeu/api/external.rb', line 150

def_delegators Vedeu::Clear::NamedGroup, :clear_by_group

.clear_by_name ⇒ Object

See Also:

• Clear::NamedInterface.render

# File 'lib/vedeu/api/external.rb', line 146

def_delegators Vedeu::Clear::NamedInterface, :clear_by_name

.configuration ⇒ Object

See Also:

• Configuration.configuration

# File 'lib/vedeu/api/external.rb', line 32

def_delegators Vedeu::Configuration, :configure, :configuration

.configure ⇒ Object

See Also:

• Configuration.configure

# File 'lib/vedeu/api/external.rb', line 32

def_delegators Vedeu::Configuration, :configure, :configuration

.cursor ⇒ Vedeu::Cursors::Cursor

Returns:

• (Vedeu::Cursors::Cursor)

# File 'lib/vedeu/api/external.rb', line 36

def_delegators Vedeu::Cursors::Repository, :cursor

.drb_restart ⇒ Object

See Also:

• Distributed::Server#restart

# File 'lib/vedeu/api/external.rb', line 46

def_delegators Vedeu::Distributed::Server, :drb_restart, :drb_start,
:drb_status, :drb_stop

.drb_start ⇒ Object

See Also:

• Distributed::Server#start

# File 'lib/vedeu/api/external.rb', line 46

def_delegators Vedeu::Distributed::Server, :drb_restart, :drb_start,
:drb_status, :drb_stop

.drb_status ⇒ Object

See Also:

• Distributed::Server#status

# File 'lib/vedeu/api/external.rb', line 46

def_delegators Vedeu::Distributed::Server, :drb_restart, :drb_start,
:drb_status, :drb_stop

.drb_stop ⇒ Object

See Also:

• Distributed::Server#stop

# File 'lib/vedeu/api/external.rb', line 46

def_delegators Vedeu::Distributed::Server, :drb_restart, :drb_start,
:drb_status, :drb_stop

.exit ⇒ Object

See Also:

• Runtime::Application.stop

# File 'lib/vedeu/api/external.rb', line 138

def_delegators Vedeu::Runtime::Application, :exit

.focus ⇒ Object

See Also:

• Models::Focus#focus

# File 'lib/vedeu/api/external.rb', line 101

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

.focus_by_name ⇒ Object

See Also:

• Models::Focus#focus_by_name

# File 'lib/vedeu/api/external.rb', line 101

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

.focus_next ⇒ Object

See Also:

• Models::Focus#focus_next

# File 'lib/vedeu/api/external.rb', line 101

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

.focus_previous ⇒ Object

See Also:

• Models::Focus#focus_previous

# File 'lib/vedeu/api/external.rb', line 101

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

.focussed? ⇒ Object

See Also:

• Models::Focus#focussed?

# File 'lib/vedeu/api/external.rb', line 101

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

.geometry ⇒ Object

See Also:

• Geometry::DSL.geometry

# File 'lib/vedeu/api/external.rb', line 55

def_delegators Vedeu::Geometry::DSL, :geometry

.goto ⇒ Object

See Also:

• Runtime::Router#goto

# File 'lib/vedeu/api/external.rb', line 122

def_delegators Vedeu::Runtime::Router, :goto

.group ⇒ Object

See Also:

• DSL::Group.group

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

def_delegators Vedeu::DSL::Group, :group

.height ⇒ Object

See Also:

• Terminal#height

# File 'lib/vedeu/api/external.rb', line 126

def_delegators Vedeu::Terminal, :height

.hide_cursor ⇒ Object

See Also:

• Cursors::Cursor#hide

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

def_delegators Vedeu::Cursors::Cursor, :hide_cursor

.hide_group ⇒ Object

See Also:

• Models::Group#hide

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

def_delegators Vedeu::Models::Group, :hide_group

.hide_interface ⇒ Object

See Also:

• Models::Interface#hide

# File 'lib/vedeu/api/external.rb', line 178

def_delegators Vedeu::Models::Interface, :hide_interface

.interface ⇒ Object

See Also:

• DSL::Interface.interface

# File 'lib/vedeu/api/external.rb', line 67

def_delegators Vedeu::DSL::Interface, :interface

.keymap ⇒ Object

See Also:

• DSL::Keymap.keymap

# File 'lib/vedeu/api/external.rb', line 63

def_delegators Vedeu::DSL::Keymap, :keymap

.keypress ⇒ Object

See Also:

• Input::Mapper.keypress

# File 'lib/vedeu/api/external.rb', line 114

def_delegators Vedeu::Input::Mapper, :keypress

.log ⇒ Object

See Also:

• Logging::Log.log

# File 'lib/vedeu/api/external.rb', line 110

def_delegators Vedeu::Logging::Log, :log, :log_stdout, :log_stderr

.log_stderr ⇒ Object

See Also:

• Logging::Log.log_stderr

# File 'lib/vedeu/api/external.rb', line 110

def_delegators Vedeu::Logging::Log, :log, :log_stdout, :log_stderr

.log_stdout ⇒ Object

See Also:

• Logging::Log.log_stdout

# File 'lib/vedeu/api/external.rb', line 110

def_delegators Vedeu::Logging::Log, :log, :log_stdout, :log_stderr

.menu ⇒ Object

See Also:

• Menus::Menu.menu

# File 'lib/vedeu/api/external.rb', line 118

def_delegators Vedeu::Menus::Menu, :menu

.render ⇒ Object

See Also:

• DSL::View.render

# File 'lib/vedeu/api/external.rb', line 75

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

.renders ⇒ Object

See Also:

• DSL::View.renders

# File 'lib/vedeu/api/external.rb', line 75

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

.show_cursor ⇒ Object

See Also:

• Cursors::Cursor#show

# File 'lib/vedeu/api/external.rb', line 158

def_delegators Vedeu::Cursors::Cursor, :show_cursor

.show_group ⇒ Object

See Also:

• Models::Group#show

# File 'lib/vedeu/api/external.rb', line 170

def_delegators Vedeu::Models::Group, :show_group

.show_interface ⇒ Object

See Also:

• Models::Interface#show

# File 'lib/vedeu/api/external.rb', line 182

def_delegators Vedeu::Models::Interface, :show_interface

.toggle_cursor ⇒ Object

See Also:

• Cursors::Cursor#toggle

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

def_delegators Vedeu::Cursors::Cursor, :toggle_cursor

.toggle_group ⇒ Object

See Also:

• Models::Group#toggle

# File 'lib/vedeu/api/external.rb', line 174

def_delegators Vedeu::Models::Group, :toggle_group

.toggle_interface ⇒ Object

See Also:

• Models::Interface#toggle

# File 'lib/vedeu/api/external.rb', line 186

def_delegators Vedeu::Models::Interface, :toggle_interface

.trigger ⇒ Object

See Also:

• Events::Trigger.trigger

# File 'lib/vedeu/api/external.rb', line 134

def_delegators Vedeu::Events::Trigger, :trigger

.unbind ⇒ Object

See Also:

• Events::Event.unbind

# File 'lib/vedeu/api/external.rb', line 83

def_delegators Vedeu::Events::Event, :bind, :bound?, :unbind

.unbind_alias ⇒ Object

See Also:

• Events::Aliases#unbind_alias

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

def_delegators Vedeu::Events::Aliases, :bind_alias, :unbind_alias

.views ⇒ Object

See Also:

• DSL::View.views

# File 'lib/vedeu/api/external.rb', line 75

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

.width ⇒ Object

See Also:

• Terminal#width

# File 'lib/vedeu/api/external.rb', line 130

def_delegators Vedeu::Terminal, :width

Instance Method Details

#bind ⇒ Object (private)

See Also:

• Events::Event.bind

# File 'lib/vedeu/api/external.rb', line 83

def_delegators Vedeu::Events::Event, :bind, :bound?, :unbind

#bind_alias ⇒ Object (private)

See Also:

• Events::Aliases#bind_alias

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

def_delegators Vedeu::Events::Aliases, :bind_alias, :unbind_alias

#border ⇒ Object (private)

See Also:

• Borders::DSL.border

# File 'lib/vedeu/api/external.rb', line 51

def_delegators Vedeu::Borders::DSL, :border

#bound? ⇒ Object (private)

See Also:

• Events::Event.bound?

# File 'lib/vedeu/api/external.rb', line 83

def_delegators Vedeu::Events::Event, :bind, :bound?, :unbind

#clear ⇒ Object (private)

See Also:

• Terminal#clear

# File 'lib/vedeu/api/external.rb', line 142

def_delegators Vedeu::Terminal, :clear

#clear_by_group ⇒ Object (private)

See Also:

• Clear::NamedGroup.render

# File 'lib/vedeu/api/external.rb', line 150

def_delegators Vedeu::Clear::NamedGroup, :clear_by_group

#clear_by_name ⇒ Object (private)

See Also:

• Clear::NamedInterface.render

# File 'lib/vedeu/api/external.rb', line 146

def_delegators Vedeu::Clear::NamedInterface, :clear_by_name

#configuration ⇒ Object (private)

See Also:

• Configuration.configuration

# File 'lib/vedeu/api/external.rb', line 32

def_delegators Vedeu::Configuration, :configure, :configuration

#configure ⇒ Object (private)

See Also:

• Configuration.configure

# File 'lib/vedeu/api/external.rb', line 32

def_delegators Vedeu::Configuration, :configure, :configuration

#cursor ⇒ Vedeu::Cursors::Cursor (private)

Returns:

• (Vedeu::Cursors::Cursor)

# File 'lib/vedeu/api/external.rb', line 36

def_delegators Vedeu::Cursors::Repository, :cursor

#drb_restart ⇒ Object (private)

See Also:

• Distributed::Server#restart

# File 'lib/vedeu/api/external.rb', line 46

def_delegators Vedeu::Distributed::Server, :drb_restart, :drb_start,
:drb_status, :drb_stop

#drb_start ⇒ Object (private)

See Also:

• Distributed::Server#start

# File 'lib/vedeu/api/external.rb', line 46

def_delegators Vedeu::Distributed::Server, :drb_restart, :drb_start,
:drb_status, :drb_stop

#drb_status ⇒ Object (private)

See Also:

• Distributed::Server#status

# File 'lib/vedeu/api/external.rb', line 46

def_delegators Vedeu::Distributed::Server, :drb_restart, :drb_start,
:drb_status, :drb_stop

#drb_stop ⇒ Object (private)

See Also:

• Distributed::Server#stop

# File 'lib/vedeu/api/external.rb', line 46

def_delegators Vedeu::Distributed::Server, :drb_restart, :drb_start,
:drb_status, :drb_stop

#exit ⇒ Object (private)

See Also:

• Runtime::Application.stop

# File 'lib/vedeu/api/external.rb', line 138

def_delegators Vedeu::Runtime::Application, :exit

#focus ⇒ Object (private)

See Also:

• Models::Focus#focus

# File 'lib/vedeu/api/external.rb', line 101

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

#focus_by_name ⇒ Object (private)

See Also:

• Models::Focus#focus_by_name

# File 'lib/vedeu/api/external.rb', line 101

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

#focus_next ⇒ Object (private)

See Also:

• Models::Focus#focus_next

# File 'lib/vedeu/api/external.rb', line 101

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

#focus_previous ⇒ Object (private)

See Also:

• Models::Focus#focus_previous

# File 'lib/vedeu/api/external.rb', line 101

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

#focussed? ⇒ Object (private)

See Also:

• Models::Focus#focussed?

# File 'lib/vedeu/api/external.rb', line 101

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

#geometry ⇒ Object (private)

See Also:

• Geometry::DSL.geometry

# File 'lib/vedeu/api/external.rb', line 55

def_delegators Vedeu::Geometry::DSL, :geometry

#goto ⇒ Object (private)

See Also:

• Runtime::Router#goto

# File 'lib/vedeu/api/external.rb', line 122

def_delegators Vedeu::Runtime::Router, :goto

#group ⇒ Object (private)

See Also:

• DSL::Group.group

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

def_delegators Vedeu::DSL::Group, :group

#height ⇒ Object (private)

See Also:

• Terminal#height

# File 'lib/vedeu/api/external.rb', line 126

def_delegators Vedeu::Terminal, :height

#hide_cursor ⇒ Object (private)

See Also:

• Cursors::Cursor#hide

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

def_delegators Vedeu::Cursors::Cursor, :hide_cursor

#hide_group ⇒ Object (private)

See Also:

• Models::Group#hide

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

def_delegators Vedeu::Models::Group, :hide_group

#hide_interface ⇒ Object (private)

See Also:

• Models::Interface#hide

# File 'lib/vedeu/api/external.rb', line 178

def_delegators Vedeu::Models::Interface, :hide_interface

#interface ⇒ Object (private)

See Also:

• DSL::Interface.interface

# File 'lib/vedeu/api/external.rb', line 67

def_delegators Vedeu::DSL::Interface, :interface

#keymap ⇒ Object (private)

See Also:

• DSL::Keymap.keymap

# File 'lib/vedeu/api/external.rb', line 63

def_delegators Vedeu::DSL::Keymap, :keymap

#keypress ⇒ Object (private)

See Also:

• Input::Mapper.keypress

# File 'lib/vedeu/api/external.rb', line 114

def_delegators Vedeu::Input::Mapper, :keypress

#log ⇒ Object (private)

See Also:

• Logging::Log.log

# File 'lib/vedeu/api/external.rb', line 110

def_delegators Vedeu::Logging::Log, :log, :log_stdout, :log_stderr

#log_stderr ⇒ Object (private)

See Also:

• Logging::Log.log_stderr

# File 'lib/vedeu/api/external.rb', line 110

def_delegators Vedeu::Logging::Log, :log, :log_stdout, :log_stderr

#log_stdout ⇒ Object (private)

See Also:

• Logging::Log.log_stdout

# File 'lib/vedeu/api/external.rb', line 110

def_delegators Vedeu::Logging::Log, :log, :log_stdout, :log_stderr

#menu ⇒ Object (private)

See Also:

• Menus::Menu.menu

# File 'lib/vedeu/api/external.rb', line 118

def_delegators Vedeu::Menus::Menu, :menu

#render ⇒ Object (private)

See Also:

• DSL::View.render

# File 'lib/vedeu/api/external.rb', line 75

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

#renders ⇒ Object (private)

See Also:

• DSL::View.renders

# File 'lib/vedeu/api/external.rb', line 75

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

#show_cursor ⇒ Object (private)

See Also:

• Cursors::Cursor#show

# File 'lib/vedeu/api/external.rb', line 158

def_delegators Vedeu::Cursors::Cursor, :show_cursor

#show_group ⇒ Object (private)

See Also:

• Models::Group#show

# File 'lib/vedeu/api/external.rb', line 170

def_delegators Vedeu::Models::Group, :show_group

#show_interface ⇒ Object (private)

See Also:

• Models::Interface#show

# File 'lib/vedeu/api/external.rb', line 182

def_delegators Vedeu::Models::Interface, :show_interface

#toggle_cursor ⇒ Object (private)

See Also:

• Cursors::Cursor#toggle

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

def_delegators Vedeu::Cursors::Cursor, :toggle_cursor

#toggle_group ⇒ Object (private)

See Also:

• Models::Group#toggle

# File 'lib/vedeu/api/external.rb', line 174

def_delegators Vedeu::Models::Group, :toggle_group

#toggle_interface ⇒ Object (private)

See Also:

• Models::Interface#toggle

# File 'lib/vedeu/api/external.rb', line 186

def_delegators Vedeu::Models::Interface, :toggle_interface

#trigger ⇒ Object (private)

See Also:

• Events::Trigger.trigger

# File 'lib/vedeu/api/external.rb', line 134

def_delegators Vedeu::Events::Trigger, :trigger

#unbind ⇒ Object (private)

See Also:

• Events::Event.unbind

# File 'lib/vedeu/api/external.rb', line 83

def_delegators Vedeu::Events::Event, :bind, :bound?, :unbind

#unbind_alias ⇒ Object (private)

See Also:

• Events::Aliases#unbind_alias

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

def_delegators Vedeu::Events::Aliases, :bind_alias, :unbind_alias

#views ⇒ Object (private)

See Also:

• DSL::View.views

# File 'lib/vedeu/api/external.rb', line 75

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

#width ⇒ Object (private)

See Also:

• Terminal#width

# File 'lib/vedeu/api/external.rb', line 130

def_delegators Vedeu::Terminal, :width