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

defined
event
events
height
interface
keypress
log
menu
resize
trigger
unevent
use
view
views
width

colour
style

line
use
cursor
delay
group
name
x
y
width
height
centred

items
name

stream
text
foreground
background

align
text
width

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
vedeu-0.2.0	docs/api.md