diff --git a/Taskfile.yml b/Taskfile.yml index e17df28..e8d404e 100644 --- a/Taskfile.yml +++ b/Taskfile.yml @@ -7,6 +7,7 @@ tasks: check: cmds: - ruff check + - mypy TkEasyGUI/ test: cmds: - ruff check diff --git a/docs/README.md b/docs/README.md index ad1e315..821d9ff 100644 --- a/docs/README.md +++ b/docs/README.md @@ -64,3 +64,7 @@ Here is a list of elements: ### TkEasyGUI Original features - [Custom Events](https://github.com/kujirahand/tkeasygui-python/blob/main/docs/custom_events.md) + +### Package developper + +- [TkEasyGUI Package Developer's Guide](/docs/dev.md) diff --git a/docs/TkEasyGUI/widgets-py.md b/docs/TkEasyGUI/widgets-py.md index 6c44871..ae47947 100644 --- a/docs/TkEasyGUI/widgets-py.md +++ b/docs/TkEasyGUI/widgets-py.md @@ -95,72 +95,187 @@ class Button( ### Methods of Button - +- [bind](#buttonbind) +- [bind_events](#buttonbind_events) +- [create](#buttoncreate) +- [disptach_event](#buttondisptach_event) +- [get](#buttonget) +- [get_height](#buttonget_height) +- [get_name](#buttonget_name) +- [get_prev_widget](#buttonget_prev_widget) +- [get_text](#buttonget_text) +- [get_width](#buttonget_width) +- [post_create](#buttonpost_create) +- [prepare_create](#buttonprepare_create) +- [set_button_color](#buttonset_button_color) +- [set_disabled](#buttonset_disabled) +- [set_text](#buttonset_text) +- [update](#buttonupdate) ### Button.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) + ### Button.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) + ### Button.create Create a Button widget. +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) + ### Button.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) + ### Button.get Returns the text of the button.. +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) + ### Button.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) + ### Button.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) + ### Button.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) + ### Button.get_text Get the text of the button. +```py +def get_text(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) + ### Button.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) + ### Button.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) + ### Button.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) + ### Button.set_button_color Set the button color. +```py +def set_button_color(self, button_color: Union[str, tuple[str,str]], update: bool = True) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) + ### Button.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) + ### Button.set_text Set the text of the button. +```py +def set_text(self, text: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) + ### Button.update Update the widget. +```py +def update(self, + text: Union[str, None] = None, + disabled: Union[bool, None] = None, + button_color: Union[str, tuple[str,str], None] = None, + **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) + ## CalendarBrowse CalendarBrowse element. @@ -185,66 +300,170 @@ class CalendarBrowse( ### Methods of CalendarBrowse - +- [bind](#calendarbrowsebind) +- [bind_events](#calendarbrowsebind_events) +- [create](#calendarbrowsecreate) +- [disptach_event](#calendarbrowsedisptach_event) +- [get](#calendarbrowseget) +- [get_height](#calendarbrowseget_height) +- [get_name](#calendarbrowseget_name) +- [get_prev_widget](#calendarbrowseget_prev_widget) +- [get_width](#calendarbrowseget_width) +- [post_create](#calendarbrowsepost_create) +- [prepare_create](#calendarbrowseprepare_create) +- [set_disabled](#calendarbrowseset_disabled) +- [set_text](#calendarbrowseset_text) +- [show_dialog](#calendarbrowseshow_dialog) +- [update](#calendarbrowseupdate) ### CalendarBrowse.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3785) + ### CalendarBrowse.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3785) + ### CalendarBrowse.create +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3785) + ### CalendarBrowse.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3785) + ### CalendarBrowse.get Get the value of the widget. +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3785) + ### CalendarBrowse.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3785) + ### CalendarBrowse.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3785) + ### CalendarBrowse.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3785) + ### CalendarBrowse.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3785) + ### CalendarBrowse.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3785) + ### CalendarBrowse.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3785) + ### CalendarBrowse.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3785) + ### CalendarBrowse.set_text Set the text of the button. +```py +def set_text(self, text: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3785) + ### CalendarBrowse.show_dialog Show file dialog +```py +def show_dialog(self, *args) -> Union[str, None]: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3785) + ### CalendarBrowse.update Update the widget. +```py +def update(self, text: Union[str, None] = None, **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3785) + ## CalendarButton CalendarButton element. (alias of CalendarBrowse) @@ -269,66 +488,170 @@ class CalendarButton( ### Methods of CalendarButton - +- [bind](#calendarbuttonbind) +- [bind_events](#calendarbuttonbind_events) +- [create](#calendarbuttoncreate) +- [disptach_event](#calendarbuttondisptach_event) +- [get](#calendarbuttonget) +- [get_height](#calendarbuttonget_height) +- [get_name](#calendarbuttonget_name) +- [get_prev_widget](#calendarbuttonget_prev_widget) +- [get_width](#calendarbuttonget_width) +- [post_create](#calendarbuttonpost_create) +- [prepare_create](#calendarbuttonprepare_create) +- [set_disabled](#calendarbuttonset_disabled) +- [set_text](#calendarbuttonset_text) +- [show_dialog](#calendarbuttonshow_dialog) +- [update](#calendarbuttonupdate) ### CalendarButton.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3785) + ### CalendarButton.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3785) + ### CalendarButton.create +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3785) + ### CalendarButton.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3785) + ### CalendarButton.get Get the value of the widget. +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3785) + ### CalendarButton.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3785) + ### CalendarButton.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3785) + ### CalendarButton.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3785) + ### CalendarButton.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3785) + ### CalendarButton.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3785) + ### CalendarButton.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3785) + ### CalendarButton.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3785) + ### CalendarButton.set_text Set the text of the button. +```py +def set_text(self, text: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3785) + ### CalendarButton.show_dialog Show file dialog +```py +def show_dialog(self, *args) -> Union[str, None]: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3785) + ### CalendarButton.update Update the widget. +```py +def update(self, text: Union[str, None] = None, **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3785) + ## Canvas Canvas element. @@ -351,62 +674,159 @@ class Canvas( ### Methods of Canvas - +- [bind](#canvasbind) +- [bind_events](#canvasbind_events) +- [clear](#canvasclear) +- [create](#canvascreate) +- [disptach_event](#canvasdisptach_event) +- [get](#canvasget) +- [get_height](#canvasget_height) +- [get_name](#canvasget_name) +- [get_prev_widget](#canvasget_prev_widget) +- [get_width](#canvasget_width) +- [post_create](#canvaspost_create) +- [prepare_create](#canvasprepare_create) +- [set_disabled](#canvasset_disabled) +- [update](#canvasupdate) ### Canvas.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2747) + ### Canvas.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2747) + ### Canvas.clear Clear the canvas. +```py +def clear(self) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2747) + ### Canvas.create +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2747) + ### Canvas.disptach_event Dispatch event -### Canvas.get - +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2747) + +### Canvas.get + Return Widget +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2747) + ### Canvas.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2747) + ### Canvas.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2747) + ### Canvas.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2747) + ### Canvas.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2747) + ### Canvas.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2747) + ### Canvas.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2747) + ### Canvas.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2747) + ### Canvas.update Update the widget. +```py +def update(self, *args, **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2747) + ## Checkbox Checkbox element. @@ -427,70 +847,181 @@ class Checkbox( ### Methods of Checkbox - +- [bind](#checkboxbind) +- [bind_events](#checkboxbind_events) +- [create](#checkboxcreate) +- [disptach_event](#checkboxdisptach_event) +- [get](#checkboxget) +- [get_height](#checkboxget_height) +- [get_name](#checkboxget_name) +- [get_prev_widget](#checkboxget_prev_widget) +- [get_value](#checkboxget_value) +- [get_width](#checkboxget_width) +- [post_create](#checkboxpost_create) +- [prepare_create](#checkboxprepare_create) +- [set_disabled](#checkboxset_disabled) +- [set_text](#checkboxset_text) +- [set_value](#checkboxset_value) +- [update](#checkboxupdate) ### Checkbox.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1914) + ### Checkbox.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1914) + ### Checkbox.create +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1914) + ### Checkbox.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1914) + ### Checkbox.get Get the value of the widget. +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1914) + ### Checkbox.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1914) + ### Checkbox.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1914) + ### Checkbox.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1914) + ### Checkbox.get_value Get the value of the widget. +```py +def get_value(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1914) + ### Checkbox.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1914) + ### Checkbox.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1914) + ### Checkbox.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1914) + ### Checkbox.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1914) + ### Checkbox.set_text Set the text of the widget. +```py +def set_text(self, text: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1914) + ### Checkbox.set_value Set the value of the widget. +```py +def set_value(self, b: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1914) + ### Checkbox.update Update the widget. +```py +def update(self, *args, **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1914) + ## CloseButton CloseButton element. @@ -508,76 +1039,198 @@ class CloseButton( ### Methods of CloseButton - +- [bind](#closebuttonbind) +- [bind_events](#closebuttonbind_events) +- [close_window](#closebuttonclose_window) +- [create](#closebuttoncreate) +- [disptach_event](#closebuttondisptach_event) +- [get](#closebuttonget) +- [get_height](#closebuttonget_height) +- [get_name](#closebuttonget_name) +- [get_prev_widget](#closebuttonget_prev_widget) +- [get_text](#closebuttonget_text) +- [get_width](#closebuttonget_width) +- [post_create](#closebuttonpost_create) +- [prepare_create](#closebuttonprepare_create) +- [set_button_color](#closebuttonset_button_color) +- [set_disabled](#closebuttonset_disabled) +- [set_text](#closebuttonset_text) +- [update](#closebuttonupdate) ### CloseButton.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1885) + ### CloseButton.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1885) + ### CloseButton.close_window Close the window. +```py +def close_window(self) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1885) + ### CloseButton.create Create a Button widget. +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1885) + ### CloseButton.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1885) + ### CloseButton.get Returns the text of the button.. +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1885) + ### CloseButton.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1885) + ### CloseButton.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1885) + ### CloseButton.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1885) + ### CloseButton.get_text Get the text of the button. +```py +def get_text(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1885) + ### CloseButton.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1885) + ### CloseButton.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1885) + ### CloseButton.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1885) + ### CloseButton.set_button_color Set the button color. +```py +def set_button_color(self, button_color: Union[str, tuple[str,str]], update: bool = True) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1885) + ### CloseButton.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1885) + ### CloseButton.set_text Set the text of the button. +```py +def set_text(self, text: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1885) + ### CloseButton.update Update the widget. +```py +def update(self, + text: Union[str, None] = None, + disabled: Union[bool, None] = None, + button_color: Union[str, tuple[str,str], None] = None, + **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1885) + ## ColorBrowse FolderBrowse element. @@ -601,66 +1254,170 @@ class ColorBrowse( ### Methods of ColorBrowse - +- [bind](#colorbrowsebind) +- [bind_events](#colorbrowsebind_events) +- [create](#colorbrowsecreate) +- [disptach_event](#colorbrowsedisptach_event) +- [get](#colorbrowseget) +- [get_height](#colorbrowseget_height) +- [get_name](#colorbrowseget_name) +- [get_prev_widget](#colorbrowseget_prev_widget) +- [get_width](#colorbrowseget_width) +- [post_create](#colorbrowsepost_create) +- [prepare_create](#colorbrowseprepare_create) +- [set_disabled](#colorbrowseset_disabled) +- [set_text](#colorbrowseset_text) +- [show_dialog](#colorbrowseshow_dialog) +- [update](#colorbrowseupdate) ### ColorBrowse.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3651) + ### ColorBrowse.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3651) + ### ColorBrowse.create +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3651) + ### ColorBrowse.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3651) + ### ColorBrowse.get Get the value of the widget. +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3651) + ### ColorBrowse.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3651) + ### ColorBrowse.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3651) + ### ColorBrowse.get_prev_widget Get the previous widget. -### ColorBrowse.get_width +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3651) + +### ColorBrowse.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3651) + ### ColorBrowse.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3651) + ### ColorBrowse.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3651) + ### ColorBrowse.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3651) + ### ColorBrowse.set_text Set the text of the button. +```py +def set_text(self, text: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3651) + ### ColorBrowse.show_dialog Show file dialog +```py +def show_dialog(self, *args) -> Union[str, None]: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3651) + ### ColorBrowse.update Update the widget. +```py +def update(self, text: Union[str, None] = None, **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3651) + ## Column Frame element. @@ -689,58 +1446,148 @@ class Column( ### Methods of Column - +- [bind](#columnbind) +- [bind_events](#columnbind_events) +- [create](#columncreate) +- [disptach_event](#columndisptach_event) +- [get](#columnget) +- [get_height](#columnget_height) +- [get_name](#columnget_name) +- [get_prev_widget](#columnget_prev_widget) +- [get_width](#columnget_width) +- [post_create](#columnpost_create) +- [prepare_create](#columnprepare_create) +- [set_disabled](#columnset_disabled) +- [update](#columnupdate) ### Column.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1367) + ### Column.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1367) + ### Column.create +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1367) + ### Column.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1367) + ### Column.get Return Widget +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1367) + ### Column.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1367) + ### Column.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1367) + ### Column.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1367) + ### Column.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1367) + ### Column.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1367) + ### Column.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1367) + ### Column.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1367) + ### Column.update Update the widget. +```py +def update(self, *args, **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1367) + ## Combo Combo element. @@ -763,72 +1610,183 @@ class Combo( ### Methods of Combo - +- [bind](#combobind) +- [bind_events](#combobind_events) +- [create](#combocreate) +- [disptach_event](#combodisptach_event) +- [get](#comboget) +- [get_height](#comboget_height) +- [get_name](#comboget_name) +- [get_prev_widget](#comboget_prev_widget) +- [get_width](#comboget_width) +- [post_create](#combopost_create) +- [prepare_create](#comboprepare_create) +- [set_disabled](#comboset_disabled) +- [set_readonly](#comboset_readonly) +- [set_value](#comboset_value) +- [set_values](#comboset_values) +- [update](#comboupdate) ### Combo.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3183) + ### Combo.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3183) + ### Combo.create [Combo.create] create Listbox widget +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3183) + ### Combo.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3183) + ### Combo.get Get the value of the widget. +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3183) + ### Combo.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3183) + ### Combo.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3183) + ### Combo.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3183) + ### Combo.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3183) + ### Combo.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3183) + ### Combo.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3183) + ### Combo.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3183) + ### Combo.set_readonly set readonly +```py +def set_readonly(self, readonly: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3183) + ### Combo.set_value Set the value of the widget. +```py +def set_value(self, v: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3183) + ### Combo.set_values Set values to list +```py +def set_values(self, values: list[str]) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3183) + ### Combo.update Update the widget. +```py +def update(self, *args, **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3183) + ## Element Element class. @@ -848,60 +1806,150 @@ class Element( ### Methods of Element - +- [bind](#elementbind) +- [bind_events](#elementbind_events) +- [create](#elementcreate) +- [disptach_event](#elementdisptach_event) +- [get](#elementget) +- [get_height](#elementget_height) +- [get_name](#elementget_name) +- [get_prev_widget](#elementget_prev_widget) +- [get_width](#elementget_width) +- [post_create](#elementpost_create) +- [prepare_create](#elementprepare_create) +- [set_disabled](#elementset_disabled) +- [update](#elementupdate) ### Element.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L963) + ### Element.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L963) + ### Element.create Create a widget. +```py +def create(self, win: Window, parent: tk.Widget) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L963) + ### Element.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L963) + ### Element.get Get the value of the widget. +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L963) + ### Element.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L963) + ### Element.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L963) + ### Element.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L963) + ### Element.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L963) + ### Element.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L963) + ### Element.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L963) + ### Element.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L963) + ### Element.update update widget configuration. +```py +def update(self, *args, **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L963) + ## FileBrowse FileBrowse element. @@ -927,66 +1975,170 @@ class FileBrowse( ### Methods of FileBrowse - +- [bind](#filebrowsebind) +- [bind_events](#filebrowsebind_events) +- [create](#filebrowsecreate) +- [disptach_event](#filebrowsedisptach_event) +- [get](#filebrowseget) +- [get_height](#filebrowseget_height) +- [get_name](#filebrowseget_name) +- [get_prev_widget](#filebrowseget_prev_widget) +- [get_width](#filebrowseget_width) +- [post_create](#filebrowsepost_create) +- [prepare_create](#filebrowseprepare_create) +- [set_disabled](#filebrowseset_disabled) +- [set_text](#filebrowseset_text) +- [show_dialog](#filebrowseshow_dialog) +- [update](#filebrowseupdate) ### FileBrowse.bind Bind event. @see [Window.bind](#windowbind) -### FileBrowse.bind_events +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3478) + +### FileBrowse.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3478) + ### FileBrowse.create +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3478) + ### FileBrowse.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3478) + ### FileBrowse.get Get the value of the widget. +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3478) + ### FileBrowse.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3478) + ### FileBrowse.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3478) + ### FileBrowse.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3478) + ### FileBrowse.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3478) + ### FileBrowse.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3478) + ### FileBrowse.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3478) + ### FileBrowse.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3478) + ### FileBrowse.set_text Set the text of the button. +```py +def set_text(self, text: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3478) + ### FileBrowse.show_dialog Show file dialog +```py +def show_dialog(self, *args) -> Union[str, None]: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3478) + ### FileBrowse.update Update the widget. +```py +def update(self, text: Union[str, None] = None, **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3478) + ## FileSaveAs FileSaveAs element. (alias of FileSaveAsBrowse) @@ -1010,66 +2162,170 @@ class FileSaveAs( ### Methods of FileSaveAs - +- [bind](#filesaveasbind) +- [bind_events](#filesaveasbind_events) +- [create](#filesaveascreate) +- [disptach_event](#filesaveasdisptach_event) +- [get](#filesaveasget) +- [get_height](#filesaveasget_height) +- [get_name](#filesaveasget_name) +- [get_prev_widget](#filesaveasget_prev_widget) +- [get_width](#filesaveasget_width) +- [post_create](#filesaveaspost_create) +- [prepare_create](#filesaveasprepare_create) +- [set_disabled](#filesaveasset_disabled) +- [set_text](#filesaveasset_text) +- [show_dialog](#filesaveasshow_dialog) +- [update](#filesaveasupdate) ### FileSaveAs.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3588) + ### FileSaveAs.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3588) + ### FileSaveAs.create +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3588) + ### FileSaveAs.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3588) + ### FileSaveAs.get Get the value of the widget. +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3588) + ### FileSaveAs.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3588) + ### FileSaveAs.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3588) + ### FileSaveAs.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3588) + ### FileSaveAs.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3588) + ### FileSaveAs.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3588) + ### FileSaveAs.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3588) + ### FileSaveAs.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3588) + ### FileSaveAs.set_text Set the text of the button. +```py +def set_text(self, text: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3588) + ### FileSaveAs.show_dialog Show file dialog +```py +def show_dialog(self, *args) -> Union[str, None]: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3588) + ### FileSaveAs.update Update the widget. +```py +def update(self, text: Union[str, None] = None, **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3588) + ## FileSaveAsBrowse FileSaveAsBrowse element. @@ -1093,66 +2349,170 @@ class FileSaveAsBrowse( ### Methods of FileSaveAsBrowse - +- [bind](#filesaveasbrowsebind) +- [bind_events](#filesaveasbrowsebind_events) +- [create](#filesaveasbrowsecreate) +- [disptach_event](#filesaveasbrowsedisptach_event) +- [get](#filesaveasbrowseget) +- [get_height](#filesaveasbrowseget_height) +- [get_name](#filesaveasbrowseget_name) +- [get_prev_widget](#filesaveasbrowseget_prev_widget) +- [get_width](#filesaveasbrowseget_width) +- [post_create](#filesaveasbrowsepost_create) +- [prepare_create](#filesaveasbrowseprepare_create) +- [set_disabled](#filesaveasbrowseset_disabled) +- [set_text](#filesaveasbrowseset_text) +- [show_dialog](#filesaveasbrowseshow_dialog) +- [update](#filesaveasbrowseupdate) ### FileSaveAsBrowse.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3588) + ### FileSaveAsBrowse.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3588) + ### FileSaveAsBrowse.create +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3588) + ### FileSaveAsBrowse.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3588) + ### FileSaveAsBrowse.get Get the value of the widget. +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3588) + ### FileSaveAsBrowse.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3588) + ### FileSaveAsBrowse.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3588) + ### FileSaveAsBrowse.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3588) + ### FileSaveAsBrowse.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3588) + ### FileSaveAsBrowse.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3588) + ### FileSaveAsBrowse.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3588) + ### FileSaveAsBrowse.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3588) + ### FileSaveAsBrowse.set_text Set the text of the button. +```py +def set_text(self, text: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3588) + ### FileSaveAsBrowse.show_dialog Show file dialog +```py +def show_dialog(self, *args) -> Union[str, None]: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3588) + ### FileSaveAsBrowse.update Update the widget. +```py +def update(self, text: Union[str, None] = None, **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3588) + ## FilesBrowse FilesBrowse element. @@ -1176,66 +2536,170 @@ class FilesBrowse( ### Methods of FilesBrowse - +- [bind](#filesbrowsebind) +- [bind_events](#filesbrowsebind_events) +- [create](#filesbrowsecreate) +- [disptach_event](#filesbrowsedisptach_event) +- [get](#filesbrowseget) +- [get_height](#filesbrowseget_height) +- [get_name](#filesbrowseget_name) +- [get_prev_widget](#filesbrowseget_prev_widget) +- [get_width](#filesbrowseget_width) +- [post_create](#filesbrowsepost_create) +- [prepare_create](#filesbrowseprepare_create) +- [set_disabled](#filesbrowseset_disabled) +- [set_text](#filesbrowseset_text) +- [show_dialog](#filesbrowseshow_dialog) +- [update](#filesbrowseupdate) ### FilesBrowse.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3564) + ### FilesBrowse.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3564) + ### FilesBrowse.create +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3564) + ### FilesBrowse.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3564) + ### FilesBrowse.get Get the value of the widget. +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3564) + ### FilesBrowse.get_height Get height of element. -### FilesBrowse.get_name - +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3564) + +### FilesBrowse.get_name + Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3564) + ### FilesBrowse.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3564) + ### FilesBrowse.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3564) + ### FilesBrowse.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3564) + ### FilesBrowse.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3564) + ### FilesBrowse.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3564) + ### FilesBrowse.set_text Set the text of the button. +```py +def set_text(self, text: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3564) + ### FilesBrowse.show_dialog Show file dialog +```py +def show_dialog(self, *args) -> Union[str, None]: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3564) + ### FilesBrowse.update Update the widget. +```py +def update(self, text: Union[str, None] = None, **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3564) + ## FolderBrowse FolderBrowse element. @@ -1259,66 +2723,170 @@ class FolderBrowse( ### Methods of FolderBrowse - +- [bind](#folderbrowsebind) +- [bind_events](#folderbrowsebind_events) +- [create](#folderbrowsecreate) +- [disptach_event](#folderbrowsedisptach_event) +- [get](#folderbrowseget) +- [get_height](#folderbrowseget_height) +- [get_name](#folderbrowseget_name) +- [get_prev_widget](#folderbrowseget_prev_widget) +- [get_width](#folderbrowseget_width) +- [post_create](#folderbrowsepost_create) +- [prepare_create](#folderbrowseprepare_create) +- [set_disabled](#folderbrowseset_disabled) +- [set_text](#folderbrowseset_text) +- [show_dialog](#folderbrowseshow_dialog) +- [update](#folderbrowseupdate) ### FolderBrowse.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3616) + ### FolderBrowse.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3616) + ### FolderBrowse.create +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3616) + ### FolderBrowse.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3616) + ### FolderBrowse.get Get the value of the widget. +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3616) + ### FolderBrowse.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3616) + ### FolderBrowse.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3616) + ### FolderBrowse.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3616) + ### FolderBrowse.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3616) + ### FolderBrowse.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3616) + ### FolderBrowse.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3616) + ### FolderBrowse.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3616) + ### FolderBrowse.set_text Set the text of the button. +```py +def set_text(self, text: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3616) + ### FolderBrowse.show_dialog Show file dialog +```py +def show_dialog(self, *args) -> Union[str, None]: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3616) + ### FolderBrowse.update Update the widget. +```py +def update(self, text: Union[str, None] = None, **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3616) + ## Frame Frame element. @@ -1355,60 +2923,150 @@ class Frame( ### Methods of Frame - +- [bind](#framebind) +- [bind_events](#framebind_events) +- [create](#framecreate) +- [disptach_event](#framedisptach_event) +- [get](#frameget) +- [get_height](#frameget_height) +- [get_name](#frameget_name) +- [get_prev_widget](#frameget_prev_widget) +- [get_width](#frameget_width) +- [post_create](#framepost_create) +- [prepare_create](#frameprepare_create) +- [set_disabled](#frameset_disabled) +- [update](#frameupdate) ### Frame.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1298) + ### Frame.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1298) + ### Frame.create Create a Frame widget. +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1298) + ### Frame.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1298) + ### Frame.get Return Widget +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1298) + ### Frame.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1298) + ### Frame.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1298) + ### Frame.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1298) + ### Frame.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1298) + ### Frame.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1298) + ### Frame.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1298) + ### Frame.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1298) + ### Frame.update Update the widget. +```py +def update(self, *args, **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1298) + ## Graph Graph element. @@ -1430,102 +3088,269 @@ class Graph( ### Methods of Graph - +- [bind](#graphbind) +- [bind_events](#graphbind_events) +- [create](#graphcreate) +- [disptach_event](#graphdisptach_event) +- [draw_arc](#graphdraw_arc) +- [draw_circle](#graphdraw_circle) +- [draw_image](#graphdraw_image) +- [draw_line](#graphdraw_line) +- [draw_lines](#graphdraw_lines) +- [draw_oval](#graphdraw_oval) +- [draw_point](#graphdraw_point) +- [draw_polygon](#graphdraw_polygon) +- [draw_rectangle](#graphdraw_rectangle) +- [draw_text](#graphdraw_text) +- [erase](#grapherase) +- [get](#graphget) +- [get_height](#graphget_height) +- [get_name](#graphget_name) +- [get_prev_widget](#graphget_prev_widget) +- [get_width](#graphget_width) +- [post_create](#graphpost_create) +- [prepare_create](#graphprepare_create) +- [set_disabled](#graphset_disabled) +- [update](#graphupdate) ### Graph.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2792) + ### Graph.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2792) + ### Graph.create +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2792) + ### Graph.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2792) + ### Graph.draw_arc Draw an arc. +```py +def draw_arc(self, top_left: PointType, bottom_right: PointType, extent: Union[int, None] = None, start_angle: Union[int, None] = None, style: Union[str, None] = None, arc_color: Union[str, None] = 'black', line_width: int = 1, fill_color: Union[str, None] = None) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2792) + ### Graph.draw_circle Draw a circle. +```py +def draw_circle(self, center_location: PointType, radius: Union[int, float], fill_color: Union[str, None] = None, line_color: Union[str, None] = 'black', line_width: int = 1) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2792) + ### Graph.draw_image Draw image +```py +def draw_image(self, filename: Union[str, None] = None, data: Union[bytes, None] = None, location: Union[PointType, None] = None) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2792) + ### Graph.draw_line Draw a line. +```py +def draw_line(self, point_from: PointType, point_to: PointType, color: str = 'black', width: int = 1) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2792) + ### Graph.draw_lines Draw lines. +```py +def draw_lines(self, points: list[PointType], color='black', width=1) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2792) + ### Graph.draw_oval Draw an oval. +```py +def draw_oval(self, top_left: PointType, bottom_right: PointType, fill_color: Union[str, None] = None, line_color: Union[str, None] = None, line_width: int = 1): +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2792) + ### Graph.draw_point Draw a point. +```py +def draw_point(self, point: PointType, size: int = 2, color: str = 'black') -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2792) + ### Graph.draw_polygon Draw polygon +```py +def draw_polygon(self, points: list[PointType], fill_color: Union[str, None] = None, line_color: Union[str, None] = None, line_width: Union[int, None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2792) + ### Graph.draw_rectangle Draw rectangle -### Graph.draw_text +```py +def draw_rectangle(self, top_left: PointType, bottom_right: PointType, fill_color: Union[str, None] = None, line_color: Union[str, None] = None, line_width: Union[int, None] = None) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2792) + +### Graph.draw_text Draw text +```py +def draw_text(self, text: str, location: PointType, color: Union[str, None]='black', font: FontType = None, angle: Union[float, str, None] = 0, text_location: TextAlign = tk.CENTER) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2792) + ### Graph.erase Delete all +```py +def erase(self) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2792) + ### Graph.get Return Widget +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2792) + ### Graph.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2792) + ### Graph.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2792) + ### Graph.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2792) + ### Graph.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2792) + ### Graph.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2792) + ### Graph.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2792) + ### Graph.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2792) + ### Graph.update Update the widget. +```py +def update(self, *args, **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2792) + ## HSeparator HSeparator element. @@ -1546,58 +3371,148 @@ class HSeparator( ### Methods of HSeparator - +- [bind](#hseparatorbind) +- [bind_events](#hseparatorbind_events) +- [create](#hseparatorcreate) +- [disptach_event](#hseparatordisptach_event) +- [get](#hseparatorget) +- [get_height](#hseparatorget_height) +- [get_name](#hseparatorget_name) +- [get_prev_widget](#hseparatorget_prev_widget) +- [get_width](#hseparatorget_width) +- [post_create](#hseparatorpost_create) +- [prepare_create](#hseparatorprepare_create) +- [set_disabled](#hseparatorset_disabled) +- [update](#hseparatorupdate) ### HSeparator.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3040) + ### HSeparator.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3040) + ### HSeparator.create +```py +def create(self, win: Window, parent: tk.Widget) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3040) + ### HSeparator.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3040) + ### HSeparator.get Get the value of the widget. +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3040) + ### HSeparator.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3040) + ### HSeparator.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3040) + ### HSeparator.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3040) + ### HSeparator.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3040) + ### HSeparator.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3040) + ### HSeparator.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3040) + ### HSeparator.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3040) + ### HSeparator.update update widget configuration. +```py +def update(self, *args, **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3040) + ## Image Image element. @@ -1621,73 +3536,201 @@ class Image( ### Methods of Image - +- [bind](#imagebind) +- [bind_events](#imagebind_events) +- [create](#imagecreate) +- [disptach_event](#imagedisptach_event) +- [erase](#imageerase) +- [get](#imageget) +- [get_height](#imageget_height) +- [get_name](#imageget_name) +- [get_prev_widget](#imageget_prev_widget) +- [get_width](#imageget_width) +- [post_create](#imagepost_create) +- [prepare_create](#imageprepare_create) +- [screenshot](#imagescreenshot) +- [set_disabled](#imageset_disabled) +- [set_image](#imageset_image) +- [update](#imageupdate) ### Image.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2903) + ### Image.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2903) + ### Image.create Create a Image widget. +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2903) + ### Image.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2903) + ### Image.erase Erase image +```py +def erase(self) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2903) + ### Image.get Return Widget +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2903) + ### Image.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2903) + ### Image.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2903) + ### Image.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2903) + ### Image.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2903) + ### Image.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2903) + ### Image.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2903) + ### Image.screenshot Take a screenshot +```py +def screenshot(self) -> PIL.Image: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2903) + ### Image.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2903) + ### Image.set_image Set image to Image widget. - ImageResizeType is NO_RESIZE/FIT_HEIGHT/FIT_WIDTH/FIT_BOTH/IGNORE_ASPECT_RATIO/CROP_TO_SQUARE +```py +def set_image( + self, + source: Union[bytes, str, None] = None, + filename: Union[str, None] = None, + data: Union[bytes, None] = None, + size: Union[tuple[int, int], None] = None, + resize_type: ImageResizeType = ImageResizeType.FIT_BOTH, + background_color: Union[str, None] = None, # background color (example) "red", "#FF0000" + ) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2903) + ### Image.update Update the widget. +```py +def update( + self, + source: Union[bytes, str, None] = None, + filename: Union[str, None] = None, + data: Union[bytes, None] = None, + size: Union[tuple[int, int], None] = None, + resize_type: ImageResizeType = ImageResizeType.FIT_BOTH, + background_color: Union[tuple[int, int, int], None] = None, + **kw, + ) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2903) + ## Input Text input element. @@ -1726,124 +3769,326 @@ class Input( ### Methods of Input - +- [bind](#inputbind) +- [bind_events](#inputbind_events) +- [copy](#inputcopy) +- [copy_selected_text](#inputcopy_selected_text) +- [create](#inputcreate) +- [cut](#inputcut) +- [delete_selected](#inputdelete_selected) +- [disptach_event](#inputdisptach_event) +- [get](#inputget) +- [get_cursor_pos](#inputget_cursor_pos) +- [get_height](#inputget_height) +- [get_name](#inputget_name) +- [get_prev_widget](#inputget_prev_widget) +- [get_selected_text](#inputget_selected_text) +- [get_selection_length](#inputget_selection_length) +- [get_selection_pos](#inputget_selection_pos) +- [get_selection_start](#inputget_selection_start) +- [get_text](#inputget_text) +- [get_width](#inputget_width) +- [paste](#inputpaste) +- [post_create](#inputpost_create) +- [prepare_create](#inputprepare_create) +- [select_all](#inputselect_all) +- [set_cursor_pos](#inputset_cursor_pos) +- [set_disabled](#inputset_disabled) +- [set_readonly](#inputset_readonly) +- [set_selection_start](#inputset_selection_start) +- [set_text](#inputset_text) +- [update](#inputupdate) ### Input.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### Input.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### Input.copy copy to clipboard +```py +def copy(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### Input.copy_selected_text Copy selected text +```py +def copy_selected_text(self) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### Input.create create Input widget +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### Input.cut cut to clipboard +```py +def cut(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### Input.delete_selected delete selected text +```py +def delete_selected(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### Input.disptach_event Dispatch event -### Input.get +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + +### Input.get Get the value of the widget. +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### Input.get_cursor_pos get cursor position +```py +def get_cursor_pos(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### Input.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### Input.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### Input.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### Input.get_selected_text get selected text +```py +def get_selected_text(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### Input.get_selection_length get selection length +```py +def get_selection_length(self) -> tuple[int, int]: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### Input.get_selection_pos get selection positions +```py +def get_selection_pos(self) -> tuple[int, int]: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### Input.get_selection_start get selection start +```py +def get_selection_start(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### Input.get_text get text +```py +def get_text(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### Input.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### Input.paste paste from clipboard +```py +def paste(self): +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### Input.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### Input.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### Input.select_all select_all +```py +def select_all(self) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### Input.set_cursor_pos set cursor position +```py +def set_cursor_pos(self, index: int) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### Input.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### Input.set_readonly set readonly +```py +def set_readonly(self, readonly: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### Input.set_selection_start set selection start and length +```py +def set_selection_start(self, sel_start: int, sel_length: int=0) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### Input.set_text set text +```py +def set_text(self, text: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### Input.update Update the widget. +```py +def update(self, text: Union[str, None] = None, readonly: Union[bool, None] = None, **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ## InputText InputText element. (alias of Input) @@ -1882,124 +4127,326 @@ class InputText( ### Methods of InputText - +- [bind](#inputtextbind) +- [bind_events](#inputtextbind_events) +- [copy](#inputtextcopy) +- [copy_selected_text](#inputtextcopy_selected_text) +- [create](#inputtextcreate) +- [cut](#inputtextcut) +- [delete_selected](#inputtextdelete_selected) +- [disptach_event](#inputtextdisptach_event) +- [get](#inputtextget) +- [get_cursor_pos](#inputtextget_cursor_pos) +- [get_height](#inputtextget_height) +- [get_name](#inputtextget_name) +- [get_prev_widget](#inputtextget_prev_widget) +- [get_selected_text](#inputtextget_selected_text) +- [get_selection_length](#inputtextget_selection_length) +- [get_selection_pos](#inputtextget_selection_pos) +- [get_selection_start](#inputtextget_selection_start) +- [get_text](#inputtextget_text) +- [get_width](#inputtextget_width) +- [paste](#inputtextpaste) +- [post_create](#inputtextpost_create) +- [prepare_create](#inputtextprepare_create) +- [select_all](#inputtextselect_all) +- [set_cursor_pos](#inputtextset_cursor_pos) +- [set_disabled](#inputtextset_disabled) +- [set_readonly](#inputtextset_readonly) +- [set_selection_start](#inputtextset_selection_start) +- [set_text](#inputtextset_text) +- [update](#inputtextupdate) ### InputText.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### InputText.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### InputText.copy copy to clipboard +```py +def copy(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### InputText.copy_selected_text Copy selected text +```py +def copy_selected_text(self) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### InputText.create create Input widget +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### InputText.cut cut to clipboard +```py +def cut(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### InputText.delete_selected delete selected text +```py +def delete_selected(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### InputText.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### InputText.get Get the value of the widget. +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### InputText.get_cursor_pos get cursor position +```py +def get_cursor_pos(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### InputText.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### InputText.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### InputText.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### InputText.get_selected_text get selected text +```py +def get_selected_text(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### InputText.get_selection_length get selection length +```py +def get_selection_length(self) -> tuple[int, int]: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### InputText.get_selection_pos get selection positions +```py +def get_selection_pos(self) -> tuple[int, int]: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### InputText.get_selection_start get selection start +```py +def get_selection_start(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### InputText.get_text get text +```py +def get_text(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### InputText.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### InputText.paste paste from clipboard +```py +def paste(self): +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### InputText.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### InputText.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### InputText.select_all select_all +```py +def select_all(self) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### InputText.set_cursor_pos set cursor position +```py +def set_cursor_pos(self, index: int) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### InputText.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### InputText.set_readonly set readonly +```py +def set_readonly(self, readonly: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### InputText.set_selection_start set selection start and length +```py +def set_selection_start(self, sel_start: int, sel_length: int=0) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### InputText.set_text set text +```py +def set_text(self, text: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ### InputText.update Update the widget. +```py +def update(self, text: Union[str, None] = None, readonly: Union[bool, None] = None, **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2067) + ## Label Label element (alias of Text) @@ -2031,66 +4478,170 @@ class Label( ### Methods of Label - +- [bind](#labelbind) +- [bind_events](#labelbind_events) +- [create](#labelcreate) +- [disptach_event](#labeldisptach_event) +- [get](#labelget) +- [get_height](#labelget_height) +- [get_name](#labelget_name) +- [get_prev_widget](#labelget_prev_widget) +- [get_text](#labelget_text) +- [get_width](#labelget_width) +- [post_create](#labelpost_create) +- [prepare_create](#labelprepare_create) +- [set_disabled](#labelset_disabled) +- [set_text](#labelset_text) +- [update](#labelupdate) ### Label.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1594) + ### Label.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1594) + ### Label.create Create a Text widget. +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1594) + ### Label.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1594) + ### Label.get Get the value of the widget. +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1594) + ### Label.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1594) + ### Label.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1594) + ### Label.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1594) + ### Label.get_text +```py +def get_text(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1594) + ### Label.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1594) + ### Label.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1594) + ### Label.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1594) + ### Label.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1594) + ### Label.set_text Set the text of the widget. +```py +def set_text(self, text: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1594) + ### Label.update Update the widget. +```py +def update(self, text: Union[str, None] = None, *args, **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1594) + ## ListBrowse ListBrowse element. @@ -2117,66 +4668,170 @@ class ListBrowse( ### Methods of ListBrowse - +- [bind](#listbrowsebind) +- [bind_events](#listbrowsebind_events) +- [create](#listbrowsecreate) +- [disptach_event](#listbrowsedisptach_event) +- [get](#listbrowseget) +- [get_height](#listbrowseget_height) +- [get_name](#listbrowseget_name) +- [get_prev_widget](#listbrowseget_prev_widget) +- [get_width](#listbrowseget_width) +- [post_create](#listbrowsepost_create) +- [prepare_create](#listbrowseprepare_create) +- [set_disabled](#listbrowseset_disabled) +- [set_text](#listbrowseset_text) +- [show_dialog](#listbrowseshow_dialog) +- [update](#listbrowseupdate) ### ListBrowse.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3687) + ### ListBrowse.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3687) + ### ListBrowse.create +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3687) + ### ListBrowse.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3687) + ### ListBrowse.get Get the value of the widget. +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3687) + ### ListBrowse.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3687) + ### ListBrowse.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3687) + ### ListBrowse.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3687) + ### ListBrowse.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3687) + ### ListBrowse.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3687) + ### ListBrowse.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3687) + ### ListBrowse.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3687) + ### ListBrowse.set_text Set the text of the button. +```py +def set_text(self, text: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3687) + ### ListBrowse.show_dialog -Show Listbox dialog +Show Listbox dialog + +```py +def show_dialog(self, *args) -> Union[str, None]: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3687) ### ListBrowse.update Update the widget. +```py +def update(self, text: Union[str, None] = None, **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3687) + ## Listbox Listbox element. @@ -2201,80 +4856,205 @@ class Listbox( ### Methods of Listbox - +- [bind](#listboxbind) +- [bind_events](#listboxbind_events) +- [create](#listboxcreate) +- [disptach_event](#listboxdisptach_event) +- [get](#listboxget) +- [get_cursor_index](#listboxget_cursor_index) +- [get_height](#listboxget_height) +- [get_name](#listboxget_name) +- [get_prev_widget](#listboxget_prev_widget) +- [get_selected_items](#listboxget_selected_items) +- [get_width](#listboxget_width) +- [post_create](#listboxpost_create) +- [prepare_create](#listboxprepare_create) +- [select_values](#listboxselect_values) +- [set_cursor_index](#listboxset_cursor_index) +- [set_disabled](#listboxset_disabled) +- [set_values](#listboxset_values) +- [update](#listboxupdate) ### Listbox.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3065) + ### Listbox.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3065) + ### Listbox.create [Listbox.create] create Listbox widget +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3065) + ### Listbox.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3065) + ### Listbox.get Get the value of the widget. +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3065) + ### Listbox.get_cursor_index Get cursor index (return -1 if not selected) +```py +def get_cursor_index(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3065) + ### Listbox.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3065) + ### Listbox.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3065) + ### Listbox.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3065) + ### Listbox.get_selected_items Get selected items +```py +def get_selected_items(self) -> list[str]: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3065) + ### Listbox.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3065) + ### Listbox.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3065) + ### Listbox.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3065) + ### Listbox.select_values Select values +```py +def select_values(self, values: tuple[list[str], None]) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3065) + ### Listbox.set_cursor_index Set cursor index +```py +def set_cursor_index(self, index: int) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3065) + ### Listbox.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3065) + ### Listbox.set_values Set values to list +```py +def set_values(self, values: list[str]) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3065) + ### Listbox.update Update the widget. +```py +def update(self, *args, **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3065) + ## Menu Menu element. @@ -2305,66 +5085,170 @@ class Menu( ### Methods of Menu - +- [bind](#menubind) +- [bind_events](#menubind_events) +- [create](#menucreate) +- [disptach_event](#menudisptach_event) +- [get](#menuget) +- [get_height](#menuget_height) +- [get_name](#menuget_name) +- [get_prev_widget](#menuget_prev_widget) +- [get_text](#menuget_text) +- [get_width](#menuget_width) +- [post_create](#menupost_create) +- [prepare_create](#menuprepare_create) +- [set_disabled](#menuset_disabled) +- [set_text](#menuset_text) +- [update](#menuupdate) ### Menu.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1673) + ### Menu.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1673) + ### Menu.create Create a Text widget. +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1673) + ### Menu.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1673) + ### Menu.get Get the value of the widget. +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1673) + ### Menu.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1673) + ### Menu.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1673) + ### Menu.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1673) + ### Menu.get_text +```py +def get_text(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1673) + ### Menu.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1673) + ### Menu.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1673) + ### Menu.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1673) + ### Menu.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1673) + ### Menu.set_text Set the text of the widget. +```py +def set_text(self, text: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1673) + ### Menu.update Update the widget. +```py +def update(self, menu_definition: Union[list[list[Union[str, list[Any]]]], None] = None, *args, **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1673) + ## Multiline Multiline text input element. @@ -2402,132 +5286,354 @@ class Multiline( ### Methods of Multiline - +- [bind](#multilinebind) +- [bind_events](#multilinebind_events) +- [copy](#multilinecopy) +- [create](#multilinecreate) +- [cut](#multilinecut) +- [disptach_event](#multilinedisptach_event) +- [get](#multilineget) +- [get_cursor_pos](#multilineget_cursor_pos) +- [get_height](#multilineget_height) +- [get_name](#multilineget_name) +- [get_prev_widget](#multilineget_prev_widget) +- [get_selected_text](#multilineget_selected_text) +- [get_selection_length](#multilineget_selection_length) +- [get_selection_pos](#multilineget_selection_pos) +- [get_selection_start](#multilineget_selection_start) +- [get_text](#multilineget_text) +- [get_width](#multilineget_width) +- [index_to_pos](#multilineindex_to_pos) +- [paste](#multilinepaste) +- [pos_to_index](#multilinepos_to_index) +- [post_create](#multilinepost_create) +- [prepare_create](#multilineprepare_create) +- [print](#multilineprint) +- [select_all](#multilineselect_all) +- [set_cursor_pos](#multilineset_cursor_pos) +- [set_disabled](#multilineset_disabled) +- [set_readonly](#multilineset_readonly) +- [set_selection_pos](#multilineset_selection_pos) +- [set_selection_start](#multilineset_selection_start) +- [set_text](#multilineset_text) +- [update](#multilineupdate) ### Multiline.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Multiline.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Multiline.copy Copy the selected text. +```py +def copy(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Multiline.create Create a Multiline widget. +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Multiline.cut Cut the selected text. +```py +def cut(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Multiline.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Multiline.get Get the value of the widget. +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Multiline.get_cursor_pos Get Cursor position. liek `3.0` row=3, col=0 +```py +def get_cursor_pos(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Multiline.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Multiline.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Multiline.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Multiline.get_selected_text Get the selected text. +```py +def get_selected_text(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Multiline.get_selection_length get selection length +```py +def get_selection_length(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Multiline.get_selection_pos Get selection position, returns (start_pos, end_pos). +```py +def get_selection_pos(self) -> tuple[str, str]: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Multiline.get_selection_start get selection start +```py +def get_selection_start(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Multiline.get_text -Get the text of the widget. +Get the text of the widget. + +```py +def get_text(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) ### Multiline.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Multiline.index_to_pos Convert index to postion. +```py +def index_to_pos(self, index: int) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Multiline.paste Paste the text. +```py +def paste(self) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Multiline.pos_to_index Convert position to index. +```py +def pos_to_index(self, pos: str) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Multiline.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Multiline.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Multiline.print Print text. +```py +def print(self, text: str, text_color: Union[str, None] = None, background_color: Union[str, None] = None, end:str="\n", autoscroll: bool = False) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Multiline.select_all select all text +```py +def select_all(self) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Multiline.set_cursor_pos Set cursor position. (like `3.0`, row=3, col=0) +```py +def set_cursor_pos(self, pos: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Multiline.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Multiline.set_readonly Set readonly +```py +def set_readonly(self, readonly: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Multiline.set_selection_pos Set selection position. +```py +def set_selection_pos(self, start_pos: str, end_pos: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Multiline.set_selection_start set selection start +```py +def set_selection_start(self, index: int, sel_length: int=0) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Multiline.set_text Set text +```py +def set_text(self, text: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Multiline.update Update the widget. +```py +def update( + self, + text: Union[str, None] = None, + readonly: Union[bool, None] = None, + autoscroll: Union[bool, None] = None, # When autoscroll is set to True, it scrolls to the end with text changes. + **kw, + ) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ## MultilineBrowse MultilineBrowse element. @@ -2552,66 +5658,170 @@ class MultilineBrowse( ### Methods of MultilineBrowse - +- [bind](#multilinebrowsebind) +- [bind_events](#multilinebrowsebind_events) +- [create](#multilinebrowsecreate) +- [disptach_event](#multilinebrowsedisptach_event) +- [get](#multilinebrowseget) +- [get_height](#multilinebrowseget_height) +- [get_name](#multilinebrowseget_name) +- [get_prev_widget](#multilinebrowseget_prev_widget) +- [get_width](#multilinebrowseget_width) +- [post_create](#multilinebrowsepost_create) +- [prepare_create](#multilinebrowseprepare_create) +- [set_disabled](#multilinebrowseset_disabled) +- [set_text](#multilinebrowseset_text) +- [show_dialog](#multilinebrowseshow_dialog) +- [update](#multilinebrowseupdate) ### MultilineBrowse.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3736) + ### MultilineBrowse.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3736) + ### MultilineBrowse.create +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3736) + ### MultilineBrowse.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3736) + ### MultilineBrowse.get Get the value of the widget. +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3736) + ### MultilineBrowse.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3736) + ### MultilineBrowse.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3736) + ### MultilineBrowse.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3736) + ### MultilineBrowse.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3736) + ### MultilineBrowse.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3736) + ### MultilineBrowse.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3736) + ### MultilineBrowse.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3736) + ### MultilineBrowse.set_text Set the text of the button. +```py +def set_text(self, text: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3736) + ### MultilineBrowse.show_dialog Show Listbox dialog +```py +def show_dialog(self, *args) -> Union[str, None]: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3736) + ### MultilineBrowse.update Update the widget. +```py +def update(self, text: Union[str, None] = None, **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3736) + ## Output Output element. (alias of Multiline) TODO: implement @@ -2649,132 +5859,354 @@ class Output( ### Methods of Output - +- [bind](#outputbind) +- [bind_events](#outputbind_events) +- [copy](#outputcopy) +- [create](#outputcreate) +- [cut](#outputcut) +- [disptach_event](#outputdisptach_event) +- [get](#outputget) +- [get_cursor_pos](#outputget_cursor_pos) +- [get_height](#outputget_height) +- [get_name](#outputget_name) +- [get_prev_widget](#outputget_prev_widget) +- [get_selected_text](#outputget_selected_text) +- [get_selection_length](#outputget_selection_length) +- [get_selection_pos](#outputget_selection_pos) +- [get_selection_start](#outputget_selection_start) +- [get_text](#outputget_text) +- [get_width](#outputget_width) +- [index_to_pos](#outputindex_to_pos) +- [paste](#outputpaste) +- [pos_to_index](#outputpos_to_index) +- [post_create](#outputpost_create) +- [prepare_create](#outputprepare_create) +- [print](#outputprint) +- [select_all](#outputselect_all) +- [set_cursor_pos](#outputset_cursor_pos) +- [set_disabled](#outputset_disabled) +- [set_readonly](#outputset_readonly) +- [set_selection_pos](#outputset_selection_pos) +- [set_selection_start](#outputset_selection_start) +- [set_text](#outputset_text) +- [update](#outputupdate) ### Output.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Output.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Output.copy Copy the selected text. +```py +def copy(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Output.create Create a Multiline widget. +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Output.cut Cut the selected text. +```py +def cut(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Output.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Output.get Get the value of the widget. +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Output.get_cursor_pos Get Cursor position. liek `3.0` row=3, col=0 +```py +def get_cursor_pos(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Output.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Output.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Output.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Output.get_selected_text Get the selected text. +```py +def get_selected_text(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Output.get_selection_length get selection length +```py +def get_selection_length(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Output.get_selection_pos Get selection position, returns (start_pos, end_pos). +```py +def get_selection_pos(self) -> tuple[str, str]: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Output.get_selection_start get selection start +```py +def get_selection_start(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Output.get_text Get the text of the widget. +```py +def get_text(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Output.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Output.index_to_pos Convert index to postion. +```py +def index_to_pos(self, index: int) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Output.paste Paste the text. +```py +def paste(self) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Output.pos_to_index Convert position to index. +```py +def pos_to_index(self, pos: str) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Output.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Output.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Output.print Print text. +```py +def print(self, text: str, text_color: Union[str, None] = None, background_color: Union[str, None] = None, end:str="\n", autoscroll: bool = False) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Output.select_all select all text +```py +def select_all(self) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Output.set_cursor_pos Set cursor position. (like `3.0`, row=3, col=0) +```py +def set_cursor_pos(self, pos: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Output.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Output.set_readonly Set readonly +```py +def set_readonly(self, readonly: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Output.set_selection_pos Set selection position. +```py +def set_selection_pos(self, start_pos: str, end_pos: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Output.set_selection_start set selection start +```py +def set_selection_start(self, index: int, sel_length: int=0) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Output.set_text Set text +```py +def set_text(self, text: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Output.update Update the widget. +```py +def update( + self, + text: Union[str, None] = None, + readonly: Union[bool, None] = None, + autoscroll: Union[bool, None] = None, # When autoscroll is set to True, it scrolls to the end with text changes. + **kw, + ) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ## Radio Checkbox element. @@ -2795,74 +6227,192 @@ class Radio( ### Methods of Radio - +- [bind](#radiobind) +- [bind_events](#radiobind_events) +- [create](#radiocreate) +- [disptach_event](#radiodisptach_event) +- [get](#radioget) +- [get_height](#radioget_height) +- [get_name](#radioget_name) +- [get_prev_widget](#radioget_prev_widget) +- [get_value](#radioget_value) +- [get_width](#radioget_width) +- [is_selected](#radiois_selected) +- [post_create](#radiopost_create) +- [prepare_create](#radioprepare_create) +- [select](#radioselect) +- [set_disabled](#radioset_disabled) +- [set_text](#radioset_text) +- [update](#radioupdate) ### Radio.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1978) + ### Radio.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1978) + ### Radio.create +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1978) + ### Radio.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1978) + ### Radio.get Get the value of the widget. +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1978) + ### Radio.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1978) + ### Radio.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1978) + ### Radio.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1978) + ### Radio.get_value Get the value of the widget. +```py +def get_value(self) -> bool: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1978) + ### Radio.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1978) + ### Radio.is_selected Check if the radio button is selected. +```py +def is_selected(self) -> bool: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1978) + ### Radio.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1978) + ### Radio.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1978) + ### Radio.select Select the radio button. +```py +def select(self) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1978) + ### Radio.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1978) + ### Radio.set_text Set the text of the widget. +```py +def set_text(self, text: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1978) + ### Radio.update Update the widget. +```py +def update(self, text: Union[str, None] = None, **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1978) + ## Slider Slider element. @@ -2890,70 +6440,187 @@ class Slider( ### Methods of Slider - +- [bind](#sliderbind) +- [bind_events](#sliderbind_events) +- [create](#slidercreate) +- [disptach_event](#sliderdisptach_event) +- [get](#sliderget) +- [get_height](#sliderget_height) +- [get_name](#sliderget_name) +- [get_prev_widget](#sliderget_prev_widget) +- [get_range](#sliderget_range) +- [get_width](#sliderget_width) +- [post_create](#sliderpost_create) +- [prepare_create](#sliderprepare_create) +- [set](#sliderset) +- [set_disabled](#sliderset_disabled) +- [set_range](#sliderset_range) +- [update](#sliderupdate) ### Slider.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2627) + ### Slider.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2627) + ### Slider.create Create the widget. +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2627) + ### Slider.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2627) + ### Slider.get Return slider value. +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2627) + ### Slider.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2627) + ### Slider.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2627) + ### Slider.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2627) + ### Slider.get_range +```py +def get_range(self) -> tuple[float, float]: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2627) + ### Slider.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2627) + ### Slider.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2627) + ### Slider.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2627) + ### Slider.set Set value of Slider +```py +def set(self, value: float) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2627) + ### Slider.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2627) + ### Slider.set_range Set the range of the slider. +```py +def set_range(self, from_: float, to: float) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2627) + ### Slider.update Update the widget. +```py +def update( + self, + value: Union[float, None] = None, + range: Union[tuple[float, float], None] = None, + disable_number_display: Union[bool, None] = None, + **kw, + ) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2627) + ## Submit Subtmi element. (Alias of Button) : todo: add submit event @@ -2988,72 +6655,187 @@ class Submit( ### Methods of Submit - +- [bind](#submitbind) +- [bind_events](#submitbind_events) +- [create](#submitcreate) +- [disptach_event](#submitdisptach_event) +- [get](#submitget) +- [get_height](#submitget_height) +- [get_name](#submitget_name) +- [get_prev_widget](#submitget_prev_widget) +- [get_text](#submitget_text) +- [get_width](#submitget_width) +- [post_create](#submitpost_create) +- [prepare_create](#submitprepare_create) +- [set_button_color](#submitset_button_color) +- [set_disabled](#submitset_disabled) +- [set_text](#submitset_text) +- [update](#submitupdate) ### Submit.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) + ### Submit.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) + ### Submit.create Create a Button widget. +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) + ### Submit.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) + ### Submit.get Returns the text of the button.. +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) + ### Submit.get_height -Get height of element. +Get height of element. + +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) ### Submit.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) + ### Submit.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) + ### Submit.get_text Get the text of the button. +```py +def get_text(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) + ### Submit.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) + ### Submit.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) + ### Submit.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) + ### Submit.set_button_color Set the button color. +```py +def set_button_color(self, button_color: Union[str, tuple[str,str]], update: bool = True) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) + ### Submit.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) + ### Submit.set_text Set the text of the button. +```py +def set_text(self, text: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) + ### Submit.update Update the widget. +```py +def update(self, + text: Union[str, None] = None, + disabled: Union[bool, None] = None, + button_color: Union[str, tuple[str,str], None] = None, + **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1775) + ## Tab (experimental) Tab element - Tab is used together with TabGroup. @@ -3101,58 +6883,148 @@ class Tab( ### Methods of Tab - +- [bind](#tabbind) +- [bind_events](#tabbind_events) +- [create](#tabcreate) +- [disptach_event](#tabdisptach_event) +- [get](#tabget) +- [get_height](#tabget_height) +- [get_name](#tabget_name) +- [get_prev_widget](#tabget_prev_widget) +- [get_width](#tabget_width) +- [post_create](#tabpost_create) +- [prepare_create](#tabprepare_create) +- [set_disabled](#tabset_disabled) +- [update](#tabupdate) ### Tab.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1446) + ### Tab.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1446) + ### Tab.create +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1446) + ### Tab.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1446) + ### Tab.get Return Widget title +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1446) + ### Tab.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1446) + ### Tab.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1446) + ### Tab.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1446) + ### Tab.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1446) + ### Tab.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1446) + ### Tab.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1446) + ### Tab.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1446) + ### Tab.update Update the widget. +```py +def update(self, *args, **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1446) + ## TabGroup (experimental) TabGroup element - Specify the Tab element for the child elements. @@ -3200,56 +7072,146 @@ class TabGroup( ### Methods of TabGroup - +- [bind](#tabgroupbind) +- [bind_events](#tabgroupbind_events) +- [create](#tabgroupcreate) +- [disptach_event](#tabgroupdisptach_event) +- [get](#tabgroupget) +- [get_height](#tabgroupget_height) +- [get_name](#tabgroupget_name) +- [get_prev_widget](#tabgroupget_prev_widget) +- [get_width](#tabgroupget_width) +- [post_create](#tabgrouppost_create) +- [prepare_create](#tabgroupprepare_create) +- [set_disabled](#tabgroupset_disabled) +- [update](#tabgroupupdate) ### TabGroup.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1526) + ### TabGroup.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1526) + ### TabGroup.create +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1526) + ### TabGroup.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1526) + ### TabGroup.get Return Widget +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1526) + ### TabGroup.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1526) + ### TabGroup.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1526) + ### TabGroup.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1526) + ### TabGroup.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1526) + ### TabGroup.post_create +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1526) + ### TabGroup.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1526) + ### TabGroup.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1526) + ### TabGroup.update Update the widget. +```py +def update(self, *args, **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1526) + ## Table Table element. @@ -3288,68 +7250,172 @@ class Table( ### Methods of Table - +- [bind](#tablebind) +- [bind_events](#tablebind_events) +- [create](#tablecreate) +- [disptach_event](#tabledisptach_event) +- [get](#tableget) +- [get_height](#tableget_height) +- [get_name](#tableget_name) +- [get_prev_widget](#tableget_prev_widget) +- [get_width](#tableget_width) +- [load_from_file](#tableload_from_file) +- [post_create](#tablepost_create) +- [prepare_create](#tableprepare_create) +- [set_disabled](#tableset_disabled) +- [set_values](#tableset_values) +- [update](#tableupdate) ### Table.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3254) + ### Table.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3254) + ### Table.create Create a Table widget. +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3254) + ### Table.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3254) + ### Table.get Get the value of the widget. +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3254) + ### Table.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3254) + ### Table.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3254) + ### Table.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3254) + ### Table.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3254) + ### Table.load_from_file Load data from a file. +```py +def load_from_file(self, filename: str, delimiter: str = ",", encoding: str = "UTF-8", use_header: bool = True) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3254) + ### Table.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3254) + ### Table.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3254) + ### Table.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3254) + ### Table.set_values Set values to the table. +```py +def set_values(self, values: list[list[str]], headings: Union[list[str], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3254) + ### Table.update Update the widget. +```py +def update(self, *args, **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3254) + ## Text Text element. @@ -3381,66 +7447,170 @@ class Text( ### Methods of Text - +- [bind](#textbind) +- [bind_events](#textbind_events) +- [create](#textcreate) +- [disptach_event](#textdisptach_event) +- [get](#textget) +- [get_height](#textget_height) +- [get_name](#textget_name) +- [get_prev_widget](#textget_prev_widget) +- [get_text](#textget_text) +- [get_width](#textget_width) +- [post_create](#textpost_create) +- [prepare_create](#textprepare_create) +- [set_disabled](#textset_disabled) +- [set_text](#textset_text) +- [update](#textupdate) ### Text.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1594) + ### Text.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1594) + ### Text.create Create a Text widget. +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1594) + ### Text.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1594) + ### Text.get Get the value of the widget. +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1594) + ### Text.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1594) + ### Text.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1594) + ### Text.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1594) + ### Text.get_text +```py +def get_text(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1594) + ### Text.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1594) + ### Text.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1594) + ### Text.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1594) + ### Text.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1594) + ### Text.set_text Set the text of the widget. +```py +def set_text(self, text: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1594) + ### Text.update Update the widget. +```py +def update(self, text: Union[str, None] = None, *args, **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L1594) + ## Textarea Textarea element. (alias of Multiline) @@ -3478,132 +7648,354 @@ class Textarea( ### Methods of Textarea - +- [bind](#textareabind) +- [bind_events](#textareabind_events) +- [copy](#textareacopy) +- [create](#textareacreate) +- [cut](#textareacut) +- [disptach_event](#textareadisptach_event) +- [get](#textareaget) +- [get_cursor_pos](#textareaget_cursor_pos) +- [get_height](#textareaget_height) +- [get_name](#textareaget_name) +- [get_prev_widget](#textareaget_prev_widget) +- [get_selected_text](#textareaget_selected_text) +- [get_selection_length](#textareaget_selection_length) +- [get_selection_pos](#textareaget_selection_pos) +- [get_selection_start](#textareaget_selection_start) +- [get_text](#textareaget_text) +- [get_width](#textareaget_width) +- [index_to_pos](#textareaindex_to_pos) +- [paste](#textareapaste) +- [pos_to_index](#textareapos_to_index) +- [post_create](#textareapost_create) +- [prepare_create](#textareaprepare_create) +- [print](#textareaprint) +- [select_all](#textareaselect_all) +- [set_cursor_pos](#textareaset_cursor_pos) +- [set_disabled](#textareaset_disabled) +- [set_readonly](#textareaset_readonly) +- [set_selection_pos](#textareaset_selection_pos) +- [set_selection_start](#textareaset_selection_start) +- [set_text](#textareaset_text) +- [update](#textareaupdate) ### Textarea.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Textarea.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Textarea.copy Copy the selected text. +```py +def copy(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Textarea.create Create a Multiline widget. +```py +def create(self, win: Window, parent: tk.Widget) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Textarea.cut Cut the selected text. +```py +def cut(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Textarea.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Textarea.get Get the value of the widget. +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Textarea.get_cursor_pos Get Cursor position. liek `3.0` row=3, col=0 +```py +def get_cursor_pos(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Textarea.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Textarea.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Textarea.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Textarea.get_selected_text Get the selected text. +```py +def get_selected_text(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Textarea.get_selection_length get selection length +```py +def get_selection_length(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Textarea.get_selection_pos Get selection position, returns (start_pos, end_pos). +```py +def get_selection_pos(self) -> tuple[str, str]: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Textarea.get_selection_start get selection start +```py +def get_selection_start(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Textarea.get_text Get the text of the widget. +```py +def get_text(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Textarea.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Textarea.index_to_pos Convert index to postion. +```py +def index_to_pos(self, index: int) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Textarea.paste Paste the text. +```py +def paste(self) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Textarea.pos_to_index Convert position to index. +```py +def pos_to_index(self, pos: str) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Textarea.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Textarea.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Textarea.print Print text. +```py +def print(self, text: str, text_color: Union[str, None] = None, background_color: Union[str, None] = None, end:str="\n", autoscroll: bool = False) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Textarea.select_all select all text +```py +def select_all(self) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Textarea.set_cursor_pos Set cursor position. (like `3.0`, row=3, col=0) +```py +def set_cursor_pos(self, pos: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Textarea.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Textarea.set_readonly Set readonly +```py +def set_readonly(self, readonly: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Textarea.set_selection_pos Set selection position. +```py +def set_selection_pos(self, start_pos: str, end_pos: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Textarea.set_selection_start set selection start +```py +def set_selection_start(self, index: int, sel_length: int=0) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Textarea.set_text Set text +```py +def set_text(self, text: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ### Textarea.update Update the widget. +```py +def update( + self, + text: Union[str, None] = None, + readonly: Union[bool, None] = None, + autoscroll: Union[bool, None] = None, # When autoscroll is set to True, it scrolls to the end with text changes. + **kw, + ) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L2310) + ## TkEasyError @@ -3650,58 +8042,148 @@ class VSeparator( ### Methods of VSeparator - +- [bind](#vseparatorbind) +- [bind_events](#vseparatorbind_events) +- [create](#vseparatorcreate) +- [disptach_event](#vseparatordisptach_event) +- [get](#vseparatorget) +- [get_height](#vseparatorget_height) +- [get_name](#vseparatorget_name) +- [get_prev_widget](#vseparatorget_prev_widget) +- [get_width](#vseparatorget_width) +- [post_create](#vseparatorpost_create) +- [prepare_create](#vseparatorprepare_create) +- [set_disabled](#vseparatorset_disabled) +- [update](#vseparatorupdate) ### VSeparator.bind Bind event. @see [Window.bind](#windowbind) +```py +def bind(self, event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3016) + ### VSeparator.bind_events Bind user events. @see [custom events](/docs/custom_events.md) The specification is such that if the suffix "/hide" is attached to an event key, that event key will not be returned to the user. @see [Window.read](#windowread) -### VSeparator.create +```py +def bind_events(self, events: dict[str, str], event_mode: EventMode="user") -> Element: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3016) + +### VSeparator.create + +```py +def create(self, win: Window, parent: tk.Widget) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3016) ### VSeparator.disptach_event Dispatch event +```py +def disptach_event(self, values: Union[dict[str, Any], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3016) + ### VSeparator.get Get the value of the widget. +```py +def get(self) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3016) + ### VSeparator.get_height Get height of element. +```py +def get_height(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3016) + ### VSeparator.get_name Get key of element. +```py +def get_name(self) -> str: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3016) + ### VSeparator.get_prev_widget Get the previous widget. +```py +def get_prev_widget(self, target_key: Union[str, None] = None) -> tk.Widget: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3016) + ### VSeparator.get_width Get width of element. +```py +def get_width(self) -> int: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3016) + ### VSeparator.post_create Post create widget. +```py +def post_create(self, win: Window, parent: tk.Widget) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3016) + ### VSeparator.prepare_create +```py +def prepare_create(self, win: Window) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3016) + ### VSeparator.set_disabled Set disabled widgets state +```py +def set_disabled(self, disabled: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3016) + ### VSeparator.update update widget configuration. +```py +def update(self, *args, **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L3016) + ## Window Main window object in TkEasyGUI @@ -3736,20 +8218,77 @@ class Window( ### Methods of Window - +- [bind](#windowbind) +- [cancel_close](#windowcancel_close) +- [close](#windowclose) +- [event_iter](#windowevent_iter) +- [focus](#windowfocus) +- [focus_element](#windowfocus_element) +- [get_center_location](#windowget_center_location) +- [get_element_by_key](#windowget_element_by_key) +- [get_elements_by_type](#windowget_elements_by_type) +- [get_location](#windowget_location) +- [get_screen_size](#windowget_screen_size) +- [get_size](#windowget_size) +- [get_values](#windowget_values) +- [hide](#windowhide) +- [hide_titlebar](#windowhide_titlebar) +- [is_alive](#windowis_alive) +- [is_running](#windowis_running) +- [keep_on_top](#windowkeep_on_top) +- [maximize](#windowmaximize) +- [minimize](#windowminimize) +- [move](#windowmove) +- [move_to_center](#windowmove_to_center) +- [normal](#windownormal) +- [post_event](#windowpost_event) +- [post_event_after](#windowpost_event_after) +- [read](#windowread) +- [refresh](#windowrefresh) +- [register_event_hooks](#windowregister_event_hooks) +- [send_to_back](#windowsend_to_back) +- [set_alpha_channel](#windowset_alpha_channel) +- [set_grab_anywhere](#windowset_grab_anywhere) +- [set_icon](#windowset_icon) +- [set_location](#windowset_location) +- [set_size](#windowset_size) +- [set_timeout](#windowset_timeout) +- [set_title](#windowset_title) +- [show](#windowshow) +- [start_thread](#windowstart_thread) +- [un_hide](#windowun_hide) +- [update_idle_tasks](#windowupdate_idle_tasks) ### Window.bind [Window.bind] Bind element event and handler +```py +def bind(self, element: "Element", event_name: str, handle_name: str, propagate: bool=True, event_mode: EventMode = "user") -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.cancel_close Cancel the close event. +```py +def cancel_close(self) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.close Close the window. +```py +def close(self) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.event_iter Return generator with event and values @@ -3764,98 +8303,246 @@ with eg.Window("test", layout=[[eg.Button("Hello")]]) as window: eg.popup("Hello, World!") ``` +```py +def event_iter(self, timeout: Union[int, None] = None, timeout_key: str=TIMEOUT_KEY) -> Any: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.focus Focus the window. +```py +def focus(self) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.focus_element Focus the element. +```py +def focus_element(self, key: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.get_center_location Get center location. +```py +def get_center_location(self) -> tuple[int, int]: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.get_element_by_key Get an element by its key. +```py +def get_element_by_key(self, key: str) -> Union[Element, None]: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.get_elements_by_type Get elements by type. +```py +def get_elements_by_type(self, element_type: str) -> list[Element]: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.get_location Get window location. +```py +def get_location(self) -> tuple[int, int]: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.get_screen_size Get the screen size. +```py +def get_screen_size(self) -> tuple[int, int]: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.get_size Get the window size. +```py +def get_size(self) -> tuple[int, int]: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.get_values Get values from the window. +```py +def get_values(self) -> dict[str, Any]: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.hide Hide the window. +```py +def hide(self) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.hide_titlebar Hide the titlebar. +```py +def hide_titlebar(self, flag: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.is_alive Check if the window is alive. +```py +def is_alive(self) -> bool: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.is_running Check if the window is running. (alias as is_alive) +```py +def is_running(self) -> bool: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.keep_on_top Set the window to keep on top. +```py +def keep_on_top(self, flag: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.maximize Maximize the window. (`resizable` should be set to True) +```py +def maximize(self) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.minimize Minimize the window. +```py +def minimize(self) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.move Move the window. (same as set_location) +```py +def move(self, x: int, y: int) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.move_to_center Move the window to the center of the screen. +```py +def move_to_center(self, center_pos: Union[tuple[int, int], None] = None) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.normal set normal window. +```py +def normal(self) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.post_event Post an event. +```py +def post_event(self, key: str, values: dict[str, Any]) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.post_event_after Post an event after msec. +```py +def post_event_after(self, msec: int, key: str, values: dict[str, Any]) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.read Read events from the window. +```py +def read( + self, + timeout: Union[int, None] = None, + timeout_key: str = WINDOW_TIMEOUT + ) -> tuple[str, dict[str, Any]]: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.refresh Refresh window +```py +def refresh(self) -> "Window": +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.register_event_hooks Register event hooks. (append hook events) @@ -3875,42 +8562,102 @@ window.register_event_hooks({ - If you specify a function that returns True, it changes the event name to f"{event}-stopped" and then re-collects the values associated with keys that occur afterwards. - @see [Window.read](#windowread) +```py +def register_event_hooks(self, hooks: dict[str, list[callable]]) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.send_to_back Send the window to the back, and make it not keep on top. +```py +def send_to_back(self) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.set_alpha_channel Set the alpha channel of the window. +```py +def set_alpha_channel(self, alpha: float) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.set_grab_anywhere Set grab anywhere +```py +def set_grab_anywhere(self, flag: bool) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.set_icon Set the icon for the window. +```py +def set_icon(self, icon: Union[bytes, str]) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.set_location Set window location. +```py +def set_location(self, xy: tuple[int, int]) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.set_size Set the window size. +```py +def set_size(self, size: tuple[int, int]) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.set_timeout Set a timeout event. +```py +def set_timeout(self, callback: callable, msec: int, *args, **kw) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.set_title Set the title of the window. +```py +def set_title(self, title: str) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.show Show hidden window (hide -> show) +```py +def show(self) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.start_thread Start a thread. @@ -3933,14 +8680,38 @@ with eg.Window("threading", layout=[[eg.Button("Run")]]) as window: eg.print("Thread end", result) ``` +```py +def start_thread( + self, + target: callable, + end_key: str = WINDOW_THREAD_END, # the thread processing is complete, end_key will be released + *args, + **kw, + ) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.un_hide Un hide the window. +```py +def un_hide(self) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + ### Window.update_idle_tasks Update idle tasks. +```py +def update_idle_tasks(self) -> None: +``` + +- [source](https://github.com/kujirahand/tkeasygui-python/blob/main/TkEasyGUI/widgets.py#L82) + # Functions of TkEasyGUI.widgets - [generate_element_id](#generate_element_id) diff --git a/makedoc.py b/makedoc.py index 3af3dd1..364bc4f 100644 --- a/makedoc.py +++ b/makedoc.py @@ -11,6 +11,7 @@ OUTPUT_DIR = os.path.join(SCRIPT_DIR, "docs", "TkEasyGUI") DOCS_SCRIPTS_DIR = os.path.join(SCRIPT_DIR, "docs", "scripts") REPO = "https://github.com/kujirahand/tkeasygui-python/blob/main" + def main(): package_path = eg.__path__[0] print(package_path) @@ -18,9 +19,14 @@ def main(): root_name = eg.__package__ # get modules + outputs = [] files = glob.glob(os.path.join(package_path, "*.py")) for file in files: read_module(file, root_name) + outputs.append(file) + print("[output files]") + for file in outputs: + print("-", file) def read_module(file: str, root_name: str) -> None: module_name = os.path.basename(file).replace(".py", "") @@ -55,12 +61,13 @@ def read_module(file: str, root_name: str) -> None: elements.append(class_name) # get init code if p.__init__ is not None: - print("@@@", prop) + print(f"- class {prop}") code_def = get_function_definition(p.__init__, skip_self=True) code_def = re.sub("^def __init__", f"class {class_name}", code_def) code_def = re.sub(r"->\s*None\s*:", "", code_def) if prop == "Button": - print("@@@", code_def) + # for DEBUG - print only button + print("@@@ (debug)", code_def) # print(inspect.getsource(p.__init__)) if code_def != "": classes += "```py\n" @@ -77,12 +84,14 @@ def read_module(file: str, root_name: str) -> None: for name, method in methods: if name.startswith("_"): continue - print("###", class_name, name) + print(f" - (method) {module_name}.{class_name}.{name}") method_doc += f"### {class_name}.{name}\n\n" doc = trim_docstring(method.__doc__) if doc.strip() != "": method_doc += doc.strip() + "\n\n" - if type(p) is not types.FunctionType: + ff = getattr(p, name) + if not isinstance(ff, types.FunctionType): + print("*** skip *** ", type(ff), class_name, name) continue def_code = get_function_definition(method, skip_self=True) method_doc += "```py\n" @@ -125,7 +134,8 @@ def read_module(file: str, root_name: str) -> None: if prop.startswith("_"): continue p = getattr(mod, prop) - if type(p) is types.FunctionType: + if isinstance(p, types.FunctionType): + print(f"- (func_type) {module_name}.{prop}") doc = trim_docstring(p.__doc__) code = p.__code__ def_code = get_function_definition(p) @@ -150,6 +160,7 @@ def read_module(file: str, root_name: str) -> None: # print(result) with open(output_file, "w", encoding="utf-8") as fp: fp.write(result) + print("- output=", output_file) def trim_docstring(doc): """docstringのインデントを整形する""" diff --git a/requirements.txt b/requirements.txt index b82a07c..e9c9d5f 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,4 @@ -ruff Pillow pyperclip +ruff +mypy