From 857bf40072817082a8388fce4673684048ed7c0d Mon Sep 17 00:00:00 2001 From: Lea Anthony Date: Sun, 5 Nov 2023 18:06:11 +1100 Subject: [PATCH] Update parser and bindings generation Update tests --- mkdocs-website/docs/en/API/application.md | 3 +- mkdocs-website/docs/en/API/fullapi.md | 2054 ++++++++--------- mkdocs-website/docs/en/changelog.md | 20 +- mkdocs-website/docs/en/development/changes.md | 4 +- .../docs/en/development/introduction.md | 13 +- mkdocs-website/docs/en/development/status.md | 41 +- .../docs/en/getting-started/feedback.md | 7 +- mkdocs-website/docs/en/roadmap.md | 19 +- mkdocs-website/docs/en/whats-new.md | 4 +- mkdocs-website/docs/zh/API/application.md | 53 +- mkdocs-website/docs/zh/API/mainthread.md | 22 +- mkdocs-website/docs/zh/API/menu.md | 20 +- mkdocs-website/docs/zh/API/systray.md | 5 +- mkdocs-website/docs/zh/API/window.md | 15 +- mkdocs-website/docs/zh/changelog.md | 23 +- mkdocs-website/docs/zh/development/changes.md | 141 +- .../docs/zh/development/introduction.md | 52 +- mkdocs-website/docs/zh/development/status.md | 460 ++-- .../docs/zh/getting-started/feedback.md | 9 +- .../docs/zh/getting-started/installation.md | 5 +- .../docs/zh/getting-started/next-steps.md | 12 +- mkdocs-website/docs/zh/index.md | 3 +- mkdocs-website/docs/zh/roadmap.md | 13 +- mkdocs-website/docs/zh/whats-new.md | 30 +- v3/Taskfile.yaml | 2 +- 25 files changed, 1526 insertions(+), 1504 deletions(-) diff --git a/mkdocs-website/docs/en/API/application.md b/mkdocs-website/docs/en/API/application.md index 577aa210655..2d1a3c1cfbf 100644 --- a/mkdocs-website/docs/en/API/application.md +++ b/mkdocs-website/docs/en/API/application.md @@ -1,6 +1,7 @@ # Application -The application API assists in creating an application using the Wails framework. +The application API assists in creating an application using the Wails +framework. ### New diff --git a/mkdocs-website/docs/en/API/fullapi.md b/mkdocs-website/docs/en/API/fullapi.md index 4193f1ab500..52ce0c2bffa 100644 --- a/mkdocs-website/docs/en/API/fullapi.md +++ b/mkdocs-website/docs/en/API/fullapi.md @@ -6,330 +6,329 @@ import "github.com/wailsapp/wails/v3/pkg/application" ## Index -- [Constants](<#constants>) -- [Variables](<#variables>) -- [func DefaultLogger\(level slog.Level\) \*slog.Logger](<#DefaultLogger>) -- [func Fatal\(message string, args ...interface\{\}\)](<#Fatal>) -- [func InvokeAsync\(fn func\(\)\)](<#InvokeAsync>) -- [func InvokeSync\(fn func\(\)\)](<#InvokeSync>) -- [func InvokeSyncWithError\(fn func\(\) error\) \(err error\)](<#InvokeSyncWithError>) -- [func InvokeSyncWithResult\[T any\]\(fn func\(\) T\) \(res T\)](<#InvokeSyncWithResult>) -- [func InvokeSyncWithResultAndError\[T any\]\(fn func\(\) \(T, error\)\) \(res T, err error\)](<#InvokeSyncWithResultAndError>) -- [func NewIconFromResource\(instance w32.HINSTANCE, resId uint16\) \(w32.HICON, error\)](<#NewIconFromResource>) -- [func ScaleToDefaultDPI\(pixels int, dpi uint\) int](<#ScaleToDefaultDPI>) -- [func ScaleWithDPI\(pixels int, dpi uint\) int](<#ScaleWithDPI>) -- [type ActivationPolicy](<#ActivationPolicy>) -- [type App](<#App>) - - [func Get\(\) \*App](<#Get>) - - [func New\(appOptions Options\) \*App](<#New>) - - [func \(a \*App\) Capabilities\(\) capabilities.Capabilities](<#App.Capabilities>) - - [func \(a \*App\) Clipboard\(\) \*Clipboard](<#App.Clipboard>) - - [func \(a \*App\) CurrentWindow\(\) \*WebviewWindow](<#App.CurrentWindow>) - - [func \(a \*App\) GetPID\(\) int](<#App.GetPID>) - - [func \(a \*App\) GetPrimaryScreen\(\) \(\*Screen, error\)](<#App.GetPrimaryScreen>) - - [func \(a \*App\) GetScreens\(\) \(\[\]\*Screen, error\)](<#App.GetScreens>) - - [func \(a \*App\) GetWindowByName\(name string\) \*WebviewWindow](<#App.GetWindowByName>) - - [func \(a \*App\) Hide\(\)](<#App.Hide>) - - [func \(a \*App\) IsDarkMode\(\) bool](<#App.IsDarkMode>) - - [func \(a \*App\) NewMenu\(\) \*Menu](<#App.NewMenu>) - - [func \(a \*App\) NewSystemTray\(\) \*SystemTray](<#App.NewSystemTray>) - - [func \(a \*App\) NewWebviewWindow\(\) \*WebviewWindow](<#App.NewWebviewWindow>) - - [func \(a \*App\) NewWebviewWindowWithOptions\(windowOptions WebviewWindowOptions\) \*WebviewWindow](<#App.NewWebviewWindowWithOptions>) - - [func \(a \*App\) On\(eventType events.ApplicationEventType, callback func\(event \*Event\)\) func\(\)](<#App.On>) - - [func \(a \*App\) OnWindowCreation\(callback func\(window \*WebviewWindow\)\)](<#App.OnWindowCreation>) - - [func \(a \*App\) Quit\(\)](<#App.Quit>) - - [func \(a \*App\) RegisterContextMenu\(name string, menu \*Menu\)](<#App.RegisterContextMenu>) - - [func \(a \*App\) RegisterHook\(eventType events.ApplicationEventType, callback func\(event \*Event\)\) func\(\)](<#App.RegisterHook>) - - [func \(a \*App\) Run\(\) error](<#App.Run>) - - [func \(a \*App\) SetMenu\(menu \*Menu\)](<#App.SetMenu>) - - [func \(a \*App\) Show\(\)](<#App.Show>) - - [func \(a \*App\) ShowAboutDialog\(\)](<#App.ShowAboutDialog>) -- [type ApplicationEventContext](<#ApplicationEventContext>) - - [func \(c ApplicationEventContext\) IsDarkMode\(\) bool](<#ApplicationEventContext.IsDarkMode>) - - [func \(c ApplicationEventContext\) OpenedFiles\(\) \[\]string](<#ApplicationEventContext.OpenedFiles>) -- [type Args](<#Args>) - - [func \(a \*Args\) Bool\(s string\) \*bool](<#Args.Bool>) - - [func \(a \*Args\) Float64\(s string\) \*float64](<#Args.Float64>) - - [func \(a \*Args\) Int\(s string\) \*int](<#Args.Int>) - - [func \(a \*Args\) String\(key string\) \*string](<#Args.String>) - - [func \(a \*Args\) UInt\(s string\) \*uint](<#Args.UInt>) - - [func \(a \*Args\) UInt8\(s string\) \*uint8](<#Args.UInt8>) -- [type AssetOptions](<#AssetOptions>) -- [type BackdropType](<#BackdropType>) -- [type BackgroundType](<#BackgroundType>) -- [type Bindings](<#Bindings>) - - [func NewBindings\(structs \[\]any, aliases map\[uint32\]uint32\) \(\*Bindings, error\)](<#NewBindings>) - - [func \(b \*Bindings\) Add\(structPtr interface\{\}\) error](<#Bindings.Add>) - - [func \(b \*Bindings\) AddPlugins\(plugins map\[string\]Plugin\) error](<#Bindings.AddPlugins>) - - [func \(b \*Bindings\) GenerateID\(name string\) \(uint32, error\)](<#Bindings.GenerateID>) - - [func \(b \*Bindings\) Get\(options \*CallOptions\) \*BoundMethod](<#Bindings.Get>) - - [func \(b \*Bindings\) GetByID\(id uint32\) \*BoundMethod](<#Bindings.GetByID>) -- [type BoundMethod](<#BoundMethod>) - - [func \(b \*BoundMethod\) Call\(args \[\]interface\{\}\) \(returnValue interface\{\}, err error\)](<#BoundMethod.Call>) - - [func \(b \*BoundMethod\) String\(\) string](<#BoundMethod.String>) -- [type Button](<#Button>) - - [func \(b \*Button\) OnClick\(callback func\(\)\) \*Button](<#Button.OnClick>) - - [func \(b \*Button\) SetAsCancel\(\) \*Button](<#Button.SetAsCancel>) - - [func \(b \*Button\) SetAsDefault\(\) \*Button](<#Button.SetAsDefault>) -- [type CallOptions](<#CallOptions>) - - [func \(c CallOptions\) Name\(\) string](<#CallOptions.Name>) -- [type Clipboard](<#Clipboard>) - - [func \(c \*Clipboard\) SetText\(text string\) bool](<#Clipboard.SetText>) - - [func \(c \*Clipboard\) Text\(\) \(string, bool\)](<#Clipboard.Text>) -- [type Context](<#Context>) - - [func \(c \*Context\) ClickedMenuItem\(\) \*MenuItem](<#Context.ClickedMenuItem>) - - [func \(c \*Context\) ContextMenuData\(\) any](<#Context.ContextMenuData>) - - [func \(c \*Context\) IsChecked\(\) bool](<#Context.IsChecked>) -- [type ContextMenuData](<#ContextMenuData>) -- [type DialogType](<#DialogType>) -- [type Event](<#Event>) - - [func \(w \*Event\) Cancel\(\)](<#Event.Cancel>) - - [func \(w \*Event\) Context\(\) \*ApplicationEventContext](<#Event.Context>) -- [type EventListener](<#EventListener>) -- [type EventProcessor](<#EventProcessor>) - - [func NewWailsEventProcessor\(dispatchEventToWindows func\(\*WailsEvent\)\) \*EventProcessor](<#NewWailsEventProcessor>) - - [func \(e \*EventProcessor\) Emit\(thisEvent \*WailsEvent\)](<#EventProcessor.Emit>) - - [func \(e \*EventProcessor\) Off\(eventName string\)](<#EventProcessor.Off>) - - [func \(e \*EventProcessor\) OffAll\(\)](<#EventProcessor.OffAll>) - - [func \(e \*EventProcessor\) On\(eventName string, callback func\(event \*WailsEvent\)\) func\(\)](<#EventProcessor.On>) - - [func \(e \*EventProcessor\) OnMultiple\(eventName string, callback func\(event \*WailsEvent\), counter int\) func\(\)](<#EventProcessor.OnMultiple>) - - [func \(e \*EventProcessor\) Once\(eventName string, callback func\(event \*WailsEvent\)\) func\(\)](<#EventProcessor.Once>) - - [func \(e \*EventProcessor\) RegisterHook\(eventName string, callback func\(\*WailsEvent\)\) func\(\)](<#EventProcessor.RegisterHook>) -- [type FileFilter](<#FileFilter>) -- [type IconPosition](<#IconPosition>) -- [type MacAppearanceType](<#MacAppearanceType>) -- [type MacBackdrop](<#MacBackdrop>) -- [type MacOptions](<#MacOptions>) -- [type MacTitleBar](<#MacTitleBar>) -- [type MacToolbarStyle](<#MacToolbarStyle>) -- [type MacWindow](<#MacWindow>) -- [type Menu](<#Menu>) - - [func NewMenu\(\) \*Menu](<#NewMenu>) - - [func \(m \*Menu\) Add\(label string\) \*MenuItem](<#Menu.Add>) - - [func \(m \*Menu\) AddCheckbox\(label string, enabled bool\) \*MenuItem](<#Menu.AddCheckbox>) - - [func \(m \*Menu\) AddRadio\(label string, enabled bool\) \*MenuItem](<#Menu.AddRadio>) - - [func \(m \*Menu\) AddRole\(role Role\) \*Menu](<#Menu.AddRole>) - - [func \(m \*Menu\) AddSeparator\(\)](<#Menu.AddSeparator>) - - [func \(m \*Menu\) AddSubmenu\(s string\) \*Menu](<#Menu.AddSubmenu>) - - [func \(m \*Menu\) SetLabel\(label string\)](<#Menu.SetLabel>) - - [func \(m \*Menu\) Update\(\)](<#Menu.Update>) -- [type MenuItem](<#MenuItem>) - - [func \(m \*MenuItem\) Checked\(\) bool](<#MenuItem.Checked>) - - [func \(m \*MenuItem\) Enabled\(\) bool](<#MenuItem.Enabled>) - - [func \(m \*MenuItem\) Hidden\(\) bool](<#MenuItem.Hidden>) - - [func \(m \*MenuItem\) IsCheckbox\(\) bool](<#MenuItem.IsCheckbox>) - - [func \(m \*MenuItem\) IsRadio\(\) bool](<#MenuItem.IsRadio>) - - [func \(m \*MenuItem\) IsSeparator\(\) bool](<#MenuItem.IsSeparator>) - - [func \(m \*MenuItem\) IsSubmenu\(\) bool](<#MenuItem.IsSubmenu>) - - [func \(m \*MenuItem\) Label\(\) string](<#MenuItem.Label>) - - [func \(m \*MenuItem\) OnClick\(f func\(\*Context\)\) \*MenuItem](<#MenuItem.OnClick>) - - [func \(m \*MenuItem\) SetAccelerator\(shortcut string\) \*MenuItem](<#MenuItem.SetAccelerator>) - - [func \(m \*MenuItem\) SetChecked\(checked bool\) \*MenuItem](<#MenuItem.SetChecked>) - - [func \(m \*MenuItem\) SetEnabled\(enabled bool\) \*MenuItem](<#MenuItem.SetEnabled>) - - [func \(m \*MenuItem\) SetHidden\(hidden bool\) \*MenuItem](<#MenuItem.SetHidden>) - - [func \(m \*MenuItem\) SetLabel\(s string\) \*MenuItem](<#MenuItem.SetLabel>) - - [func \(m \*MenuItem\) SetTooltip\(s string\) \*MenuItem](<#MenuItem.SetTooltip>) - - [func \(m \*MenuItem\) Tooltip\(\) string](<#MenuItem.Tooltip>) -- [type MessageDialog](<#MessageDialog>) - - [func ErrorDialog\(\) \*MessageDialog](<#ErrorDialog>) - - [func InfoDialog\(\) \*MessageDialog](<#InfoDialog>) - - [func OpenDirectoryDialog\(\) \*MessageDialog](<#OpenDirectoryDialog>) - - [func QuestionDialog\(\) \*MessageDialog](<#QuestionDialog>) - - [func WarningDialog\(\) \*MessageDialog](<#WarningDialog>) - - [func \(d \*MessageDialog\) AddButton\(s string\) \*Button](<#MessageDialog.AddButton>) - - [func \(d \*MessageDialog\) AddButtons\(buttons \[\]\*Button\) \*MessageDialog](<#MessageDialog.AddButtons>) - - [func \(d \*MessageDialog\) AttachToWindow\(window \*WebviewWindow\) \*MessageDialog](<#MessageDialog.AttachToWindow>) - - [func \(d \*MessageDialog\) SetCancelButton\(button \*Button\) \*MessageDialog](<#MessageDialog.SetCancelButton>) - - [func \(d \*MessageDialog\) SetDefaultButton\(button \*Button\) \*MessageDialog](<#MessageDialog.SetDefaultButton>) - - [func \(d \*MessageDialog\) SetIcon\(icon \[\]byte\) \*MessageDialog](<#MessageDialog.SetIcon>) - - [func \(d \*MessageDialog\) SetMessage\(message string\) \*MessageDialog](<#MessageDialog.SetMessage>) - - [func \(d \*MessageDialog\) SetTitle\(title string\) \*MessageDialog](<#MessageDialog.SetTitle>) - - [func \(d \*MessageDialog\) Show\(\)](<#MessageDialog.Show>) -- [type MessageDialogOptions](<#MessageDialogOptions>) -- [type MessageProcessor](<#MessageProcessor>) - - [func NewMessageProcessor\(logger \*slog.Logger\) \*MessageProcessor](<#NewMessageProcessor>) - - [func \(m \*MessageProcessor\) Error\(message string, args ...any\)](<#MessageProcessor.Error>) - - [func \(m \*MessageProcessor\) HandleRuntimeCall\(rw http.ResponseWriter, r \*http.Request\)](<#MessageProcessor.HandleRuntimeCall>) - - [func \(m \*MessageProcessor\) HandleRuntimeCallWithIDs\(rw http.ResponseWriter, r \*http.Request\)](<#MessageProcessor.HandleRuntimeCallWithIDs>) - - [func \(m \*MessageProcessor\) Info\(message string, args ...any\)](<#MessageProcessor.Info>) -- [type Middleware](<#Middleware>) - - [func ChainMiddleware\(middleware ...Middleware\) Middleware](<#ChainMiddleware>) -- [type OpenFileDialogOptions](<#OpenFileDialogOptions>) -- [type OpenFileDialogStruct](<#OpenFileDialogStruct>) - - [func OpenFileDialog\(\) \*OpenFileDialogStruct](<#OpenFileDialog>) - - [func OpenFileDialogWithOptions\(options \*OpenFileDialogOptions\) \*OpenFileDialogStruct](<#OpenFileDialogWithOptions>) - - [func \(d \*OpenFileDialogStruct\) AddFilter\(displayName, pattern string\) \*OpenFileDialogStruct](<#OpenFileDialogStruct.AddFilter>) - - [func \(d \*OpenFileDialogStruct\) AllowsOtherFileTypes\(allowsOtherFileTypes bool\) \*OpenFileDialogStruct](<#OpenFileDialogStruct.AllowsOtherFileTypes>) - - [func \(d \*OpenFileDialogStruct\) AttachToWindow\(window \*WebviewWindow\) \*OpenFileDialogStruct](<#OpenFileDialogStruct.AttachToWindow>) - - [func \(d \*OpenFileDialogStruct\) CanChooseDirectories\(canChooseDirectories bool\) \*OpenFileDialogStruct](<#OpenFileDialogStruct.CanChooseDirectories>) - - [func \(d \*OpenFileDialogStruct\) CanChooseFiles\(canChooseFiles bool\) \*OpenFileDialogStruct](<#OpenFileDialogStruct.CanChooseFiles>) - - [func \(d \*OpenFileDialogStruct\) CanCreateDirectories\(canCreateDirectories bool\) \*OpenFileDialogStruct](<#OpenFileDialogStruct.CanCreateDirectories>) - - [func \(d \*OpenFileDialogStruct\) CanSelectHiddenExtension\(canSelectHiddenExtension bool\) \*OpenFileDialogStruct](<#OpenFileDialogStruct.CanSelectHiddenExtension>) - - [func \(d \*OpenFileDialogStruct\) HideExtension\(hideExtension bool\) \*OpenFileDialogStruct](<#OpenFileDialogStruct.HideExtension>) - - [func \(d \*OpenFileDialogStruct\) PromptForMultipleSelection\(\) \(\[\]string, error\)](<#OpenFileDialogStruct.PromptForMultipleSelection>) - - [func \(d \*OpenFileDialogStruct\) PromptForSingleSelection\(\) \(string, error\)](<#OpenFileDialogStruct.PromptForSingleSelection>) - - [func \(d \*OpenFileDialogStruct\) ResolvesAliases\(resolvesAliases bool\) \*OpenFileDialogStruct](<#OpenFileDialogStruct.ResolvesAliases>) - - [func \(d \*OpenFileDialogStruct\) SetButtonText\(text string\) \*OpenFileDialogStruct](<#OpenFileDialogStruct.SetButtonText>) - - [func \(d \*OpenFileDialogStruct\) SetDirectory\(directory string\) \*OpenFileDialogStruct](<#OpenFileDialogStruct.SetDirectory>) - - [func \(d \*OpenFileDialogStruct\) SetMessage\(message string\) \*OpenFileDialogStruct](<#OpenFileDialogStruct.SetMessage>) - - [func \(d \*OpenFileDialogStruct\) SetOptions\(options \*OpenFileDialogOptions\)](<#OpenFileDialogStruct.SetOptions>) - - [func \(d \*OpenFileDialogStruct\) SetTitle\(title string\) \*OpenFileDialogStruct](<#OpenFileDialogStruct.SetTitle>) - - [func \(d \*OpenFileDialogStruct\) ShowHiddenFiles\(showHiddenFiles bool\) \*OpenFileDialogStruct](<#OpenFileDialogStruct.ShowHiddenFiles>) - - [func \(d \*OpenFileDialogStruct\) TreatsFilePackagesAsDirectories\(treatsFilePackagesAsDirectories bool\) \*OpenFileDialogStruct](<#OpenFileDialogStruct.TreatsFilePackagesAsDirectories>) -- [type Options](<#Options>) -- [type Parameter](<#Parameter>) - - [func \(p \*Parameter\) IsError\(\) bool](<#Parameter.IsError>) - - [func \(p \*Parameter\) IsType\(typename string\) bool](<#Parameter.IsType>) -- [type Plugin](<#Plugin>) -- [type PluginCallOptions](<#PluginCallOptions>) -- [type PluginManager](<#PluginManager>) - - [func NewPluginManager\(plugins map\[string\]Plugin, assetServer \*assetserver.AssetServer\) \*PluginManager](<#NewPluginManager>) - - [func \(p \*PluginManager\) Init\(\) error](<#PluginManager.Init>) - - [func \(p \*PluginManager\) Shutdown\(\)](<#PluginManager.Shutdown>) -- [type PositionOptions](<#PositionOptions>) -- [type QueryParams](<#QueryParams>) - - [func \(qp QueryParams\) Args\(\) \(\*Args, error\)](<#QueryParams.Args>) - - [func \(qp QueryParams\) Bool\(key string\) \*bool](<#QueryParams.Bool>) - - [func \(qp QueryParams\) Float64\(key string\) \*float64](<#QueryParams.Float64>) - - [func \(qp QueryParams\) Int\(key string\) \*int](<#QueryParams.Int>) - - [func \(qp QueryParams\) String\(key string\) \*string](<#QueryParams.String>) - - [func \(qp QueryParams\) ToStruct\(str any\) error](<#QueryParams.ToStruct>) - - [func \(qp QueryParams\) UInt\(key string\) \*uint](<#QueryParams.UInt>) - - [func \(qp QueryParams\) UInt8\(key string\) \*uint8](<#QueryParams.UInt8>) -- [type RGBA](<#RGBA>) -- [type RadioGroup](<#RadioGroup>) - - [func \(r \*RadioGroup\) Add\(id int, item \*MenuItem\)](<#RadioGroup.Add>) - - [func \(r \*RadioGroup\) Bounds\(\) \(int, int\)](<#RadioGroup.Bounds>) - - [func \(r \*RadioGroup\) MenuID\(item \*MenuItem\) int](<#RadioGroup.MenuID>) -- [type RadioGroupMember](<#RadioGroupMember>) -- [type Rect](<#Rect>) -- [type Role](<#Role>) -- [type SaveFileDialogOptions](<#SaveFileDialogOptions>) -- [type SaveFileDialogStruct](<#SaveFileDialogStruct>) - - [func SaveFileDialog\(\) \*SaveFileDialogStruct](<#SaveFileDialog>) - - [func SaveFileDialogWithOptions\(s \*SaveFileDialogOptions\) \*SaveFileDialogStruct](<#SaveFileDialogWithOptions>) - - [func \(d \*SaveFileDialogStruct\) AddFilter\(displayName, pattern string\) \*SaveFileDialogStruct](<#SaveFileDialogStruct.AddFilter>) - - [func \(d \*SaveFileDialogStruct\) AllowsOtherFileTypes\(allowOtherFileTypes bool\) \*SaveFileDialogStruct](<#SaveFileDialogStruct.AllowsOtherFileTypes>) - - [func \(d \*SaveFileDialogStruct\) AttachToWindow\(window \*WebviewWindow\) \*SaveFileDialogStruct](<#SaveFileDialogStruct.AttachToWindow>) - - [func \(d \*SaveFileDialogStruct\) CanCreateDirectories\(canCreateDirectories bool\) \*SaveFileDialogStruct](<#SaveFileDialogStruct.CanCreateDirectories>) - - [func \(d \*SaveFileDialogStruct\) CanSelectHiddenExtension\(canSelectHiddenExtension bool\) \*SaveFileDialogStruct](<#SaveFileDialogStruct.CanSelectHiddenExtension>) - - [func \(d \*SaveFileDialogStruct\) HideExtension\(hideExtension bool\) \*SaveFileDialogStruct](<#SaveFileDialogStruct.HideExtension>) - - [func \(d \*SaveFileDialogStruct\) PromptForSingleSelection\(\) \(string, error\)](<#SaveFileDialogStruct.PromptForSingleSelection>) - - [func \(d \*SaveFileDialogStruct\) SetButtonText\(text string\) \*SaveFileDialogStruct](<#SaveFileDialogStruct.SetButtonText>) - - [func \(d \*SaveFileDialogStruct\) SetDirectory\(directory string\) \*SaveFileDialogStruct](<#SaveFileDialogStruct.SetDirectory>) - - [func \(d \*SaveFileDialogStruct\) SetFilename\(filename string\) \*SaveFileDialogStruct](<#SaveFileDialogStruct.SetFilename>) - - [func \(d \*SaveFileDialogStruct\) SetMessage\(message string\) \*SaveFileDialogStruct](<#SaveFileDialogStruct.SetMessage>) - - [func \(d \*SaveFileDialogStruct\) SetOptions\(options \*SaveFileDialogOptions\)](<#SaveFileDialogStruct.SetOptions>) - - [func \(d \*SaveFileDialogStruct\) ShowHiddenFiles\(showHiddenFiles bool\) \*SaveFileDialogStruct](<#SaveFileDialogStruct.ShowHiddenFiles>) - - [func \(d \*SaveFileDialogStruct\) TreatsFilePackagesAsDirectories\(treatsFilePackagesAsDirectories bool\) \*SaveFileDialogStruct](<#SaveFileDialogStruct.TreatsFilePackagesAsDirectories>) -- [type Screen](<#Screen>) -- [type Size](<#Size>) -- [type SystemTray](<#SystemTray>) - - [func \(s \*SystemTray\) AttachWindow\(window \*WebviewWindow\) \*SystemTray](<#SystemTray.AttachWindow>) - - [func \(s \*SystemTray\) Destroy\(\)](<#SystemTray.Destroy>) - - [func \(s \*SystemTray\) Label\(\) string](<#SystemTray.Label>) - - [func \(s \*SystemTray\) OnClick\(handler func\(\)\) \*SystemTray](<#SystemTray.OnClick>) - - [func \(s \*SystemTray\) OnDoubleClick\(handler func\(\)\) \*SystemTray](<#SystemTray.OnDoubleClick>) - - [func \(s \*SystemTray\) OnMouseEnter\(handler func\(\)\) \*SystemTray](<#SystemTray.OnMouseEnter>) - - [func \(s \*SystemTray\) OnMouseLeave\(handler func\(\)\) \*SystemTray](<#SystemTray.OnMouseLeave>) - - [func \(s \*SystemTray\) OnRightClick\(handler func\(\)\) \*SystemTray](<#SystemTray.OnRightClick>) - - [func \(s \*SystemTray\) OnRightDoubleClick\(handler func\(\)\) \*SystemTray](<#SystemTray.OnRightDoubleClick>) - - [func \(s \*SystemTray\) OpenMenu\(\)](<#SystemTray.OpenMenu>) - - [func \(s \*SystemTray\) PositionWindow\(window \*WebviewWindow, offset int\) error](<#SystemTray.PositionWindow>) - - [func \(s \*SystemTray\) SetDarkModeIcon\(icon \[\]byte\) \*SystemTray](<#SystemTray.SetDarkModeIcon>) - - [func \(s \*SystemTray\) SetIcon\(icon \[\]byte\) \*SystemTray](<#SystemTray.SetIcon>) - - [func \(s \*SystemTray\) SetIconPosition\(iconPosition int\) \*SystemTray](<#SystemTray.SetIconPosition>) - - [func \(s \*SystemTray\) SetLabel\(label string\)](<#SystemTray.SetLabel>) - - [func \(s \*SystemTray\) SetMenu\(menu \*Menu\) \*SystemTray](<#SystemTray.SetMenu>) - - [func \(s \*SystemTray\) SetTemplateIcon\(icon \[\]byte\) \*SystemTray](<#SystemTray.SetTemplateIcon>) - - [func \(s \*SystemTray\) WindowDebounce\(debounce time.Duration\) \*SystemTray](<#SystemTray.WindowDebounce>) - - [func \(s \*SystemTray\) WindowOffset\(offset int\) \*SystemTray](<#SystemTray.WindowOffset>) -- [type Theme](<#Theme>) -- [type ThemeSettings](<#ThemeSettings>) -- [type WailsEvent](<#WailsEvent>) - - [func \(e \*WailsEvent\) Cancel\(\)](<#WailsEvent.Cancel>) -- [type WebviewWindow](<#WebviewWindow>) - - [func \(w \*WebviewWindow\) AbsolutePosition\(\) \(int, int\)](<#WebviewWindow.AbsolutePosition>) - - [func \(w \*WebviewWindow\) Center\(\)](<#WebviewWindow.Center>) - - [func \(w \*WebviewWindow\) Close\(\)](<#WebviewWindow.Close>) - - [func \(w \*WebviewWindow\) Destroy\(\)](<#WebviewWindow.Destroy>) - - [func \(w \*WebviewWindow\) ExecJS\(js string\)](<#WebviewWindow.ExecJS>) - - [func \(w \*WebviewWindow\) Flash\(enabled bool\)](<#WebviewWindow.Flash>) - - [func \(w \*WebviewWindow\) Focus\(\)](<#WebviewWindow.Focus>) - - [func \(w \*WebviewWindow\) ForceReload\(\)](<#WebviewWindow.ForceReload>) - - [func \(w \*WebviewWindow\) Fullscreen\(\) \*WebviewWindow](<#WebviewWindow.Fullscreen>) - - [func \(w \*WebviewWindow\) GetScreen\(\) \(\*Screen, error\)](<#WebviewWindow.GetScreen>) - - [func \(w \*WebviewWindow\) GetZoom\(\) float64](<#WebviewWindow.GetZoom>) - - [func \(w \*WebviewWindow\) Height\(\) int](<#WebviewWindow.Height>) - - [func \(w \*WebviewWindow\) Hide\(\) \*WebviewWindow](<#WebviewWindow.Hide>) - - [func \(w \*WebviewWindow\) IsFocused\(\) bool](<#WebviewWindow.IsFocused>) - - [func \(w \*WebviewWindow\) IsFullscreen\(\) bool](<#WebviewWindow.IsFullscreen>) - - [func \(w \*WebviewWindow\) IsMaximised\(\) bool](<#WebviewWindow.IsMaximised>) - - [func \(w \*WebviewWindow\) IsMinimised\(\) bool](<#WebviewWindow.IsMinimised>) - - [func \(w \*WebviewWindow\) IsVisible\(\) bool](<#WebviewWindow.IsVisible>) - - [func \(w \*WebviewWindow\) Maximise\(\) \*WebviewWindow](<#WebviewWindow.Maximise>) - - [func \(w \*WebviewWindow\) Minimise\(\) \*WebviewWindow](<#WebviewWindow.Minimise>) - - [func \(w \*WebviewWindow\) Name\(\) string](<#WebviewWindow.Name>) - - [func \(w \*WebviewWindow\) NativeWindowHandle\(\) \(uintptr, error\)](<#WebviewWindow.NativeWindowHandle>) - - [func \(w \*WebviewWindow\) On\(eventType events.WindowEventType, callback func\(event \*WindowEvent\)\) func\(\)](<#WebviewWindow.On>) - - [func \(w \*WebviewWindow\) Print\(\) error](<#WebviewWindow.Print>) - - [func \(w \*WebviewWindow\) RegisterContextMenu\(name string, menu \*Menu\)](<#WebviewWindow.RegisterContextMenu>) - - [func \(w \*WebviewWindow\) RegisterHook\(eventType events.WindowEventType, callback func\(event \*WindowEvent\)\) func\(\)](<#WebviewWindow.RegisterHook>) - - [func \(w \*WebviewWindow\) RelativePosition\(\) \(int, int\)](<#WebviewWindow.RelativePosition>) - - [func \(w \*WebviewWindow\) Reload\(\)](<#WebviewWindow.Reload>) - - [func \(w \*WebviewWindow\) Resizable\(\) bool](<#WebviewWindow.Resizable>) - - [func \(w \*WebviewWindow\) Restore\(\)](<#WebviewWindow.Restore>) - - [func \(w \*WebviewWindow\) SetAbsolutePosition\(x int, y int\)](<#WebviewWindow.SetAbsolutePosition>) - - [func \(w \*WebviewWindow\) SetAlwaysOnTop\(b bool\) \*WebviewWindow](<#WebviewWindow.SetAlwaysOnTop>) - - [func \(w \*WebviewWindow\) SetBackgroundColour\(colour RGBA\) \*WebviewWindow](<#WebviewWindow.SetBackgroundColour>) - - [func \(w \*WebviewWindow\) SetEnabled\(enabled bool\)](<#WebviewWindow.SetEnabled>) - - [func \(w \*WebviewWindow\) SetFrameless\(frameless bool\) \*WebviewWindow](<#WebviewWindow.SetFrameless>) - - [func \(w \*WebviewWindow\) SetFullscreenButtonEnabled\(enabled bool\) \*WebviewWindow](<#WebviewWindow.SetFullscreenButtonEnabled>) - - [func \(w \*WebviewWindow\) SetHTML\(html string\) \*WebviewWindow](<#WebviewWindow.SetHTML>) - - [func \(w \*WebviewWindow\) SetMaxSize\(maxWidth, maxHeight int\) \*WebviewWindow](<#WebviewWindow.SetMaxSize>) - - [func \(w \*WebviewWindow\) SetMinSize\(minWidth, minHeight int\) \*WebviewWindow](<#WebviewWindow.SetMinSize>) - - [func \(w \*WebviewWindow\) SetRelativePosition\(x, y int\) \*WebviewWindow](<#WebviewWindow.SetRelativePosition>) - - [func \(w \*WebviewWindow\) SetResizable\(b bool\) \*WebviewWindow](<#WebviewWindow.SetResizable>) - - [func \(w \*WebviewWindow\) SetSize\(width, height int\) \*WebviewWindow](<#WebviewWindow.SetSize>) - - [func \(w \*WebviewWindow\) SetTitle\(title string\) \*WebviewWindow](<#WebviewWindow.SetTitle>) - - [func \(w \*WebviewWindow\) SetURL\(s string\) \*WebviewWindow](<#WebviewWindow.SetURL>) - - [func \(w \*WebviewWindow\) SetZoom\(magnification float64\) \*WebviewWindow](<#WebviewWindow.SetZoom>) - - [func \(w \*WebviewWindow\) Show\(\) \*WebviewWindow](<#WebviewWindow.Show>) - - [func \(w \*WebviewWindow\) Size\(\) \(int, int\)](<#WebviewWindow.Size>) - - [func \(w \*WebviewWindow\) ToggleDevTools\(\)](<#WebviewWindow.ToggleDevTools>) - - [func \(w \*WebviewWindow\) ToggleFullscreen\(\)](<#WebviewWindow.ToggleFullscreen>) - - [func \(w \*WebviewWindow\) UnFullscreen\(\)](<#WebviewWindow.UnFullscreen>) - - [func \(w \*WebviewWindow\) UnMaximise\(\)](<#WebviewWindow.UnMaximise>) - - [func \(w \*WebviewWindow\) UnMinimise\(\)](<#WebviewWindow.UnMinimise>) - - [func \(w \*WebviewWindow\) Width\(\) int](<#WebviewWindow.Width>) - - [func \(w \*WebviewWindow\) Zoom\(\)](<#WebviewWindow.Zoom>) - - [func \(w \*WebviewWindow\) ZoomIn\(\)](<#WebviewWindow.ZoomIn>) - - [func \(w \*WebviewWindow\) ZoomOut\(\)](<#WebviewWindow.ZoomOut>) - - [func \(w \*WebviewWindow\) ZoomReset\(\) \*WebviewWindow](<#WebviewWindow.ZoomReset>) -- [type WebviewWindowOptions](<#WebviewWindowOptions>) -- [type Win32Menu](<#Win32Menu>) - - [func NewApplicationMenu\(parent w32.HWND, inputMenu \*Menu\) \*Win32Menu](<#NewApplicationMenu>) - - [func NewPopupMenu\(parent w32.HWND, inputMenu \*Menu\) \*Win32Menu](<#NewPopupMenu>) - - [func \(p \*Win32Menu\) Destroy\(\)](<#Win32Menu.Destroy>) - - [func \(p \*Win32Menu\) OnMenuClose\(fn func\(\)\)](<#Win32Menu.OnMenuClose>) - - [func \(p \*Win32Menu\) OnMenuOpen\(fn func\(\)\)](<#Win32Menu.OnMenuOpen>) - - [func \(p \*Win32Menu\) ProcessCommand\(cmdMsgID int\) bool](<#Win32Menu.ProcessCommand>) - - [func \(p \*Win32Menu\) ShowAt\(x int, y int\)](<#Win32Menu.ShowAt>) - - [func \(p \*Win32Menu\) ShowAtCursor\(\)](<#Win32Menu.ShowAtCursor>) - - [func \(p \*Win32Menu\) Update\(\)](<#Win32Menu.Update>) - - [func \(p \*Win32Menu\) UpdateMenuItem\(item \*MenuItem\)](<#Win32Menu.UpdateMenuItem>) -- [type WindowAttachConfig](<#WindowAttachConfig>) -- [type WindowEvent](<#WindowEvent>) - - [func NewWindowEvent\(\) \*WindowEvent](<#NewWindowEvent>) - - [func \(w \*WindowEvent\) Cancel\(\)](<#WindowEvent.Cancel>) - - [func \(w \*WindowEvent\) Context\(\) \*WindowEventContext](<#WindowEvent.Context>) -- [type WindowEventContext](<#WindowEventContext>) - - [func \(c WindowEventContext\) DroppedFiles\(\) \[\]string](<#WindowEventContext.DroppedFiles>) -- [type WindowEventListener](<#WindowEventListener>) -- [type WindowState](<#WindowState>) -- [type WindowsOptions](<#WindowsOptions>) -- [type WindowsWindow](<#WindowsWindow>) - +- [Constants](#constants) +- [Variables](#variables) +- [func DefaultLogger\(level slog.Level\) \*slog.Logger](#DefaultLogger) +- [func Fatal\(message string, args ...interface\{\}\)](#Fatal) +- [func InvokeAsync\(fn func\(\)\)](#InvokeAsync) +- [func InvokeSync\(fn func\(\)\)](#InvokeSync) +- [func InvokeSyncWithError\(fn func\(\) error\) \(err error\)](#InvokeSyncWithError) +- [func InvokeSyncWithResult\[T any\]\(fn func\(\) T\) \(res T\)](#InvokeSyncWithResult) +- [func InvokeSyncWithResultAndError\[T any\]\(fn func\(\) \(T, error\)\) \(res T, err error\)](#InvokeSyncWithResultAndError) +- [func NewIconFromResource\(instance w32.HINSTANCE, resId uint16\) \(w32.HICON, error\)](#NewIconFromResource) +- [func ScaleToDefaultDPI\(pixels int, dpi uint\) int](#ScaleToDefaultDPI) +- [func ScaleWithDPI\(pixels int, dpi uint\) int](#ScaleWithDPI) +- [type ActivationPolicy](#ActivationPolicy) +- [type App](#App) + - [func Get\(\) \*App](#Get) + - [func New\(appOptions Options\) \*App](#New) + - [func \(a \*App\) Capabilities\(\) capabilities.Capabilities](#App.Capabilities) + - [func \(a \*App\) Clipboard\(\) \*Clipboard](#App.Clipboard) + - [func \(a \*App\) CurrentWindow\(\) \*WebviewWindow](#App.CurrentWindow) + - [func \(a \*App\) GetPID\(\) int](#App.GetPID) + - [func \(a \*App\) GetPrimaryScreen\(\) \(\*Screen, error\)](#App.GetPrimaryScreen) + - [func \(a \*App\) GetScreens\(\) \(\[\]\*Screen, error\)](#App.GetScreens) + - [func \(a \*App\) GetWindowByName\(name string\) \*WebviewWindow](#App.GetWindowByName) + - [func \(a \*App\) Hide\(\)](#App.Hide) + - [func \(a \*App\) IsDarkMode\(\) bool](#App.IsDarkMode) + - [func \(a \*App\) NewMenu\(\) \*Menu](#App.NewMenu) + - [func \(a \*App\) NewSystemTray\(\) \*SystemTray](#App.NewSystemTray) + - [func \(a \*App\) NewWebviewWindow\(\) \*WebviewWindow](#App.NewWebviewWindow) + - [func \(a \*App\) NewWebviewWindowWithOptions\(windowOptions WebviewWindowOptions\) \*WebviewWindow](#App.NewWebviewWindowWithOptions) + - [func \(a \*App\) On\(eventType events.ApplicationEventType, callback func\(event \*Event\)\) func\(\)](#App.On) + - [func \(a \*App\) OnWindowCreation\(callback func\(window \*WebviewWindow\)\)](#App.OnWindowCreation) + - [func \(a \*App\) Quit\(\)](#App.Quit) + - [func \(a \*App\) RegisterContextMenu\(name string, menu \*Menu\)](#App.RegisterContextMenu) + - [func \(a \*App\) RegisterHook\(eventType events.ApplicationEventType, callback func\(event \*Event\)\) func\(\)](#App.RegisterHook) + - [func \(a \*App\) Run\(\) error](#App.Run) + - [func \(a \*App\) SetMenu\(menu \*Menu\)](#App.SetMenu) + - [func \(a \*App\) Show\(\)](#App.Show) + - [func \(a \*App\) ShowAboutDialog\(\)](#App.ShowAboutDialog) +- [type ApplicationEventContext](#ApplicationEventContext) + - [func \(c ApplicationEventContext\) IsDarkMode\(\) bool](#ApplicationEventContext.IsDarkMode) + - [func \(c ApplicationEventContext\) OpenedFiles\(\) \[\]string](#ApplicationEventContext.OpenedFiles) +- [type Args](#Args) + - [func \(a \*Args\) Bool\(s string\) \*bool](#Args.Bool) + - [func \(a \*Args\) Float64\(s string\) \*float64](#Args.Float64) + - [func \(a \*Args\) Int\(s string\) \*int](#Args.Int) + - [func \(a \*Args\) String\(key string\) \*string](#Args.String) + - [func \(a \*Args\) UInt\(s string\) \*uint](#Args.UInt) + - [func \(a \*Args\) UInt8\(s string\) \*uint8](#Args.UInt8) +- [type AssetOptions](#AssetOptions) +- [type BackdropType](#BackdropType) +- [type BackgroundType](#BackgroundType) +- [type Bindings](#Bindings) + - [func NewBindings\(structs \[\]any, aliases map\[uint32\]uint32\) \(\*Bindings, error\)](#NewBindings) + - [func \(b \*Bindings\) Add\(structPtr interface\{\}\) error](#Bindings.Add) + - [func \(b \*Bindings\) AddPlugins\(plugins map\[string\]Plugin\) error](#Bindings.AddPlugins) + - [func \(b \*Bindings\) GenerateID\(name string\) \(uint32, error\)](#Bindings.GenerateID) + - [func \(b \*Bindings\) Get\(options \*CallOptions\) \*BoundMethod](#Bindings.Get) + - [func \(b \*Bindings\) GetByID\(id uint32\) \*BoundMethod](#Bindings.GetByID) +- [type BoundMethod](#BoundMethod) + - [func \(b \*BoundMethod\) Call\(args \[\]interface\{\}\) \(returnValue interface\{\}, err error\)](#BoundMethod.Call) + - [func \(b \*BoundMethod\) String\(\) string](#BoundMethod.String) +- [type Button](#Button) + - [func \(b \*Button\) OnClick\(callback func\(\)\) \*Button](#Button.OnClick) + - [func \(b \*Button\) SetAsCancel\(\) \*Button](#Button.SetAsCancel) + - [func \(b \*Button\) SetAsDefault\(\) \*Button](#Button.SetAsDefault) +- [type CallOptions](#CallOptions) + - [func \(c CallOptions\) Name\(\) string](#CallOptions.Name) +- [type Clipboard](#Clipboard) + - [func \(c \*Clipboard\) SetText\(text string\) bool](#Clipboard.SetText) + - [func \(c \*Clipboard\) Text\(\) \(string, bool\)](#Clipboard.Text) +- [type Context](#Context) + - [func \(c \*Context\) ClickedMenuItem\(\) \*MenuItem](#Context.ClickedMenuItem) + - [func \(c \*Context\) ContextMenuData\(\) any](#Context.ContextMenuData) + - [func \(c \*Context\) IsChecked\(\) bool](#Context.IsChecked) +- [type ContextMenuData](#ContextMenuData) +- [type DialogType](#DialogType) +- [type Event](#Event) + - [func \(w \*Event\) Cancel\(\)](#Event.Cancel) + - [func \(w \*Event\) Context\(\) \*ApplicationEventContext](#Event.Context) +- [type EventListener](#EventListener) +- [type EventProcessor](#EventProcessor) + - [func NewWailsEventProcessor\(dispatchEventToWindows func\(\*WailsEvent\)\) \*EventProcessor](#NewWailsEventProcessor) + - [func \(e \*EventProcessor\) Emit\(thisEvent \*WailsEvent\)](#EventProcessor.Emit) + - [func \(e \*EventProcessor\) Off\(eventName string\)](#EventProcessor.Off) + - [func \(e \*EventProcessor\) OffAll\(\)](#EventProcessor.OffAll) + - [func \(e \*EventProcessor\) On\(eventName string, callback func\(event \*WailsEvent\)\) func\(\)](#EventProcessor.On) + - [func \(e \*EventProcessor\) OnMultiple\(eventName string, callback func\(event \*WailsEvent\), counter int\) func\(\)](#EventProcessor.OnMultiple) + - [func \(e \*EventProcessor\) Once\(eventName string, callback func\(event \*WailsEvent\)\) func\(\)](#EventProcessor.Once) + - [func \(e \*EventProcessor\) RegisterHook\(eventName string, callback func\(\*WailsEvent\)\) func\(\)](#EventProcessor.RegisterHook) +- [type FileFilter](#FileFilter) +- [type IconPosition](#IconPosition) +- [type MacAppearanceType](#MacAppearanceType) +- [type MacBackdrop](#MacBackdrop) +- [type MacOptions](#MacOptions) +- [type MacTitleBar](#MacTitleBar) +- [type MacToolbarStyle](#MacToolbarStyle) +- [type MacWindow](#MacWindow) +- [type Menu](#Menu) + - [func NewMenu\(\) \*Menu](#NewMenu) + - [func \(m \*Menu\) Add\(label string\) \*MenuItem](#Menu.Add) + - [func \(m \*Menu\) AddCheckbox\(label string, enabled bool\) \*MenuItem](#Menu.AddCheckbox) + - [func \(m \*Menu\) AddRadio\(label string, enabled bool\) \*MenuItem](#Menu.AddRadio) + - [func \(m \*Menu\) AddRole\(role Role\) \*Menu](#Menu.AddRole) + - [func \(m \*Menu\) AddSeparator\(\)](#Menu.AddSeparator) + - [func \(m \*Menu\) AddSubmenu\(s string\) \*Menu](#Menu.AddSubmenu) + - [func \(m \*Menu\) SetLabel\(label string\)](#Menu.SetLabel) + - [func \(m \*Menu\) Update\(\)](#Menu.Update) +- [type MenuItem](#MenuItem) + - [func \(m \*MenuItem\) Checked\(\) bool](#MenuItem.Checked) + - [func \(m \*MenuItem\) Enabled\(\) bool](#MenuItem.Enabled) + - [func \(m \*MenuItem\) Hidden\(\) bool](#MenuItem.Hidden) + - [func \(m \*MenuItem\) IsCheckbox\(\) bool](#MenuItem.IsCheckbox) + - [func \(m \*MenuItem\) IsRadio\(\) bool](#MenuItem.IsRadio) + - [func \(m \*MenuItem\) IsSeparator\(\) bool](#MenuItem.IsSeparator) + - [func \(m \*MenuItem\) IsSubmenu\(\) bool](#MenuItem.IsSubmenu) + - [func \(m \*MenuItem\) Label\(\) string](#MenuItem.Label) + - [func \(m \*MenuItem\) OnClick\(f func\(\*Context\)\) \*MenuItem](#MenuItem.OnClick) + - [func \(m \*MenuItem\) SetAccelerator\(shortcut string\) \*MenuItem](#MenuItem.SetAccelerator) + - [func \(m \*MenuItem\) SetChecked\(checked bool\) \*MenuItem](#MenuItem.SetChecked) + - [func \(m \*MenuItem\) SetEnabled\(enabled bool\) \*MenuItem](#MenuItem.SetEnabled) + - [func \(m \*MenuItem\) SetHidden\(hidden bool\) \*MenuItem](#MenuItem.SetHidden) + - [func \(m \*MenuItem\) SetLabel\(s string\) \*MenuItem](#MenuItem.SetLabel) + - [func \(m \*MenuItem\) SetTooltip\(s string\) \*MenuItem](#MenuItem.SetTooltip) + - [func \(m \*MenuItem\) Tooltip\(\) string](#MenuItem.Tooltip) +- [type MessageDialog](#MessageDialog) + - [func ErrorDialog\(\) \*MessageDialog](#ErrorDialog) + - [func InfoDialog\(\) \*MessageDialog](#InfoDialog) + - [func OpenDirectoryDialog\(\) \*MessageDialog](#OpenDirectoryDialog) + - [func QuestionDialog\(\) \*MessageDialog](#QuestionDialog) + - [func WarningDialog\(\) \*MessageDialog](#WarningDialog) + - [func \(d \*MessageDialog\) AddButton\(s string\) \*Button](#MessageDialog.AddButton) + - [func \(d \*MessageDialog\) AddButtons\(buttons \[\]\*Button\) \*MessageDialog](#MessageDialog.AddButtons) + - [func \(d \*MessageDialog\) AttachToWindow\(window \*WebviewWindow\) \*MessageDialog](#MessageDialog.AttachToWindow) + - [func \(d \*MessageDialog\) SetCancelButton\(button \*Button\) \*MessageDialog](#MessageDialog.SetCancelButton) + - [func \(d \*MessageDialog\) SetDefaultButton\(button \*Button\) \*MessageDialog](#MessageDialog.SetDefaultButton) + - [func \(d \*MessageDialog\) SetIcon\(icon \[\]byte\) \*MessageDialog](#MessageDialog.SetIcon) + - [func \(d \*MessageDialog\) SetMessage\(message string\) \*MessageDialog](#MessageDialog.SetMessage) + - [func \(d \*MessageDialog\) SetTitle\(title string\) \*MessageDialog](#MessageDialog.SetTitle) + - [func \(d \*MessageDialog\) Show\(\)](#MessageDialog.Show) +- [type MessageDialogOptions](#MessageDialogOptions) +- [type MessageProcessor](#MessageProcessor) + - [func NewMessageProcessor\(logger \*slog.Logger\) \*MessageProcessor](#NewMessageProcessor) + - [func \(m \*MessageProcessor\) Error\(message string, args ...any\)](#MessageProcessor.Error) + - [func \(m \*MessageProcessor\) HandleRuntimeCall\(rw http.ResponseWriter, r \*http.Request\)](#MessageProcessor.HandleRuntimeCall) + - [func \(m \*MessageProcessor\) HandleRuntimeCallWithIDs\(rw http.ResponseWriter, r \*http.Request\)](#MessageProcessor.HandleRuntimeCallWithIDs) + - [func \(m \*MessageProcessor\) Info\(message string, args ...any\)](#MessageProcessor.Info) +- [type Middleware](#Middleware) + - [func ChainMiddleware\(middleware ...Middleware\) Middleware](#ChainMiddleware) +- [type OpenFileDialogOptions](#OpenFileDialogOptions) +- [type OpenFileDialogStruct](#OpenFileDialogStruct) + - [func OpenFileDialog\(\) \*OpenFileDialogStruct](#OpenFileDialog) + - [func OpenFileDialogWithOptions\(options \*OpenFileDialogOptions\) \*OpenFileDialogStruct](#OpenFileDialogWithOptions) + - [func \(d \*OpenFileDialogStruct\) AddFilter\(displayName, pattern string\) \*OpenFileDialogStruct](#OpenFileDialogStruct.AddFilter) + - [func \(d \*OpenFileDialogStruct\) AllowsOtherFileTypes\(allowsOtherFileTypes bool\) \*OpenFileDialogStruct](#OpenFileDialogStruct.AllowsOtherFileTypes) + - [func \(d \*OpenFileDialogStruct\) AttachToWindow\(window \*WebviewWindow\) \*OpenFileDialogStruct](#OpenFileDialogStruct.AttachToWindow) + - [func \(d \*OpenFileDialogStruct\) CanChooseDirectories\(canChooseDirectories bool\) \*OpenFileDialogStruct](#OpenFileDialogStruct.CanChooseDirectories) + - [func \(d \*OpenFileDialogStruct\) CanChooseFiles\(canChooseFiles bool\) \*OpenFileDialogStruct](#OpenFileDialogStruct.CanChooseFiles) + - [func \(d \*OpenFileDialogStruct\) CanCreateDirectories\(canCreateDirectories bool\) \*OpenFileDialogStruct](#OpenFileDialogStruct.CanCreateDirectories) + - [func \(d \*OpenFileDialogStruct\) CanSelectHiddenExtension\(canSelectHiddenExtension bool\) \*OpenFileDialogStruct](#OpenFileDialogStruct.CanSelectHiddenExtension) + - [func \(d \*OpenFileDialogStruct\) HideExtension\(hideExtension bool\) \*OpenFileDialogStruct](#OpenFileDialogStruct.HideExtension) + - [func \(d \*OpenFileDialogStruct\) PromptForMultipleSelection\(\) \(\[\]string, error\)](#OpenFileDialogStruct.PromptForMultipleSelection) + - [func \(d \*OpenFileDialogStruct\) PromptForSingleSelection\(\) \(string, error\)](#OpenFileDialogStruct.PromptForSingleSelection) + - [func \(d \*OpenFileDialogStruct\) ResolvesAliases\(resolvesAliases bool\) \*OpenFileDialogStruct](#OpenFileDialogStruct.ResolvesAliases) + - [func \(d \*OpenFileDialogStruct\) SetButtonText\(text string\) \*OpenFileDialogStruct](#OpenFileDialogStruct.SetButtonText) + - [func \(d \*OpenFileDialogStruct\) SetDirectory\(directory string\) \*OpenFileDialogStruct](#OpenFileDialogStruct.SetDirectory) + - [func \(d \*OpenFileDialogStruct\) SetMessage\(message string\) \*OpenFileDialogStruct](#OpenFileDialogStruct.SetMessage) + - [func \(d \*OpenFileDialogStruct\) SetOptions\(options \*OpenFileDialogOptions\)](#OpenFileDialogStruct.SetOptions) + - [func \(d \*OpenFileDialogStruct\) SetTitle\(title string\) \*OpenFileDialogStruct](#OpenFileDialogStruct.SetTitle) + - [func \(d \*OpenFileDialogStruct\) ShowHiddenFiles\(showHiddenFiles bool\) \*OpenFileDialogStruct](#OpenFileDialogStruct.ShowHiddenFiles) + - [func \(d \*OpenFileDialogStruct\) TreatsFilePackagesAsDirectories\(treatsFilePackagesAsDirectories bool\) \*OpenFileDialogStruct](#OpenFileDialogStruct.TreatsFilePackagesAsDirectories) +- [type Options](#Options) +- [type Parameter](#Parameter) + - [func \(p \*Parameter\) IsError\(\) bool](#Parameter.IsError) + - [func \(p \*Parameter\) IsType\(typename string\) bool](#Parameter.IsType) +- [type Plugin](#Plugin) +- [type PluginCallOptions](#PluginCallOptions) +- [type PluginManager](#PluginManager) + - [func NewPluginManager\(plugins map\[string\]Plugin, assetServer \*assetserver.AssetServer\) \*PluginManager](#NewPluginManager) + - [func \(p \*PluginManager\) Init\(\) error](#PluginManager.Init) + - [func \(p \*PluginManager\) Shutdown\(\)](#PluginManager.Shutdown) +- [type PositionOptions](#PositionOptions) +- [type QueryParams](#QueryParams) + - [func \(qp QueryParams\) Args\(\) \(\*Args, error\)](#QueryParams.Args) + - [func \(qp QueryParams\) Bool\(key string\) \*bool](#QueryParams.Bool) + - [func \(qp QueryParams\) Float64\(key string\) \*float64](#QueryParams.Float64) + - [func \(qp QueryParams\) Int\(key string\) \*int](#QueryParams.Int) + - [func \(qp QueryParams\) String\(key string\) \*string](#QueryParams.String) + - [func \(qp QueryParams\) ToStruct\(str any\) error](#QueryParams.ToStruct) + - [func \(qp QueryParams\) UInt\(key string\) \*uint](#QueryParams.UInt) + - [func \(qp QueryParams\) UInt8\(key string\) \*uint8](#QueryParams.UInt8) +- [type RGBA](#RGBA) +- [type RadioGroup](#RadioGroup) + - [func \(r \*RadioGroup\) Add\(id int, item \*MenuItem\)](#RadioGroup.Add) + - [func \(r \*RadioGroup\) Bounds\(\) \(int, int\)](#RadioGroup.Bounds) + - [func \(r \*RadioGroup\) MenuID\(item \*MenuItem\) int](#RadioGroup.MenuID) +- [type RadioGroupMember](#RadioGroupMember) +- [type Rect](#Rect) +- [type Role](#Role) +- [type SaveFileDialogOptions](#SaveFileDialogOptions) +- [type SaveFileDialogStruct](#SaveFileDialogStruct) + - [func SaveFileDialog\(\) \*SaveFileDialogStruct](#SaveFileDialog) + - [func SaveFileDialogWithOptions\(s \*SaveFileDialogOptions\) \*SaveFileDialogStruct](#SaveFileDialogWithOptions) + - [func \(d \*SaveFileDialogStruct\) AddFilter\(displayName, pattern string\) \*SaveFileDialogStruct](#SaveFileDialogStruct.AddFilter) + - [func \(d \*SaveFileDialogStruct\) AllowsOtherFileTypes\(allowOtherFileTypes bool\) \*SaveFileDialogStruct](#SaveFileDialogStruct.AllowsOtherFileTypes) + - [func \(d \*SaveFileDialogStruct\) AttachToWindow\(window \*WebviewWindow\) \*SaveFileDialogStruct](#SaveFileDialogStruct.AttachToWindow) + - [func \(d \*SaveFileDialogStruct\) CanCreateDirectories\(canCreateDirectories bool\) \*SaveFileDialogStruct](#SaveFileDialogStruct.CanCreateDirectories) + - [func \(d \*SaveFileDialogStruct\) CanSelectHiddenExtension\(canSelectHiddenExtension bool\) \*SaveFileDialogStruct](#SaveFileDialogStruct.CanSelectHiddenExtension) + - [func \(d \*SaveFileDialogStruct\) HideExtension\(hideExtension bool\) \*SaveFileDialogStruct](#SaveFileDialogStruct.HideExtension) + - [func \(d \*SaveFileDialogStruct\) PromptForSingleSelection\(\) \(string, error\)](#SaveFileDialogStruct.PromptForSingleSelection) + - [func \(d \*SaveFileDialogStruct\) SetButtonText\(text string\) \*SaveFileDialogStruct](#SaveFileDialogStruct.SetButtonText) + - [func \(d \*SaveFileDialogStruct\) SetDirectory\(directory string\) \*SaveFileDialogStruct](#SaveFileDialogStruct.SetDirectory) + - [func \(d \*SaveFileDialogStruct\) SetFilename\(filename string\) \*SaveFileDialogStruct](#SaveFileDialogStruct.SetFilename) + - [func \(d \*SaveFileDialogStruct\) SetMessage\(message string\) \*SaveFileDialogStruct](#SaveFileDialogStruct.SetMessage) + - [func \(d \*SaveFileDialogStruct\) SetOptions\(options \*SaveFileDialogOptions\)](#SaveFileDialogStruct.SetOptions) + - [func \(d \*SaveFileDialogStruct\) ShowHiddenFiles\(showHiddenFiles bool\) \*SaveFileDialogStruct](#SaveFileDialogStruct.ShowHiddenFiles) + - [func \(d \*SaveFileDialogStruct\) TreatsFilePackagesAsDirectories\(treatsFilePackagesAsDirectories bool\) \*SaveFileDialogStruct](#SaveFileDialogStruct.TreatsFilePackagesAsDirectories) +- [type Screen](#Screen) +- [type Size](#Size) +- [type SystemTray](#SystemTray) + - [func \(s \*SystemTray\) AttachWindow\(window \*WebviewWindow\) \*SystemTray](#SystemTray.AttachWindow) + - [func \(s \*SystemTray\) Destroy\(\)](#SystemTray.Destroy) + - [func \(s \*SystemTray\) Label\(\) string](#SystemTray.Label) + - [func \(s \*SystemTray\) OnClick\(handler func\(\)\) \*SystemTray](#SystemTray.OnClick) + - [func \(s \*SystemTray\) OnDoubleClick\(handler func\(\)\) \*SystemTray](#SystemTray.OnDoubleClick) + - [func \(s \*SystemTray\) OnMouseEnter\(handler func\(\)\) \*SystemTray](#SystemTray.OnMouseEnter) + - [func \(s \*SystemTray\) OnMouseLeave\(handler func\(\)\) \*SystemTray](#SystemTray.OnMouseLeave) + - [func \(s \*SystemTray\) OnRightClick\(handler func\(\)\) \*SystemTray](#SystemTray.OnRightClick) + - [func \(s \*SystemTray\) OnRightDoubleClick\(handler func\(\)\) \*SystemTray](#SystemTray.OnRightDoubleClick) + - [func \(s \*SystemTray\) OpenMenu\(\)](#SystemTray.OpenMenu) + - [func \(s \*SystemTray\) PositionWindow\(window \*WebviewWindow, offset int\) error](#SystemTray.PositionWindow) + - [func \(s \*SystemTray\) SetDarkModeIcon\(icon \[\]byte\) \*SystemTray](#SystemTray.SetDarkModeIcon) + - [func \(s \*SystemTray\) SetIcon\(icon \[\]byte\) \*SystemTray](#SystemTray.SetIcon) + - [func \(s \*SystemTray\) SetIconPosition\(iconPosition int\) \*SystemTray](#SystemTray.SetIconPosition) + - [func \(s \*SystemTray\) SetLabel\(label string\)](#SystemTray.SetLabel) + - [func \(s \*SystemTray\) SetMenu\(menu \*Menu\) \*SystemTray](#SystemTray.SetMenu) + - [func \(s \*SystemTray\) SetTemplateIcon\(icon \[\]byte\) \*SystemTray](#SystemTray.SetTemplateIcon) + - [func \(s \*SystemTray\) WindowDebounce\(debounce time.Duration\) \*SystemTray](#SystemTray.WindowDebounce) + - [func \(s \*SystemTray\) WindowOffset\(offset int\) \*SystemTray](#SystemTray.WindowOffset) +- [type Theme](#Theme) +- [type ThemeSettings](#ThemeSettings) +- [type WailsEvent](#WailsEvent) + - [func \(e \*WailsEvent\) Cancel\(\)](#WailsEvent.Cancel) +- [type WebviewWindow](#WebviewWindow) + - [func \(w \*WebviewWindow\) AbsolutePosition\(\) \(int, int\)](#WebviewWindow.AbsolutePosition) + - [func \(w \*WebviewWindow\) Center\(\)](#WebviewWindow.Center) + - [func \(w \*WebviewWindow\) Close\(\)](#WebviewWindow.Close) + - [func \(w \*WebviewWindow\) Destroy\(\)](#WebviewWindow.Destroy) + - [func \(w \*WebviewWindow\) ExecJS\(js string\)](#WebviewWindow.ExecJS) + - [func \(w \*WebviewWindow\) Flash\(enabled bool\)](#WebviewWindow.Flash) + - [func \(w \*WebviewWindow\) Focus\(\)](#WebviewWindow.Focus) + - [func \(w \*WebviewWindow\) ForceReload\(\)](#WebviewWindow.ForceReload) + - [func \(w \*WebviewWindow\) Fullscreen\(\) \*WebviewWindow](#WebviewWindow.Fullscreen) + - [func \(w \*WebviewWindow\) GetScreen\(\) \(\*Screen, error\)](#WebviewWindow.GetScreen) + - [func \(w \*WebviewWindow\) GetZoom\(\) float64](#WebviewWindow.GetZoom) + - [func \(w \*WebviewWindow\) Height\(\) int](#WebviewWindow.Height) + - [func \(w \*WebviewWindow\) Hide\(\) \*WebviewWindow](#WebviewWindow.Hide) + - [func \(w \*WebviewWindow\) IsFocused\(\) bool](#WebviewWindow.IsFocused) + - [func \(w \*WebviewWindow\) IsFullscreen\(\) bool](#WebviewWindow.IsFullscreen) + - [func \(w \*WebviewWindow\) IsMaximised\(\) bool](#WebviewWindow.IsMaximised) + - [func \(w \*WebviewWindow\) IsMinimised\(\) bool](#WebviewWindow.IsMinimised) + - [func \(w \*WebviewWindow\) IsVisible\(\) bool](#WebviewWindow.IsVisible) + - [func \(w \*WebviewWindow\) Maximise\(\) \*WebviewWindow](#WebviewWindow.Maximise) + - [func \(w \*WebviewWindow\) Minimise\(\) \*WebviewWindow](#WebviewWindow.Minimise) + - [func \(w \*WebviewWindow\) Name\(\) string](#WebviewWindow.Name) + - [func \(w \*WebviewWindow\) NativeWindowHandle\(\) \(uintptr, error\)](#WebviewWindow.NativeWindowHandle) + - [func \(w \*WebviewWindow\) On\(eventType events.WindowEventType, callback func\(event \*WindowEvent\)\) func\(\)](#WebviewWindow.On) + - [func \(w \*WebviewWindow\) Print\(\) error](#WebviewWindow.Print) + - [func \(w \*WebviewWindow\) RegisterContextMenu\(name string, menu \*Menu\)](#WebviewWindow.RegisterContextMenu) + - [func \(w \*WebviewWindow\) RegisterHook\(eventType events.WindowEventType, callback func\(event \*WindowEvent\)\) func\(\)](#WebviewWindow.RegisterHook) + - [func \(w \*WebviewWindow\) RelativePosition\(\) \(int, int\)](#WebviewWindow.RelativePosition) + - [func \(w \*WebviewWindow\) Reload\(\)](#WebviewWindow.Reload) + - [func \(w \*WebviewWindow\) Resizable\(\) bool](#WebviewWindow.Resizable) + - [func \(w \*WebviewWindow\) Restore\(\)](#WebviewWindow.Restore) + - [func \(w \*WebviewWindow\) SetAbsolutePosition\(x int, y int\)](#WebviewWindow.SetAbsolutePosition) + - [func \(w \*WebviewWindow\) SetAlwaysOnTop\(b bool\) \*WebviewWindow](#WebviewWindow.SetAlwaysOnTop) + - [func \(w \*WebviewWindow\) SetBackgroundColour\(colour RGBA\) \*WebviewWindow](#WebviewWindow.SetBackgroundColour) + - [func \(w \*WebviewWindow\) SetEnabled\(enabled bool\)](#WebviewWindow.SetEnabled) + - [func \(w \*WebviewWindow\) SetFrameless\(frameless bool\) \*WebviewWindow](#WebviewWindow.SetFrameless) + - [func \(w \*WebviewWindow\) SetFullscreenButtonEnabled\(enabled bool\) \*WebviewWindow](#WebviewWindow.SetFullscreenButtonEnabled) + - [func \(w \*WebviewWindow\) SetHTML\(html string\) \*WebviewWindow](#WebviewWindow.SetHTML) + - [func \(w \*WebviewWindow\) SetMaxSize\(maxWidth, maxHeight int\) \*WebviewWindow](#WebviewWindow.SetMaxSize) + - [func \(w \*WebviewWindow\) SetMinSize\(minWidth, minHeight int\) \*WebviewWindow](#WebviewWindow.SetMinSize) + - [func \(w \*WebviewWindow\) SetRelativePosition\(x, y int\) \*WebviewWindow](#WebviewWindow.SetRelativePosition) + - [func \(w \*WebviewWindow\) SetResizable\(b bool\) \*WebviewWindow](#WebviewWindow.SetResizable) + - [func \(w \*WebviewWindow\) SetSize\(width, height int\) \*WebviewWindow](#WebviewWindow.SetSize) + - [func \(w \*WebviewWindow\) SetTitle\(title string\) \*WebviewWindow](#WebviewWindow.SetTitle) + - [func \(w \*WebviewWindow\) SetURL\(s string\) \*WebviewWindow](#WebviewWindow.SetURL) + - [func \(w \*WebviewWindow\) SetZoom\(magnification float64\) \*WebviewWindow](#WebviewWindow.SetZoom) + - [func \(w \*WebviewWindow\) Show\(\) \*WebviewWindow](#WebviewWindow.Show) + - [func \(w \*WebviewWindow\) Size\(\) \(int, int\)](#WebviewWindow.Size) + - [func \(w \*WebviewWindow\) ToggleDevTools\(\)](#WebviewWindow.ToggleDevTools) + - [func \(w \*WebviewWindow\) ToggleFullscreen\(\)](#WebviewWindow.ToggleFullscreen) + - [func \(w \*WebviewWindow\) UnFullscreen\(\)](#WebviewWindow.UnFullscreen) + - [func \(w \*WebviewWindow\) UnMaximise\(\)](#WebviewWindow.UnMaximise) + - [func \(w \*WebviewWindow\) UnMinimise\(\)](#WebviewWindow.UnMinimise) + - [func \(w \*WebviewWindow\) Width\(\) int](#WebviewWindow.Width) + - [func \(w \*WebviewWindow\) Zoom\(\)](#WebviewWindow.Zoom) + - [func \(w \*WebviewWindow\) ZoomIn\(\)](#WebviewWindow.ZoomIn) + - [func \(w \*WebviewWindow\) ZoomOut\(\)](#WebviewWindow.ZoomOut) + - [func \(w \*WebviewWindow\) ZoomReset\(\) \*WebviewWindow](#WebviewWindow.ZoomReset) +- [type WebviewWindowOptions](#WebviewWindowOptions) +- [type Win32Menu](#Win32Menu) + - [func NewApplicationMenu\(parent w32.HWND, inputMenu \*Menu\) \*Win32Menu](#NewApplicationMenu) + - [func NewPopupMenu\(parent w32.HWND, inputMenu \*Menu\) \*Win32Menu](#NewPopupMenu) + - [func \(p \*Win32Menu\) Destroy\(\)](#Win32Menu.Destroy) + - [func \(p \*Win32Menu\) OnMenuClose\(fn func\(\)\)](#Win32Menu.OnMenuClose) + - [func \(p \*Win32Menu\) OnMenuOpen\(fn func\(\)\)](#Win32Menu.OnMenuOpen) + - [func \(p \*Win32Menu\) ProcessCommand\(cmdMsgID int\) bool](#Win32Menu.ProcessCommand) + - [func \(p \*Win32Menu\) ShowAt\(x int, y int\)](#Win32Menu.ShowAt) + - [func \(p \*Win32Menu\) ShowAtCursor\(\)](#Win32Menu.ShowAtCursor) + - [func \(p \*Win32Menu\) Update\(\)](#Win32Menu.Update) + - [func \(p \*Win32Menu\) UpdateMenuItem\(item \*MenuItem\)](#Win32Menu.UpdateMenuItem) +- [type WindowAttachConfig](#WindowAttachConfig) +- [type WindowEvent](#WindowEvent) + - [func NewWindowEvent\(\) \*WindowEvent](#NewWindowEvent) + - [func \(w \*WindowEvent\) Cancel\(\)](#WindowEvent.Cancel) + - [func \(w \*WindowEvent\) Context\(\) \*WindowEventContext](#WindowEvent.Context) +- [type WindowEventContext](#WindowEventContext) + - [func \(c WindowEventContext\) DroppedFiles\(\) \[\]string](#WindowEventContext.DroppedFiles) +- [type WindowEventListener](#WindowEventListener) +- [type WindowState](#WindowState) +- [type WindowsOptions](#WindowsOptions) +- [type WindowsWindow](#WindowsWindow) ## Constants @@ -484,13 +483,15 @@ const ( var BuildInfo *debug.BuildInfo ``` -BuildSettings contains the build settings for the application +BuildSettings contains the build settings for the +application ```go var BuildSettings map[string]string ``` -MacTitleBarDefault results in the default Mac MacTitleBar +MacTitleBarDefault results in the default Mac +MacTitleBar ```go var MacTitleBarDefault = MacTitleBar{ @@ -503,7 +504,9 @@ var MacTitleBarDefault = MacTitleBar{ } ``` -MacTitleBarHidden results in a hidden title bar and a full size content window, yet the title bar still has the standard window controls \(“traffic lights”\) in the top left. +MacTitleBarHidden results in a hidden title bar +and a full size content window, yet the title bar still has the standard window +controls \(“traffic lights”\) in the top left. ```go var MacTitleBarHidden = MacTitleBar{ @@ -516,7 +519,9 @@ var MacTitleBarHidden = MacTitleBar{ } ``` -MacTitleBarHiddenInset results in a hidden title bar with an alternative look where the traffic light buttons are slightly more inset from the window edge. +MacTitleBarHiddenInset results in a hidden +title bar with an alternative look where the traffic light buttons are slightly +more inset from the window edge. ```go var MacTitleBarHiddenInset = MacTitleBar{ @@ -529,7 +534,9 @@ var MacTitleBarHiddenInset = MacTitleBar{ } ``` -MacTitleBarHiddenInsetUnified results in a hidden title bar with an alternative look where the traffic light buttons are even more inset from the window edge. +MacTitleBarHiddenInsetUnified +results in a hidden title bar with an alternative look where the traffic light +buttons are even more inset from the window edge. ```go var MacTitleBarHiddenInsetUnified = MacTitleBar{ @@ -792,97 +799,88 @@ var WebviewWindowDefaults = &WebviewWindowOptions{ ``` -## func [DefaultLogger]() + +## func [DefaultLogger](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/logger_windows.go#L14) ```go func DefaultLogger(level slog.Level) *slog.Logger ``` - - -## func [Fatal]() + +## func [Fatal](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/errors.go#L8) ```go func Fatal(message string, args ...interface{}) ``` - - -## func [InvokeAsync]() + +## func [InvokeAsync](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/mainthread.go#L70) ```go func InvokeAsync(fn func()) ``` - - -## func [InvokeSync]() + +## func [InvokeSync](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/mainthread.go#L23) ```go func InvokeSync(fn func()) ``` - - -## func [InvokeSyncWithError]() + +## func [InvokeSyncWithError](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/mainthread.go#L46) ```go func InvokeSyncWithError(fn func() error) (err error) ``` - - -## func [InvokeSyncWithResult]() + +## func [InvokeSyncWithResult](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/mainthread.go#L34) ```go func InvokeSyncWithResult[T any](fn func() T) (res T) ``` - - -## func [InvokeSyncWithResultAndError]() + +## func [InvokeSyncWithResultAndError](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/mainthread.go#L58) ```go func InvokeSyncWithResultAndError[T any](fn func() (T, error)) (res T, err error) ``` - - -## func [NewIconFromResource]() + +## func [NewIconFromResource](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window_windows.go#L1603) ```go func NewIconFromResource(instance w32.HINSTANCE, resId uint16) (w32.HICON, error) ``` - - -## func [ScaleToDefaultDPI]() + +## func [ScaleToDefaultDPI](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window_windows.go#L1599) ```go func ScaleToDefaultDPI(pixels int, dpi uint) int ``` - - -## func [ScaleWithDPI]() + +## func [ScaleWithDPI](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window_windows.go#L1595) ```go func ScaleWithDPI(pixels int, dpi uint) int ``` - - -## type [ActivationPolicy]() + +## type [ActivationPolicy](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/options_application_mac.go#L4) ActivationPolicy is the activation policy for the application. @@ -904,9 +902,8 @@ const ( ``` -## type [App]() - +## type [App](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L214-L269) ```go type App struct { @@ -921,225 +918,204 @@ type App struct { ``` -### func [Get]() + +### func [Get](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L36) ```go func Get() *App ``` - - -### func [New]() + +### func [New](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L40) ```go func New(appOptions Options) *App ``` - - -### func \(\*App\) [Capabilities]() + +### func \(\*App\) [Capabilities](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L300) ```go func (a *App) Capabilities() capabilities.Capabilities ``` - - -### func \(\*App\) [Clipboard]() + +### func \(\*App\) [Clipboard](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L639) ```go func (a *App) Clipboard() *Clipboard ``` - - -### func \(\*App\) [CurrentWindow]() + +### func \(\*App\) [CurrentWindow](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L563) ```go func (a *App) CurrentWindow() *WebviewWindow ``` - - -### func \(\*App\) [GetPID]() + +### func \(\*App\) [GetPID](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L347) ```go func (a *App) GetPID() int ``` - - -### func \(\*App\) [GetPrimaryScreen]() + +### func \(\*App\) [GetPrimaryScreen](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L631) ```go func (a *App) GetPrimaryScreen() (*Screen, error) ``` - - -### func \(\*App\) [GetScreens]() + +### func \(\*App\) [GetScreens](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L635) ```go func (a *App) GetScreens() ([]*Screen, error) ``` - - -### func \(\*App\) [GetWindowByName]() + +### func \(\*App\) [GetWindowByName](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L716) ```go func (a *App) GetWindowByName(name string) *WebviewWindow ``` - - -### func \(\*App\) [Hide]() + +### func \(\*App\) [Hide](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L686) ```go func (a *App) Hide() ``` - - -### func \(\*App\) [IsDarkMode]() + +### func \(\*App\) [IsDarkMode](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L679) ```go func (a *App) IsDarkMode() bool ``` - - -### func \(\*App\) [NewMenu]() + +### func \(\*App\) [NewMenu](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/menu.go#L98) ```go func (a *App) NewMenu() *Menu ``` - - -### func \(\*App\) [NewSystemTray]() + +### func \(\*App\) [NewSystemTray](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L397) ```go func (a *App) NewSystemTray() *SystemTray ``` - - -### func \(\*App\) [NewWebviewWindow]() + +### func \(\*App\) [NewWebviewWindow](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L343) ```go func (a *App) NewWebviewWindow() *WebviewWindow ``` - - -### func \(\*App\) [NewWebviewWindowWithOptions]() + +### func \(\*App\) [NewWebviewWindowWithOptions](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L379) ```go func (a *App) NewWebviewWindowWithOptions(windowOptions WebviewWindowOptions) *WebviewWindow ``` - - -### func \(\*App\) [On]() + +### func \(\*App\) [On](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L304) ```go func (a *App) On(eventType events.ApplicationEventType, callback func(event *Event)) func() ``` - - -### func \(\*App\) [OnWindowCreation]() + +### func \(\*App\) [OnWindowCreation](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L712) ```go func (a *App) OnWindowCreation(callback func(window *WebviewWindow)) ``` - - -### func \(\*App\) [Quit]() + +### func \(\*App\) [Quit](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L573) ```go func (a *App) Quit() ``` - - -### func \(\*App\) [RegisterContextMenu]() + +### func \(\*App\) [RegisterContextMenu](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L698) ```go func (a *App) RegisterContextMenu(name string, menu *Menu) ``` - - -### func \(\*App\) [RegisterHook]() + +### func \(\*App\) [RegisterHook](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L327) ```go func (a *App) RegisterHook(eventType events.ApplicationEventType, callback func(event *Event)) func() ``` -RegisterHook registers a hook for the given event type. Hooks are called before the event listeners and can cancel the event. The returned function can be called to remove the hook. +RegisterHook registers a hook for the given event type. Hooks are called before +the event listeners and can cancel the event. The returned function can be +called to remove the hook. -### func \(\*App\) [Run]() + +### func \(\*App\) [Run](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L410) ```go func (a *App) Run() error ``` - - -### func \(\*App\) [SetMenu]() + +### func \(\*App\) [SetMenu](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L591) ```go func (a *App) SetMenu(menu *Menu) ``` - - -### func \(\*App\) [Show]() + +### func \(\*App\) [Show](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L692) ```go func (a *App) Show() ``` - - -### func \(\*App\) [ShowAboutDialog]() + +### func \(\*App\) [ShowAboutDialog](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L597) ```go func (a *App) ShowAboutDialog() ``` - - -## type [ApplicationEventContext]() - +## type [ApplicationEventContext](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/context_application_event.go#L10-L13) ```go type ApplicationEventContext struct { @@ -1148,27 +1124,24 @@ type ApplicationEventContext struct { ``` -### func \(ApplicationEventContext\) [IsDarkMode]() + +### func \(ApplicationEventContext\) [IsDarkMode](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/context_application_event.go#L35) ```go func (c ApplicationEventContext) IsDarkMode() bool ``` - - -### func \(ApplicationEventContext\) [OpenedFiles]() + +### func \(ApplicationEventContext\) [OpenedFiles](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/context_application_event.go#L15) ```go func (c ApplicationEventContext) OpenedFiles() []string ``` - - -## type [Args]() - +## type [Args](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/messageprocessor_params.go#L109-L111) ```go type Args struct { @@ -1177,61 +1150,56 @@ type Args struct { ``` -### func \(\*Args\) [Bool]() + +### func \(\*Args\) [Bool](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/messageprocessor_params.go#L178) ```go func (a *Args) Bool(s string) *bool ``` - - -### func \(\*Args\) [Float64]() + +### func \(\*Args\) [Float64](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/messageprocessor_params.go#L167) ```go func (a *Args) Float64(s string) *float64 ``` - - -### func \(\*Args\) [Int]() + +### func \(\*Args\) [Int](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/messageprocessor_params.go#L124) ```go func (a *Args) Int(s string) *int ``` - - -### func \(\*Args\) [String]() + +### func \(\*Args\) [String](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/messageprocessor_params.go#L113) ```go func (a *Args) String(key string) *string ``` - - -### func \(\*Args\) [UInt]() + +### func \(\*Args\) [UInt](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/messageprocessor_params.go#L157) ```go func (a *Args) UInt(s string) *uint ``` - - -### func \(\*Args\) [UInt8]() + +### func \(\*Args\) [UInt8](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/messageprocessor_params.go#L148) ```go func (a *Args) UInt8(s string) *uint8 ``` - - -## type [AssetOptions]() + +## type [AssetOptions](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/options_application.go#L57-L87) AssetOptions defines the configuration of the AssetServer. @@ -1270,9 +1238,8 @@ type AssetOptions struct { ``` -## type [BackdropType]() - +## type [BackdropType](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/options_webview_window_win.go#L5) ```go type BackdropType int32 @@ -1291,9 +1258,8 @@ const ( ``` -## type [BackgroundType]() - +## type [BackgroundType](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/options_webview_window.go#L137) ```go type BackgroundType int @@ -1310,9 +1276,8 @@ const ( ``` -## type [Bindings]() - +## type [Bindings](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/bindings.go#L76-L80) ```go type Bindings struct { @@ -1321,16 +1286,16 @@ type Bindings struct { ``` -### func [NewBindings]() + +### func [NewBindings](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/bindings.go#L82) ```go func NewBindings(structs []any, aliases map[uint32]uint32) (*Bindings, error) ``` - - -### func \(\*Bindings\) [Add]() + +### func \(\*Bindings\) [Add](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/bindings.go#L98) ```go func (b *Bindings) Add(structPtr interface{}) error @@ -1339,16 +1304,16 @@ func (b *Bindings) Add(structPtr interface{}) error Add the given struct methods to the Bindings -### func \(\*Bindings\) [AddPlugins]() + +### func \(\*Bindings\) [AddPlugins](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/bindings.go#L123) ```go func (b *Bindings) AddPlugins(plugins map[string]Plugin) error ``` - - -### func \(\*Bindings\) [GenerateID]() + +### func \(\*Bindings\) [GenerateID](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/bindings.go#L190) ```go func (b *Bindings) GenerateID(name string) (uint32, error) @@ -1357,7 +1322,8 @@ func (b *Bindings) GenerateID(name string) (uint32, error) GenerateID generates a unique ID for a binding -### func \(\*Bindings\) [Get]() + +### func \(\*Bindings\) [Get](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/bindings.go#L161) ```go func (b *Bindings) Get(options *CallOptions) *BoundMethod @@ -1366,7 +1332,8 @@ func (b *Bindings) Get(options *CallOptions) *BoundMethod Get returns the bound method with the given name -### func \(\*Bindings\) [GetByID]() + +### func \(\*Bindings\) [GetByID](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/bindings.go#L178) ```go func (b *Bindings) GetByID(id uint32) *BoundMethod @@ -1375,9 +1342,11 @@ func (b *Bindings) GetByID(id uint32) *BoundMethod GetByID returns the bound method with the given ID -## type [BoundMethod]() -BoundMethod defines all the data related to a Go method that is bound to the Wails application +## type [BoundMethod](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/bindings.go#L64-L74) + +BoundMethod defines all the data related to a Go method that is bound to the +Wails application ```go type BoundMethod struct { @@ -1394,7 +1363,8 @@ type BoundMethod struct { ``` -### func \(\*BoundMethod\) [Call]() + +### func \(\*BoundMethod\) [Call](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/bindings.go#L298) ```go func (b *BoundMethod) Call(args []interface{}) (returnValue interface{}, err error) @@ -1403,18 +1373,16 @@ func (b *BoundMethod) Call(args []interface{}) (returnValue interface{}, err err Call will attempt to call this bound method with the given args -### func \(\*BoundMethod\) [String]() + +### func \(\*BoundMethod\) [String](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/bindings.go#L203) ```go func (b *BoundMethod) String() string ``` - - -## type [Button]() - +## type [Button](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L47-L52) ```go type Button struct { @@ -1426,36 +1394,32 @@ type Button struct { ``` -### func \(\*Button\) [OnClick]() + +### func \(\*Button\) [OnClick](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L54) ```go func (b *Button) OnClick(callback func()) *Button ``` - - -### func \(\*Button\) [SetAsCancel]() + +### func \(\*Button\) [SetAsCancel](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L64) ```go func (b *Button) SetAsCancel() *Button ``` - - -### func \(\*Button\) [SetAsDefault]() + +### func \(\*Button\) [SetAsDefault](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L59) ```go func (b *Button) SetAsDefault() *Button ``` - - -## type [CallOptions]() - +## type [CallOptions](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/bindings.go#L13-L19) ```go type CallOptions struct { @@ -1468,18 +1432,16 @@ type CallOptions struct { ``` -### func \(CallOptions\) [Name]() + +### func \(CallOptions\) [Name](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/bindings.go#L21) ```go func (c CallOptions) Name() string ``` - - -## type [Clipboard]() - +## type [Clipboard](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/clipboard.go#L8-L10) ```go type Clipboard struct { @@ -1488,27 +1450,24 @@ type Clipboard struct { ``` -### func \(\*Clipboard\) [SetText]() + +### func \(\*Clipboard\) [SetText](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/clipboard.go#L18) ```go func (c *Clipboard) SetText(text string) bool ``` - - -### func \(\*Clipboard\) [Text]() + +### func \(\*Clipboard\) [Text](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/clipboard.go#L22) ```go func (c *Clipboard) Text() (string, bool) ``` - - -## type [Context]() - +## type [Context](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/context.go#L3-L6) ```go type Context struct { @@ -1517,36 +1476,32 @@ type Context struct { ``` -### func \(\*Context\) [ClickedMenuItem]() + +### func \(\*Context\) [ClickedMenuItem](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/context.go#L20) ```go func (c *Context) ClickedMenuItem() *MenuItem ``` - - -### func \(\*Context\) [ContextMenuData]() + +### func \(\*Context\) [ContextMenuData](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/context.go#L35) ```go func (c *Context) ContextMenuData() any ``` - - -### func \(\*Context\) [IsChecked]() + +### func \(\*Context\) [IsChecked](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/context.go#L28) ```go func (c *Context) IsChecked() bool ``` - - -## type [ContextMenuData]() - +## type [ContextMenuData](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/messageprocessor_contextmenu.go#L7-L12) ```go type ContextMenuData struct { @@ -1558,9 +1513,8 @@ type ContextMenuData struct { ``` -## type [DialogType]() - +## type [DialogType](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L8) ```go type DialogType int @@ -1579,9 +1533,8 @@ const ( ``` -## type [Event]() - +## type [Event](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/events.go#L10-L14) ```go type Event struct { @@ -1593,27 +1546,24 @@ type Event struct { ``` -### func \(\*Event\) [Cancel]() + +### func \(\*Event\) [Cancel](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/events.go#L27) ```go func (w *Event) Cancel() ``` - - -### func \(\*Event\) [Context]() + +### func \(\*Event\) [Context](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/events.go#L16) ```go func (w *Event) Context() *ApplicationEventContext ``` - - -## type [EventListener]() - +## type [EventListener](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L32-L34) ```go type EventListener struct { @@ -1622,7 +1572,8 @@ type EventListener struct { ``` -## type [EventProcessor]() + +## type [EventProcessor](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/events.go#L77-L84) EventProcessor handles custom events @@ -1633,16 +1584,16 @@ type EventProcessor struct { ``` -### func [NewWailsEventProcessor]() + +### func [NewWailsEventProcessor](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/events.go#L86) ```go func NewWailsEventProcessor(dispatchEventToWindows func(*WailsEvent)) *EventProcessor ``` - - -### func \(\*EventProcessor\) [Emit]() + +### func \(\*EventProcessor\) [Emit](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/events.go#L110) ```go func (e *EventProcessor) Emit(thisEvent *WailsEvent) @@ -1651,25 +1602,24 @@ func (e *EventProcessor) Emit(thisEvent *WailsEvent) Emit sends an event to all listeners -### func \(\*EventProcessor\) [Off]() + +### func \(\*EventProcessor\) [Off](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/events.go#L131) ```go func (e *EventProcessor) Off(eventName string) ``` - - -### func \(\*EventProcessor\) [OffAll]() + +### func \(\*EventProcessor\) [OffAll](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/events.go#L135) ```go func (e *EventProcessor) OffAll() ``` - - -### func \(\*EventProcessor\) [On]() + +### func \(\*EventProcessor\) [On](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/events.go#L95) ```go func (e *EventProcessor) On(eventName string, callback func(event *WailsEvent)) func() @@ -1678,7 +1628,8 @@ func (e *EventProcessor) On(eventName string, callback func(event *WailsEvent)) On is the equivalent of Javascript's \`addEventListener\` -### func \(\*EventProcessor\) [OnMultiple]() + +### func \(\*EventProcessor\) [OnMultiple](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/events.go#L100) ```go func (e *EventProcessor) OnMultiple(eventName string, callback func(event *WailsEvent), counter int) func() @@ -1687,7 +1638,8 @@ func (e *EventProcessor) OnMultiple(eventName string, callback func(event *Wails OnMultiple is the same as \`On\` but will unregister after \`count\` events -### func \(\*EventProcessor\) [Once]() + +### func \(\*EventProcessor\) [Once](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/events.go#L105) ```go func (e *EventProcessor) Once(eventName string, callback func(event *WailsEvent)) func() @@ -1696,18 +1648,19 @@ func (e *EventProcessor) Once(eventName string, callback func(event *WailsEvent) Once is the same as \`On\` but will unregister after the first event -### func \(\*EventProcessor\) [RegisterHook]() + +### func \(\*EventProcessor\) [RegisterHook](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/events.go#L167) ```go func (e *EventProcessor) RegisterHook(eventName string, callback func(*WailsEvent)) func() ``` -RegisterHook provides a means of registering methods to be called before emitting the event +RegisterHook provides a means of registering methods to be called before +emitting the event -## type [FileFilter]() - +## type [FileFilter](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L165-L168) ```go type FileFilter struct { @@ -1717,16 +1670,16 @@ type FileFilter struct { ``` -## type [IconPosition]() - +## type [IconPosition](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/systemtray.go#L12) ```go type IconPosition int ``` -## type [MacAppearanceType]() + +## type [MacAppearanceType](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/options_mac.go#L119) MacAppearanceType is a type of Appearance for Cocoa windows @@ -1758,7 +1711,8 @@ const ( ``` -## type [MacBackdrop]() + +## type [MacBackdrop](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/options_mac.go#L6) MacBackdrop is the backdrop type for macOS @@ -1780,7 +1734,8 @@ const ( ``` -## type [MacOptions]() + +## type [MacOptions](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/options_application_mac.go#L16-L22) MacOptions contains options for macOS applications. @@ -1795,7 +1750,8 @@ type MacOptions struct { ``` -## type [MacTitleBar]() + +## type [MacTitleBar](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/options_mac.go#L54-L69) MacTitleBar contains options for the Mac titlebar @@ -1819,7 +1775,8 @@ type MacTitleBar struct { ``` -## type [MacToolbarStyle]() + +## type [MacToolbarStyle](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/options_mac.go#L18) MacToolbarStyle is the style of toolbar for macOS @@ -1845,7 +1802,8 @@ const ( ``` -## type [MacWindow]() + +## type [MacWindow](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/options_mac.go#L34-L51) MacWindow contains macOS specific options for Webview Windows @@ -1871,9 +1829,8 @@ type MacWindow struct { ``` -## type [Menu]() - +## type [Menu](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/menu.go#L7-L12) ```go type Menu struct { @@ -1882,90 +1839,80 @@ type Menu struct { ``` -### func [NewMenu]() + +### func [NewMenu](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/menu.go#L14) ```go func NewMenu() *Menu ``` - - -### func \(\*Menu\) [Add]() + +### func \(\*Menu\) [Add](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/menu.go#L18) ```go func (m *Menu) Add(label string) *MenuItem ``` - - -### func \(\*Menu\) [AddCheckbox]() + +### func \(\*Menu\) [AddCheckbox](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/menu.go#L29) ```go func (m *Menu) AddCheckbox(label string, enabled bool) *MenuItem ``` - - -### func \(\*Menu\) [AddRadio]() + +### func \(\*Menu\) [AddRadio](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/menu.go#L35) ```go func (m *Menu) AddRadio(label string, enabled bool) *MenuItem ``` - - -### func \(\*Menu\) [AddRole]() + +### func \(\*Menu\) [AddRole](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/menu.go#L55) ```go func (m *Menu) AddRole(role Role) *Menu ``` - - -### func \(\*Menu\) [AddSeparator]() + +### func \(\*Menu\) [AddSeparator](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/menu.go#L24) ```go func (m *Menu) AddSeparator() ``` - - -### func \(\*Menu\) [AddSubmenu]() + +### func \(\*Menu\) [AddSubmenu](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/menu.go#L49) ```go func (m *Menu) AddSubmenu(s string) *Menu ``` - - -### func \(\*Menu\) [SetLabel]() + +### func \(\*Menu\) [SetLabel](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/menu.go#L88) ```go func (m *Menu) SetLabel(label string) ``` - - -### func \(\*Menu\) [Update]() + +### func \(\*Menu\) [Update](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/menu.go#L41) ```go func (m *Menu) Update() ``` - - -## type [MenuItem]() - +## type [MenuItem](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/menuitem.go#L45-L61) ```go type MenuItem struct { @@ -1974,153 +1921,136 @@ type MenuItem struct { ``` -### func \(\*MenuItem\) [Checked]() + +### func \(\*MenuItem\) [Checked](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/menuitem.go#L273) ```go func (m *MenuItem) Checked() bool ``` - - -### func \(\*MenuItem\) [Enabled]() + +### func \(\*MenuItem\) [Enabled](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/menuitem.go#L310) ```go func (m *MenuItem) Enabled() bool ``` - - -### func \(\*MenuItem\) [Hidden]() + +### func \(\*MenuItem\) [Hidden](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/menuitem.go#L293) ```go func (m *MenuItem) Hidden() bool ``` - - -### func \(\*MenuItem\) [IsCheckbox]() + +### func \(\*MenuItem\) [IsCheckbox](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/menuitem.go#L285) ```go func (m *MenuItem) IsCheckbox() bool ``` - - -### func \(\*MenuItem\) [IsRadio]() + +### func \(\*MenuItem\) [IsRadio](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/menuitem.go#L289) ```go func (m *MenuItem) IsRadio() bool ``` - - -### func \(\*MenuItem\) [IsSeparator]() + +### func \(\*MenuItem\) [IsSeparator](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/menuitem.go#L277) ```go func (m *MenuItem) IsSeparator() bool ``` - - -### func \(\*MenuItem\) [IsSubmenu]() + +### func \(\*MenuItem\) [IsSubmenu](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/menuitem.go#L281) ```go func (m *MenuItem) IsSubmenu() bool ``` - - -### func \(\*MenuItem\) [Label]() + +### func \(\*MenuItem\) [Label](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/menuitem.go#L302) ```go func (m *MenuItem) Label() string ``` - - -### func \(\*MenuItem\) [OnClick]() + +### func \(\*MenuItem\) [OnClick](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/menuitem.go#L297) ```go func (m *MenuItem) OnClick(f func(*Context)) *MenuItem ``` - - -### func \(\*MenuItem\) [SetAccelerator]() + +### func \(\*MenuItem\) [SetAccelerator](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/menuitem.go#L220) ```go func (m *MenuItem) SetAccelerator(shortcut string) *MenuItem ``` - - -### func \(\*MenuItem\) [SetChecked]() + +### func \(\*MenuItem\) [SetChecked](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/menuitem.go#L257) ```go func (m *MenuItem) SetChecked(checked bool) *MenuItem ``` - - -### func \(\*MenuItem\) [SetEnabled]() + +### func \(\*MenuItem\) [SetEnabled](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/menuitem.go#L249) ```go func (m *MenuItem) SetEnabled(enabled bool) *MenuItem ``` - - -### func \(\*MenuItem\) [SetHidden]() + +### func \(\*MenuItem\) [SetHidden](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/menuitem.go#L265) ```go func (m *MenuItem) SetHidden(hidden bool) *MenuItem ``` - - -### func \(\*MenuItem\) [SetLabel]() + +### func \(\*MenuItem\) [SetLabel](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/menuitem.go#L241) ```go func (m *MenuItem) SetLabel(s string) *MenuItem ``` - - -### func \(\*MenuItem\) [SetTooltip]() + +### func \(\*MenuItem\) [SetTooltip](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/menuitem.go#L233) ```go func (m *MenuItem) SetTooltip(s string) *MenuItem ``` - - -### func \(\*MenuItem\) [Tooltip]() + +### func \(\*MenuItem\) [Tooltip](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/menuitem.go#L306) ```go func (m *MenuItem) Tooltip() string ``` - - -## type [MessageDialog]() - +## type [MessageDialog](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L82-L87) ```go type MessageDialog struct { @@ -2130,135 +2060,120 @@ type MessageDialog struct { ``` -### func [ErrorDialog]() + +### func [ErrorDialog](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L615) ```go func ErrorDialog() *MessageDialog ``` - - -### func [InfoDialog]() + +### func [InfoDialog](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L603) ```go func InfoDialog() *MessageDialog ``` - - -### func [OpenDirectoryDialog]() + +### func [OpenDirectoryDialog](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L619) ```go func OpenDirectoryDialog() *MessageDialog ``` - - -### func [QuestionDialog]() + +### func [QuestionDialog](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L607) ```go func QuestionDialog() *MessageDialog ``` - - -### func [WarningDialog]() + +### func [WarningDialog](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L611) ```go func WarningDialog() *MessageDialog ``` - - -### func \(\*MessageDialog\) [AddButton]() + +### func \(\*MessageDialog\) [AddButton](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L122) ```go func (d *MessageDialog) AddButton(s string) *Button ``` - - -### func \(\*MessageDialog\) [AddButtons]() + +### func \(\*MessageDialog\) [AddButtons](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L130) ```go func (d *MessageDialog) AddButtons(buttons []*Button) *MessageDialog ``` - - -### func \(\*MessageDialog\) [AttachToWindow]() + +### func \(\*MessageDialog\) [AttachToWindow](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L135) ```go func (d *MessageDialog) AttachToWindow(window *WebviewWindow) *MessageDialog ``` - - -### func \(\*MessageDialog\) [SetCancelButton]() + +### func \(\*MessageDialog\) [SetCancelButton](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L148) ```go func (d *MessageDialog) SetCancelButton(button *Button) *MessageDialog ``` - - -### func \(\*MessageDialog\) [SetDefaultButton]() + +### func \(\*MessageDialog\) [SetDefaultButton](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L140) ```go func (d *MessageDialog) SetDefaultButton(button *Button) *MessageDialog ``` - - -### func \(\*MessageDialog\) [SetIcon]() + +### func \(\*MessageDialog\) [SetIcon](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L117) ```go func (d *MessageDialog) SetIcon(icon []byte) *MessageDialog ``` - - -### func \(\*MessageDialog\) [SetMessage]() + +### func \(\*MessageDialog\) [SetMessage](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L156) ```go func (d *MessageDialog) SetMessage(message string) *MessageDialog ``` - - -### func \(\*MessageDialog\) [SetTitle]() + +### func \(\*MessageDialog\) [SetTitle](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L105) ```go func (d *MessageDialog) SetTitle(title string) *MessageDialog ``` - - -### func \(\*MessageDialog\) [Show]() + +### func \(\*MessageDialog\) [Show](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L110) ```go func (d *MessageDialog) Show() ``` - - -## type [MessageDialogOptions]() - +## type [MessageDialogOptions](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L73-L80) ```go type MessageDialogOptions struct { @@ -2272,9 +2187,8 @@ type MessageDialogOptions struct { ``` -## type [MessageProcessor]() - +## type [MessageProcessor](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/messageprocessor.go#L26-L29) ```go type MessageProcessor struct { @@ -2283,61 +2197,60 @@ type MessageProcessor struct { ``` -### func [NewMessageProcessor]() + +### func [NewMessageProcessor](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/messageprocessor.go#L31) ```go func NewMessageProcessor(logger *slog.Logger) *MessageProcessor ``` - - -### func \(\*MessageProcessor\) [Error]() + +### func \(\*MessageProcessor\) [Error](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/messageprocessor.go#L147) ```go func (m *MessageProcessor) Error(message string, args ...any) ``` - - -### func \(\*MessageProcessor\) [HandleRuntimeCall]() + +### func \(\*MessageProcessor\) [HandleRuntimeCall](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/messageprocessor.go#L65) ```go func (m *MessageProcessor) HandleRuntimeCall(rw http.ResponseWriter, r *http.Request) ``` - - -### func \(\*MessageProcessor\) [HandleRuntimeCallWithIDs]() + +### func \(\*MessageProcessor\) [HandleRuntimeCallWithIDs](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/messageprocessor.go#L104) ```go func (m *MessageProcessor) HandleRuntimeCallWithIDs(rw http.ResponseWriter, r *http.Request) ``` - - -### func \(\*MessageProcessor\) [Info]() + +### func \(\*MessageProcessor\) [Info](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/messageprocessor.go#L151) ```go func (m *MessageProcessor) Info(message string, args ...any) ``` - - -## type [Middleware]() -Middleware defines HTTP middleware that can be applied to the AssetServer. The handler passed as next is the next handler in the chain. One can decide to call the next handler or implement a specialized handling. +## type [Middleware](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/options_application.go#L92) + +Middleware defines HTTP middleware that can be applied to the AssetServer. The +handler passed as next is the next handler in the chain. One can decide to call +the next handler or implement a specialized handling. ```go type Middleware func(next http.Handler) http.Handler ``` -### func [ChainMiddleware]() + +### func [ChainMiddleware](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/options_application.go#L95) ```go func ChainMiddleware(middleware ...Middleware) Middleware @@ -2346,9 +2259,8 @@ func ChainMiddleware(middleware ...Middleware) Middleware ChainMiddleware allows chaining multiple middlewares to one middleware. -## type [OpenFileDialogOptions]() - +## type [OpenFileDialogOptions](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L170-L188) ```go type OpenFileDialogOptions struct { @@ -2373,9 +2285,8 @@ type OpenFileDialogOptions struct { ``` -## type [OpenFileDialogStruct]() - +## type [OpenFileDialogStruct](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L190-L211) ```go type OpenFileDialogStruct struct { @@ -2384,189 +2295,172 @@ type OpenFileDialogStruct struct { ``` -### func [OpenFileDialog]() + +### func [OpenFileDialog](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L623) ```go func OpenFileDialog() *OpenFileDialogStruct ``` - - -### func [OpenFileDialogWithOptions]() + +### func [OpenFileDialogWithOptions](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L661) ```go func OpenFileDialogWithOptions(options *OpenFileDialogOptions) *OpenFileDialogStruct ``` - - -### func \(\*OpenFileDialogStruct\) [AddFilter]() + +### func \(\*OpenFileDialogStruct\) [AddFilter](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L279) ```go func (d *OpenFileDialogStruct) AddFilter(displayName, pattern string) *OpenFileDialogStruct ``` -AddFilter adds a filter to the dialog. The filter is a display name and a semicolon separated list of extensions. EG: AddFilter\("Image Files", "\*.jpg;\*.png"\) +AddFilter adds a filter to the dialog. The filter is a display name and a +semicolon separated list of extensions. EG: AddFilter\("Image Files", +"\*.jpg;\*.png"\) -### func \(\*OpenFileDialogStruct\) [AllowsOtherFileTypes]() + +### func \(\*OpenFileDialogStruct\) [AllowsOtherFileTypes](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L228) ```go func (d *OpenFileDialogStruct) AllowsOtherFileTypes(allowsOtherFileTypes bool) *OpenFileDialogStruct ``` - - -### func \(\*OpenFileDialogStruct\) [AttachToWindow]() + +### func \(\*OpenFileDialogStruct\) [AttachToWindow](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L248) ```go func (d *OpenFileDialogStruct) AttachToWindow(window *WebviewWindow) *OpenFileDialogStruct ``` - - -### func \(\*OpenFileDialogStruct\) [CanChooseDirectories]() + +### func \(\*OpenFileDialogStruct\) [CanChooseDirectories](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L218) ```go func (d *OpenFileDialogStruct) CanChooseDirectories(canChooseDirectories bool) *OpenFileDialogStruct ``` - - -### func \(\*OpenFileDialogStruct\) [CanChooseFiles]() + +### func \(\*OpenFileDialogStruct\) [CanChooseFiles](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L213) ```go func (d *OpenFileDialogStruct) CanChooseFiles(canChooseFiles bool) *OpenFileDialogStruct ``` - - -### func \(\*OpenFileDialogStruct\) [CanCreateDirectories]() + +### func \(\*OpenFileDialogStruct\) [CanCreateDirectories](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L223) ```go func (d *OpenFileDialogStruct) CanCreateDirectories(canCreateDirectories bool) *OpenFileDialogStruct ``` - - -### func \(\*OpenFileDialogStruct\) [CanSelectHiddenExtension]() + +### func \(\*OpenFileDialogStruct\) [CanSelectHiddenExtension](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L310) ```go func (d *OpenFileDialogStruct) CanSelectHiddenExtension(canSelectHiddenExtension bool) *OpenFileDialogStruct ``` - - -### func \(\*OpenFileDialogStruct\) [HideExtension]() + +### func \(\*OpenFileDialogStruct\) [HideExtension](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L238) ```go func (d *OpenFileDialogStruct) HideExtension(hideExtension bool) *OpenFileDialogStruct ``` - - -### func \(\*OpenFileDialogStruct\) [PromptForMultipleSelection]() + +### func \(\*OpenFileDialogStruct\) [PromptForMultipleSelection](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L287) ```go func (d *OpenFileDialogStruct) PromptForMultipleSelection() ([]string, error) ``` - - -### func \(\*OpenFileDialogStruct\) [PromptForSingleSelection]() + +### func \(\*OpenFileDialogStruct\) [PromptForSingleSelection](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L263) ```go func (d *OpenFileDialogStruct) PromptForSingleSelection() (string, error) ``` - - -### func \(\*OpenFileDialogStruct\) [ResolvesAliases]() + +### func \(\*OpenFileDialogStruct\) [ResolvesAliases](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L253) ```go func (d *OpenFileDialogStruct) ResolvesAliases(resolvesAliases bool) *OpenFileDialogStruct ``` - - -### func \(\*OpenFileDialogStruct\) [SetButtonText]() + +### func \(\*OpenFileDialogStruct\) [SetButtonText](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L300) ```go func (d *OpenFileDialogStruct) SetButtonText(text string) *OpenFileDialogStruct ``` - - -### func \(\*OpenFileDialogStruct\) [SetDirectory]() + +### func \(\*OpenFileDialogStruct\) [SetDirectory](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L305) ```go func (d *OpenFileDialogStruct) SetDirectory(directory string) *OpenFileDialogStruct ``` - - -### func \(\*OpenFileDialogStruct\) [SetMessage]() + +### func \(\*OpenFileDialogStruct\) [SetMessage](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L295) ```go func (d *OpenFileDialogStruct) SetMessage(message string) *OpenFileDialogStruct ``` - - -### func \(\*OpenFileDialogStruct\) [SetOptions]() + +### func \(\*OpenFileDialogStruct\) [SetOptions](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L315) ```go func (d *OpenFileDialogStruct) SetOptions(options *OpenFileDialogOptions) ``` - - -### func \(\*OpenFileDialogStruct\) [SetTitle]() + +### func \(\*OpenFileDialogStruct\) [SetTitle](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L258) ```go func (d *OpenFileDialogStruct) SetTitle(title string) *OpenFileDialogStruct ``` - - -### func \(\*OpenFileDialogStruct\) [ShowHiddenFiles]() + +### func \(\*OpenFileDialogStruct\) [ShowHiddenFiles](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L233) ```go func (d *OpenFileDialogStruct) ShowHiddenFiles(showHiddenFiles bool) *OpenFileDialogStruct ``` - - -### func \(\*OpenFileDialogStruct\) [TreatsFilePackagesAsDirectories]() + +### func \(\*OpenFileDialogStruct\) [TreatsFilePackagesAsDirectories](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L243) ```go func (d *OpenFileDialogStruct) TreatsFilePackagesAsDirectories(treatsFilePackagesAsDirectories bool) *OpenFileDialogStruct ``` - - -## type [Options]() - +## type [Options](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/options_application.go#L9-L54) ```go type Options struct { @@ -2618,7 +2512,8 @@ type Options struct { ``` -## type [Parameter]() + +## type [Parameter](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/bindings.go#L38-L42) Parameter defines a Go method parameter @@ -2631,7 +2526,8 @@ type Parameter struct { ``` -### func \(\*Parameter\) [IsError]() + +### func \(\*Parameter\) [IsError](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/bindings.go#L58) ```go func (p *Parameter) IsError() bool @@ -2640,7 +2536,8 @@ func (p *Parameter) IsError() bool IsError returns true if the parameter type is an error -### func \(\*Parameter\) [IsType]() + +### func \(\*Parameter\) [IsType](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/bindings.go#L53) ```go func (p *Parameter) IsType(typename string) bool @@ -2649,9 +2546,8 @@ func (p *Parameter) IsType(typename string) bool IsType returns true if the given -## type [Plugin]() - +## type [Plugin](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/plugins.go#L5-L11) ```go type Plugin interface { @@ -2664,9 +2560,8 @@ type Plugin interface { ``` -## type [PluginCallOptions]() - +## type [PluginCallOptions](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/bindings.go#L25-L28) ```go type PluginCallOptions struct { @@ -2676,9 +2571,8 @@ type PluginCallOptions struct { ``` -## type [PluginManager]() - +## type [PluginManager](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/plugins.go#L13-L17) ```go type PluginManager struct { @@ -2687,36 +2581,32 @@ type PluginManager struct { ``` -### func [NewPluginManager]() + +### func [NewPluginManager](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/plugins.go#L19) ```go func NewPluginManager(plugins map[string]Plugin, assetServer *assetserver.AssetServer) *PluginManager ``` - - -### func \(\*PluginManager\) [Init]() + +### func \(\*PluginManager\) [Init](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/plugins.go#L27) ```go func (p *PluginManager) Init() error ``` - - -### func \(\*PluginManager\) [Shutdown]() + +### func \(\*PluginManager\) [Shutdown](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/plugins.go#L45) ```go func (p *PluginManager) Shutdown() ``` - - -## type [PositionOptions]() - +## type [PositionOptions](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/systemtray.go#L41-L43) ```go type PositionOptions struct { @@ -2725,90 +2615,80 @@ type PositionOptions struct { ``` -## type [QueryParams]() - +## type [QueryParams](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/messageprocessor_params.go#L9) ```go type QueryParams map[string][]string ``` -### func \(QueryParams\) [Args]() + +### func \(QueryParams\) [Args](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/messageprocessor_params.go#L189) ```go func (qp QueryParams) Args() (*Args, error) ``` - - -### func \(QueryParams\) [Bool]() + +### func \(QueryParams\) [Bool](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/messageprocessor_params.go#L77) ```go func (qp QueryParams) Bool(key string) *bool ``` - - -### func \(QueryParams\) [Float64]() + +### func \(QueryParams\) [Float64](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/messageprocessor_params.go#L89) ```go func (qp QueryParams) Float64(key string) *float64 ``` - - -### func \(QueryParams\) [Int]() + +### func \(QueryParams\) [Int](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/messageprocessor_params.go#L22) ```go func (qp QueryParams) Int(key string) *int ``` - - -### func \(QueryParams\) [String]() + +### func \(QueryParams\) [String](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/messageprocessor_params.go#L11) ```go func (qp QueryParams) String(key string) *string ``` - - -### func \(QueryParams\) [ToStruct]() + +### func \(QueryParams\) [ToStruct](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/messageprocessor_params.go#L101) ```go func (qp QueryParams) ToStruct(str any) error ``` - - -### func \(QueryParams\) [UInt]() + +### func \(QueryParams\) [UInt](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/messageprocessor_params.go#L55) ```go func (qp QueryParams) UInt(key string) *uint ``` - - -### func \(QueryParams\) [UInt8]() + +### func \(QueryParams\) [UInt8](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/messageprocessor_params.go#L34) ```go func (qp QueryParams) UInt8(key string) *uint8 ``` - - -## type [RGBA]() - +## type [RGBA](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/options_webview_window.go#L133-L135) ```go type RGBA struct { @@ -2817,45 +2697,40 @@ type RGBA struct { ``` -## type [RadioGroup]() - +## type [RadioGroup](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/popupmenu_windows.go#L17) ```go type RadioGroup []*RadioGroupMember ``` -### func \(\*RadioGroup\) [Add]() + +### func \(\*RadioGroup\) [Add](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/popupmenu_windows.go#L19) ```go func (r *RadioGroup) Add(id int, item *MenuItem) ``` - - -### func \(\*RadioGroup\) [Bounds]() + +### func \(\*RadioGroup\) [Bounds](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/popupmenu_windows.go#L26) ```go func (r *RadioGroup) Bounds() (int, int) ``` - - -### func \(\*RadioGroup\) [MenuID]() + +### func \(\*RadioGroup\) [MenuID](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/popupmenu_windows.go#L31) ```go func (r *RadioGroup) MenuID(item *MenuItem) int ``` - - -## type [RadioGroupMember]() - +## type [RadioGroupMember](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/popupmenu_windows.go#L12-L15) ```go type RadioGroupMember struct { @@ -2865,9 +2740,8 @@ type RadioGroupMember struct { ``` -## type [Rect]() - +## type [Rect](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/screen.go#L16-L21) ```go type Rect struct { @@ -2879,7 +2753,8 @@ type Rect struct { ``` -## type [Role]() + +## type [Role](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/roles.go#L9) Role is a type to identify menu roles @@ -2887,7 +2762,8 @@ Role is a type to identify menu roles type Role uint ``` -These constants need to be kept in sync with \`v2/internal/frontend/desktop/darwin/Role.h\` +These constants need to be kept in sync with +\`v2/internal/frontend/desktop/darwin/Role.h\` ```go const ( @@ -2930,9 +2806,8 @@ const ( ``` -## type [SaveFileDialogOptions]() - +## type [SaveFileDialogOptions](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L351-L365) ```go type SaveFileDialogOptions struct { @@ -2953,9 +2828,8 @@ type SaveFileDialogOptions struct { ``` -## type [SaveFileDialogStruct]() - +## type [SaveFileDialogStruct](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L367-L385) ```go type SaveFileDialogStruct struct { @@ -2964,153 +2838,140 @@ type SaveFileDialogStruct struct { ``` -### func [SaveFileDialog]() + +### func [SaveFileDialog](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L627) ```go func SaveFileDialog() *SaveFileDialogStruct ``` - - -### func [SaveFileDialogWithOptions]() + +### func [SaveFileDialogWithOptions](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/application.go#L667) ```go func SaveFileDialogWithOptions(s *SaveFileDialogOptions) *SaveFileDialogStruct ``` - - -### func \(\*SaveFileDialogStruct\) [AddFilter]() + +### func \(\*SaveFileDialogStruct\) [AddFilter](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L409) ```go func (d *SaveFileDialogStruct) AddFilter(displayName, pattern string) *SaveFileDialogStruct ``` -AddFilter adds a filter to the dialog. The filter is a display name and a semicolon separated list of extensions. EG: AddFilter\("Image Files", "\*.jpg;\*.png"\) +AddFilter adds a filter to the dialog. The filter is a display name and a +semicolon separated list of extensions. EG: AddFilter\("Image Files", +"\*.jpg;\*.png"\) -### func \(\*SaveFileDialogStruct\) [AllowsOtherFileTypes]() + +### func \(\*SaveFileDialogStruct\) [AllowsOtherFileTypes](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L464) ```go func (d *SaveFileDialogStruct) AllowsOtherFileTypes(allowOtherFileTypes bool) *SaveFileDialogStruct ``` - - -### func \(\*SaveFileDialogStruct\) [AttachToWindow]() + +### func \(\*SaveFileDialogStruct\) [AttachToWindow](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L442) ```go func (d *SaveFileDialogStruct) AttachToWindow(window *WebviewWindow) *SaveFileDialogStruct ``` - - -### func \(\*SaveFileDialogStruct\) [CanCreateDirectories]() + +### func \(\*SaveFileDialogStruct\) [CanCreateDirectories](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L417) ```go func (d *SaveFileDialogStruct) CanCreateDirectories(canCreateDirectories bool) *SaveFileDialogStruct ``` - - -### func \(\*SaveFileDialogStruct\) [CanSelectHiddenExtension]() + +### func \(\*SaveFileDialogStruct\) [CanSelectHiddenExtension](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L422) ```go func (d *SaveFileDialogStruct) CanSelectHiddenExtension(canSelectHiddenExtension bool) *SaveFileDialogStruct ``` - - -### func \(\*SaveFileDialogStruct\) [HideExtension]() + +### func \(\*SaveFileDialogStruct\) [HideExtension](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L469) ```go func (d *SaveFileDialogStruct) HideExtension(hideExtension bool) *SaveFileDialogStruct ``` - - -### func \(\*SaveFileDialogStruct\) [PromptForSingleSelection]() + +### func \(\*SaveFileDialogStruct\) [PromptForSingleSelection](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L447) ```go func (d *SaveFileDialogStruct) PromptForSingleSelection() (string, error) ``` - - -### func \(\*SaveFileDialogStruct\) [SetButtonText]() + +### func \(\*SaveFileDialogStruct\) [SetButtonText](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L454) ```go func (d *SaveFileDialogStruct) SetButtonText(text string) *SaveFileDialogStruct ``` - - -### func \(\*SaveFileDialogStruct\) [SetDirectory]() + +### func \(\*SaveFileDialogStruct\) [SetDirectory](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L437) ```go func (d *SaveFileDialogStruct) SetDirectory(directory string) *SaveFileDialogStruct ``` - - -### func \(\*SaveFileDialogStruct\) [SetFilename]() + +### func \(\*SaveFileDialogStruct\) [SetFilename](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L459) ```go func (d *SaveFileDialogStruct) SetFilename(filename string) *SaveFileDialogStruct ``` - - -### func \(\*SaveFileDialogStruct\) [SetMessage]() + +### func \(\*SaveFileDialogStruct\) [SetMessage](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L432) ```go func (d *SaveFileDialogStruct) SetMessage(message string) *SaveFileDialogStruct ``` - - -### func \(\*SaveFileDialogStruct\) [SetOptions]() + +### func \(\*SaveFileDialogStruct\) [SetOptions](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L391) ```go func (d *SaveFileDialogStruct) SetOptions(options *SaveFileDialogOptions) ``` - - -### func \(\*SaveFileDialogStruct\) [ShowHiddenFiles]() + +### func \(\*SaveFileDialogStruct\) [ShowHiddenFiles](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L427) ```go func (d *SaveFileDialogStruct) ShowHiddenFiles(showHiddenFiles bool) *SaveFileDialogStruct ``` - - -### func \(\*SaveFileDialogStruct\) [TreatsFilePackagesAsDirectories]() + +### func \(\*SaveFileDialogStruct\) [TreatsFilePackagesAsDirectories](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/dialogs.go#L474) ```go func (d *SaveFileDialogStruct) TreatsFilePackagesAsDirectories(treatsFilePackagesAsDirectories bool) *SaveFileDialogStruct ``` - - -## type [Screen]() - +## type [Screen](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/screen.go#L3-L14) ```go type Screen struct { @@ -3128,9 +2989,8 @@ type Screen struct { ``` -## type [Size]() - +## type [Size](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/screen.go#L23-L26) ```go type Size struct { @@ -3140,9 +3000,8 @@ type Size struct { ``` -## type [SystemTray]() - +## type [SystemTray](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/systemtray.go#L45-L66) ```go type SystemTray struct { @@ -3151,169 +3010,162 @@ type SystemTray struct { ``` -### func \(\*SystemTray\) [AttachWindow]() + +### func \(\*SystemTray\) [AttachWindow](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/systemtray.go#L247) ```go func (s *SystemTray) AttachWindow(window *WebviewWindow) *SystemTray ``` -AttachWindow attaches a window to the system tray. The window will be shown when the system tray icon is clicked. The window will be hidden when the system tray icon is clicked again, or when the window loses focus. +AttachWindow attaches a window to the system tray. The window will be shown when +the system tray icon is clicked. The window will be hidden when the system tray +icon is clicked again, or when the window loses focus. -### func \(\*SystemTray\) [Destroy]() + +### func \(\*SystemTray\) [Destroy](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/systemtray.go#L187) ```go func (s *SystemTray) Destroy() ``` - - -### func \(\*SystemTray\) [Label]() + +### func \(\*SystemTray\) [Label](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/systemtray.go#L93) ```go func (s *SystemTray) Label() string ``` - - -### func \(\*SystemTray\) [OnClick]() + +### func \(\*SystemTray\) [OnClick](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/systemtray.go#L194) ```go func (s *SystemTray) OnClick(handler func()) *SystemTray ``` - - -### func \(\*SystemTray\) [OnDoubleClick]() + +### func \(\*SystemTray\) [OnDoubleClick](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/systemtray.go#L204) ```go func (s *SystemTray) OnDoubleClick(handler func()) *SystemTray ``` - - -### func \(\*SystemTray\) [OnMouseEnter]() + +### func \(\*SystemTray\) [OnMouseEnter](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/systemtray.go#L214) ```go func (s *SystemTray) OnMouseEnter(handler func()) *SystemTray ``` - - -### func \(\*SystemTray\) [OnMouseLeave]() + +### func \(\*SystemTray\) [OnMouseLeave](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/systemtray.go#L219) ```go func (s *SystemTray) OnMouseLeave(handler func()) *SystemTray ``` - - -### func \(\*SystemTray\) [OnRightClick]() + +### func \(\*SystemTray\) [OnRightClick](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/systemtray.go#L199) ```go func (s *SystemTray) OnRightClick(handler func()) *SystemTray ``` - - -### func \(\*SystemTray\) [OnRightDoubleClick]() + +### func \(\*SystemTray\) [OnRightDoubleClick](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/systemtray.go#L209) ```go func (s *SystemTray) OnRightDoubleClick(handler func()) *SystemTray ``` - - -### func \(\*SystemTray\) [OpenMenu]() + +### func \(\*SystemTray\) [OpenMenu](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/systemtray.go#L290) ```go func (s *SystemTray) OpenMenu() ``` - - -### func \(\*SystemTray\) [PositionWindow]() + +### func \(\*SystemTray\) [PositionWindow](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/systemtray.go#L122) ```go func (s *SystemTray) PositionWindow(window *WebviewWindow, offset int) error ``` - - -### func \(\*SystemTray\) [SetDarkModeIcon]() + +### func \(\*SystemTray\) [SetDarkModeIcon](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/systemtray.go#L142) ```go func (s *SystemTray) SetDarkModeIcon(icon []byte) *SystemTray ``` - - -### func \(\*SystemTray\) [SetIcon]() + +### func \(\*SystemTray\) [SetIcon](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/systemtray.go#L131) ```go func (s *SystemTray) SetIcon(icon []byte) *SystemTray ``` - - -### func \(\*SystemTray\) [SetIconPosition]() + +### func \(\*SystemTray\) [SetIconPosition](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/systemtray.go#L164) ```go func (s *SystemTray) SetIconPosition(iconPosition int) *SystemTray ``` - - -### func \(\*SystemTray\) [SetLabel]() + +### func \(\*SystemTray\) [SetLabel](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/systemtray.go#L83) ```go func (s *SystemTray) SetLabel(label string) ``` - - -### func \(\*SystemTray\) [SetMenu]() + +### func \(\*SystemTray\) [SetMenu](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/systemtray.go#L153) ```go func (s *SystemTray) SetMenu(menu *Menu) *SystemTray ``` - - -### func \(\*SystemTray\) [SetTemplateIcon]() + +### func \(\*SystemTray\) [SetTemplateIcon](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/systemtray.go#L175) ```go func (s *SystemTray) SetTemplateIcon(icon []byte) *SystemTray ``` - - -### func \(\*SystemTray\) [WindowDebounce]() + +### func \(\*SystemTray\) [WindowDebounce](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/systemtray.go#L262) ```go func (s *SystemTray) WindowDebounce(debounce time.Duration) *SystemTray ``` -WindowDebounce is used by Windows to indicate how long to wait before responding to a mouse up event on the notification icon. This prevents the window from being hidden and then immediately shown when the user clicks on the system tray icon. See https://stackoverflow.com/questions/4585283/alternate-showing-hiding-window-when-notify-icon-is-clicked +WindowDebounce is used by Windows to indicate how long to wait before responding +to a mouse up event on the notification icon. This prevents the window from +being hidden and then immediately shown when the user clicks on the system tray +icon. See +https://stackoverflow.com/questions/4585283/alternate-showing-hiding-window-when-notify-icon-is-clicked -### func \(\*SystemTray\) [WindowOffset]() + +### func \(\*SystemTray\) [WindowOffset](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/systemtray.go#L253) ```go func (s *SystemTray) WindowOffset(offset int) *SystemTray @@ -3322,9 +3174,8 @@ func (s *SystemTray) WindowOffset(offset int) *SystemTray WindowOffset sets the gap in pixels between the system tray and the window -## type [Theme]() - +## type [Theme](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/options_webview_window_win.go#L79) ```go type Theme int @@ -3344,9 +3195,11 @@ const ( ``` -## type [ThemeSettings]() -ThemeSettings defines custom colours to use in dark or light mode. They may be set using the hex values: 0x00BBGGRR +## type [ThemeSettings](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/options_webview_window_win.go#L92-L105) + +ThemeSettings defines custom colours to use in dark or light mode. They may be +set using the hex values: 0x00BBGGRR ```go type ThemeSettings struct { @@ -3366,9 +3219,8 @@ type ThemeSettings struct { ``` -## type [WailsEvent]() - +## type [WailsEvent](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/events.go#L42-L47) ```go type WailsEvent struct { @@ -3380,18 +3232,16 @@ type WailsEvent struct { ``` -### func \(\*WailsEvent\) [Cancel]() + +### func \(\*WailsEvent\) [Cancel](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/events.go#L49) ```go func (e *WailsEvent) Cancel() ``` - - -## type [WebviewWindow]() - +## type [WebviewWindow](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L97-L116) ```go type WebviewWindow struct { @@ -3400,7 +3250,8 @@ type WebviewWindow struct { ``` -### func \(\*WebviewWindow\) [AbsolutePosition]() + +### func \(\*WebviewWindow\) [AbsolutePosition](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L679) ```go func (w *WebviewWindow) AbsolutePosition() (int, int) @@ -3409,7 +3260,8 @@ func (w *WebviewWindow) AbsolutePosition() (int, int) AbsolutePosition returns the absolute position of the window to the screen -### func \(\*WebviewWindow\) [Center]() + +### func \(\*WebviewWindow\) [Center](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L580) ```go func (w *WebviewWindow) Center() @@ -3418,7 +3270,8 @@ func (w *WebviewWindow) Center() Center centers the window on the screen -### func \(\*WebviewWindow\) [Close]() + +### func \(\*WebviewWindow\) [Close](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L770) ```go func (w *WebviewWindow) Close() @@ -3427,16 +3280,16 @@ func (w *WebviewWindow) Close() Close closes the window -### func \(\*WebviewWindow\) [Destroy]() + +### func \(\*WebviewWindow\) [Destroy](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L690) ```go func (w *WebviewWindow) Destroy() ``` - - -### func \(\*WebviewWindow\) [ExecJS]() + +### func \(\*WebviewWindow\) [ExecJS](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L434) ```go func (w *WebviewWindow) ExecJS(js string) @@ -3445,7 +3298,8 @@ func (w *WebviewWindow) ExecJS(js string) ExecJS executes the given javascript in the context of the window. -### func \(\*WebviewWindow\) [Flash]() + +### func \(\*WebviewWindow\) [Flash](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L465) ```go func (w *WebviewWindow) Flash(enabled bool) @@ -3454,16 +3308,16 @@ func (w *WebviewWindow) Flash(enabled bool) Flash flashes the window's taskbar button/icon. Windows only. -### func \(\*WebviewWindow\) [Focus]() + +### func \(\*WebviewWindow\) [Focus](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L1004) ```go func (w *WebviewWindow) Focus() ``` - - -### func \(\*WebviewWindow\) [ForceReload]() + +### func \(\*WebviewWindow\) [ForceReload](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L712) ```go func (w *WebviewWindow) ForceReload() @@ -3472,16 +3326,19 @@ func (w *WebviewWindow) ForceReload() ForceReload forces the window to reload the page assets -### func \(\*WebviewWindow\) [Fullscreen]() + +### func \(\*WebviewWindow\) [Fullscreen](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L442) ```go func (w *WebviewWindow) Fullscreen() *WebviewWindow ``` -Fullscreen sets the window to fullscreen mode. Min/Max size constraints are disabled. +Fullscreen sets the window to fullscreen mode. Min/Max size constraints are +disabled. -### func \(\*WebviewWindow\) [GetScreen]() + +### func \(\*WebviewWindow\) [GetScreen](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L916) ```go func (w *WebviewWindow) GetScreen() (*Screen, error) @@ -3490,7 +3347,8 @@ func (w *WebviewWindow) GetScreen() (*Screen, error) GetScreen returns the screen that the window is on -### func \(\*WebviewWindow\) [GetZoom]() + +### func \(\*WebviewWindow\) [GetZoom](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L346) ```go func (w *WebviewWindow) GetZoom() float64 @@ -3499,7 +3357,8 @@ func (w *WebviewWindow) GetZoom() float64 GetZoom returns the current zoom level of the window. -### func \(\*WebviewWindow\) [Height]() + +### func \(\*WebviewWindow\) [Height](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L659) ```go func (w *WebviewWindow) Height() int @@ -3508,7 +3367,8 @@ func (w *WebviewWindow) Height() int Height returns the height of the window -### func \(\*WebviewWindow\) [Hide]() + +### func \(\*WebviewWindow\) [Hide](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L315) ```go func (w *WebviewWindow) Hide() *WebviewWindow @@ -3517,7 +3377,8 @@ func (w *WebviewWindow) Hide() *WebviewWindow Hide hides the window. -### func \(\*WebviewWindow\) [IsFocused]() + +### func \(\*WebviewWindow\) [IsFocused](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L511) ```go func (w *WebviewWindow) IsFocused() bool @@ -3526,7 +3387,8 @@ func (w *WebviewWindow) IsFocused() bool IsFocused returns true if the window is currently focused -### func \(\*WebviewWindow\) [IsFullscreen]() + +### func \(\*WebviewWindow\) [IsFullscreen](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L519) ```go func (w *WebviewWindow) IsFullscreen() bool @@ -3535,7 +3397,8 @@ func (w *WebviewWindow) IsFullscreen() bool IsFullscreen returns true if the window is fullscreen -### func \(\*WebviewWindow\) [IsMaximised]() + +### func \(\*WebviewWindow\) [IsMaximised](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L491) ```go func (w *WebviewWindow) IsMaximised() bool @@ -3544,7 +3407,8 @@ func (w *WebviewWindow) IsMaximised() bool IsMaximised returns true if the window is maximised -### func \(\*WebviewWindow\) [IsMinimised]() + +### func \(\*WebviewWindow\) [IsMinimised](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L475) ```go func (w *WebviewWindow) IsMinimised() bool @@ -3553,7 +3417,8 @@ func (w *WebviewWindow) IsMinimised() bool IsMinimised returns true if the window is minimised -### func \(\*WebviewWindow\) [IsVisible]() + +### func \(\*WebviewWindow\) [IsVisible](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L483) ```go func (w *WebviewWindow) IsVisible() bool @@ -3562,7 +3427,8 @@ func (w *WebviewWindow) IsVisible() bool IsVisible returns true if the window is visible -### func \(\*WebviewWindow\) [Maximise]() + +### func \(\*WebviewWindow\) [Maximise](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L822) ```go func (w *WebviewWindow) Maximise() *WebviewWindow @@ -3571,7 +3437,8 @@ func (w *WebviewWindow) Maximise() *WebviewWindow Maximise maximises the window. Min/Max size constraints are disabled. -### func \(\*WebviewWindow\) [Minimise]() + +### func \(\*WebviewWindow\) [Minimise](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L809) ```go func (w *WebviewWindow) Minimise() *WebviewWindow @@ -3580,7 +3447,8 @@ func (w *WebviewWindow) Minimise() *WebviewWindow Minimise minimises the window. -### func \(\*WebviewWindow\) [Name]() + +### func \(\*WebviewWindow\) [Name](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L234) ```go func (w *WebviewWindow) Name() string @@ -3589,7 +3457,8 @@ func (w *WebviewWindow) Name() string Name returns the name of the window -### func \(\*WebviewWindow\) [NativeWindowHandle]() + +### func \(\*WebviewWindow\) [NativeWindowHandle](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L997) ```go func (w *WebviewWindow) NativeWindowHandle() (uintptr, error) @@ -3598,7 +3467,8 @@ func (w *WebviewWindow) NativeWindowHandle() (uintptr, error) NativeWindowHandle returns the platform native window handle for the window. -### func \(\*WebviewWindow\) [On]() + +### func \(\*WebviewWindow\) [On](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L589) ```go func (w *WebviewWindow) On(eventType events.WindowEventType, callback func(event *WindowEvent)) func() @@ -3607,16 +3477,16 @@ func (w *WebviewWindow) On(eventType events.WindowEventType, callback func(event On registers a callback for the given window event -### func \(\*WebviewWindow\) [Print]() + +### func \(\*WebviewWindow\) [Print](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L1027) ```go func (w *WebviewWindow) Print() error ``` - - -### func \(\*WebviewWindow\) [RegisterContextMenu]() + +### func \(\*WebviewWindow\) [RegisterContextMenu](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L990) ```go func (w *WebviewWindow) RegisterContextMenu(name string, menu *Menu) @@ -3625,7 +3495,8 @@ func (w *WebviewWindow) RegisterContextMenu(name string, menu *Menu) RegisterContextMenu registers a context menu and assigns it the given name. -### func \(\*WebviewWindow\) [RegisterHook]() + +### func \(\*WebviewWindow\) [RegisterHook](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L609) ```go func (w *WebviewWindow) RegisterHook(eventType events.WindowEventType, callback func(event *WindowEvent)) func() @@ -3634,7 +3505,8 @@ func (w *WebviewWindow) RegisterHook(eventType events.WindowEventType, callback RegisterHook registers a hook for the given window event -### func \(\*WebviewWindow\) [RelativePosition]() + +### func \(\*WebviewWindow\) [RelativePosition](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L667) ```go func (w *WebviewWindow) RelativePosition() (int, int) @@ -3643,7 +3515,8 @@ func (w *WebviewWindow) RelativePosition() (int, int) RelativePosition returns the relative position of the window to the screen -### func \(\*WebviewWindow\) [Reload]() + +### func \(\*WebviewWindow\) [Reload](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L704) ```go func (w *WebviewWindow) Reload() @@ -3652,7 +3525,8 @@ func (w *WebviewWindow) Reload() Reload reloads the page assets -### func \(\*WebviewWindow\) [Resizable]() + +### func \(\*WebviewWindow\) [Resizable](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L365) ```go func (w *WebviewWindow) Resizable() bool @@ -3661,25 +3535,27 @@ func (w *WebviewWindow) Resizable() bool Resizable returns true if the window is resizable. -### func \(\*WebviewWindow\) [Restore]() + +### func \(\*WebviewWindow\) [Restore](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L871) ```go func (w *WebviewWindow) Restore() ``` -Restore restores the window to its previous state if it was previously minimised, maximised or fullscreen. +Restore restores the window to its previous state if it was previously +minimised, maximised or fullscreen. -### func \(\*WebviewWindow\) [SetAbsolutePosition]() + +### func \(\*WebviewWindow\) [SetAbsolutePosition](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L1043) ```go func (w *WebviewWindow) SetAbsolutePosition(x int, y int) ``` - - -### func \(\*WebviewWindow\) [SetAlwaysOnTop]() + +### func \(\*WebviewWindow\) [SetAlwaysOnTop](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L290) ```go func (w *WebviewWindow) SetAlwaysOnTop(b bool) *WebviewWindow @@ -3688,7 +3564,8 @@ func (w *WebviewWindow) SetAlwaysOnTop(b bool) *WebviewWindow SetAlwaysOnTop sets the window to be always on top. -### func \(\*WebviewWindow\) [SetBackgroundColour]() + +### func \(\*WebviewWindow\) [SetBackgroundColour](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L527) ```go func (w *WebviewWindow) SetBackgroundColour(colour RGBA) *WebviewWindow @@ -3697,16 +3574,16 @@ func (w *WebviewWindow) SetBackgroundColour(colour RGBA) *WebviewWindow SetBackgroundColour sets the background colour of the window -### func \(\*WebviewWindow\) [SetEnabled]() + +### func \(\*WebviewWindow\) [SetEnabled](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L1034) ```go func (w *WebviewWindow) SetEnabled(enabled bool) ``` - - -### func \(\*WebviewWindow\) [SetFrameless]() + +### func \(\*WebviewWindow\) [SetFrameless](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L924) ```go func (w *WebviewWindow) SetFrameless(frameless bool) *WebviewWindow @@ -3715,16 +3592,16 @@ func (w *WebviewWindow) SetFrameless(frameless bool) *WebviewWindow SetFrameless removes the window frame and title bar -### func \(\*WebviewWindow\) [SetFullscreenButtonEnabled]() + +### func \(\*WebviewWindow\) [SetFullscreenButtonEnabled](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L454) ```go func (w *WebviewWindow) SetFullscreenButtonEnabled(enabled bool) *WebviewWindow ``` - - -### func \(\*WebviewWindow\) [SetHTML]() + +### func \(\*WebviewWindow\) [SetHTML](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L786) ```go func (w *WebviewWindow) SetHTML(html string) *WebviewWindow @@ -3733,7 +3610,8 @@ func (w *WebviewWindow) SetHTML(html string) *WebviewWindow SetHTML sets the HTML of the window to the given html string. -### func \(\*WebviewWindow\) [SetMaxSize]() + +### func \(\*WebviewWindow\) [SetMaxSize](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L402) ```go func (w *WebviewWindow) SetMaxSize(maxWidth, maxHeight int) *WebviewWindow @@ -3742,7 +3620,8 @@ func (w *WebviewWindow) SetMaxSize(maxWidth, maxHeight int) *WebviewWindow SetMaxSize sets the maximum size of the window. -### func \(\*WebviewWindow\) [SetMinSize]() + +### func \(\*WebviewWindow\) [SetMinSize](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L370) ```go func (w *WebviewWindow) SetMinSize(minWidth, minHeight int) *WebviewWindow @@ -3751,7 +3630,8 @@ func (w *WebviewWindow) SetMinSize(minWidth, minHeight int) *WebviewWindow SetMinSize sets the minimum size of the window. -### func \(\*WebviewWindow\) [SetRelativePosition]() + +### func \(\*WebviewWindow\) [SetRelativePosition](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L797) ```go func (w *WebviewWindow) SetRelativePosition(x, y int) *WebviewWindow @@ -3760,7 +3640,8 @@ func (w *WebviewWindow) SetRelativePosition(x, y int) *WebviewWindow SetRelativePosition sets the position of the window. -### func \(\*WebviewWindow\) [SetResizable]() + +### func \(\*WebviewWindow\) [SetResizable](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L354) ```go func (w *WebviewWindow) SetResizable(b bool) *WebviewWindow @@ -3769,7 +3650,8 @@ func (w *WebviewWindow) SetResizable(b bool) *WebviewWindow SetResizable sets whether the window is resizable. -### func \(\*WebviewWindow\) [SetSize]() + +### func \(\*WebviewWindow\) [SetSize](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L239) ```go func (w *WebviewWindow) SetSize(width, height int) *WebviewWindow @@ -3778,7 +3660,8 @@ func (w *WebviewWindow) SetSize(width, height int) *WebviewWindow SetSize sets the size of the window -### func \(\*WebviewWindow\) [SetTitle]() + +### func \(\*WebviewWindow\) [SetTitle](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L223) ```go func (w *WebviewWindow) SetTitle(title string) *WebviewWindow @@ -3787,16 +3670,16 @@ func (w *WebviewWindow) SetTitle(title string) *WebviewWindow SetTitle sets the title of the window -### func \(\*WebviewWindow\) [SetURL]() + +### func \(\*WebviewWindow\) [SetURL](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L324) ```go func (w *WebviewWindow) SetURL(s string) *WebviewWindow ``` - - -### func \(\*WebviewWindow\) [SetZoom]() + +### func \(\*WebviewWindow\) [SetZoom](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L335) ```go func (w *WebviewWindow) SetZoom(magnification float64) *WebviewWindow @@ -3805,7 +3688,8 @@ func (w *WebviewWindow) SetZoom(magnification float64) *WebviewWindow SetZoom sets the zoom level of the window. -### func \(\*WebviewWindow\) [Show]() + +### func \(\*WebviewWindow\) [Show](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L301) ```go func (w *WebviewWindow) Show() *WebviewWindow @@ -3814,7 +3698,8 @@ func (w *WebviewWindow) Show() *WebviewWindow Show shows the window. -### func \(\*WebviewWindow\) [Size]() + +### func \(\*WebviewWindow\) [Size](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L499) ```go func (w *WebviewWindow) Size() (int, int) @@ -3823,16 +3708,16 @@ func (w *WebviewWindow) Size() (int, int) Size returns the size of the window -### func \(\*WebviewWindow\) [ToggleDevTools]() + +### func \(\*WebviewWindow\) [ToggleDevTools](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L733) ```go func (w *WebviewWindow) ToggleDevTools() ``` - - -### func \(\*WebviewWindow\) [ToggleFullscreen]() + +### func \(\*WebviewWindow\) [ToggleFullscreen](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L720) ```go func (w *WebviewWindow) ToggleFullscreen() @@ -3841,7 +3726,8 @@ func (w *WebviewWindow) ToggleFullscreen() ToggleFullscreen toggles the window between fullscreen and normal -### func \(\*WebviewWindow\) [UnFullscreen]() + +### func \(\*WebviewWindow\) [UnFullscreen](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L859) ```go func (w *WebviewWindow) UnFullscreen() @@ -3850,7 +3736,8 @@ func (w *WebviewWindow) UnFullscreen() UnFullscreen un\-fullscreens the window. -### func \(\*WebviewWindow\) [UnMaximise]() + +### func \(\*WebviewWindow\) [UnMaximise](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L847) ```go func (w *WebviewWindow) UnMaximise() @@ -3859,7 +3746,8 @@ func (w *WebviewWindow) UnMaximise() UnMaximise un\-maximises the window. -### func \(\*WebviewWindow\) [UnMinimise]() + +### func \(\*WebviewWindow\) [UnMinimise](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L836) ```go func (w *WebviewWindow) UnMinimise() @@ -3868,7 +3756,8 @@ func (w *WebviewWindow) UnMinimise() UnMinimise un\-minimises the window. Min/Max size constraints are re\-enabled. -### func \(\*WebviewWindow\) [Width]() + +### func \(\*WebviewWindow\) [Width](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L651) ```go func (w *WebviewWindow) Width() int @@ -3877,16 +3766,16 @@ func (w *WebviewWindow) Width() int Width returns the width of the window -### func \(\*WebviewWindow\) [Zoom]() + +### func \(\*WebviewWindow\) [Zoom](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L777) ```go func (w *WebviewWindow) Zoom() ``` - - -### func \(\*WebviewWindow\) [ZoomIn]() + +### func \(\*WebviewWindow\) [ZoomIn](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L751) ```go func (w *WebviewWindow) ZoomIn() @@ -3895,7 +3784,8 @@ func (w *WebviewWindow) ZoomIn() ZoomIn increases the zoom level of the webview content -### func \(\*WebviewWindow\) [ZoomOut]() + +### func \(\*WebviewWindow\) [ZoomOut](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L761) ```go func (w *WebviewWindow) ZoomOut() @@ -3904,7 +3794,8 @@ func (w *WebviewWindow) ZoomOut() ZoomOut decreases the zoom level of the webview content -### func \(\*WebviewWindow\) [ZoomReset]() + +### func \(\*WebviewWindow\) [ZoomReset](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L741) ```go func (w *WebviewWindow) ZoomReset() *WebviewWindow @@ -3913,9 +3804,8 @@ func (w *WebviewWindow) ZoomReset() *WebviewWindow ZoomReset resets the zoom level of the webview content to 100% -## type [WebviewWindowOptions]() - +## type [WebviewWindowOptions](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/options_webview_window.go#L12-L118) ```go type WebviewWindowOptions struct { @@ -4028,9 +3918,8 @@ type WebviewWindowOptions struct { ``` -## type [Win32Menu]() - +## type [Win32Menu](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/popupmenu_windows.go#L40-L51) ```go type Win32Menu struct { @@ -4039,99 +3928,88 @@ type Win32Menu struct { ``` -### func [NewApplicationMenu]() + +### func [NewApplicationMenu](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/popupmenu_windows.go#L143) ```go func NewApplicationMenu(parent w32.HWND, inputMenu *Menu) *Win32Menu ``` - - -### func [NewPopupMenu]() + +### func [NewPopupMenu](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/popupmenu_windows.go#L132) ```go func NewPopupMenu(parent w32.HWND, inputMenu *Menu) *Win32Menu ``` - - -### func \(\*Win32Menu\) [Destroy]() + +### func \(\*Win32Menu\) [Destroy](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/popupmenu_windows.go#L200) ```go func (p *Win32Menu) Destroy() ``` - - -### func \(\*Win32Menu\) [OnMenuClose]() + +### func \(\*Win32Menu\) [OnMenuClose](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/popupmenu_windows.go#L241) ```go func (p *Win32Menu) OnMenuClose(fn func()) ``` - - -### func \(\*Win32Menu\) [OnMenuOpen]() + +### func \(\*Win32Menu\) [OnMenuOpen](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/popupmenu_windows.go#L237) ```go func (p *Win32Menu) OnMenuOpen(fn func()) ``` - - -### func \(\*Win32Menu\) [ProcessCommand]() + +### func \(\*Win32Menu\) [ProcessCommand](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/popupmenu_windows.go#L185) ```go func (p *Win32Menu) ProcessCommand(cmdMsgID int) bool ``` - - -### func \(\*Win32Menu\) [ShowAt]() + +### func \(\*Win32Menu\) [ShowAt](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/popupmenu_windows.go#L154) ```go func (p *Win32Menu) ShowAt(x int, y int) ``` - - -### func \(\*Win32Menu\) [ShowAtCursor]() + +### func \(\*Win32Menu\) [ShowAtCursor](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/popupmenu_windows.go#L176) ```go func (p *Win32Menu) ShowAtCursor() ``` - - -### func \(\*Win32Menu\) [Update]() + +### func \(\*Win32Menu\) [Update](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/popupmenu_windows.go#L124) ```go func (p *Win32Menu) Update() ``` - - -### func \(\*Win32Menu\) [UpdateMenuItem]() + +### func \(\*Win32Menu\) [UpdateMenuItem](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/popupmenu_windows.go#L204) ```go func (p *Win32Menu) UpdateMenuItem(item *MenuItem) ``` - - -## type [WindowAttachConfig]() - +## type [WindowAttachConfig](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/systemtray.go#L224-L243) ```go type WindowAttachConfig struct { @@ -4149,9 +4027,8 @@ type WindowAttachConfig struct { ``` -## type [WindowEvent]() - +## type [WindowEvent](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L76-L79) ```go type WindowEvent struct { @@ -4161,36 +4038,32 @@ type WindowEvent struct { ``` -### func [NewWindowEvent]() + +### func [NewWindowEvent](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L85) ```go func NewWindowEvent() *WindowEvent ``` - - -### func \(\*WindowEvent\) [Cancel]() + +### func \(\*WindowEvent\) [Cancel](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L89) ```go func (w *WindowEvent) Cancel() ``` - - -### func \(\*WindowEvent\) [Context]() + +### func \(\*WindowEvent\) [Context](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L81) ```go func (w *WindowEvent) Context() *WindowEventContext ``` - - -## type [WindowEventContext]() - +## type [WindowEventContext](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/context_window_event.go#L10-L13) ```go type WindowEventContext struct { @@ -4199,18 +4072,16 @@ type WindowEventContext struct { ``` -### func \(WindowEventContext\) [DroppedFiles]() + +### func \(WindowEventContext\) [DroppedFiles](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/context_window_event.go#L15) ```go func (c WindowEventContext) DroppedFiles() []string ``` - - -## type [WindowEventListener]() - +## type [WindowEventListener](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/webview_window.go#L93-L95) ```go type WindowEventListener struct { @@ -4219,9 +4090,8 @@ type WindowEventListener struct { ``` -## type [WindowState]() - +## type [WindowState](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/options_webview_window.go#L3) ```go type WindowState int @@ -4239,7 +4109,8 @@ const ( ``` -## type [WindowsOptions]() + +## type [WindowsOptions](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/options_application_win.go#L4-L21) WindowsOptions contains options for Windows applications. @@ -4265,9 +4136,8 @@ type WindowsOptions struct { ``` -## type [WindowsWindow]() - +## type [WindowsWindow](https://github.com/wailsapp/wails/blob/master/v3/pkg/application/options_webview_window_win.go#L15-L77) ```go type WindowsWindow struct { @@ -4333,4 +4203,4 @@ type WindowsWindow struct { // Menu is the menu to use for the window. Menu *Menu } -``` \ No newline at end of file +``` diff --git a/mkdocs-website/docs/en/changelog.md b/mkdocs-website/docs/en/changelog.md index 4f6cb8bc65f..139174598de 100644 --- a/mkdocs-website/docs/en/changelog.md +++ b/mkdocs-website/docs/en/changelog.md @@ -19,16 +19,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added -- [darwin] add Event ApplicationShouldHandleReopen to able handle dock icon click by @5aaee9 in [#2991](https://github.com/wailsapp/wails/pull/2991) -- [darwin] add getPrimaryScreen/getScreens to impl by @tmclane in [#2618](https://github.com/wailsapp/wails/pull/2618) +- [darwin] add Event ApplicationShouldHandleReopen to able handle dock icon + click by @5aaee9 in [#2991](https://github.com/wailsapp/wails/pull/2991) +- [darwin] add getPrimaryScreen/getScreens to impl by @tmclane in + [#2618](https://github.com/wailsapp/wails/pull/2618) ### Fixed -- Fixed Doctor apt package verify by [Atterpac](https://github.com/Atterpac) in [#2972](https://github.com/wailsapp/wails/pull/2972). -- Fixed application frozen when quit (Darwin) by @5aaee9 in [#2982](https://github.com/wailsapp/wails/pull/2982) -- Fixed background colours of examples on Windows by [mmgvh](https://github.com/mmghv) in [#2750](https://github.com/wailsapp/wails/pull/2750). -- Fixed default context menus by [mmgvh](https://github.com/mmghv) in [#2753](https://github.com/wailsapp/wails/pull/2753). - +- Fixed Doctor apt package verify by [Atterpac](https://github.com/Atterpac) in + [#2972](https://github.com/wailsapp/wails/pull/2972). +- Fixed application frozen when quit (Darwin) by @5aaee9 in + [#2982](https://github.com/wailsapp/wails/pull/2982) +- Fixed background colours of examples on Windows by + [mmgvh](https://github.com/mmghv) in + [#2750](https://github.com/wailsapp/wails/pull/2750). +- Fixed default context menus by [mmgvh](https://github.com/mmghv) in + [#2753](https://github.com/wailsapp/wails/pull/2753). ### Changed diff --git a/mkdocs-website/docs/en/development/changes.md b/mkdocs-website/docs/en/development/changes.md index 9b37d257640..d5bbfd741a1 100644 --- a/mkdocs-website/docs/en/development/changes.md +++ b/mkdocs-website/docs/en/development/changes.md @@ -1,7 +1,7 @@ # Changes for v3 -!!! note - This is currently an unsorted brain dump of changes. It will be organised into a more readable format soon. +!!! note This is currently an unsorted brain dump of changes. It will be +organised into a more readable format soon. ## Options diff --git a/mkdocs-website/docs/en/development/introduction.md b/mkdocs-website/docs/en/development/introduction.md index 5b7f619e6ef..e2c8e89a1b5 100644 --- a/mkdocs-website/docs/en/development/introduction.md +++ b/mkdocs-website/docs/en/development/introduction.md @@ -1,7 +1,6 @@ # Introduction -!!! note - This guide is a work in progress. +!!! note This guide is a work in progress. Thanks for wanting to help out with development of Wails! This guide will help you get started. @@ -48,8 +47,10 @@ The project has the following structure: ### Alpha Todo List -We are currently tracking known issues and tasks in the [Alpha Todo List](https://github.com/orgs/wailsapp/projects/6). -If you want to help out, please check this list and follow the instructions in the [Feedback](../getting-started/feedback.md) page. +We are currently tracking known issues and tasks in the +[Alpha Todo List](https://github.com/orgs/wailsapp/projects/6). If you want to +help out, please check this list and follow the instructions in the +[Feedback](../getting-started/feedback.md) page. ### Adding window functionality @@ -140,8 +141,8 @@ The `InjectJS()` method returns JavaScript that should be injected into all windows as they are created. This is useful for adding custom JavaScript functions that complement the plugin. -The built-in plugins can be found in the `v3/plugins` directory. -Check them out for inspiration. +The built-in plugins can be found in the `v3/plugins` directory. Check them out +for inspiration. ## Tasks diff --git a/mkdocs-website/docs/en/development/status.md b/mkdocs-website/docs/en/development/status.md index 3d6a9e440c7..a2ba2bb1038 100644 --- a/mkdocs-website/docs/en/development/status.md +++ b/mkdocs-website/docs/en/development/status.md @@ -16,7 +16,7 @@ Status of features in v3. Application interface methods | Method | Windows | Linux | Mac | Notes | -|---------------------------------------------------------------|---------|-------|-----|-------| +| ------------------------------------------------------------- | ------- | ----- | --- | ----- | | run() error | Y | Y | Y | | | destroy() | | Y | Y | | | setApplicationMenu(menu \*Menu) | Y | Y | Y | | @@ -36,7 +36,7 @@ Application interface methods Webview Window Interface Methods | Method | Windows | Linux | Mac | Notes | -|----------------------------------------------------|---------|-------|-----|------------------------------------------| +| -------------------------------------------------- | ------- | ----- | --- | ---------------------------------------- | | center() | Y | Y | Y | | | close() | y | Y | Y | | | destroy() | | Y | Y | | @@ -90,7 +90,7 @@ Webview Window Interface Methods ### Application | Feature | Windows | Linux | Mac | Notes | -|---------|---------|-------|-----|-------| +| ------- | ------- | ----- | --- | ----- | | Quit | Y | Y | Y | | | Hide | Y | | Y | | | Show | Y | | Y | | @@ -98,7 +98,7 @@ Webview Window Interface Methods ### Dialogs | Feature | Windows | Linux | Mac | Notes | -|----------|---------|-------|-----|-------| +| -------- | ------- | ----- | --- | ----- | | Info | Y | Y | Y | | | Warning | Y | Y | Y | | | Error | Y | Y | Y | | @@ -109,14 +109,14 @@ Webview Window Interface Methods ### Clipboard | Feature | Windows | Linux | Mac | Notes | -|---------|---------|-------|-----|-------| +| ------- | ------- | ----- | --- | ----- | | SetText | Y | | Y | | | Text | Y | | Y | | ### ContextMenu | Feature | Windows | Linux | Mac | Notes | -|------------------|---------|-------|-----|-------| +| ---------------- | ------- | ----- | --- | ----- | | OpenContextMenu | Y | | Y | | | On By Default | | | | | | Control via HTML | Y | | | | @@ -134,7 +134,7 @@ show the context menu unless it is explicitly set with ### Screens | Feature | Windows | Linux | Mac | Notes | -|------------|---------|-------|-----|-------| +| ---------- | ------- | ----- | --- | ----- | | GetAll | Y | Y | Y | | | GetPrimary | Y | Y | Y | | | GetCurrent | Y | Y | Y | | @@ -142,7 +142,7 @@ show the context menu unless it is explicitly set with ### System | Feature | Windows | Linux | Mac | Notes | -|------------|---------|-------|-----|-------| +| ---------- | ------- | ----- | --- | ----- | | IsDarkMode | | | Y | | ### Window @@ -152,7 +152,7 @@ Y = Supported U = Untested - = Not available | Feature | Windows | Linux | Mac | Notes | -|---------------------|---------|-------|-----|--------------------------------------------------------------------------------------| +| ------------------- | ------- | ----- | --- | ------------------------------------------------------------------------------------ | | Center | Y | Y | Y | | | Focus | Y | Y | | | | FullScreen | Y | Y | Y | | @@ -190,7 +190,7 @@ applied when the window is created. An 'X' indicates that the option is not supported by the platform. | Feature | Windows | Linux | Mac | Notes | -|---------------------------------|---------|-------|-----|--------------------------------------------| +| ------------------------------- | ------- | ----- | --- | ------------------------------------------ | | AlwaysOnTop | Y | | | | | BackgroundColour | Y | Y | | | | BackgroundType | | | | Acrylic seems to work but the others don't | @@ -230,13 +230,13 @@ To log or not to log? System logger vs custom logger. ## Menu | Event | Windows | Linux | Mac | Notes | -|--------------------------|---------|-------|-----|-------| +| ------------------------ | ------- | ----- | --- | ----- | | Default Application Menu | Y | Y | Y | | ## Tray Menus | Feature | Windows | Linux | Mac | Notes | -|--------------------|---------|-------|-----|----------------------------------------------------------------------| +| ------------------ | ------- | ----- | --- | -------------------------------------------------------------------- | | Icon | Y | | Y | Windows has default icons for light/dark mode & supports PNG or ICO. | | Label | - | | Y | | | Label (ANSI Codes) | - | | | | @@ -245,7 +245,7 @@ To log or not to log? System logger vs custom logger. ### Methods | Method | Windows | Linux | Mac | Notes | -|-------------------------------|---------|-------|-----|-------| +| ----------------------------- | ------- | ----- | --- | ----- | | setLabel(label string) | - | | Y | | | run() | Y | | Y | | | setIcon(icon []byte) | Y | | Y | | @@ -260,7 +260,7 @@ To log or not to log? System logger vs custom logger. Mapping native events to cross-platform events. | Event | Windows | Linux | Mac | Notes | -|--------------------------|---------|-------|-----------------|-------| +| ------------------------ | ------- | ----- | --------------- | ----- | | WindowWillClose | | | WindowWillClose | | | WindowDidClose | | | | | | WindowDidResize | | | | | @@ -284,7 +284,7 @@ Contains a lot needed for development. ## Theme | Mode | Windows | Linux | Mac | Notes | -|--------|---------|-------|-----|-------| +| ------ | ------- | ----- | --- | ----- | | Dark | Y | | | | | Light | Y | | | | | System | Y | | | | @@ -302,7 +302,7 @@ All templates are working. Built-in plugin support: | Plugin | Windows | Linux | Mac | Notes | -|-----------------|---------|-------|-----|-------| +| --------------- | ------- | ----- | --- | ----- | | Browser | Y | | Y | | | KV Store | Y | Y | Y | | | Log | Y | Y | Y | | @@ -318,7 +318,7 @@ TODO: ## Packaging | | Windows | Linux | Mac | Notes | -|-----------------|---------|-------|-----|-------| +| --------------- | ------- | ----- | --- | ----- | | Icon Generation | Y | | Y | | | Icon Embedding | Y | | Y | | | Info.plist | - | | Y | | @@ -329,7 +329,7 @@ TODO: ## Frameless Windows | Feature | Windows | Linux | Mac | Notes | -|---------|---------|-------|-----|------------------------------------------------| +| ------- | ------- | ----- | --- | ---------------------------------------------- | | Resize | Y | | Y | | | Drag | Y | Y | Y | Linux - can always drag with `Meta`+left mouse | @@ -340,7 +340,7 @@ TODO: ### Mac Options | Feature | Default | Notes | -|-------------------------|-------------------|------------------------------------------------------| +| ----------------------- | ----------------- | ---------------------------------------------------- | | Backdrop | MacBackdropNormal | Standard solid window | | DisableShadow | false | | | TitleBar | | Standard window decorations by default | @@ -356,7 +356,7 @@ TODO: ### Windows Options | Feature | Default | Notes | -|-----------------------------------|---------------|---------------------------------------------| +| --------------------------------- | ------------- | ------------------------------------------- | | BackdropType | Solid | | | DisableIcon | false | | | Theme | SystemDefault | | @@ -385,4 +385,3 @@ The examples can be compiled using the following command: CGO_ENABLED=0 go build -tags purego Note: things are currently not working after the refactor - diff --git a/mkdocs-website/docs/en/getting-started/feedback.md b/mkdocs-website/docs/en/getting-started/feedback.md index 27424fb64e5..c872a488b2d 100644 --- a/mkdocs-website/docs/en/getting-started/feedback.md +++ b/mkdocs-website/docs/en/getting-started/feedback.md @@ -1,7 +1,7 @@ # Feedback -We welcome (and encourage) your feedback! Please search for existing tickets or posts before creating new ones. -Here are the different ways to provide feedback: +We welcome (and encourage) your feedback! Please search for existing tickets or +posts before creating new ones. Here are the different ways to provide feedback: === "Bugs" @@ -35,7 +35,8 @@ Here are the different ways to provide feedback: - Please *don't* just add comments like "+1" or "me too". - Please feel free to comment if there is more to add to the post, such as "this bug also affect ARM builds" or "Another option would be to ....." -There is a list of known issues & work in progress can be found [here](https://github.com/orgs/wailsapp/projects/6). +There is a list of known issues & work in progress can be found +[here](https://github.com/orgs/wailsapp/projects/6). ## Things we are looking for feedback on diff --git a/mkdocs-website/docs/en/roadmap.md b/mkdocs-website/docs/en/roadmap.md index ac965272dd0..5738f4cd299 100644 --- a/mkdocs-website/docs/en/roadmap.md +++ b/mkdocs-website/docs/en/roadmap.md @@ -1,7 +1,8 @@ -**# Roadmap +\*\*# Roadmap -The roadmap is a living document and is subject to change. If you have any suggestions, please open an issue. -Each milestone will have a set of goals that we are aiming to achieve. These are subject to change. +The roadmap is a living document and is subject to change. If you have any +suggestions, please open an issue. Each milestone will have a set of goals that +we are aiming to achieve. These are subject to change. ## Alpha milestones @@ -9,8 +10,9 @@ Each milestone will have a set of goals that we are aiming to achieve. These are #### Goals -Alpha 1 is the initial release. It is intended to get feedback on the new API and to get people experimenting with it. -The main goal is to get most of the examples working on all platforms. +Alpha 1 is the initial release. It is intended to get feedback on the new API +and to get people experimenting with it. The main goal is to get most of the +examples working on all platforms. #### Status @@ -20,15 +22,16 @@ The main goal is to get most of the examples working on all platforms. {{ read_csv("status.csv") }} -- Mac Dialogs work, however the file dialogs issue a warning that needs to be fixed. +- Mac Dialogs work, however the file dialogs issue a warning that needs to be + fixed. #### TODO: -- [ ] Fix `+[CATransaction synchronize] called within transaction` warnings on Mac +- [ ] Fix `+[CATransaction synchronize] called within transaction` warnings on + Mac - [ ] When hiding window, application terminates ### Alpha 2 - [ ] Most examples working on Linux - [ ] Project creation via `wails init` - diff --git a/mkdocs-website/docs/en/whats-new.md b/mkdocs-website/docs/en/whats-new.md index cd4783f26d9..0fcd67b1ced 100644 --- a/mkdocs-website/docs/en/whats-new.md +++ b/mkdocs-website/docs/en/whats-new.md @@ -1,7 +1,7 @@ # What's new in v3? -!!! note - The features that will be included in the v3 release may change from this list. +!!! note The features that will be included in the v3 release may change from +this list. ## Multiple Windows diff --git a/mkdocs-website/docs/zh/API/application.md b/mkdocs-website/docs/zh/API/application.md index 877b8e0441c..76f03663598 100644 --- a/mkdocs-website/docs/zh/API/application.md +++ b/mkdocs-website/docs/zh/API/application.md @@ -6,7 +6,8 @@ API：`New(appOptions Options) *App` -`New(appOptions Options)` 使用给定的应用程序选项创建一个新的应用程序。它对未指定的选项应用默认值，将其与提供的选项合并，然后初始化并返回应用程序的实例。 +`New(appOptions Options)` 使用给定的应用程序选项创建一个新的应用程序。它对未指定 +的选项应用默认值，将其与提供的选项合并，然后初始化并返回应用程序的实例。 如果在初始化过程中出现错误，应用程序将停止，并显示提供的错误消息。 @@ -40,7 +41,8 @@ func main() { API：`Capabilities() capabilities.Capabilities` -`Capabilities()` 返回应用程序当前具有的功能的映射。这些功能可以是操作系统提供的不同功能，如 webview 功能。 +`Capabilities()` 返回应用程序当前具有的功能的映射。这些功能可以是操作系统提供的 +不同功能，如 webview 功能。 ```go // 获取应用程序的功能 @@ -92,7 +94,8 @@ API：`Quit()` API：`IsDarkMode() bool` -`IsDarkMode()` 检查应用程序是否在暗模式下运行。它返回一个布尔值，指示是否启用了暗模式。 +`IsDarkMode()` 检查应用程序是否在暗模式下运行。它返回一个布尔值，指示是否启用了 +暗模式。 ```go // 检查是否启用了暗模式 @@ -138,7 +141,8 @@ API：`NewWebviewWindow() *WebviewWindow` API：`NewWebviewWindowWithOptions(windowOptions WebviewWindowOptions) *WebviewWindow` -`NewWebviewWindowWithOptions()` 使用自定义选项创建一个新的 Webview 窗口。新创建的窗口将添加到应用程序管理的窗口映射中。 +`NewWebviewWindowWithOptions()` 使用自定义选项创建一个新的 Webview 窗口。新创建 +的窗口将添加到应用程序管理的窗口映射中。 ```go // 使用自定义选项创建一个新的 Webview 窗口 @@ -178,7 +182,8 @@ API：`GetWindowByName(name string) *WebviewWindow` API：`CurrentWindow() *WebviewWindow` -`CurrentWindow()` 获取并返回应用程序中当前活动窗口的指针。如果没有窗口，则返回 nil。 +`CurrentWindow()` 获取并返回应用程序中当前活动窗口的指针。如果没有窗口，则返回 +nil。 ```go // 获取当前窗口 @@ -189,7 +194,8 @@ API：`CurrentWindow() *WebviewWindow` API：`RegisterContextMenu(name string, menu *Menu)` -`RegisterContextMenu()` 注册具有给定名称的上下文菜单。稍后可以在应用程序中使用该菜单。 +`RegisterContextMenu()` 注册具有给定名称的上下文菜单。稍后可以在应用程序中使用该 +菜单。 ```go @@ -204,7 +210,8 @@ API：`RegisterContextMenu(name string, menu *Menu)` API：`SetMenu(menu *Menu)` -`SetMenu()` 设置应用程序的菜单。在 Mac 上，这将是全局菜单。对于 Windows 和 Linux，这将是任何新窗口的默认菜单。 +`SetMenu()` 设置应用程序的菜单。在 Mac 上，这将是全局菜单。对于 Windows 和 +Linux，这将是任何新窗口的默认菜单。 ```go // 创建一个新的菜单 @@ -229,55 +236,64 @@ API：`ShowAboutDialog()` API：`InfoDialog()` -`InfoDialog()` 创建并返回一个具有 `InfoDialogType` 的 `MessageDialog` 的新实例。此对话框通常用于向用户显示信息消息。 +`InfoDialog()` 创建并返回一个具有 `InfoDialogType` 的 `MessageDialog` 的新实例。 +此对话框通常用于向用户显示信息消息。 ### Question API：`QuestionDialog()` -`QuestionDialog()` 创建并返回一个具有 `QuestionDialogType` 的 `MessageDialog` 的新实例。此对话框通常用于向用户提问并期望回应。 +`QuestionDialog()` 创建并返回一个具有 `QuestionDialogType` 的 `MessageDialog` 的 +新实例。此对话框通常用于向用户提问并期望回应。 ### Warning API：`WarningDialog()` -`WarningDialog()` 创建并返回一个具有 `WarningDialogType` 的 `MessageDialog` 的新实例。如其名称所示，此对话框主要用于向用户显示警告消息。 +`WarningDialog()` 创建并返回一个具有 `WarningDialogType` 的 `MessageDialog` 的新 +实例。如其名称所示，此对话框主要用于向用户显示警告消息。 ### Error API：`ErrorDialog()` -`ErrorDialog()` 创建并返回一个具有 `ErrorDialogType` 的 `MessageDialog` 的新实例。此对话框设计用于在需要向用户显示错误消息时使用。 +`ErrorDialog()` 创建并返回一个具有 `ErrorDialogType` 的 `MessageDialog` 的新实 +例。此对话框设计用于在需要向用户显示错误消息时使用。 ### OpenFile API：`OpenFileDialog()` -`OpenFileDialog()` 创建并返回一个新的 `OpenFileDialogStruct`。此对话框提示用户从其文件系统中选择一个或多个文件。 +`OpenFileDialog()` 创建并返回一个新的 `OpenFileDialogStruct`。此对话框提示用户从 +其文件系统中选择一个或多个文件。 ### SaveFile API：`SaveFileDialog()` -`SaveFileDialog()` 创建并返回一个新的 `SaveFileDialogStruct`。此对话框提示用户选择其文件系统上的位置以保存文件。 +`SaveFileDialog()` 创建并返回一个新的 `SaveFileDialogStruct`。此对话框提示用户选 +择其文件系统上的位置以保存文件。 ### OpenDirectory API：`OpenDirectoryDialog()` -`OpenDirectoryDialog()` 创建并返回一个具有 `OpenDirectoryDialogType` 的 `MessageDialog` 的新实例。此对话框使用户能够从其文件系统中选择目录。 +`OpenDirectoryDialog()` 创建并返回一个具有 `OpenDirectoryDialogType` 的 +`MessageDialog` 的新实例。此对话框使用户能够从其文件系统中选择目录。 ### On API：`On(eventType events.ApplicationEventType, callback func(event *Event)) func()` -`On()` 注册特定应用程序事件的事件侦听器。提供的回调函数将在相应事件发生时触发。该函数返回一个可调用的函数，用于删除侦听器。 +`On()` 注册特定应用程序事件的事件侦听器。提供的回调函数将在相应事件发生时触发。 +该函数返回一个可调用的函数，用于删除侦听器。 ### RegisterHook API：`RegisterHook(eventType events.ApplicationEventType, callback func(event *Event)) func()` -`RegisterHook()` 注册要在特定事件期间作为钩子运行的回调函数。这些钩子在使用 `On()` 附加的侦听器之前运行。该函数返回一个可调用的函数，用于删除钩子。 +`RegisterHook()` 注册要在特定事件期间作为钩子运行的回调函数。这些钩子在使用 +`On()` 附加的侦听器之前运行。该函数返回一个可调用的函数，用于删除钩子。 ### GetPrimaryScreen @@ -291,7 +307,8 @@ API：`GetScreens() ([]*Screen, error)` `GetScreens()` 返回有关连接到系统的所有屏幕的信息。 -这是提供的 `App` 结构中导出的方法的简要摘要。请注意，有关更详细的功能或注意事项，请参考实际的 Go 代码或进一步的内部文档。 +这是提供的 `App` 结构中导出的方法的简要摘要。请注意，有关更详细的功能或注意事 +项，请参考实际的 Go 代码或进一步的内部文档。 ## Options @@ -315,4 +332,4 @@ API：`GetScreens() ([]*Screen, error)` --8<-- ../v3/pkg/application/options_application_mac.go --8<-- -``` \ No newline at end of file +``` diff --git a/mkdocs-website/docs/zh/API/mainthread.md b/mkdocs-website/docs/zh/API/mainthread.md index 0bf337c80ba..0ddb768e6ae 100644 --- a/mkdocs-website/docs/zh/API/mainthread.md +++ b/mkdocs-website/docs/zh/API/mainthread.md @@ -1,28 +1,34 @@ # 主线程函数 -这些方法是在主线程上运行代码的实用函数。当您想要在UI线程上运行自定义代码时，这是必需的。 +这些方法是在主线程上运行代码的实用函数。当您想要在UI线程上运行自定义代码时，这是 +必需的。 ### InvokeSync API: `InvokeSync(fn func())` -此函数以同步方式运行传入的函数（`fn`）。它使用一个`WaitGroup`（`wg`）确保主线程在`fn`函数完成之前等待，然后才继续执行。如果在`fn`内部发生恐慌，它将传递给应用程序选项中定义的处理程序函数`PanicHandler`。 +此函数以同步方式运行传入的函数（`fn`）。它使用一个`WaitGroup`（`wg`）确保主线程 +在`fn`函数完成之前等待，然后才继续执行。如果在`fn`内部发生恐慌，它将传递给应用程 +序选项中定义的处理程序函数`PanicHandler`。 ### InvokeSyncWithResult API: `InvokeSyncWithResult[T any](fn func() T) (res T)` -此函数与`InvokeSync(fn func())`类似，但它返回一个结果。可用于调用具有单个返回值的任何函数。 +此函数与`InvokeSync(fn func())`类似，但它返回一个结果。可用于调用具有单个返回值 +的任何函数。 ### InvokeSyncWithError API: `InvokeSyncWithError(fn func() error) (err error)` -此函数同步运行`fn`并返回`fn`产生的任何错误。请注意，如果在`fn`执行期间发生恐慌，此函数将从恢复。 +此函数同步运行`fn`并返回`fn`产生的任何错误。请注意，如果在`fn`执行期间发生恐慌， +此函数将从恢复。 ### InvokeSyncWithResultAndError -API: `InvokeSyncWithResultAndError[T any](fn func() (T, error)) (res T, err error)` +API: +`InvokeSyncWithResultAndError[T any](fn func() (T, error)) (res T, err error)` 此函数同步运行`fn`并返回类型为`T`的结果和一个错误。 @@ -30,8 +36,10 @@ API: `InvokeSyncWithResultAndError[T any](fn func() (T, error)) (res T, err erro API: `InvokeAsync(fn func())` -此函数以异步方式运行`fn`。它在主线程上运行给定的函数。如果在`fn`内部发生恐慌，它将传递给应用程序选项中定义的处理程序函数`PanicHandler`。 +此函数以异步方式运行`fn`。它在主线程上运行给定的函数。如果在`fn`内部发生恐慌，它 +将传递给应用程序选项中定义的处理程序函数`PanicHandler`。 --- -注意：这些函数将阻塞执行，直到`fn`完成。确保`fn`不会阻塞至关重要。如果需要运行阻塞函数，请改用`InvokeAsync`。 \ No newline at end of file +注意：这些函数将阻塞执行，直到`fn`完成。确保`fn`不会阻塞至关重要。如果需要运行阻 +塞函数，请改用`InvokeAsync`。 diff --git a/mkdocs-website/docs/zh/API/menu.md b/mkdocs-website/docs/zh/API/menu.md index b66af74956f..aefa5801c29 100644 --- a/mkdocs-website/docs/zh/API/menu.md +++ b/mkdocs-website/docs/zh/API/menu.md @@ -1,6 +1,7 @@ # 菜单 -可以创建菜单并添加到应用程序中。它们可以用于创建上下文菜单、系统托盘菜单和应用程序菜单。 +可以创建菜单并添加到应用程序中。它们可以用于创建上下文菜单、系统托盘菜单和应用程 +序菜单。 要创建一个新菜单，请调用： @@ -15,7 +16,8 @@ API：`Add(label string) *MenuItem` -此方法以 `string` 类型的 `label` 作为输入，并将具有给定标签的新 `MenuItem` 添加到菜单中。它返回添加的 `MenuItem`。 +此方法以 `string` 类型的 `label` 作为输入，并将具有给定标签的新 `MenuItem` 添加 +到菜单中。它返回添加的 `MenuItem`。 ### 添加分隔符 @@ -27,13 +29,15 @@ API：`AddSeparator()` API：`AddCheckbox(label string, enabled bool) *MenuItem` -此方法以 `string` 类型的 `label` 和 `bool` 类型的 `enabled` 作为输入，并将具有给定标签和启用状态的新复选框 `MenuItem` 添加到菜单中。它返回添加的 `MenuItem`。 +此方法以 `string` 类型的 `label` 和 `bool` 类型的 `enabled` 作为输入，并将具有给 +定标签和启用状态的新复选框 `MenuItem` 添加到菜单中。它返回添加的 `MenuItem`。 ### 添加单选按钮 API：`AddRadio(label string, enabled bool) *MenuItem` -此方法以 `string` 类型的 `label` 和 `bool` 类型的 `enabled` 作为输入，并将具有给定标签和启用状态的新单选按钮 `MenuItem` 添加到菜单中。它返回添加的 `MenuItem`。 +此方法以 `string` 类型的 `label` 和 `bool` 类型的 `enabled` 作为输入，并将具有给 +定标签和启用状态的新单选按钮 `MenuItem` 添加到菜单中。它返回添加的 `MenuItem`。 ### 更新 @@ -45,16 +49,18 @@ API：`Update()` API：`AddSubmenu(s string) *Menu` -此方法以 `string` 类型的 `s` 作为输入，并将具有给定标签的新子菜单 `MenuItem` 添加到菜单中。它返回添加的子菜单。 +此方法以 `string` 类型的 `s` 作为输入，并将具有给定标签的新子菜单 `MenuItem` 添 +加到菜单中。它返回添加的子菜单。 ### 添加角色 API：`AddRole(role Role) *Menu` -此方法以 `Role` 类型的 `role` 作为输入，如果不为 `nil`，则将其添加到菜单中，并返回 `Menu`。 +此方法以 `Role` 类型的 `role` 作为输入，如果不为 `nil`，则将其添加到菜单中，并返 +回 `Menu`。 ### 设置标签 API：`SetLabel(label string)` -此方法设置 `Menu` 的 `label`。 \ No newline at end of file +此方法设置 `Menu` 的 `label`。 diff --git a/mkdocs-website/docs/zh/API/systray.md b/mkdocs-website/docs/zh/API/systray.md index f7535990c0d..fde922e24a0 100644 --- a/mkdocs-website/docs/zh/API/systray.md +++ b/mkdocs-website/docs/zh/API/systray.md @@ -93,10 +93,11 @@ API：`WindowOffset(offset int) *SystemTray` API：`WindowDebounce(debounce time.Duration) *SystemTray` -`WindowDebounce` 方法设置防抖时间。在 Windows 上，它用于指定在响应通知图标上的鼠标松开事件之前等待多长时间。 +`WindowDebounce` 方法设置防抖时间。在 Windows 上，它用于指定在响应通知图标上的鼠 +标松开事件之前等待多长时间。 ### OpenMenu API：`OpenMenu()` -`OpenMenu` 方法打开与系统托盘关联的菜单。 \ No newline at end of file +`OpenMenu` 方法打开与系统托盘关联的菜单。 diff --git a/mkdocs-website/docs/zh/API/window.md b/mkdocs-website/docs/zh/API/window.md index 9a46b115656..256ac490c0e 100644 --- a/mkdocs-website/docs/zh/API/window.md +++ b/mkdocs-website/docs/zh/API/window.md @@ -1,6 +1,8 @@ # 窗口 -要创建一个窗口，可以使用[Application.NewWebviewWindow](application.md#newwebviewwindow)或[Application.NewWebviewWindowWithOptions](application.md#newwebviewwindowwithoptions)。前者创建一个具有默认选项的窗口，而后者允许您指定自定义选项。 +要创建一个窗口，可以使 +用[Application.NewWebviewWindow](application.md#newwebviewwindow)或[Application.NewWebviewWindowWithOptions](application.md#newwebviewwindowwithoptions)。 +前者创建一个具有默认选项的窗口，而后者允许您指定自定义选项。 这些方法可在返回的WebviewWindow对象上调用： @@ -20,7 +22,8 @@ API: `Name() string` API: `SetSize(width, height int) *WebviewWindow` -此方法将WebviewWindow的大小设置为提供的宽度和高度参数。如果提供的尺寸超过约束条件，它们将被相应调整。 +此方法将WebviewWindow的大小设置为提供的宽度和高度参数。如果提供的尺寸超过约束条 +件，它们将被相应调整。 ### SetAlwaysOnTop @@ -32,7 +35,8 @@ API: `SetAlwaysOnTop(b bool) *WebviewWindow` API: `Show() *WebviewWindow` -`Show`方法用于使窗口可见。如果窗口未运行，它首先调用`run`方法启动窗口，然后使其可见。 +`Show`方法用于使窗口可见。如果窗口未运行，它首先调用`run`方法启动窗口，然后使其 +可见。 ### Hide @@ -68,7 +72,8 @@ API: `GetScreen() (*Screen, error)` API: `SetFrameless(frameless bool) *WebviewWindow` -此函数用于移除窗口边框和标题栏。它根据提供的布尔值（true表示无边框，false表示有边框）切换窗口的无边框状态。 +此函数用于移除窗口边框和标题栏。它根据提供的布尔值（true表示无边框，false表示有 +边框）切换窗口的无边框状态。 #### RegisterContextMenu @@ -98,4 +103,4 @@ API: `SetEnabled(enabled bool)` API: `SetAbsolutePosition(x int, y int)` -此函数设置窗口在屏幕上的绝对位置。 \ No newline at end of file +此函数设置窗口在屏幕上的绝对位置。 diff --git a/mkdocs-website/docs/zh/changelog.md b/mkdocs-website/docs/zh/changelog.md index 8bc95fe2b4d..bcd1a9bb4ce 100644 --- a/mkdocs-website/docs/zh/changelog.md +++ b/mkdocs-website/docs/zh/changelog.md @@ -1,6 +1,6 @@ # 更新日志 -