Class button
awesome button API
Furthermore to the classes described here, one can also use signals as described in signals.
Some signal names are starting with a dot. These dots are artefacts from the documentation generation, you get the real signal name by removing the starting dot.
Info:
- Copyright: 2008-2009 Julien Danjou
- Author: Julien Danjou <julien@danjou.info>
Signals
| press | When bound mouse button + modifiers are pressed. | 
| property::button | When property changes. | 
| property::modifiers | When property changes. | 
| release | When bound mouse button + modifiers are pressed. | 
Tables
| button.button | Button object. | 
Methods
| button:instances () | Get the number of instances. | 
| button:set_index_miss_handler (cb) | Set a __index metamethod for all button instances. | 
| button:set_newindex_miss_handler (cb) | Set a __newindex metamethod for all button instances. | 
| button:disconnect_signal (name, func) | Disconnect from a signal. | 
| button:emit_signal (name, ...) | Emit a signal. | 
| button:connect_signal (name, func) | Connect to a signal. | 
Signals
- press
- 
    When bound mouse button + modifiers are pressed.
    Arguments:- ... One or more arguments are possible
 
- property::button
- When property changes.
- property::modifiers
- When property changes.
- release
- 
    When bound mouse button + modifiers are pressed.
    Arguments:- ... One or more arguments are possible
 
Tables
- button.button
- 
    Button object.
    Fields:- button int The mouse button number, or 0 for any button.
- modifiers table The modifier key table that should be pressed while the button is pressed.
 
Methods
- button:instances ()
- 
    Get the number of instances.
    Returns:- 
           int
        The number of button objects alive.
    
 
- button:set_index_miss_handler (cb)
- 
    Set a __index metamethod for all button instances.
    - cb function The meta-method
 
- button:set_newindex_miss_handler (cb)
- 
    Set a __newindex metamethod for all button instances.
    - cb function The meta-method
 
- button:disconnect_signal (name, func)
- 
    Disconnect from a signal.
    - name string The name of the signal.
- func function The callback that should be disconnected.
 
- button:emit_signal (name, ...)
- 
    Emit a signal.
    - name string The name of the signal.
- ... Extra arguments for the callback functions. Each connected function receives the object as first argument and then any extra arguments that are given to emit_signal().
 
- button:connect_signal (name, func)
- 
    Connect to a signal.
    - name string The name of the signal.
- func function The callback to call when the signal is emitted.