diff --git a/changes/1762.doc.rst b/changes/1762.doc.rst new file mode 100644 index 0000000000..df58cceeb1 --- /dev/null +++ b/changes/1762.doc.rst @@ -0,0 +1 @@ +API support tables now indicate beta status using a dimmed check mark. diff --git a/docs/_static/custom.css b/docs/_static/custom.css index a280c4e9a5..c704618ad9 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -1,14 +1,30 @@ -div.body table.widget-descriptions td p -{ - text-align: center; +body { + --color-beta: #c8c8c8; + --color-beta-dark: #484848; +} +body[data-theme="dark"] { + --color-beta: var(--color-beta-dark); } -div.body table.widget-support th p, -div.body table.widget-support td p { +@media (prefers-color-scheme: dark) { + body:not([data-theme="light"]) { + --color-beta: var(--color-beta-dark); + } +} + +div.widget-descriptions td p, +div.widget-support td p { text-align: center; } -div.body table.widget-descriptions td:first-of-type p, -div.body table.widget-descriptions th:first-of-type p -{ +div.widget-descriptions th:first-of-type p { text-align: left; } + +span.stable { + font-weight: bold; +} + +span.beta { + font-weight: bold; + color: var(--color-beta); +} diff --git a/docs/_static/yes.png b/docs/_static/yes.png deleted file mode 100644 index 47976fa37a..0000000000 Binary files a/docs/_static/yes.png and /dev/null differ diff --git a/docs/conf.py b/docs/conf.py index 73af3ff60f..f3b384302d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -100,6 +100,14 @@ # A list of ignored prefixes for module index sorting. # modindex_common_prefix = [] +# Check marks for API support tables. +rst_prolog = """ +.. role:: stable +.. role:: beta +.. |y| replace:: :stable:`✓` +.. |b| replace:: :beta:`✓` +""" + # -- Options for HTML output --------------------------------------------------- diff --git a/docs/reference/api/app.rst b/docs/reference/api/app.rst index 4985b179cf..62a2af040d 100644 --- a/docs/reference/api/app.rst +++ b/docs/reference/api/app.rst @@ -8,9 +8,6 @@ Application :included_cols: 4,5,6,7,8,9 :exclude: {0: '(?!(App|Component))'} -.. |y| image:: /_static/yes.png - :width: 16 - The app is the main entry point and container for the Toga GUI. Usage diff --git a/docs/reference/api/containers/box.rst b/docs/reference/api/containers/box.rst index a9d0796202..08210cbae1 100644 --- a/docs/reference/api/containers/box.rst +++ b/docs/reference/api/containers/box.rst @@ -8,9 +8,6 @@ Box :included_cols: 4,5,6,7,8,9 :exclude: {0: '(?!(Box|Component))'} -.. |y| image:: /_static/yes.png - :width: 16 - The box is a generic container for widgets, allowing you to construct layouts. Usage diff --git a/docs/reference/api/containers/optioncontainer.rst b/docs/reference/api/containers/optioncontainer.rst index da50bfdde8..248d618260 100644 --- a/docs/reference/api/containers/optioncontainer.rst +++ b/docs/reference/api/containers/optioncontainer.rst @@ -8,9 +8,6 @@ Option Container :included_cols: 4,5,6,7,8,9 :exclude: {0: '(?!(OptionContainer|Component))'} -.. |y| image:: /_static/yes.png - :width: 16 - The Option Container widget is a user-selection control for choosing from a pre-configured list of controls, like a tab view. .. figure:: /reference/images/OptionContainer.jpeg diff --git a/docs/reference/api/containers/scrollcontainer.rst b/docs/reference/api/containers/scrollcontainer.rst index 7d0f8f4c48..37788f5fa2 100644 --- a/docs/reference/api/containers/scrollcontainer.rst +++ b/docs/reference/api/containers/scrollcontainer.rst @@ -8,9 +8,6 @@ Scroll Container :included_cols: 4,5,6,7,8,9 :exclude: {0: '(?!(ScrollContainer|Component))'} -.. |y| image:: /_static/yes.png - :width: 16 - The Scroll Container is similar to the iframe or scrollable div element in HTML, it contains an object with its own scrollable selection. diff --git a/docs/reference/api/containers/splitcontainer.rst b/docs/reference/api/containers/splitcontainer.rst index eb581504c5..c4246521f0 100644 --- a/docs/reference/api/containers/splitcontainer.rst +++ b/docs/reference/api/containers/splitcontainer.rst @@ -8,9 +8,6 @@ Split Container :included_cols: 4,5,6,7,8,9 :exclude: {0: '(?!(SplitContainer|Component))'} -.. |y| image:: /_static/yes.png - :width: 16 - The split container is a container with a movable split and the option for 2 or 3 elements. .. figure:: /reference/images/SplitContainer.jpeg diff --git a/docs/reference/api/index.rst b/docs/reference/api/index.rst index edc8a8b648..a60cf99047 100644 --- a/docs/reference/api/index.rst +++ b/docs/reference/api/index.rst @@ -67,9 +67,6 @@ Resources :doc:`Image ` An image =================================================== ================================= -.. |y| image:: /_static/yes.png - :width: 16 - .. toctree:: :hidden: diff --git a/docs/reference/api/mainwindow.rst b/docs/reference/api/mainwindow.rst index 5525e3ce3b..925775686e 100644 --- a/docs/reference/api/mainwindow.rst +++ b/docs/reference/api/mainwindow.rst @@ -8,9 +8,6 @@ MainWindow :included_cols: 4,5,6,7,8,9 :exclude: {0: '(?!(MainWindow|Component))'} -.. |y| image:: /_static/yes.png - :width: 16 - A window for displaying components to the user Usage diff --git a/docs/reference/api/resources/command.rst b/docs/reference/api/resources/command.rst index 5b581db7f7..609946a1c0 100644 --- a/docs/reference/api/resources/command.rst +++ b/docs/reference/api/resources/command.rst @@ -8,9 +8,6 @@ Command :included_cols: 4,5,6,7,8,9 :exclude: {0: '(?!(Command|Component))'} -.. |y| image:: /_static/yes.png - :width: 16 - Usage ----- diff --git a/docs/reference/api/resources/fonts.rst b/docs/reference/api/resources/fonts.rst index 376c17f8e9..448cf8f5c1 100644 --- a/docs/reference/api/resources/fonts.rst +++ b/docs/reference/api/resources/fonts.rst @@ -8,9 +8,6 @@ Font :included_cols: 4,5,6,7,8,9 :exclude: {0: '(?!(Font|Component))'} -.. |y| image:: /_static/yes.png - :width: 16 - The font class is used for abstracting the platforms implementation of fonts. Reference diff --git a/docs/reference/api/resources/group.rst b/docs/reference/api/resources/group.rst index 928c345270..f90fcd754c 100644 --- a/docs/reference/api/resources/group.rst +++ b/docs/reference/api/resources/group.rst @@ -8,9 +8,6 @@ Group :included_cols: 4,5,6,7,8,9 :exclude: {0: '(?!(Group|Component))'} -.. |y| image:: /_static/yes.png - :width: 16 - Usage diff --git a/docs/reference/api/resources/icons.rst b/docs/reference/api/resources/icons.rst index 74cc1462aa..46b0116820 100644 --- a/docs/reference/api/resources/icons.rst +++ b/docs/reference/api/resources/icons.rst @@ -8,9 +8,6 @@ Icon :included_cols: 4,5,6,7,8,9 :exclude: {0: '(?!(Icon|Component))'} -.. |y| image:: /_static/yes.png - :width: 16 - Usage ----- diff --git a/docs/reference/api/resources/images.rst b/docs/reference/api/resources/images.rst index 1f674b8a57..b1330ed402 100644 --- a/docs/reference/api/resources/images.rst +++ b/docs/reference/api/resources/images.rst @@ -8,9 +8,6 @@ Image :included_cols: 4,5,6,7,8,9 :exclude: {0: '(?!(Image|Component)$)'} -.. |y| image:: /_static/yes.png - :width: 16 - An image is graphical content of arbitrary size. diff --git a/docs/reference/api/widgets/activityindicator.rst b/docs/reference/api/widgets/activityindicator.rst index 80e67a8ce3..c343ad53f9 100644 --- a/docs/reference/api/widgets/activityindicator.rst +++ b/docs/reference/api/widgets/activityindicator.rst @@ -8,9 +8,6 @@ Activity Indicator :included_cols: 4,5,6,7,8,9 :exclude: {0: '(?!^(ActivityIndicator|Component)$)'} -.. |y| image:: /_static/yes.png - :width: 16 - The activity indicator is a (spinning) animation for showing progress in an indeterminate task. Usage diff --git a/docs/reference/api/widgets/button.rst b/docs/reference/api/widgets/button.rst index afdb3b389f..128a7b1484 100644 --- a/docs/reference/api/widgets/button.rst +++ b/docs/reference/api/widgets/button.rst @@ -18,9 +18,6 @@ Availability :included_cols: 4,5,6,7,8,9 :exclude: {0: '(?!(Button|Component))'} -.. |y| image:: /_static/yes.png - :width: 16 - Usage ----- diff --git a/docs/reference/api/widgets/canvas.rst b/docs/reference/api/widgets/canvas.rst index 4fbb9926e4..be778599ad 100644 --- a/docs/reference/api/widgets/canvas.rst +++ b/docs/reference/api/widgets/canvas.rst @@ -8,9 +8,6 @@ Canvas :included_cols: 4,5,6,7,8,9 :exclude: {0: '(?!(Canvas|Component))'} -.. |y| image:: /_static/yes.png - :width: 16 - The canvas is used for creating a blank widget that you can draw on. Usage diff --git a/docs/reference/api/widgets/detailedlist.rst b/docs/reference/api/widgets/detailedlist.rst index 3902981d95..3ddb6d97a1 100644 --- a/docs/reference/api/widgets/detailedlist.rst +++ b/docs/reference/api/widgets/detailedlist.rst @@ -8,9 +8,6 @@ DetailedList :included_cols: 4,5,6,7,8,9 :exclude: {0: '(?!(DetailedList|Component))'} -.. |y| image:: /_static/yes.png - :width: 16 - Usage diff --git a/docs/reference/api/widgets/divider.rst b/docs/reference/api/widgets/divider.rst index a642387fde..ec21386f66 100644 --- a/docs/reference/api/widgets/divider.rst +++ b/docs/reference/api/widgets/divider.rst @@ -8,9 +8,6 @@ Divider :included_cols: 4,5,6,7,8,9 :exclude: {0: '(?!(Divider|Component))'} -.. |y| image:: /_static/yes.png - :width: 16 - The divider is used to visually separate sections of a user layout with a line. Usage diff --git a/docs/reference/api/widgets/imageview.rst b/docs/reference/api/widgets/imageview.rst index 22962e9f78..7b95a817af 100644 --- a/docs/reference/api/widgets/imageview.rst +++ b/docs/reference/api/widgets/imageview.rst @@ -8,9 +8,6 @@ Image View :included_cols: 4,5,6,7,8,9 :exclude: {0: '(?!^(ImageView|Component)$)'} -.. |y| image:: /_static/yes.png - :width: 16 - The Image View is a container for an image to be rendered on the display Usage diff --git a/docs/reference/api/widgets/label.rst b/docs/reference/api/widgets/label.rst index 1ba4fc9e05..e0742b73cc 100644 --- a/docs/reference/api/widgets/label.rst +++ b/docs/reference/api/widgets/label.rst @@ -15,9 +15,6 @@ Availability :included_cols: 4,5,6,7,8,9 :exclude: {0: '(?!^(Label|Component)$)'} -.. |y| image:: /_static/yes.png - :width: 16 - Usage ----- diff --git a/docs/reference/api/widgets/multilinetextinput.rst b/docs/reference/api/widgets/multilinetextinput.rst index 8bd69d4820..d12e6d508a 100644 --- a/docs/reference/api/widgets/multilinetextinput.rst +++ b/docs/reference/api/widgets/multilinetextinput.rst @@ -8,9 +8,6 @@ Multi-line text input :included_cols: 4,5,6,7,8,9 :exclude: {0: '(?!^(MultilineTextInput|Component)$)'} -.. |y| image:: /_static/yes.png - :width: 16 - The Multi-line text input is similar to the text input but designed for larger inputs, similar to the textarea field of HTML. Usage diff --git a/docs/reference/api/widgets/numberinput.rst b/docs/reference/api/widgets/numberinput.rst index db501f8c75..a6f4a73a40 100644 --- a/docs/reference/api/widgets/numberinput.rst +++ b/docs/reference/api/widgets/numberinput.rst @@ -8,9 +8,6 @@ Number Input :included_cols: 4,5,6,7,8,9 :exclude: {0: '(?!^(NumberInput|Component)$)'} -.. |y| image:: /_static/yes.png - :width: 16 - The Number input is a text input box that is limited to numeric input. .. figure:: /reference/images/NumberInput.jpeg diff --git a/docs/reference/api/widgets/passwordinput.rst b/docs/reference/api/widgets/passwordinput.rst index 0b7bd3ac42..d386343b29 100644 --- a/docs/reference/api/widgets/passwordinput.rst +++ b/docs/reference/api/widgets/passwordinput.rst @@ -8,9 +8,6 @@ PasswordInput :included_cols: 4,5,6,7,8,9 :exclude: {0: '(?!^(PasswordInput|Component)$)'} -.. |y| image:: /_static/yes.png - :width: 16 - Usage ----- diff --git a/docs/reference/api/widgets/progressbar.rst b/docs/reference/api/widgets/progressbar.rst index 833f60d50d..b1b4e6344c 100644 --- a/docs/reference/api/widgets/progressbar.rst +++ b/docs/reference/api/widgets/progressbar.rst @@ -8,9 +8,6 @@ Progress Bar :included_cols: 4,5,6,7,8,9 :exclude: {0: '(?!^(ProgressBar|Component)$)'} -.. |y| image:: /_static/yes.png - :width: 16 - The progress bar is a simple widget for showing a percentage progress for task completion. Usage diff --git a/docs/reference/api/widgets/selection.rst b/docs/reference/api/widgets/selection.rst index ef7615a86d..21e0be0c4f 100644 --- a/docs/reference/api/widgets/selection.rst +++ b/docs/reference/api/widgets/selection.rst @@ -8,9 +8,6 @@ Selection :included_cols: 4,5,6,7,8,9 :exclude: {0: '(?!^(Selection|Component)$)'} -.. |y| image:: /_static/yes.png - :width: 16 - The Selection widget is a simple control for allowing the user to choose between a list of string options. .. figure:: /reference/images/Selection.jpeg diff --git a/docs/reference/api/widgets/slider.rst b/docs/reference/api/widgets/slider.rst index df61146981..1fc85ba2e3 100644 --- a/docs/reference/api/widgets/slider.rst +++ b/docs/reference/api/widgets/slider.rst @@ -8,9 +8,6 @@ Slider :included_cols: 4,5,6,7,8,9 :exclude: {0: '(?!^(Slider|Component)$)'} -.. |y| image:: /_static/yes.png - :width: 16 - Usage diff --git a/docs/reference/api/widgets/switch.rst b/docs/reference/api/widgets/switch.rst index acaa698847..237349a9be 100644 --- a/docs/reference/api/widgets/switch.rst +++ b/docs/reference/api/widgets/switch.rst @@ -8,9 +8,6 @@ Switch :included_cols: 4,5,6,7,8,9 :exclude: {0: '(?!^(Switch|Component)$)'} -.. |y| image:: /_static/yes.png - :width: 16 - The switch widget is a clickable button with two stable states, True (on, checked) and False (off, unchecked). diff --git a/docs/reference/api/widgets/table.rst b/docs/reference/api/widgets/table.rst index cb86a75e18..93cd09efce 100644 --- a/docs/reference/api/widgets/table.rst +++ b/docs/reference/api/widgets/table.rst @@ -8,9 +8,6 @@ Table :included_cols: 4,5,6,7,8,9 :exclude: {0: '(?!^(Table|Component)$)'} -.. |y| image:: /_static/yes.png - :width: 16 - The table widget is a widget for displaying tabular data. It can be instantiated with the list of headings and then data rows can be added. diff --git a/docs/reference/api/widgets/textinput.rst b/docs/reference/api/widgets/textinput.rst index 095a1f26d1..378d8fd1d2 100644 --- a/docs/reference/api/widgets/textinput.rst +++ b/docs/reference/api/widgets/textinput.rst @@ -8,9 +8,6 @@ Text Input :included_cols: 4,5,6,7,8,9 :exclude: {0: '(?!^(TextInput|Component)$)'} -.. |y| image:: /_static/yes.png - :width: 16 - The text input widget is a simple input field for user entry of text data. .. figure:: /reference/images/TextInput.jpeg diff --git a/docs/reference/api/widgets/tree.rst b/docs/reference/api/widgets/tree.rst index 31e3e83e5b..e7c19d0b92 100644 --- a/docs/reference/api/widgets/tree.rst +++ b/docs/reference/api/widgets/tree.rst @@ -8,9 +8,6 @@ Tree :included_cols: 4,5,6,7,8,9 :exclude: {0: '(?!^(Tree|Component)$)'} -.. |y| image:: /_static/yes.png - :width: 16 - The tree widget is still under development. Usage diff --git a/docs/reference/api/widgets/webview.rst b/docs/reference/api/widgets/webview.rst index d57ad8047c..1f1b65b537 100644 --- a/docs/reference/api/widgets/webview.rst +++ b/docs/reference/api/widgets/webview.rst @@ -8,9 +8,6 @@ WebView :included_cols: 4,5,6,7,8,9 :exclude: {0: '(?!^(WebView|Component)$)'} -.. |y| image:: /_static/yes.png - :width: 16 - The Web View widget is used for displaying an embedded browser window within an application. Both sites served by a web server and local content can be displayed. Due to security diff --git a/docs/reference/api/widgets/widget.rst b/docs/reference/api/widgets/widget.rst index 6c7e031555..311311b032 100644 --- a/docs/reference/api/widgets/widget.rst +++ b/docs/reference/api/widgets/widget.rst @@ -8,9 +8,6 @@ Widget :included_cols: 4,5,6,7,8,9 :exclude: {0: '(?!^(Widget|Component)$)'} -.. |y| image:: /_static/yes.png - :width: 16 - The base class of all widgets. This class should not be be instantiated directly. Reference diff --git a/docs/reference/api/window.rst b/docs/reference/api/window.rst index 09a3d291c6..73c2d348d5 100644 --- a/docs/reference/api/window.rst +++ b/docs/reference/api/window.rst @@ -8,9 +8,6 @@ Window :included_cols: 4,5,6,7,8,9 :exclude: {0: '(?!(Window|Component))'} -.. |y| image:: /_static/yes.png - :width: 16 - A window for displaying components to the user Usage diff --git a/docs/reference/data/widgets_by_platform.csv b/docs/reference/data/widgets_by_platform.csv index 2e852bf36c..456d068972 100644 --- a/docs/reference/data/widgets_by_platform.csv +++ b/docs/reference/data/widgets_by_platform.csv @@ -1,34 +1,34 @@ Component,Type,Component,Description,macOS,GTK,Windows,iOS,Android,Web -Application,Core Component,:class:`~toga.app.App`,The application itself,|y|,|y|,|y|,|y|,|y|,|y| -Window,Core Component,:class:`~toga.window.Window`,Window object,|y|,|y|,|y|,|y|,|y|,|y| -MainWindow,Core Component,:class:`~toga.app.MainWindow`,Main window of the application,|y|,|y|,|y|,|y|,|y|,|y| -ActivityIndicator,Core Component,:class:`~toga.widgets.activityindicator.ActivityIndicator`,A spinning activity animation,|y|,|y|,,,, -Button,General Widget,:class:`~toga.widgets.button.Button`,Basic clickable Button,|y|,|y|,|y|,|y|,|y|,|y| -Canvas,General Widget,:class:`~toga.widgets.canvas.Canvas`,Area you can draw on,|y|,|y|,|y|,|y|,, -DatePicker,General Widget,:class:`~toga.widgets.datepicker.DatePicker`,An input for dates,,,|y|,,|y|, -DetailedList,General Widget,:class:`~toga.widgets.detailedlist.DetailedList`,A list of complex content,|y|,|y|,,|y|,|y|, -Divider,General Widget,:class:`~toga.widgets.divider.Divider`,A horizontal or vertical line,|y|,|y|,|y|,,, -ImageView,General Widget,:class:`~toga.widgets.imageview.ImageView`,Image Viewer,|y|,|y|,|y|,|y|,|y|, -Label,General Widget,:class:`~toga.widgets.label.Label`,Text label,|y|,|y|,|y|,|y|,|y|,|y| -MultilineTextInput,General Widget,:class:`~toga.widgets.multilinetextinput.MultilineTextInput`,Multi-line Text Input field,|y|,|y|,|y|,|y|,|y|, -NumberInput,General Widget,:class:`~toga.widgets.numberinput.NumberInput`,Number Input field,|y|,|y|,|y|,|y|,|y|, -PasswordInput,General Widget,:class:`~toga.widgets.passwordinput.PasswordInput`,A text input that hides it’s input,|y|,|y|,|y|,|y|,|y|, -ProgressBar,General Widget,:class:`~toga.widgets.progressbar.ProgressBar`,Progress Bar,|y|,|y|,|y|,|y|,|y|, -Selection,General Widget,:class:`~toga.widgets.selection.Selection`,Selection,|y|,|y|,|y|,|y|,|y|, -Slider,General Widget,:class:`~toga.widgets.slider.Slider`,Slider,|y|,|y|,|y|,|y|,|y|, -Switch,General Widget,:class:`~toga.widgets.switch.Switch`,Switch,|y|,|y|,|y|,|y|,|y|, -Table,General Widget,:class:`~toga.widgets.table.Table`,Table of data,|y|,|y|,|y|,,|y|, -TextInput,General Widget,:class:`~toga.widgets.textinput.TextInput`,Text Input field,|y|,|y|,|y|,|y|,|y|,|y| -TimePicker,General Widget,:class:`~toga.widgets.timepicker.TimePicker`,An input for times,,,|y|,,|y|, -Tree,General Widget,:class:`~toga.widgets.tree.Tree`,Tree of data,|y|,|y|,|y|,,, -WebView,General Widget,:class:`~toga.widgets.webview.WebView`,A panel for displaying HTML,|y|,|y|,|y|,|y|,|y|, -Widget,General Widget,:class:`~toga.widgets.base.Widget`,The base widget,|y|,|y|,|y|,|y|,|y|,|y| -Box,Layout Widget,:class:`~toga.widgets.box.Box`,Container for components,|y|,|y|,|y|,|y|,|y|,|y| -ScrollContainer,Layout Widget,:class:`~toga.widgets.scrollcontainer.ScrollContainer`,Scrollable Container,|y|,|y|,|y|,|y|,|y|, -SplitContainer,Layout Widget,:class:`~toga.widgets.splitcontainer.SplitContainer`,Split Container,|y|,|y|,|y|,,, -OptionContainer,Layout Widget,:class:`~toga.widgets.optioncontainer.OptionContainer`,Option Container,|y|,|y|,|y|,,, -Font,Resource,:class:`~toga.fonts.Font`,Fonts,|y|,|y|,|y|,|y|,|y|, -Command,Resource,:class:`~toga.command.Command`,Command,|y|,|y|,|y|,,|y|, -Group,Resource,:class:`~toga.command.Group`,Command group,|y|,|y|,|y|,|y|,|y|, -Icon,Resource,:class:`~toga.icons.Icon`,"An icon for buttons, menus, etc",|y|,|y|,|y|,|y|,|y|, -Image,Resource,:class:`~toga.images.Image`,An image,|y|,|y|,|y|,|y|,|y|, +Application,Core Component,:class:`~toga.app.App`,The application itself,|b|,|b|,|b|,|b|,|b|,|b| +Window,Core Component,:class:`~toga.window.Window`,Window object,|b|,|b|,|b|,|b|,|b|,|b| +MainWindow,Core Component,:class:`~toga.app.MainWindow`,Main window of the application,|b|,|b|,|b|,|b|,|b|,|b| +ActivityIndicator,Core Component,:class:`~toga.widgets.activityindicator.ActivityIndicator`,A spinning activity animation,|b|,|b|,,,, +Button,General Widget,:class:`~toga.widgets.button.Button`,Basic clickable Button,|y|,|b|,|b|,|b|,|b|,|b| +Canvas,General Widget,:class:`~toga.widgets.canvas.Canvas`,Area you can draw on,|b|,|b|,|b|,|b|,, +DatePicker,General Widget,:class:`~toga.widgets.datepicker.DatePicker`,An input for dates,,,|b|,,|b|, +DetailedList,General Widget,:class:`~toga.widgets.detailedlist.DetailedList`,A list of complex content,|b|,|b|,,|b|,|b|, +Divider,General Widget,:class:`~toga.widgets.divider.Divider`,A horizontal or vertical line,|b|,|b|,|b|,,, +ImageView,General Widget,:class:`~toga.widgets.imageview.ImageView`,Image Viewer,|b|,|b|,|b|,|b|,|b|, +Label,General Widget,:class:`~toga.widgets.label.Label`,Text label,|b|,|b|,|b|,|b|,|b|,|b| +MultilineTextInput,General Widget,:class:`~toga.widgets.multilinetextinput.MultilineTextInput`,Multi-line Text Input field,|b|,|b|,|b|,|b|,|b|, +NumberInput,General Widget,:class:`~toga.widgets.numberinput.NumberInput`,Number Input field,|b|,|b|,|b|,|b|,|b|, +PasswordInput,General Widget,:class:`~toga.widgets.passwordinput.PasswordInput`,A text input that hides it’s input,|b|,|b|,|b|,|b|,|b|, +ProgressBar,General Widget,:class:`~toga.widgets.progressbar.ProgressBar`,Progress Bar,|b|,|b|,|b|,|b|,|b|, +Selection,General Widget,:class:`~toga.widgets.selection.Selection`,Selection,|b|,|b|,|b|,|b|,|b|, +Slider,General Widget,:class:`~toga.widgets.slider.Slider`,Slider,|b|,|b|,|b|,|b|,|b|, +Switch,General Widget,:class:`~toga.widgets.switch.Switch`,Switch,|b|,|b|,|b|,|b|,|b|, +Table,General Widget,:class:`~toga.widgets.table.Table`,Table of data,|b|,|b|,|b|,,|b|, +TextInput,General Widget,:class:`~toga.widgets.textinput.TextInput`,Text Input field,|b|,|b|,|b|,|b|,|b|,|b| +TimePicker,General Widget,:class:`~toga.widgets.timepicker.TimePicker`,An input for times,,,|b|,,|b|, +Tree,General Widget,:class:`~toga.widgets.tree.Tree`,Tree of data,|b|,|b|,|b|,,, +WebView,General Widget,:class:`~toga.widgets.webview.WebView`,A panel for displaying HTML,|b|,|b|,|b|,|b|,|b|, +Widget,General Widget,:class:`~toga.widgets.base.Widget`,The base widget,|b|,|b|,|b|,|b|,|b|,|b| +Box,Layout Widget,:class:`~toga.widgets.box.Box`,Container for components,|b|,|b|,|b|,|b|,|b|,|b| +ScrollContainer,Layout Widget,:class:`~toga.widgets.scrollcontainer.ScrollContainer`,Scrollable Container,|b|,|b|,|b|,|b|,|b|, +SplitContainer,Layout Widget,:class:`~toga.widgets.splitcontainer.SplitContainer`,Split Container,|b|,|b|,|b|,,, +OptionContainer,Layout Widget,:class:`~toga.widgets.optioncontainer.OptionContainer`,Option Container,|b|,|b|,|b|,,, +Font,Resource,:class:`~toga.fonts.Font`,Fonts,|b|,|b|,|b|,|b|,|b|, +Command,Resource,:class:`~toga.command.Command`,Command,|b|,|b|,|b|,,|b|, +Group,Resource,:class:`~toga.command.Group`,Command group,|b|,|b|,|b|,|b|,|b|, +Icon,Resource,:class:`~toga.icons.Icon`,"An icon for buttons, menus, etc",|b|,|b|,|b|,|b|,|b|, +Image,Resource,:class:`~toga.images.Image`,An image,|b|,|b|,|b|,|b|,|b|, diff --git a/docs/reference/widgets_by_platform.rst b/docs/reference/widgets_by_platform.rst index f0d54dc638..cc99e7ef44 100644 --- a/docs/reference/widgets_by_platform.rst +++ b/docs/reference/widgets_by_platform.rst @@ -1,6 +1,9 @@ -========================= -Toga widgets by platforms -========================= +===================== +Toga APIs by platform +===================== + +* |y| = stable +* |b| = beta Core Components =============== @@ -54,6 +57,3 @@ Resources :class: longtable :stub-columns: 1 :widths: 3 1 1 1 1 1 1 - -.. |y| image:: /_static/yes.png - :width: 16