Documentation: Position the widget example images so they are more
naturally in context with the description text.
This commit is contained in:
parent
7cc49e8002
commit
fa8e942762
|
@ -16,14 +16,13 @@
|
|||
# along with this Python-EFL. If not, see <http://www.gnu.org/licenses/>.
|
||||
#
|
||||
|
||||
|
||||
"""
|
||||
|
||||
.. image:: /images/actionslider-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/actionslider-preview.png
|
||||
|
||||
An actionslider is a switcher for two or three labels with
|
||||
customizable magnet properties.
|
||||
|
||||
|
|
|
@ -18,11 +18,10 @@
|
|||
|
||||
"""
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/background-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
The background widget is used for setting a solid color, image or Edje group
|
||||
as a background to a window or any container object.
|
||||
|
|
|
@ -22,7 +22,7 @@ Widget description
|
|||
------------------
|
||||
|
||||
.. image:: /images/box-preview.png
|
||||
|
||||
:align: left
|
||||
|
||||
A box arranges objects in a linear fashion, governed by a layout function
|
||||
that defines the details of this arrangement.
|
||||
|
|
|
@ -18,11 +18,10 @@
|
|||
|
||||
"""
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/bubble-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
The Bubble is a widget to show text similar to how speech is
|
||||
represented in comics.
|
||||
|
|
|
@ -21,7 +21,7 @@ Widget description
|
|||
------------------
|
||||
|
||||
.. image:: /images/button-preview.png
|
||||
|
||||
:align: left
|
||||
|
||||
This is a push-button. Press it and run some function. It can contain
|
||||
a simple label and icon object and it also has an autorepeat feature.
|
||||
|
|
|
@ -22,7 +22,7 @@ Widget description
|
|||
------------------
|
||||
|
||||
.. image:: /images/calendar-preview.png
|
||||
|
||||
:align: left
|
||||
|
||||
This is a calendar widget.
|
||||
|
||||
|
|
|
@ -22,7 +22,7 @@ Widget description
|
|||
------------------
|
||||
|
||||
.. image:: /images/check-preview.png
|
||||
|
||||
:align: left
|
||||
|
||||
The check widget allows for toggling a value between true and false.
|
||||
|
||||
|
|
|
@ -22,7 +22,7 @@ Widget description
|
|||
------------------
|
||||
|
||||
.. image:: /images/clock-preview.png
|
||||
|
||||
:align: left
|
||||
|
||||
This is a digital clock widget.
|
||||
|
||||
|
|
|
@ -18,11 +18,11 @@
|
|||
|
||||
"""
|
||||
|
||||
.. image:: /images/colorselector-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/colorselector-preview.png
|
||||
|
||||
A Colorselector is a color selection widget.
|
||||
|
||||
It allows application to set a series of colors. It also allows to
|
||||
|
|
|
@ -17,11 +17,11 @@
|
|||
|
||||
"""
|
||||
|
||||
.. image:: /images/conformant-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/conformant-preview.png
|
||||
|
||||
The aim is to provide a widget that can be used in elementary apps to
|
||||
account for space taken up by the indicator, virtual keypad & softkey
|
||||
windows when running the illume2 module of E17.
|
||||
|
|
|
@ -22,8 +22,7 @@ Widget description
|
|||
------------------
|
||||
|
||||
.. image:: /images/ctxpopup-preview.png
|
||||
|
||||
Context popup widget.
|
||||
:align: left
|
||||
|
||||
A ctxpopup is a widget that, when shown, pops up a list of items. It
|
||||
automatically chooses an area inside its parent object's view to
|
||||
|
|
|
@ -18,11 +18,11 @@
|
|||
|
||||
"""
|
||||
|
||||
.. image:: /images/dayselector-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/dayselector-preview.png
|
||||
|
||||
Dayselector displays all seven days of the week and allows the user to
|
||||
select multiple days.
|
||||
|
||||
|
|
|
@ -17,11 +17,11 @@
|
|||
|
||||
"""
|
||||
|
||||
.. image:: /images/diskselector-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/diskselector-preview.png
|
||||
|
||||
A diskselector is a kind of list widget. It scrolls horizontally,
|
||||
and can contain label and icon objects. Three items are displayed
|
||||
with the selected one in the middle.
|
||||
|
|
|
@ -22,7 +22,7 @@ Widget description
|
|||
------------------
|
||||
|
||||
.. image:: /images/entry-preview.png
|
||||
|
||||
:align: left
|
||||
|
||||
An entry is a convenience widget which shows a box that the user can
|
||||
enter text into.
|
||||
|
|
|
@ -18,11 +18,11 @@
|
|||
|
||||
"""
|
||||
|
||||
.. image:: /images/fileselector-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/fileselector-preview.png
|
||||
|
||||
A file selector is a widget that allows a user to navigate through a
|
||||
file system, reporting file selections back via its API.
|
||||
|
||||
|
|
|
@ -18,11 +18,10 @@
|
|||
|
||||
"""
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/fileselector-button-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
This is a button that, when clicked, creates an Elementary window (or
|
||||
inner window) with a :py:class:`elementary.fileselector.Fileselector`
|
||||
|
|
|
@ -18,11 +18,10 @@
|
|||
|
||||
"""
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/fileselector-entry-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
This is an entry made to be filled with or display a file
|
||||
system path string.
|
||||
|
|
|
@ -18,11 +18,10 @@
|
|||
|
||||
"""
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/flip-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
This widget holds two content :py:class:`efl.evas.Object`: one on
|
||||
the front and one on the back. It allows you to flip from front to back
|
||||
|
|
|
@ -22,7 +22,7 @@ Widget description
|
|||
------------------
|
||||
|
||||
.. image:: /images/flipselector-preview.png
|
||||
|
||||
:align: left
|
||||
|
||||
A flip selector is a widget to show a set of *text* items, one
|
||||
at a time, with the same sheet switching style as the :py:class:`Clock`
|
||||
|
|
|
@ -18,11 +18,10 @@
|
|||
|
||||
"""
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/frame-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
Frame is a widget that holds some content and has a title.
|
||||
|
||||
|
|
|
@ -18,11 +18,10 @@
|
|||
|
||||
"""
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/gengrid-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
This widget aims to position objects in a grid layout while actually
|
||||
creating and rendering only the visible ones, using the same idea as the
|
||||
|
|
|
@ -17,11 +17,10 @@
|
|||
|
||||
"""
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/genlist-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
This widget aims to have more expansive list than the simple list in
|
||||
Elementary that could have more flexible items and allow many more
|
||||
|
|
|
@ -18,11 +18,11 @@
|
|||
|
||||
"""
|
||||
|
||||
.. image:: /images/gesturelayer-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/gesturelayer-preview.png
|
||||
|
||||
Use the GestureLayer to detect gestures. The advantage is that you don't
|
||||
have to implement gesture detection, just set callbacks for gesture states.
|
||||
|
||||
|
|
|
@ -18,11 +18,10 @@
|
|||
|
||||
"""
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/grid-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
A grid layout widget.
|
||||
|
||||
|
|
|
@ -22,7 +22,7 @@ Widget description
|
|||
------------------
|
||||
|
||||
.. image:: /images/hover-preview.png
|
||||
|
||||
:align: left
|
||||
|
||||
A Hover object will hover over its ``parent`` object at the ``target``
|
||||
location.
|
||||
|
|
|
@ -22,7 +22,7 @@ Widget description
|
|||
------------------
|
||||
|
||||
.. image:: /images/hoversel-preview.png
|
||||
|
||||
:align: left
|
||||
|
||||
A hoversel is a button that pops up a list of items (automatically
|
||||
choosing the direction to display) that have a label and, optionally, an
|
||||
|
|
|
@ -18,11 +18,10 @@
|
|||
|
||||
"""
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/icon-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
An icon object is used to display standard icon images ("delete",
|
||||
"edit", "arrows", etc.) or images coming from a custom file (PNG, JPG,
|
||||
|
|
|
@ -18,11 +18,10 @@
|
|||
|
||||
"""
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/index-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
An index widget gives you an index for fast access to whichever
|
||||
group of other UI items one might have.
|
||||
|
|
|
@ -21,7 +21,7 @@ Widget description
|
|||
------------------
|
||||
|
||||
.. image:: /images/innerwindow-preview.png
|
||||
|
||||
:align: left
|
||||
|
||||
An inwin is a window inside a window that is useful for a quick popup.
|
||||
It does not hover.
|
||||
|
|
|
@ -18,11 +18,10 @@
|
|||
|
||||
"""
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/label-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
Widget to display text, with simple html-like markup.
|
||||
|
||||
|
|
|
@ -17,11 +17,10 @@
|
|||
|
||||
"""
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/layout-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
This is a container widget that takes a standard Edje design file and
|
||||
wraps it very thinly in a widget.
|
||||
|
|
|
@ -18,11 +18,10 @@
|
|||
|
||||
"""
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/list-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
A list widget is a container whose children are displayed vertically or
|
||||
horizontally, in order, and can be selected.
|
||||
|
|
|
@ -18,12 +18,11 @@
|
|||
|
||||
"""
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/map-preview.png
|
||||
:width: 100%
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
The *Map* is a widget specifically for displaying a geographic map.
|
||||
It uses `OpenStreetMap <http://www.openstreetmap.org/>`_ as map tile provider,
|
||||
|
|
|
@ -21,7 +21,7 @@ Widget description
|
|||
------------------
|
||||
|
||||
.. image:: /images/mapbuf-preview.png
|
||||
|
||||
:align: left
|
||||
|
||||
This holds one content object and uses an Evas Map of transformation
|
||||
points to be later used with this content. So the content will be
|
||||
|
|
|
@ -18,11 +18,10 @@
|
|||
|
||||
"""
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/menu-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
A menu is a list of items displayed above its parent.
|
||||
|
||||
|
|
|
@ -17,11 +17,10 @@
|
|||
|
||||
"""
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/multibuttonentry-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
A Multibuttonentry is a widget to allow a user enter text and manage
|
||||
it as a number of buttons. Each text button is inserted by pressing the
|
||||
|
|
|
@ -17,11 +17,10 @@
|
|||
|
||||
"""
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/naviframe-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
Naviframe stands for navigation frame. It's a views manager
|
||||
for applications.
|
||||
|
|
|
@ -17,11 +17,10 @@
|
|||
|
||||
"""
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/notify-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
Display a container in a particular region of the parent.
|
||||
|
||||
|
|
|
@ -18,11 +18,10 @@
|
|||
|
||||
"""
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/panel-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
A panel is a type of animated container that contains subobjects.
|
||||
|
||||
|
|
|
@ -21,7 +21,7 @@ Widget description
|
|||
------------------
|
||||
|
||||
.. image:: /images/panes-preview.png
|
||||
|
||||
:align: left
|
||||
|
||||
The panes widget adds a draggable bar between two contents. When
|
||||
dragged this bar will resize contents' size.
|
||||
|
|
|
@ -17,11 +17,10 @@
|
|||
|
||||
"""
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/photo-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
An Elementary photo widget is intended for displaying a photo, for
|
||||
ex., a person's image (contact).
|
||||
|
|
|
@ -21,7 +21,6 @@
|
|||
Widget description
|
||||
------------------
|
||||
|
||||
|
||||
This is a widget specifically for displaying high-resolution digital
|
||||
camera photos giving speedy feedback (fast load), low memory footprint
|
||||
and zooming and panning as well as fitting logic. It is entirely focused
|
||||
|
|
|
@ -18,11 +18,10 @@
|
|||
|
||||
"""
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/popup-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
This widget is an enhancement of :py:class:`Notify`.
|
||||
In addition to Content area, there are two optional sections namely Title
|
||||
|
|
|
@ -22,7 +22,7 @@ Widget description
|
|||
------------------
|
||||
|
||||
.. image:: /images/progressbar-preview.png
|
||||
|
||||
:align: left
|
||||
|
||||
The progress bar is a widget for visually representing the progress
|
||||
status of a given job/task.
|
||||
|
|
|
@ -21,7 +21,7 @@ Widget description
|
|||
------------------
|
||||
|
||||
.. image:: /images/radio-preview.png
|
||||
|
||||
:align: left
|
||||
|
||||
Radio is a widget that allows for one or more options to be displayed
|
||||
and have the user choose only one of them.
|
||||
|
|
|
@ -18,11 +18,10 @@
|
|||
|
||||
"""
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/scroller-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
A scroller holds a single object and "scrolls it around".
|
||||
|
||||
|
|
|
@ -17,11 +17,10 @@
|
|||
|
||||
"""
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/segmentcontrol-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
Segment control widget is a horizontal control made of multiple
|
||||
segment items, each segment item functioning similar to discrete two
|
||||
|
|
|
@ -21,7 +21,7 @@ Widget description
|
|||
------------------
|
||||
|
||||
.. image:: /images/separator-preview.png
|
||||
|
||||
:align: left
|
||||
|
||||
Separator is a very thin object used to separate other objects.
|
||||
|
||||
|
|
|
@ -17,11 +17,10 @@
|
|||
|
||||
"""
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/slider-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
The slider adds a draggable "slider" widget for selecting the value of
|
||||
something within a range.
|
||||
|
|
|
@ -18,11 +18,10 @@
|
|||
|
||||
"""
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/slideshow-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
This widget, as the name indicates, is a pre-made image
|
||||
slideshow panel, with API functions acting on (child) image
|
||||
|
|
|
@ -21,7 +21,7 @@ Widget description
|
|||
------------------
|
||||
|
||||
.. image:: /images/spinner-preview.png
|
||||
|
||||
:align: left
|
||||
|
||||
A spinner is a widget which allows the user to increase or decrease
|
||||
numeric values using arrow buttons, or edit values directly, clicking
|
||||
|
|
|
@ -21,6 +21,7 @@ Widget description
|
|||
------------------
|
||||
|
||||
.. image:: /images/table-preview.png
|
||||
:align: left
|
||||
|
||||
A container widget to arrange other widgets in a table where items can
|
||||
span multiple columns or rows - even overlap (and then be raised or
|
||||
|
|
|
@ -18,11 +18,10 @@
|
|||
|
||||
"""
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/thumb-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
A thumbnail object is used for displaying the thumbnail of an image
|
||||
or video. You must have compiled Elementary with ``Ethumb_Client``
|
||||
|
|
|
@ -18,11 +18,10 @@
|
|||
|
||||
"""
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
.. image:: /images/toolbar-preview.png
|
||||
|
||||
Widget description
|
||||
------------------
|
||||
|
||||
A toolbar is a widget that displays a list of items inside a box. It
|
||||
can be scrollable, show a menu with items that don't fit to toolbar size
|
||||
|
|
Loading…
Reference in New Issue