Skip to content

Commit 13c2865

Browse files
FredHappyfaceFredHappyface
committed
update auto docs
1 parent 09eb1a5 commit 13c2865

File tree

5 files changed

+29
-28
lines changed

5 files changed

+29
-28
lines changed

‎documentation/reference/cli2gui/application/application.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
## run
1111

12-
[Show source in application.py:17](../../../../cli2gui/application/application.py#L17)
12+
[Show source in application.py:16](../../../../cli2gui/application/application.py#L16)
1313

1414
Establish the main entry point.
1515

‎documentation/reference/cli2gui/decorators.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ Serialises data to JSON and launches the Cli2Gui application.
2727
- `options` *are* - "argparse", "getopt", "optparse", "docopt",
2828
"dephell_argparse". Defaults to "argparse".
2929
- `gui` *str, optional* - Override the gui to use. Current options are:
30-
"dearpygui" ,"pysimplegui", "pysimpleguiqt","pysimpleguiweb". Defaults to
31-
"dearpygui".
30+
"dearpygui", "pysimplegui", "pysimpleguiqt","pysimpleguiweb","freesimplegui",
31+
Defaults to "dearpygui".
3232
theme (Union[str, list[str]], optional): Set a base24 theme. Can
3333
also pass a base24 scheme file. eg. one-light.yaml. Defaults to "".
3434
darkTheme (Union[str, list[str]], optional): Set a base24 dark
@@ -83,8 +83,8 @@ Serializes data to JSON and launches the Cli2Gui application.
8383
----
8484
run_function (Callable[..., Any]): The name of the function to call eg.
8585
- `gui` *str, optional* - Override the gui to use. Current options are:
86-
"dearpygui", "pysimplegui", "pysimpleguiqt","pysimpleguiweb". Defaults to
87-
"dearpygui".
86+
"dearpygui", "pysimplegui", "pysimpleguiqt","pysimpleguiweb","freesimplegui",
87+
Defaults to "dearpygui".
8888
theme (Union[str, list[str]], optional): Set a base24 theme. Can
8989
also pass a base24 scheme file. eg. one-light.yaml. Defaults to "".
9090
darkTheme (Union[str, list[str]], optional): Set a base24 dark

‎documentation/reference/cli2gui/gui/pysimplegui_wrapper.md‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ class PySimpleGUIWrapper(AbstractGUI):
4848

4949
### PySimpleGUIWrapper()._button
5050

51-
[Show source in pysimplegui_wrapper.py:97](../../../../cli2gui/gui/pysimplegui_wrapper.py#L97)
51+
[Show source in pysimplegui_wrapper.py:100](../../../../cli2gui/gui/pysimplegui_wrapper.py#L100)
5252

5353
Return a button.
5454

@@ -60,7 +60,7 @@ def _button(self, text: str) -> gui_lib.Element: ...
6060

6161
### PySimpleGUIWrapper()._check
6262

63-
[Show source in pysimplegui_wrapper.py:87](../../../../cli2gui/gui/pysimplegui_wrapper.py#L87)
63+
[Show source in pysimplegui_wrapper.py:90](../../../../cli2gui/gui/pysimplegui_wrapper.py#L90)
6464

6565
Return a checkbox.
6666

@@ -72,7 +72,7 @@ def _check(self, key: str, default: str | None = None) -> gui_lib.Element: ...
7272

7373
### PySimpleGUIWrapper()._dropdown
7474

75-
[Show source in pysimplegui_wrapper.py:118](../../../../cli2gui/gui/pysimplegui_wrapper.py#L118)
75+
[Show source in pysimplegui_wrapper.py:121](../../../../cli2gui/gui/pysimplegui_wrapper.py#L121)
7676

7777
Return a dropdown.
7878

@@ -84,7 +84,7 @@ def _dropdown(self, key: str, argItems: list[str]) -> gui_lib.Element: ...
8484

8585
### PySimpleGUIWrapper()._fileBrowser
8686

87-
[Show source in pysimplegui_wrapper.py:127](../../../../cli2gui/gui/pysimplegui_wrapper.py#L127)
87+
[Show source in pysimplegui_wrapper.py:130](../../../../cli2gui/gui/pysimplegui_wrapper.py#L130)
8888

8989
Return a fileBrowser button and field.
9090

@@ -98,7 +98,7 @@ def _fileBrowser(
9898

9999
### PySimpleGUIWrapper()._helpArgHelp
100100

101-
[Show source in pysimplegui_wrapper.py:154](../../../../cli2gui/gui/pysimplegui_wrapper.py#L154)
101+
[Show source in pysimplegui_wrapper.py:157](../../../../cli2gui/gui/pysimplegui_wrapper.py#L157)
102102

103103
Return a label for the arg help text.
104104

@@ -110,7 +110,7 @@ def _helpArgHelp(self, helpText: str) -> gui_lib.Element: ...
110110

111111
### PySimpleGUIWrapper()._helpArgName
112112

113-
[Show source in pysimplegui_wrapper.py:150](../../../../cli2gui/gui/pysimplegui_wrapper.py#L150)
113+
[Show source in pysimplegui_wrapper.py:153](../../../../cli2gui/gui/pysimplegui_wrapper.py#L153)
114114

115115
Return a label for the arg name.
116116

@@ -122,7 +122,7 @@ def _helpArgName(self, displayName: str, commands: list[str]) -> gui_lib.Element
122122

123123
### PySimpleGUIWrapper()._helpArgNameAndHelp
124124

125-
[Show source in pysimplegui_wrapper.py:158](../../../../cli2gui/gui/pysimplegui_wrapper.py#L158)
125+
[Show source in pysimplegui_wrapper.py:161](../../../../cli2gui/gui/pysimplegui_wrapper.py#L161)
126126

127127
Return a column containing the argument name and help text.
128128

@@ -136,7 +136,7 @@ def _helpArgNameAndHelp(
136136

137137
### PySimpleGUIWrapper()._helpCounterWidget
138138

139-
[Show source in pysimplegui_wrapper.py:206](../../../../cli2gui/gui/pysimplegui_wrapper.py#L206)
139+
[Show source in pysimplegui_wrapper.py:209](../../../../cli2gui/gui/pysimplegui_wrapper.py#L209)
140140

141141
Return a set of self that make up an arg with text.
142142

@@ -148,7 +148,7 @@ def _helpCounterWidget(self, item: types.Item) -> list[gui_lib.Element]: ...
148148

149149
### PySimpleGUIWrapper()._helpDropdownWidget
150150

151-
[Show source in pysimplegui_wrapper.py:226](../../../../cli2gui/gui/pysimplegui_wrapper.py#L226)
151+
[Show source in pysimplegui_wrapper.py:229](../../../../cli2gui/gui/pysimplegui_wrapper.py#L229)
152152

153153
Return a set of self that make up an arg with a choice.
154154

@@ -160,7 +160,7 @@ def _helpDropdownWidget(self, item: types.Item) -> list[gui_lib.Element]: ...
160160

161161
### PySimpleGUIWrapper()._helpFileWidget
162162

163-
[Show source in pysimplegui_wrapper.py:216](../../../../cli2gui/gui/pysimplegui_wrapper.py#L216)
163+
[Show source in pysimplegui_wrapper.py:219](../../../../cli2gui/gui/pysimplegui_wrapper.py#L219)
164164

165165
Return a set of self that make up an arg with a file.
166166

@@ -172,7 +172,7 @@ def _helpFileWidget(self, item: types.Item) -> list[gui_lib.Element]: ...
172172

173173
### PySimpleGUIWrapper()._helpFlagWidget
174174

175-
[Show source in pysimplegui_wrapper.py:186](../../../../cli2gui/gui/pysimplegui_wrapper.py#L186)
175+
[Show source in pysimplegui_wrapper.py:189](../../../../cli2gui/gui/pysimplegui_wrapper.py#L189)
176176

177177
Return a set of self that make up an arg with true/ false.
178178

@@ -184,7 +184,7 @@ def _helpFlagWidget(self, item: types.Item) -> list[gui_lib.Element]: ...
184184

185185
### PySimpleGUIWrapper()._helpTextWidget
186186

187-
[Show source in pysimplegui_wrapper.py:196](../../../../cli2gui/gui/pysimplegui_wrapper.py#L196)
187+
[Show source in pysimplegui_wrapper.py:199](../../../../cli2gui/gui/pysimplegui_wrapper.py#L199)
188188

189189
Return a set of self that make up an arg with text.
190190

@@ -196,7 +196,7 @@ def _helpTextWidget(self, item: types.Item) -> list[gui_lib.Element]: ...
196196

197197
### PySimpleGUIWrapper()._inputText
198198

199-
[Show source in pysimplegui_wrapper.py:66](../../../../cli2gui/gui/pysimplegui_wrapper.py#L66)
199+
[Show source in pysimplegui_wrapper.py:69](../../../../cli2gui/gui/pysimplegui_wrapper.py#L69)
200200

201201
Return an input text field.
202202

@@ -208,7 +208,7 @@ def _inputText(self, key: str, default: str | None = None) -> gui_lib.Element: .
208208

209209
### PySimpleGUIWrapper()._label
210210

211-
[Show source in pysimplegui_wrapper.py:106](../../../../cli2gui/gui/pysimplegui_wrapper.py#L106)
211+
[Show source in pysimplegui_wrapper.py:109](../../../../cli2gui/gui/pysimplegui_wrapper.py#L109)
212212

213213
Return a label.
214214

@@ -220,7 +220,7 @@ def _label(self, text: str, font: int = 11) -> gui_lib.Element: ...
220220

221221
### PySimpleGUIWrapper()._spin
222222

223-
[Show source in pysimplegui_wrapper.py:76](../../../../cli2gui/gui/pysimplegui_wrapper.py#L76)
223+
[Show source in pysimplegui_wrapper.py:79](../../../../cli2gui/gui/pysimplegui_wrapper.py#L79)
224224

225225
Return an input text field.
226226

@@ -232,7 +232,7 @@ def _spin(self, key: str, default: str | None = None) -> gui_lib.Element: ...
232232

233233
### PySimpleGUIWrapper()._title
234234

235-
[Show source in pysimplegui_wrapper.py:167](../../../../cli2gui/gui/pysimplegui_wrapper.py#L167)
235+
[Show source in pysimplegui_wrapper.py:170](../../../../cli2gui/gui/pysimplegui_wrapper.py#L170)
236236

237237
Return a set of self that make up the application header.
238238

@@ -244,7 +244,7 @@ def _title(self, text: str, image: str = "") -> list[gui_lib.Element]: ...
244244

245245
### PySimpleGUIWrapper().addItemsAndGroups
246246

247-
[Show source in pysimplegui_wrapper.py:317](../../../../cli2gui/gui/pysimplegui_wrapper.py#L317)
247+
[Show source in pysimplegui_wrapper.py:320](../../../../cli2gui/gui/pysimplegui_wrapper.py#L320)
248248

249249
Items and groups and return a list of psg Elements.
250250

@@ -263,7 +263,7 @@ def addItemsAndGroups(self, section: types.Group) -> list[list[gui_lib.Element]]
263263

264264
### PySimpleGUIWrapper().addWidgetFromItem
265265

266-
[Show source in pysimplegui_wrapper.py:239](../../../../cli2gui/gui/pysimplegui_wrapper.py#L239)
266+
[Show source in pysimplegui_wrapper.py:242](../../../../cli2gui/gui/pysimplegui_wrapper.py#L242)
267267

268268
Select a widget based on the item type.
269269

@@ -277,7 +277,7 @@ def addWidgetFromItem(self, item: types.Item) -> list[gui_lib.Element]: ...
277277

278278
### PySimpleGUIWrapper().createLayout
279279

280-
[Show source in pysimplegui_wrapper.py:342](../../../../cli2gui/gui/pysimplegui_wrapper.py#L342)
280+
[Show source in pysimplegui_wrapper.py:345](../../../../cli2gui/gui/pysimplegui_wrapper.py#L345)
281281

282282
Create the pysimplegui layout from the build spec.
283283

@@ -302,7 +302,7 @@ def createLayout(
302302

303303
### PySimpleGUIWrapper().generatePopup
304304

305-
[Show source in pysimplegui_wrapper.py:257](../../../../cli2gui/gui/pysimplegui_wrapper.py#L257)
305+
[Show source in pysimplegui_wrapper.py:260](../../../../cli2gui/gui/pysimplegui_wrapper.py#L260)
306306

307307
Create the popup window.
308308

@@ -328,7 +328,7 @@ def generatePopup(
328328

329329
### PySimpleGUIWrapper().getImgData
330330

331-
[Show source in pysimplegui_wrapper.py:456](../../../../cli2gui/gui/pysimplegui_wrapper.py#L456)
331+
[Show source in pysimplegui_wrapper.py:459](../../../../cli2gui/gui/pysimplegui_wrapper.py#L459)
332332

333333
Generate image data using PIL.
334334

@@ -340,7 +340,7 @@ def getImgData(self, imagePath: str, first: bool = False) -> bytes: ...
340340

341341
### PySimpleGUIWrapper().main
342342

343-
[Show source in pysimplegui_wrapper.py:411](../../../../cli2gui/gui/pysimplegui_wrapper.py#L411)
343+
[Show source in pysimplegui_wrapper.py:414](../../../../cli2gui/gui/pysimplegui_wrapper.py#L414)
344344

345345
Run the gui (psg) with a given buildSpec, quit_callback, and run_callback.
346346

‎documentation/reference/cli2gui/types.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ Supported gui types.
5151
DEFAULT = "pysimplegui"
5252
WEB = "pysimpleguiweb"
5353
QT = "pysimpleguiqt"
54+
FSG = "freesimplegui"
5455

5556
#### Signature
5657

‎requirements_optional.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ PySimpleGUIWeb<2,>=0.39.0
44
PyYAML<7,>=6.0.1
55
catpandoc<2026,>=2024
66
dearpygui<2,>=1.11.1
7+
freesimplegui<6,>=5.1.1
78
getostheme<2026,>=2024.0.1
89
pysimplegui<6,>=5.0.3
9-
freesimplegui<6,>=5.0.0

0 commit comments

Comments
 (0)