luadoc/button.lua

   1 --- awesome button API
   2 -- @author Julien Danjou &lt;julien@danjou.info&gt;
   3 -- @copyright 2008-2009 Julien Danjou
   4 module("button")
   5
   6 --- Button object.
   7 -- @field button The mouse button number, or 0 for any button.
   8 -- @field modifiers The modifier key table that should be pressed while the
   9 -- button is pressed.
  10 -- @class table
  11 -- @name button
  12
  13 --- Add a signal.
  14 -- @param name A signal name.
  15 -- @param func A function to call when the signal is emitted.
  16 -- @name connect_signal
  17 -- @class function
  18
  19 --- Remove a signal.
  20 -- @param name A signal name.
  21 -- @param func A function to remove.
  22 -- @name disconnect_signal
  23 -- @class function
  24
  25 --- Emit a signal.
  26 -- @param name A signal name.
  27 -- @param ... Various arguments, optional.
  28 -- @name emit_signal
  29 -- @class function
  30
  31 --- Get the number of instances.
  32 -- @return The number of button objects alive.
  33 -- @name instances
  34 -- @class function