pytauri.ffi.tray

tauri::tray

Classes:

Name	Description
TrayIcon	tauri::tray::TrayIcon
TrayIconEvent	tauri::tray::TrayIconEvent
MouseButton	tauri::tray::MouseButton
MouseButtonState	tauri::tray::MouseButtonState

Attributes:

Name	Type	Description
TrayIconId		tauri::tray::TrayIconId
TrayIconEventType		See TrayIconEvent for details.

__all__ module-attribute

__all__ = ['MouseButton', 'MouseButtonState', 'TrayIcon', 'TrayIconEvent', 'TrayIconEventType', 'TrayIconId']

TrayIconId module-attribute

TrayIconId = TypeAliasType('TrayIconId', str)

tauri::tray::TrayIconId

TrayIconEventType module-attribute

TrayIconEventType = TypeAliasType('TrayIconEventType', Union[Click, DoubleClick, Enter, Move, Leave, _NonExhaustive])

See TrayIconEvent for details.

TrayIcon

tauri::tray::TrayIcon

Methods:

Name	Description
__new__
with_id
app_handle
on_menu_event	This is an alias for pytauri.ffi.AppHandle.on_menu_event.
on_tray_icon_event	Set a handler for this tray icon events.
id
set_icon
set_menu
set_tooltip
set_title
set_visible
set_temp_dir_path
set_icon_as_template
set_show_menu_on_left_click
rect

__new__

__new__(manager: ImplManager) -> Self

Source code in python/pytauri/src/pytauri/ffi/tray.py

def __new__(cls, manager: ImplManager, /) -> Self: ...

with_id staticmethod

with_id(manager: ImplManager, id: TrayIconId) -> TrayIcon

Source code in python/pytauri/src/pytauri/ffi/tray.py

@staticmethod
def with_id(manager: ImplManager, id: TrayIconId, /) -> "TrayIcon": ...  # noqa: A002

app_handle

app_handle() -> AppHandle

Source code in python/pytauri/src/pytauri/ffi/tray.py

def app_handle(self, /) -> AppHandle: ...

on_menu_event

on_menu_event(handler: Callable[[AppHandle, MenuEvent], None]) -> None

This is an alias for pytauri.ffi.AppHandle.on_menu_event.

Source code in python/pytauri/src/pytauri/ffi/tray.py

def on_menu_event(
    self, handler: Callable[[AppHandle, MenuEvent], None], /
) -> None:
    """This is an alias for [pytauri.ffi.AppHandle.on_menu_event][]."""
    ...

on_tray_icon_event

on_tray_icon_event(handler: Callable[[Self, TrayIconEventType], None]) -> None

Set a handler for this tray icon events.

Warning

handler has the same restrictions as App.run.

Source code in python/pytauri/src/pytauri/ffi/tray.py

def on_tray_icon_event(
    self, handler: Callable[[Self, "TrayIconEventType"], None], /
) -> None:
    """Set a handler for this tray icon events.

    !!! warning
        `handler` has the same restrictions as [App.run][pytauri.App.run].
    """
    ...

id

id() -> TrayIconId

Source code in python/pytauri/src/pytauri/ffi/tray.py

def id(self, /) -> TrayIconId: ...

set_icon

set_icon(icon: Optional[Image]) -> None

Source code in python/pytauri/src/pytauri/ffi/tray.py

def set_icon(self, icon: Optional[Image], /) -> None: ...

set_menu

set_menu(menu: Optional[ImplContextMenu]) -> None

Source code in python/pytauri/src/pytauri/ffi/tray.py

def set_menu(self, menu: Optional[ImplContextMenu], /) -> None: ...

set_tooltip

set_tooltip(tooltip: Optional[str]) -> None

Source code in python/pytauri/src/pytauri/ffi/tray.py

def set_tooltip(self, tooltip: Optional[str], /) -> None: ...

set_title

set_title(title: Optional[str]) -> None

Source code in python/pytauri/src/pytauri/ffi/tray.py

def set_title(self, title: Optional[str], /) -> None: ...

set_visible

set_visible(visible: bool) -> None

Source code in python/pytauri/src/pytauri/ffi/tray.py

def set_visible(self, visible: bool, /) -> None: ...

set_temp_dir_path

set_temp_dir_path(path: Optional[Pyo3Path]) -> None

Source code in python/pytauri/src/pytauri/ffi/tray.py

def set_temp_dir_path(self, path: Optional[Pyo3Path], /) -> None: ...

set_icon_as_template

set_icon_as_template(is_template: bool) -> None

Source code in python/pytauri/src/pytauri/ffi/tray.py

def set_icon_as_template(self, is_template: bool, /) -> None: ...

set_show_menu_on_left_click

set_show_menu_on_left_click(enable: bool) -> None

Source code in python/pytauri/src/pytauri/ffi/tray.py

def set_show_menu_on_left_click(self, enable: bool, /) -> None: ...

rect

rect() -> Optional[Rect]

Source code in python/pytauri/src/pytauri/ffi/tray.py

def rect(self, /) -> Optional[Rect]: ...

TrayIconEvent

tauri::tray::TrayIconEvent

Classes:

Name	Description
Click	tauri::tray::TrayIconEvent::Click
DoubleClick	tauri::tray::TrayIconEvent::DoubleClick
Enter	tauri::tray::TrayIconEvent::Enter
Move	tauri::tray::TrayIconEvent::Move
Leave	tauri::tray::TrayIconEvent::Leave

Click

tauri::tray::TrayIconEvent::Click

Attributes:

Name	Type	Description
id	TrayIconId
position	_PhysicalPositionF64
rect	Rect
button	MouseButton
button_state	MouseButtonState

id property

id: TrayIconId

position property

position: _PhysicalPositionF64

rect property

rect: Rect

button property

button: MouseButton

button_state property

button_state: MouseButtonState

DoubleClick

tauri::tray::TrayIconEvent::DoubleClick

Attributes:

Name	Type	Description
id	TrayIconId
position	_PhysicalPositionF64
rect	Rect
button	MouseButton

id property

id: TrayIconId

position property

position: _PhysicalPositionF64

rect property

rect: Rect

button property

button: MouseButton

Enter

tauri::tray::TrayIconEvent::Enter

Attributes:

Name	Type	Description
id	TrayIconId
position	_PhysicalPositionF64
rect	Rect

id property

id: TrayIconId

position property

position: _PhysicalPositionF64

rect property

rect: Rect

Move

tauri::tray::TrayIconEvent::Move

Attributes:

Name	Type	Description
id	TrayIconId
position	_PhysicalPositionF64
rect	Rect

id property

id: TrayIconId

position property

position: _PhysicalPositionF64

rect property

rect: Rect

Leave

tauri::tray::TrayIconEvent::Leave

Attributes:

Name	Type	Description
id	TrayIconId
position	_PhysicalPositionF64
rect	Rect

id property

id: TrayIconId

position property

position: _PhysicalPositionF64

rect property

rect: Rect

MouseButton

Bases: Enum

tauri::tray::MouseButton

Warning

See pytauri.ffi.menu.NativeIcon.

Attributes:

Name	Type	Description
Left
Right
Middle

Left class-attribute instance-attribute

Left = auto()

Right class-attribute instance-attribute

Right = auto()

Middle class-attribute instance-attribute

Middle = auto()

MouseButtonState

Bases: Enum

tauri::tray::MouseButtonState

Warning

See pytauri.ffi.menu.NativeIcon.

Attributes:

Name	Type	Description
Up
Down

Up class-attribute instance-attribute

Up = auto()

Down class-attribute instance-attribute

Down = auto()