43 lines
1.1 KiB
Lua
43 lines
1.1 KiB
Lua
--- awesome drawable API
|
|
-- @author Uli Schlachter <psychon@znc.in>
|
|
-- @copyright 2012 Uli Schlachter
|
|
module("drawable")
|
|
|
|
--- Drawable object.
|
|
-- @field surface The drawable's cairo surface.
|
|
-- @name drawable
|
|
-- @class table
|
|
|
|
--- Get drawable geometry. The geometry consists of x, y, width and height.
|
|
-- @return A table with drawable coordinates and geometry.
|
|
-- @name geometry
|
|
-- @class function
|
|
|
|
--- Refresh the drawable. When you are drawing to the surface, you have
|
|
-- call this function when you are done to make the result visible.
|
|
-- @name refresh
|
|
-- @class function
|
|
|
|
--- Add a signal.
|
|
-- @param name A signal name.
|
|
-- @param func A function to call when the signal is emitted.
|
|
-- @name connect_signal
|
|
-- @class function
|
|
|
|
--- Remove a signal.
|
|
-- @param name A signal name.
|
|
-- @param func A function to remove.
|
|
-- @name disconnect_signal
|
|
-- @class function
|
|
|
|
--- Emit a signal.
|
|
-- @param name A signal name.
|
|
-- @param ... Various arguments, optional.
|
|
-- @name emit_signal
|
|
-- @class function
|
|
|
|
--- Get the number of instances.
|
|
-- @return The number of drawable objects alive.
|
|
-- @name instances
|
|
-- @class function
|