Sha256: fc0e7524197be0b38ca47bb30d87c8bee1fb39b774d97272e04ea37b6e1dfbb5

Contents?: true

Size: 1.73 KB

Versions: 41

Compression:

Stored size: 1.73 KB

Contents

#Client API
Client API covers controller action event handlers.

### Controller MACROS
  * Embed(view_controller_name, spot_name, context) - Embed a view controller with the name `view_controller_name` inside the current view controller at the spot with a context
  * Goto(action_name) - Change actions
  * Push(action_name) - This works just like `Goto` except that `Pop` will restore the last action
  * Pop(action_name) - This is to be used after `Push` and will restore the state previous to the `Push`.
  * Request(service_insatnce_name, ename, params) Initiate a service.  See [Services](./services.md) for more info.  
  * Send(event_name, info) - Send a custom event on the main queue.
  * Raise(event_name, info) - Will send an event to the parent view controller (and it will bubble up, following `event_gw` which is set in `Embed` as the parent controller
  * Lower(spot_name, event_name, info) - Send an event to a particular spot
  * Helpers
    * Page Modification - See [User Page Modification Helpers](./vm.md#user_page_modification_helpers) for a list of functions available.

### Controller Event Handlers
  * Variables
    * `context` - The information for the controllers context
    * `params` - What was passed in the event
    * `__base__` - The address of the controller
    * `__info__` - Holds the `context`, current action, etc. See [Datatypes](./datatypes.md)
### Controller on_entry (actions)
    * `context` - The information for the controllers context
    * `__base__` - The address of the controller
    * `__info__` - Holds the `context`, current action, etc. See [Datatypes](./datatypes.md)
### Controller on_entry (global)
    * `context` - The information for the controllers context
    * `__base__` - The address of the controller

Version data entries

41 entries across 41 versions & 1 rubygems

Version Path
flok-0.0.105 docs/client_api.md
flok-0.0.103 docs/client_api.md
flok-0.0.102 docs/client_api.md
flok-0.0.101 docs/client_api.md
flok-0.0.100 docs/client_api.md
flok-0.0.99 docs/client_api.md
flok-0.0.98 docs/client_api.md
flok-0.0.97 docs/client_api.md
flok-0.0.96 docs/client_api.md
flok-0.0.95 docs/client_api.md
flok-0.0.94 docs/client_api.md
flok-0.0.93 docs/client_api.md
flok-0.0.92 docs/client_api.md
flok-0.0.91 docs/client_api.md
flok-0.0.90 docs/client_api.md
flok-0.0.89 docs/client_api.md
flok-0.0.88 docs/client_api.md
flok-0.0.87 docs/client_api.md
flok-0.0.86 docs/client_api.md
flok-0.0.85 docs/client_api.md