30 lines
756 B
Lua
30 lines
756 B
Lua
|
--- awesome button API
|
||
|
|
-- @author Julien Danjou <julien@danjou.info>
|
||
|
|
-- @copyright 2008-2009 Julien Danjou
|
||
|
|
module("button")
|
||
|
|
|
||
|
|
--- Button object.
|
||
|
|
-- @field button The mouse button number, or 0 for any button.
|
||
|
|
-- @field modifiers The modifier key table that should be pressed while the
|
||
|
|
-- button is pressed.
|
||
|
|
-- @class table
|
||
|
|
-- @name button
|
||
|
|
|
||
|
|
--- Add a signal.
|
||
|
|
-- @param name A signal name.
|
||
|
|
-- @param func A function to call when the signal is emited.
|
||
|
|
-- @name add_signal
|
||
|
|
-- @class function
|
||
|
|
|
||
|
|
--- Remove a signal.
|
||
|
|
-- @param name A signal name.
|
||
|
|
-- @param func A function to remove.
|
||
|
|
-- @name remove_signal
|
||
|
|
-- @class function
|
||
|
|
|
||
|
|
--- Emit a signal.
|
||
|
|
-- @param name A signal name.
|
||
|
|
-- @param ... Various arguments, optional.
|
||
|
|
-- @name emit_signal
|
||
|
|
-- @class function
|