pytauri_plugins.dialog.ffi

Original FFI interface module.

Warning

All APIs under this module should not be considered stable. You should use the re-exported APIs under the top-level module.

Classes:

Name	Description
MessageDialogButtons	tauri_plugin_dialog::MessageDialogButtons
MessageDialogKind	tauri_plugin_dialog::MessageDialogKind
MessageDialogBuilder	tauri_plugin_dialog::MessageDialogBuilder
FileDialogBuilder	tauri_plugin_dialog::FileDialogBuilder
DialogExt	tauri_plugin_dialog::DialogExt
MessageDialogBuilderArgs	tauri_plugin_dialog::MessageDialogBuilder
FileDialogBuilderArgs	tauri_plugin_dialog::FileDialogBuilder

Attributes:

Name	Type	Description
FilePath		tauri_plugin_dialog::FilePath
MessageDialogButtonsType		See MessageDialogButtons for details.
ImplDialogExt	TypeAlias	The implementers of DialogExt.

__all__ module-attribute

__all__ = ['DialogExt', 'FileDialogBuilder', 'FileDialogBuilderArgs', 'FilePath', 'ImplDialogExt', 'MessageDialogBuilder', 'MessageDialogBuilderArgs', 'MessageDialogButtons', 'MessageDialogButtonsType', 'MessageDialogKind']

FilePath module-attribute

FilePath = TypeAliasType('FilePath', StrictPyo3Path)

tauri_plugin_dialog::FilePath

MessageDialogButtonsType module-attribute

MessageDialogButtonsType = TypeAliasType('MessageDialogButtonsType', Union[Ok, OkCancel, YesNo, OkCustom, OkCancelCustom])

See MessageDialogButtons for details.

ImplDialogExt module-attribute

ImplDialogExt: TypeAlias = ImplManager

The implementers of DialogExt.

MessageDialogButtons

tauri_plugin_dialog::MessageDialogButtons

Classes:

Name	Description
Ok
OkCancel
YesNo
OkCustom
OkCancelCustom

Ok

OkCancel

YesNo

OkCustom

Bases: tuple[str]

Methods:

Name	Description
__new__

Attributes:

Name	Type	Description
__match_args__

__match_args__ class-attribute instance-attribute

__match_args__ = ('_0')

__new__

__new__(_0: str) -> Self

Source code in python/pytauri/src/pytauri_plugins/dialog/ffi.py

def __new__(cls, _0: str, /) -> Self: ...

OkCancelCustom

Bases: tuple[str, str]

Methods:

Name	Description
__new__

Attributes:

Name	Type	Description
__match_args__

__match_args__ class-attribute instance-attribute

__match_args__ = ('_0', '_1')

__new__

__new__(_0: str, _1: str) -> Self

Source code in python/pytauri/src/pytauri_plugins/dialog/ffi.py

def __new__(cls, _0: str, _1: str, /) -> Self: ...

MessageDialogKind

Bases: Enum

tauri_plugin_dialog::MessageDialogKind

Attributes:

Name	Type	Description
Info
Warning
Error

Info class-attribute instance-attribute

Info = auto()

Warning class-attribute instance-attribute

Warning = auto()

Error class-attribute instance-attribute

Error = auto()

MessageDialogBuilder

tauri_plugin_dialog::MessageDialogBuilder

Methods:

Name	Description
blocking_show
show

blocking_show

blocking_show(**kwargs: Unpack[MessageDialogBuilderArgs]) -> bool

Source code in python/pytauri/src/pytauri_plugins/dialog/ffi.py

def blocking_show(
    self, /, **kwargs: Unpack["MessageDialogBuilderArgs"]
) -> bool: ...

show

show(handler: Callable[[bool], object], /, **kwargs: Unpack[MessageDialogBuilderArgs]) -> None

Source code in python/pytauri/src/pytauri_plugins/dialog/ffi.py

def show(
    self,
    handler: Callable[[bool], object],
    /,
    **kwargs: Unpack["MessageDialogBuilderArgs"],
) -> None: ...

FileDialogBuilder

tauri_plugin_dialog::FileDialogBuilder

Methods:

Name	Description
pick_file
blocking_pick_file
pick_files
blocking_pick_files
pick_folder
blocking_pick_folder
pick_folders
blocking_pick_folders
save_file
blocking_save_file

pick_file

pick_file(handler: Callable[[Optional[FilePath]], object], /, **kwargs: Unpack[FileDialogBuilderArgs]) -> None

Source code in python/pytauri/src/pytauri_plugins/dialog/ffi.py

def pick_file(
    self,
    handler: Callable[[Optional[FilePath]], object],
    /,
    **kwargs: Unpack["FileDialogBuilderArgs"],
) -> None: ...

blocking_pick_file

blocking_pick_file(**kwargs: Unpack[FileDialogBuilderArgs]) -> Optional[FilePath]

Source code in python/pytauri/src/pytauri_plugins/dialog/ffi.py

def blocking_pick_file(
    self, /, **kwargs: Unpack["FileDialogBuilderArgs"]
) -> Optional[FilePath]: ...

pick_files

pick_files(handler: Callable[[Optional[list[FilePath]]], object], /, **kwargs: Unpack[FileDialogBuilderArgs]) -> None

Source code in python/pytauri/src/pytauri_plugins/dialog/ffi.py

def pick_files(
    self,
    handler: Callable[[Optional[list[FilePath]]], object],
    /,
    **kwargs: Unpack["FileDialogBuilderArgs"],
) -> None: ...

blocking_pick_files

blocking_pick_files(**kwargs: Unpack[FileDialogBuilderArgs]) -> Optional[list[FilePath]]

Source code in python/pytauri/src/pytauri_plugins/dialog/ffi.py

def blocking_pick_files(
    self, /, **kwargs: Unpack["FileDialogBuilderArgs"]
) -> Optional[list[FilePath]]: ...

pick_folder

pick_folder(handler: Callable[[Optional[FilePath]], object], /, **kwargs: Unpack[FileDialogBuilderArgs]) -> None

Source code in python/pytauri/src/pytauri_plugins/dialog/ffi.py

def pick_folder(
    self,
    handler: Callable[[Optional[FilePath]], object],
    /,
    **kwargs: Unpack["FileDialogBuilderArgs"],
) -> None: ...

blocking_pick_folder

blocking_pick_folder(**kwargs: Unpack[FileDialogBuilderArgs]) -> Optional[FilePath]

Source code in python/pytauri/src/pytauri_plugins/dialog/ffi.py

def blocking_pick_folder(
    self, /, **kwargs: Unpack["FileDialogBuilderArgs"]
) -> Optional[FilePath]: ...

pick_folders

pick_folders(handler: Callable[[Optional[list[FilePath]]], object], /, **kwargs: Unpack[FileDialogBuilderArgs]) -> None

Source code in python/pytauri/src/pytauri_plugins/dialog/ffi.py

def pick_folders(
    self,
    handler: Callable[[Optional[list[FilePath]]], object],
    /,
    **kwargs: Unpack["FileDialogBuilderArgs"],
) -> None: ...

blocking_pick_folders

blocking_pick_folders(**kwargs: Unpack[FileDialogBuilderArgs]) -> Optional[list[FilePath]]

Source code in python/pytauri/src/pytauri_plugins/dialog/ffi.py

def blocking_pick_folders(
    self, /, **kwargs: Unpack["FileDialogBuilderArgs"]
) -> Optional[list[FilePath]]: ...

save_file

save_file(handler: Callable[[Optional[FilePath]], object], /, **kwargs: Unpack[FileDialogBuilderArgs]) -> None

Source code in python/pytauri/src/pytauri_plugins/dialog/ffi.py

def save_file(
    self,
    handler: Callable[[Optional[FilePath]], object],
    /,
    **kwargs: Unpack["FileDialogBuilderArgs"],
) -> None: ...

blocking_save_file

blocking_save_file(**kwargs: Unpack[FileDialogBuilderArgs]) -> Optional[FilePath]

Source code in python/pytauri/src/pytauri_plugins/dialog/ffi.py

def blocking_save_file(
    self, /, **kwargs: Unpack["FileDialogBuilderArgs"]
) -> Optional[FilePath]: ...

DialogExt

tauri_plugin_dialog::DialogExt

Methods:

Name	Description
message
file

message staticmethod

message(slf: ImplDialogExt, message: str) -> MessageDialogBuilder

Source code in python/pytauri/src/pytauri_plugins/dialog/ffi.py

@staticmethod
def message(slf: "ImplDialogExt", message: str, /) -> MessageDialogBuilder: ...

file staticmethod

file(slf: ImplDialogExt) -> FileDialogBuilder

Source code in python/pytauri/src/pytauri_plugins/dialog/ffi.py

@staticmethod
def file(slf: "ImplDialogExt", /) -> FileDialogBuilder: ...

MessageDialogBuilderArgs

Bases: TypedDict

tauri_plugin_dialog::MessageDialogBuilder

Attributes:

Name	Type	Description
title	str
parent	_HasWindowHandleAndHasDisplayHandle
buttons	MessageDialogButtonsType
kind	MessageDialogKind

title instance-attribute

title: str

parent instance-attribute

parent: _HasWindowHandleAndHasDisplayHandle

buttons instance-attribute

buttons: MessageDialogButtonsType

kind instance-attribute

kind: MessageDialogKind

FileDialogBuilderArgs

Bases: TypedDict

tauri_plugin_dialog::FileDialogBuilder

Attributes:

Name	Type	Description
add_filter	tuple[str, Sequence[str]]	(name, extensions)
set_directory	Pyo3Path
set_file_name	str
set_parent	_HasWindowHandleAndHasDisplayHandle
set_title	str
set_can_create_directories	bool

add_filter instance-attribute

add_filter: tuple[str, Sequence[str]]

(name, extensions)

set_directory instance-attribute

set_directory: Pyo3Path

set_file_name instance-attribute

set_file_name: str

set_parent instance-attribute

set_parent: _HasWindowHandleAndHasDisplayHandle

set_title instance-attribute

set_title: str

set_can_create_directories instance-attribute

set_can_create_directories: bool