Window
Window
#
Bases: BaseControl
Controls the app window.
Note
This control is for Desktop platforms (macOS, Windows, Linux) only.
always_on_bottom
#
always_on_bottom: bool = False
Whether the app window should always be displayed below other windows.
Note
Has effect on Linux and Windows only.
always_on_top
#
always_on_top: bool = False
Whether the app window should always be displayed on top of other windows/apps.
badge_label
#
badge_label: str | None = None
Sets a badge label on the app window.
Note
Has effect on macOS only.
bgcolor
#
bgcolor: ColorValue | None = None
Sets background color of an application window.
Tip
Can be used together with Page.bgcolor
to make a window transparent.
focused
#
focused: bool = True
Whether the app window should be focused.
Set to True
to focus programmatically.
icon
#
icon: str | None = None
The icon of the app window.
The file should have the .ico
extension.
Note
Has effect on Windows only.
ignore_mouse_events
#
ignore_mouse_events: bool = False
Whether the app window should ignore mouse events, passing them to the window below it. If this window has focus, it will still receive keyboard events.
left
#
left: Number | None = None
Defines the horizontal position of the app window - a distance in virtual pixels from the left edge of the screen.
maximized
#
maximized: bool = False
Whether the app window is maximized.
Set to True
to maximize programmatically.
minimizable
#
minimizable: bool = True
Whether the app window can be minimized through the window's "Minimize" button.
minimized
#
minimized: bool = False
Whether the app window is minimized.
Set to True
to minimize programmatically.
on_event
#
on_event: EventHandler[WindowEvent] | None = None
Called when app window changes its state. For example, when the window is maximized or minimized.
opacity
#
opacity: Number = 1.0
Defines the opacity of the app window.
Note
Must be between 0.0
and 1.0
.
page
#
The page (of type Page
or PageView
) to which this control belongs to.
parent
#
parent: BaseControl | None
The direct ancestor(parent) of this control.
It defaults to None
and will only have a value when this control is mounted (added to the page tree).
The Page
control (which is the root of the tree) is an exception - it always has parent=None
.
prevent_close
#
prevent_close: bool = False
Set to True
to intercept the native close signal.
Could be used to implement app exit confirmation logic.
progress_bar
#
progress_bar: Number | None = None
The value from 0.0
to 1.0
to display a progress bar on Task Bar or Dock.
skip_task_bar
#
skip_task_bar: bool = False
Whether the app window should be hidden from the Task Bar (on Windows) or Dock (on macOS).
title_bar_buttons_hidden
#
title_bar_buttons_hidden: bool = False
Whether to hide the app window's title bar buttons.
Note
Has effect on macOS only.
top
#
top: Number | None = None
Defines the vertical position of a native OS window - a distance in virtual pixels from the top edge of the screen.
visible
#
visible: bool = True
Whether to make the app window visible.
Can be of use when the app starts as hidden.
before_update
#
This method is called every time when this control is being updated.
Note
Make sure not to call/request an update()
here.
wait_until_ready_to_show_async
#
Waits until the app window is ready to show.