55> Auto-generated documentation for [ cli2gui.application.application] ( ../../../../cli2gui/application/application.py ) module.
66
77- [ Application] ( #application )
8- - [ addItemsAndGroups] ( #additemsandgroups )
9- - [ createLayout] ( #createlayout )
10- - [ generatePopup] ( #generatepopup )
11- - [ isDarkMode] ( #isdarkmode )
128 - [ run] ( #run )
13- - [ setBase24Theme] ( #setbase24theme )
14- - [ setupWidgets] ( #setupwidgets )
15- - [ themeFromFile] ( #themefromfile )
16-
17- ## addItemsAndGroups
18-
19- [ Show source in application.py:178] ( ../../../../cli2gui/application/application.py#L178 )
20-
21- Add arg_items and groups to the argConstruct list.
22-
23- #### Arguments
24-
25- ----
26- - ` section ` * types.Group* - contents/ section containing name, arg_items
27- and groups
28- - ` argConstruct ` * list[ list[ Element]] * - list of widgets to
29- add to the program window
30- - ` widgets ` * Widgets* - widgets object used to generate widgets to add to
31- argConstruct
32-
33- #### Returns
34-
35- -------
36- - ` list[list[Element]] ` - updated argConstruct
37-
38- #### Signature
39-
40- ``` python
41- def addItemsAndGroups (
42- section : types.Group, argConstruct : list[list[Element]], widgets : Widgets
43- ) -> list[list[Element]]: ...
44- ```
45-
46- #### See also
47-
48- - [ Widgets] ( ./widgets.md#widgets )
49-
50-
51-
52- ## createLayout
53-
54- [ Show source in application.py:284] ( ../../../../cli2gui/application/application.py#L284 )
55-
56- Create the pysimplegui layout from the build spec.
57-
58- #### Arguments
59-
60- ----
61- - ` buildSpec ` * types.FullBuildSpec* - build spec containing widget
62- - ` widgets ` * Widgets* - class to build widgets
63- - ` pySimpleGui ` * Any* - version of PySimpleGui to use
64- - ` menu ` * list[ str]] * - menu data
65-
66- #### Returns
67-
68- -------
69- - ` list[list[Element]] ` - list of widgets (layout list)
70-
71- #### Signature
72-
73- ``` python
74- def createLayout (
75- buildSpec : types.FullBuildSpec,
76- widgets : Widgets,
77- pySimpleGui : Any,
78- menu : str | list[str ],
79- ) -> list[list[Element]]: ...
80- ```
81-
82- #### See also
83-
84- - [ Widgets] ( ./widgets.md#widgets )
85-
86-
87-
88- ## generatePopup
89-
90- [ Show source in application.py:212] ( ../../../../cli2gui/application/application.py#L212 )
91-
92- Create the popup window.
93-
94- #### Arguments
95-
96- ----
97- - ` buildSpec ` * types.FullBuildSpec* - [ description]
98- values (Union[ dict[ Any, Any] ): Returned when a button is clicked. Such
99- as the menu
100- - ` widgets ` * Widgets* - class to build widgets
101- - ` pySimpleGui ` * Any* - PySimpleGui class
102-
103- #### Returns
104-
105- -------
106- - ` pySimpleGui.Window ` - A PySimpleGui Window
107-
108- #### Signature
109-
110- ``` python
111- def generatePopup (
112- buildSpec : types.FullBuildSpec,
113- values : dict[Any, Any] | list[Any],
114- widgets : Widgets,
115- pySimpleGui : Any,
116- ) -> Window: ...
117- ```
118-
119- #### See also
120-
121- - [ Widgets] ( ./widgets.md#widgets )
122-
123-
124-
125- ## isDarkMode
126-
127- [ Show source in application.py:15] ( ../../../../cli2gui/application/application.py#L15 )
128-
129- Monkeypatch for getostheme.isDarkMode.
130-
131- #### Signature
132-
133- ``` python
134- def isDarkMode () -> bool : ...
135- ```
136-
137-
1389
13910## run
14011
141- [ Show source in application.py:350 ] ( ../../../../cli2gui/application/application.py#L350 )
12+ [ Show source in application.py:17 ] ( ../../../../cli2gui/application/application.py#L17 )
14213
14314Establish the main entry point.
14415
@@ -152,81 +23,4 @@ Establish the main entry point.
15223
15324``` python
15425def run (buildSpec : types.FullBuildSpec) -> None : ...
155- ```
156-
157-
158-
159- ## setBase24Theme
160-
161- [ Show source in application.py:44] ( ../../../../cli2gui/application/application.py#L44 )
162-
163- Set the base24 theme to the application.
164-
165- #### Arguments
166-
167- ----
168- theme (Union[ str, list[ str]] ): the light theme
169- darkTheme (Union[ str, list[ str]] ): the dark theme
170- - ` pySimpleGui ` * Any* - pysimplegui module
171-
172- #### Signature
173-
174- ``` python
175- def setBase24Theme (
176- theme : str | list[str ], darkTheme : str | list[str ], pySimpleGui : Any
177- ) -> None : ...
178- ```
179-
180-
181-
182- ## setupWidgets
183-
184- [ Show source in application.py:135] ( ../../../../cli2gui/application/application.py#L135 )
185-
186- Set the widget sizes to the application.
187-
188- #### Arguments
189-
190- ----
191- - ` gui ` * str* - user selected gui eg. pysimpleguiqt
192- sizes (Union[ dict[ str, Any]] ): widget sizes
193- - ` pySimpleGui ` * Any* - pysimplegui module
194-
195- #### Returns
196-
197- -------
198- - ` Widgets ` - widgets object all set up nicely
199-
200- #### Signature
201-
202- ``` python
203- def setupWidgets (gui : str , sizes : dict[str , Any], pySimpleGui : Any) -> Widgets: ...
204- ```
205-
206- #### See also
207-
208- - [ Widgets] ( ./widgets.md#widgets )
209-
210-
211-
212- ## themeFromFile
213-
214- [ Show source in application.py:28] ( ../../../../cli2gui/application/application.py#L28 )
215-
216- Set the base24 theme from a base24 scheme.yaml to the application.
217-
218- #### Arguments
219-
220- ----
221- - ` themeFile ` * str* - path to file
222-
223- #### Returns
224-
225- -------
226- - ` list[str] ` - theme to set
227-
228- #### Signature
229-
230- ``` python
231- def themeFromFile (themeFile : str ) -> list[str ]: ...
23226```
0 commit comments