Skip to content

Commit 805727f

Browse files
committed
Get the latest docstrings from PySimpleGUI on github so that the SDK docs online match.
1 parent 6a64f8c commit 805727f

4 files changed

Lines changed: 46 additions & 40 deletions

File tree

docs/call reference.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11420,15 +11420,13 @@ Parameter Descriptions:
1142011420

1142111421
### get
1142211422

11423-
Dummy function for tkinter port. In the Qt port you can read back the values in the table in case they were
11424-
edited. Don't know yet how to enable editing of a Tree in tkinter so just returning the values provided by
11425-
user when Table was created or Updated.
11423+
Get the selected rows using tktiner's selection method. Experimenting with this change....
1142611424

1142711425
`get()`
1142811426

1142911427
|Type|Name|Meaning|
1143011428
|---|---|---|
11431-
|List[List[Any]]| **return** | the current table values (for now what was originally provided up updated) |
11429+
|List[List[Any]]| **return** | the current table values |
1143211430

1143311431
### get_next_focus
1143411432

@@ -11652,15 +11650,13 @@ The following methods are here for backwards compatibility reference. You will
1165211650

1165311651
### Get
1165411652

11655-
Dummy function for tkinter port. In the Qt port you can read back the values in the table in case they were
11656-
edited. Don't know yet how to enable editing of a Tree in tkinter so just returning the values provided by
11657-
user when Table was created or Updated.
11653+
Get the selected rows using tktiner's selection method. Experimenting with this change....
1165811654

1165911655
`Get()`
1166011656

1166111657
|Type|Name|Meaning|
1166211658
|---|---|---|
11663-
|List[List[Any]]| **return** | the current table values (for now what was originally provided up updated) |
11659+
|List[List[Any]]| **return** | the current table values |
1166411660

1166511661
### SetFocus
1166611662

@@ -14919,6 +14915,7 @@ Parameter Descriptions:
1491914915
| str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. |
1492014916
| str | locale | defines the locale used to get day names |
1492114917
| str | format | formats result using this strftime format |
14918+
| int | begin_at_sunday_plus | Determines the left-most day in the display. 0=sunday, 1=monday, etc |
1492214919
| List[str] | month_names | optional list of month names to use (should be 12 items) |
1492314920
| List[str] | day_abbreviations | optional list of abbreviations to display as the day of week |
1492414921
| str | title | Title shown on the date chooser window |
@@ -16571,11 +16568,11 @@ Parameter Descriptions:
1657116568

1657216569
|Type|Name|Meaning|
1657316570
|--|--|--|
16574-
| str | title | text to display in eleemnt |
16571+
| str | title | text to display in titlebar of window |
1657516572
| int | current_value | current value |
16576-
| int | max_value | max value of QuickMeter |
16577-
| Any | *args | stuff to output |
16578-
| str or int or tuple or object | key | Used to differentiate between mutliple meters. Used to cancel meter early. Now optional as there is a default value for single meters |
16573+
| int | max_value | max value of progress meter |
16574+
| Any | *args | stuff to output as text in the window along with the meter |
16575+
| str or int or tuple or object | key | Used to differentiate between multiple meters. Used to cancel meter early. Now optional as there is a default value for single meters |
1657916576
| str | orientation | 'horizontal' or 'vertical' ('h' or 'v' work) (Default value = 'vertical' / 'v') |
1658016577
| (str, str) or str | bar_color | The 2 colors that make up a progress bar. Either a tuple of 2 strings or a string. Tuple - (bar, background). A string with 1 color changes the background of the bar only. A string with 2 colors separated by "on" like "red on blue" specifies a red bar on a blue background. |
1658116578
| (str, str) or str | button_color | button color (foreground, background) |
@@ -16625,11 +16622,11 @@ Parameter Descriptions:
1662516622

1662616623
|Type|Name|Meaning|
1662716624
|--|--|--|
16628-
| str | title | text to display in eleemnt |
16625+
| str | title | text to display in titlebar of window |
1662916626
| int | current_value | current value |
16630-
| int | max_value | max value of QuickMeter |
16631-
| Any | *args | stuff to output |
16632-
| str or int or tuple or object | key | Used to differentiate between mutliple meters. Used to cancel meter early. Now optional as there is a default value for single meters |
16627+
| int | max_value | max value of progress meter |
16628+
| Any | *args | stuff to output as text in the window along with the meter |
16629+
| str or int or tuple or object | key | Used to differentiate between multiple meters. Used to cancel meter early. Now optional as there is a default value for single meters |
1663316630
| str | orientation | 'horizontal' or 'vertical' ('h' or 'v' work) (Default value = 'vertical' / 'v') |
1663416631
| (str, str) or str | bar_color | The 2 colors that make up a progress bar. Either a tuple of 2 strings or a string. Tuple - (bar, background). A string with 1 color changes the background of the bar only. A string with 2 colors separated by "on" like "red on blue" specifies a red bar on a blue background. |
1663516632
| (str, str) or str | button_color | button color (foreground, background) |
@@ -16942,6 +16939,9 @@ popup_get_date(start_mon = None,
1694216939
locale = None,
1694316940
month_names = None,
1694416941
day_abbreviations = None,
16942+
day_font = "TkFixedFont 9",
16943+
mon_year_font = "TkFixedFont 10",
16944+
arrow_font = "TkFixedFont 7",
1694516945
modal = True)
1694616946
```
1694716947

@@ -16963,6 +16963,9 @@ Parameter Descriptions:
1696316963
| bool | keep_on_top | If True the window will remain above all current windows |
1696416964
| List[str] | month_names | optional list of month names to use (should be 12 items) |
1696516965
| List[str] | day_abbreviations | optional list of abbreviations to display as the day of week |
16966+
| str or tuple | day_font | Font and size to use for the calendar |
16967+
| str or tuple | mon_year_font | Font and size to use for the month and year at the top |
16968+
| str or tuple | arrow_font | Font and size to use for the arrow buttons |
1696616969
| bool | modal | If True then makes the popup will behave like a Modal window... all other windows are non-operational until this one is closed. Default = True |
1696716970
| None or (int, int, int) | **RETURN** | Tuple containing (month, day, year) of chosen date or None if was cancelled
1696816971

docs/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2078,11 +2078,11 @@ Parameter Descriptions:
20782078

20792079
|Type|Name|Meaning|
20802080
|--|--|--|
2081-
| str | title | text to display in eleemnt |
2081+
| str | title | text to display in titlebar of window |
20822082
| int | current_value | current value |
2083-
| int | max_value | max value of QuickMeter |
2084-
| Any | *args | stuff to output |
2085-
| str or int or tuple or object | key | Used to differentiate between mutliple meters. Used to cancel meter early. Now optional as there is a default value for single meters |
2083+
| int | max_value | max value of progress meter |
2084+
| Any | *args | stuff to output as text in the window along with the meter |
2085+
| str or int or tuple or object | key | Used to differentiate between multiple meters. Used to cancel meter early. Now optional as there is a default value for single meters |
20862086
| str | orientation | 'horizontal' or 'vertical' ('h' or 'v' work) (Default value = 'vertical' / 'v') |
20872087
| (str, str) or str | bar_color | The 2 colors that make up a progress bar. Either a tuple of 2 strings or a string. Tuple - (bar, background). A string with 1 color changes the background of the bar only. A string with 2 colors separated by "on" like "red on blue" specifies a red bar on a blue background. |
20882088
| (str, str) or str | button_color | button color (foreground, background) |

readme_creator/output/call reference.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11420,15 +11420,13 @@ Parameter Descriptions:
1142011420

1142111421
### get
1142211422

11423-
Dummy function for tkinter port. In the Qt port you can read back the values in the table in case they were
11424-
edited. Don't know yet how to enable editing of a Tree in tkinter so just returning the values provided by
11425-
user when Table was created or Updated.
11423+
Get the selected rows using tktiner's selection method. Experimenting with this change....
1142611424

1142711425
`get()`
1142811426

1142911427
|Type|Name|Meaning|
1143011428
|---|---|---|
11431-
|List[List[Any]]| **return** | the current table values (for now what was originally provided up updated) |
11429+
|List[List[Any]]| **return** | the current table values |
1143211430

1143311431
### get_next_focus
1143411432

@@ -11652,15 +11650,13 @@ The following methods are here for backwards compatibility reference. You will
1165211650

1165311651
### Get
1165411652

11655-
Dummy function for tkinter port. In the Qt port you can read back the values in the table in case they were
11656-
edited. Don't know yet how to enable editing of a Tree in tkinter so just returning the values provided by
11657-
user when Table was created or Updated.
11653+
Get the selected rows using tktiner's selection method. Experimenting with this change....
1165811654

1165911655
`Get()`
1166011656

1166111657
|Type|Name|Meaning|
1166211658
|---|---|---|
11663-
|List[List[Any]]| **return** | the current table values (for now what was originally provided up updated) |
11659+
|List[List[Any]]| **return** | the current table values |
1166411660

1166511661
### SetFocus
1166611662

@@ -14919,6 +14915,7 @@ Parameter Descriptions:
1491914915
| str or int or tuple or object | k | Same as the Key. You can use either k or key. Which ever is set will be used. |
1492014916
| str | locale | defines the locale used to get day names |
1492114917
| str | format | formats result using this strftime format |
14918+
| int | begin_at_sunday_plus | Determines the left-most day in the display. 0=sunday, 1=monday, etc |
1492214919
| List[str] | month_names | optional list of month names to use (should be 12 items) |
1492314920
| List[str] | day_abbreviations | optional list of abbreviations to display as the day of week |
1492414921
| str | title | Title shown on the date chooser window |
@@ -16571,11 +16568,11 @@ Parameter Descriptions:
1657116568

1657216569
|Type|Name|Meaning|
1657316570
|--|--|--|
16574-
| str | title | text to display in eleemnt |
16571+
| str | title | text to display in titlebar of window |
1657516572
| int | current_value | current value |
16576-
| int | max_value | max value of QuickMeter |
16577-
| Any | *args | stuff to output |
16578-
| str or int or tuple or object | key | Used to differentiate between mutliple meters. Used to cancel meter early. Now optional as there is a default value for single meters |
16573+
| int | max_value | max value of progress meter |
16574+
| Any | *args | stuff to output as text in the window along with the meter |
16575+
| str or int or tuple or object | key | Used to differentiate between multiple meters. Used to cancel meter early. Now optional as there is a default value for single meters |
1657916576
| str | orientation | 'horizontal' or 'vertical' ('h' or 'v' work) (Default value = 'vertical' / 'v') |
1658016577
| (str, str) or str | bar_color | The 2 colors that make up a progress bar. Either a tuple of 2 strings or a string. Tuple - (bar, background). A string with 1 color changes the background of the bar only. A string with 2 colors separated by "on" like "red on blue" specifies a red bar on a blue background. |
1658116578
| (str, str) or str | button_color | button color (foreground, background) |
@@ -16625,11 +16622,11 @@ Parameter Descriptions:
1662516622

1662616623
|Type|Name|Meaning|
1662716624
|--|--|--|
16628-
| str | title | text to display in eleemnt |
16625+
| str | title | text to display in titlebar of window |
1662916626
| int | current_value | current value |
16630-
| int | max_value | max value of QuickMeter |
16631-
| Any | *args | stuff to output |
16632-
| str or int or tuple or object | key | Used to differentiate between mutliple meters. Used to cancel meter early. Now optional as there is a default value for single meters |
16627+
| int | max_value | max value of progress meter |
16628+
| Any | *args | stuff to output as text in the window along with the meter |
16629+
| str or int or tuple or object | key | Used to differentiate between multiple meters. Used to cancel meter early. Now optional as there is a default value for single meters |
1663316630
| str | orientation | 'horizontal' or 'vertical' ('h' or 'v' work) (Default value = 'vertical' / 'v') |
1663416631
| (str, str) or str | bar_color | The 2 colors that make up a progress bar. Either a tuple of 2 strings or a string. Tuple - (bar, background). A string with 1 color changes the background of the bar only. A string with 2 colors separated by "on" like "red on blue" specifies a red bar on a blue background. |
1663516632
| (str, str) or str | button_color | button color (foreground, background) |
@@ -16942,6 +16939,9 @@ popup_get_date(start_mon = None,
1694216939
locale = None,
1694316940
month_names = None,
1694416941
day_abbreviations = None,
16942+
day_font = "TkFixedFont 9",
16943+
mon_year_font = "TkFixedFont 10",
16944+
arrow_font = "TkFixedFont 7",
1694516945
modal = True)
1694616946
```
1694716947

@@ -16963,6 +16963,9 @@ Parameter Descriptions:
1696316963
| bool | keep_on_top | If True the window will remain above all current windows |
1696416964
| List[str] | month_names | optional list of month names to use (should be 12 items) |
1696516965
| List[str] | day_abbreviations | optional list of abbreviations to display as the day of week |
16966+
| str or tuple | day_font | Font and size to use for the calendar |
16967+
| str or tuple | mon_year_font | Font and size to use for the month and year at the top |
16968+
| str or tuple | arrow_font | Font and size to use for the arrow buttons |
1696616969
| bool | modal | If True then makes the popup will behave like a Modal window... all other windows are non-operational until this one is closed. Default = True |
1696716970
| None or (int, int, int) | **RETURN** | Tuple containing (month, day, year) of chosen date or None if was cancelled
1696816971

readme_creator/output/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2078,11 +2078,11 @@ Parameter Descriptions:
20782078

20792079
|Type|Name|Meaning|
20802080
|--|--|--|
2081-
| str | title | text to display in eleemnt |
2081+
| str | title | text to display in titlebar of window |
20822082
| int | current_value | current value |
2083-
| int | max_value | max value of QuickMeter |
2084-
| Any | *args | stuff to output |
2085-
| str or int or tuple or object | key | Used to differentiate between mutliple meters. Used to cancel meter early. Now optional as there is a default value for single meters |
2083+
| int | max_value | max value of progress meter |
2084+
| Any | *args | stuff to output as text in the window along with the meter |
2085+
| str or int or tuple or object | key | Used to differentiate between multiple meters. Used to cancel meter early. Now optional as there is a default value for single meters |
20862086
| str | orientation | 'horizontal' or 'vertical' ('h' or 'v' work) (Default value = 'vertical' / 'v') |
20872087
| (str, str) or str | bar_color | The 2 colors that make up a progress bar. Either a tuple of 2 strings or a string. Tuple - (bar, background). A string with 1 color changes the background of the bar only. A string with 2 colors separated by "on" like "red on blue" specifies a red bar on a blue background. |
20882088
| (str, str) or str | button_color | button color (foreground, background) |

0 commit comments

Comments
 (0)