Skip to content

Commit

Permalink
Formatting cleanups for docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
freakboy3742 committed Dec 12, 2023
1 parent 8cbb78d commit b1cedde
Showing 1 changed file with 18 additions and 19 deletions.
37 changes: 18 additions & 19 deletions docs/reference/api/containers/optioncontainer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ A container that can display multiple labeled tabs of content.
Usage
-----

The content of an OptionContainer is a list of widgets that will form discrete
tabs in the display. Each tab can be identified by a label, and, optionally, an
icon. This list of content can be modified after initial construction:
The content of an OptionContainer is a list of widgets that will form discrete tabs in
the display. Each tab can be identified by a label, and, optionally, an icon. This list
of content can be modified after initial construction:

.. code-block:: python
Expand All @@ -70,8 +70,7 @@ icon. This list of content can be modified after initial construction:
OptionContainer content can also be specified by using :any:`OptionItem` instances
instead of tuples. This enables you to be explicit when setting an icon or enabled
status; it also allows you to set the initial enabled status *without* setting
an icon:
status; it also allows you to set the initial enabled status *without* setting an icon:

.. code-block:: python
Expand Down Expand Up @@ -134,24 +133,24 @@ item, you can specify an item using:
Notes
-----

* The use of icons on tabs varies between platforms. If the platform requires
icons, and no icon is provided, a default icon will be used. If the
platform does not support icons, any icon provided will be ignored, and
requests to retrieve the icon will return ``None``.
* The use of icons on tabs varies between platforms. If the platform requires icons, and
no icon is provided, a default icon will be used. If the platform does not support
icons, any icon provided will be ignored, and requests to retrieve the icon will
return ``None``.

* The behavior of disabled tabs varies between platforms. Some platforms
will display the tab, but put it in an unselectable state; some will hide
the tab. A hidden tab can still be referenced by index - the tab index
refers to the logical order, not the visible order.
* The behavior of disabled tabs varies between platforms. Some platforms will display
the tab, but put it in an unselectable state; some will hide the tab. A hidden tab can
still be referenced by index - the tab index refers to the logical order, not the
visible order.

* iOS can only display 5 tabs. If there are more than 5 visible tabs in an
OptionContainer, the last item will be converted into a "More" option that
will allow the user to select the additional items. While the "More" menu is
displayed, the current tab will return as ``None``.
OptionContainer, the last item will be converted into a "More" option that will allow
the user to select the additional items. While the "More" menu is displayed, the
current tab will return as ``None``.

* iOS allows for the user to rearrange icons on an OptionContainer. When
referring to tabs by index, user re-ordering is ignored; the logical order as
configured in Toga itself is used to identify tabs.
* iOS allows the user to rearrange icons on an OptionContainer. When referring to tabs
by index, user re-ordering is ignored; the logical order as configured in Toga itself
is used to identify tabs.

Reference
---------
Expand Down

0 comments on commit b1cedde

Please sign in to comment.