len0rd/suit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

API consistency

Browse source
This commit is contained in:
Matthias Richter 2016-01-02 14:40:17 +01:00
parent c1f2d96c02
commit 0fc2437a65
2 changed files with 17 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/widgets.rst
View file

@ -28,8 +28,9 @@ Creates a button widget at position ``(x,y)`` with width ``w`` and height
Creates a label at position ``(x,y)`` with width ``w`` and height ``h``.
.. function:: ImageButton(options, x,y)
.. function:: ImageButton(normal, options, x,y)
:param Image notmal: Image of the button in normal state.
:param table options: Widget options.
:param numbers x,y: Upper left corner of the widget.
:returns: Return state (see below).
@ -37,9 +38,10 @@ Creates a label at position ``(x,y)`` with width ``w`` and height ``h``.
Creates an image button widget at position ``(x,y)``.
Unlike all other widgets, an ``ImageButton`` is not affected by the current
theme.
The options table must at least contain an image for the ``normal`` state.
The pixels with non-zero alpha value define the active area of the widget.
You can provide additional ``hot`` and ``active`` images, but the widget area
The argument ``normal`` defines the image of the normal state as well as the
area of the widget: The button activates when the mouse is over a pixel with
non-zero alpha value.
You can provide additional ``hover`` and ``active`` images, but the widget area
is always computed from the ``normal`` image.
Note that ``ImageButton`` does not recieve width and height parameters. As
@ -48,13 +50,13 @@ such, it does not necessarily honor the cell size of a :doc:`layout`.
**Additional Options:**
``normal``
Image for the normal state of the widget. Mandatory.
Image for the normal state of the widget. Defaults to widget payload.
``hot``
``hover``
Image for the hot state of the widget. Defaults to ``normal`` if omitted.
``active``
Image for the active state of the widget. Defaults to ``
Image for the active state of the widget. Defaults to ``hover`` if omitted.
Mutable Widgets
---------------