Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct some discrepancies and inconsistencies in widget support docs. #2204

Merged
merged 2 commits into from
Nov 8, 2023
Merged

Correct some discrepancies and inconsistencies in widget support docs. #2204

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e83431
Correct some discrepancies and inconsistencies in widget support docs.
freakboy3742 Nov 8, 2023
3714609
Add changenote.
freakboy3742 Nov 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changes/2204.misc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Some inconsistencies in widget support documentation were corrected.
2 changes: 1 addition & 1 deletion docs/reference/api/documentapp.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The top-level representation of an application that manages documents.
.. csv-filter:: Availability (:ref:`Key <api-status-key>`)
:header-rows: 1
:file: ../data/widgets_by_platform.csv
:included_cols: 4,5,6,7,8,9
:included_cols: 4,5,6,7,8,9,10
:exclude: {0: '(?!(DocumentApp|Component))'}


Expand Down
16 changes: 16 additions & 0 deletions docs/reference/api/mainwindow.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,22 @@ The main window of the application.
:align: center
:width: 450px

.. group-tab:: Web |beta|

.. .. figure:: /reference/images/mainwindow-web.png
.. :align: center
.. :width: 300px

Screenshot not available

.. group-tab:: Textual |beta|

.. .. figure:: /reference/images/mainwindow-textual.png
.. :align: center
.. :width: 300px

Screenshot not available

Usage
-----

Expand Down
7 changes: 0 additions & 7 deletions docs/reference/api/widgets/multilinetextinput.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,6 @@ A scrollable panel that allows for the display and editing of multiple lines of

Not supported

.. rst-class:: widget-support
.. csv-filter:: Availability (:ref:`Key <api-status-key>`)
:header-rows: 1
:file: ../../data/widgets_by_platform.csv
:included_cols: 4,5,6,7,8,9,10
:exclude: {0: '(?!^(MultilineTextInput|Component)$)'}

Usage
-----

Expand Down
12 changes: 2 additions & 10 deletions docs/reference/api/widgets/selection.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,22 +35,14 @@ A widget to select a single option from a list of alternatives.
:align: center
:width: 300px

.. group-tab:: Web
.. group-tab:: Web |no|

Not supported

.. group-tab:: Textual
.. group-tab:: Textual |no|

Not supported

.. rst-class:: widget-support
.. csv-filter:: Availability (:ref:`Key <api-status-key>`)
:header-rows: 1
:file: ../../data/widgets_by_platform.csv
:included_cols: 4,5,6,7,8,9,10
:exclude: {0: '(?!^(Selection|Component)$)'}


Usage
-----

Expand Down
8 changes: 8 additions & 0 deletions docs/reference/api/window.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,14 @@ An operating system-managed container of widgets.

Not supported

.. group-tab:: Web |no|

Not supported

.. group-tab:: Textual |no|

Not supported

Usage
-----

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/data/widgets_by_platform.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Component,Type,Component,Description,macOS,GTK,Windows,iOS,Android,Web,Terminal
Application,Core Component,:class:`~toga.App`,The application itself,|y|,|y|,|y|,|y|,|y|,|b|,|b|
DocumentApp,Core Component,:class:`~toga.DocumentApp`,An application that manages documents.,|b|,|b|,,,,,
Window,Core Component,:class:`~toga.Window`,An operating system-managed container of widgets.,|y|,|y|,|y|,|y|,|y|,|b|,|b|
Window,Core Component,:class:`~toga.Window`,An operating system-managed container of widgets.,|y|,|y|,|y|,,,,
MainWindow,Core Component,:class:`~toga.MainWindow`,The main window of the application.,|y|,|y|,|y|,|y|,|y|,|b|,|b|
ActivityIndicator,General Widget,:class:`~toga.ActivityIndicator`,A spinning activity animation,|y|,|y|,,,,|b|,
Button,General Widget,:class:`~toga.Button`,Basic clickable Button,|y|,|y|,|y|,|y|,|y|,|b|,|b|
Expand Down