Contents

## Vedeu API

Vedeu provides a simple DSL for the creation of terminal/console based
applications.

Below is a list of all the API methods. These can be accessed in your
application by including Vedeu in your class or module or by calling them directly.


### API 'include' example

Doing it this way will mean you can use any API method without the `Vedeu.` prefix.

```ruby
class SomeClassInYourApplication
  include Vedeu

  # ...
```


### API direct example

Doing it this way means you need to use the `Vedeu.` prefix.

```ruby
class OtherClassInYourApplication
  # ...

  def some_method
    Vedeu.some_api_method
  end

  # ...
```

... TODO ...


### API DSL methods

Note: Nesting indicates where an API method is allowed/supposed to be used.

#### Events

- bind
- trigger
- unbind


#### Input

- keypress
- keymap
  - key
  - name
  - interface


#### Interfaces

- interface
  - background
  - border
  - cursor
  - colour
  - delay
  - focus!
  - foreground
  - geometry
    - centred (or centred!)
    - height
    - width
    - x
    - y
  - group
  - keymap
    - key
    - name
    - interface
  - line
  - name
  - style
  - use


#### Views

- renders
  - view
    - colour
    - cursor
    - geometry
      - height
      - width
      - x
      - y
    - line
      - background
      - colour
      - foreground
      - stream
        - align
        - background
        - colour
        - foreground
        - style
        - text
        - width
      - streams
        - stream
      - text
      - style
    - lines
      - line
    - name
    - style
  - use
- views
  - ... as #renders


#### Menus

- menu
  - items
  - name


#### Miscellany

- configure
- focus
- focus_by_name
- focussed?
- focus_next
- focus_previous

- height
  Usage: Vedeu.height
  Returns the height (in lines) for the current terminal.

- log
- resize
  Usage: Vedeu.resize


- width
  Usage: Vedeu.width
  Returns the width (in characters) for the current terminal.

Version data entries

51 entries across 51 versions & 1 rubygems

Version	Path
vedeu-0.4.24	docs/api.md
vedeu-0.4.23	docs/api.md
vedeu-0.4.22	docs/api.md
vedeu-0.4.21	docs/api.md
vedeu-0.4.20	docs/api.md
vedeu-0.4.19	docs/api.md
vedeu-0.4.18	docs/api.md
vedeu-0.4.17	docs/api.md
vedeu-0.4.16	docs/api.md
vedeu-0.4.15	docs/api.md
vedeu-0.4.14	docs/api.md
vedeu-0.4.13	docs/api.md
vedeu-0.4.12	docs/api.md
vedeu-0.4.11	docs/api.md
vedeu-0.4.10	docs/api.md
vedeu-0.4.9	docs/api.md
vedeu-0.4.8	docs/api.md
vedeu-0.4.7	docs/api.md
vedeu-0.4.6	docs/api.md
vedeu-0.4.5	docs/api.md