dialog

Documentation

Overview

Package dialog defines standard dialog windows for application GUIs

Index

• func ShowConfirm(title, message string, callback func(bool), parent fyne.Window)
• func ShowCustom(title, dismiss string, content fyne.CanvasObject, parent fyne.Window)
• func ShowCustomConfirm(title, confirm, dismiss string, content fyne.CanvasObject, callback func(bool), ...)
• func ShowError(err error, parent fyne.Window)
• func ShowInformation(title, message string, parent fyne.Window)
• type ConfirmDialog
  • func NewConfirm(title, message string, callback func(bool), parent fyne.Window) *ConfirmDialog
  • func (d ConfirmDialog) ApplyTheme()
  • func (d ConfirmDialog) Layout(obj []fyne.CanvasObject, size fyne.Size)
  • func (d ConfirmDialog) MinSize(obj []fyne.CanvasObject) fyne.Size
  • func (d *ConfirmDialog) SetConfirmText(label string)
  • func (d ConfirmDialog) SetDismissText(label string)
  • func (d ConfirmDialog) Show()
• type Dialog
  • func NewInformation(title, message string, parent fyne.Window) Dialog
• type ProgressDialog
  • func NewProgress(title, message string, parent fyne.Window) *ProgressDialog
  • func (d ProgressDialog) ApplyTheme()
  • func (d ProgressDialog) Layout(obj []fyne.CanvasObject, size fyne.Size)
  • func (d ProgressDialog) MinSize(obj []fyne.CanvasObject) fyne.Size
  • func (d ProgressDialog) SetDismissText(label string)
  • func (p *ProgressDialog) SetValue(v float64)
  • func (d ProgressDialog) Show()

Functions

func ShowConfirm

func ShowConfirm(title, message string, callback func(bool), parent fyne.Window)

ShowConfirm shows a dialog over the specified window for a user confirmation. The title is used for the dialog window and message is the content. The callback is executed when the user decides.

func ShowCustom

func ShowCustom(title, dismiss string, content fyne.CanvasObject, parent fyne.Window)

ShowCustom shows a dialog over the specified application using custom content. The button will have the dismiss text set. The MinSize() of the CanvasObject passed will be used to set the size of the window.

func ShowCustomConfirm

func ShowCustomConfirm(title, confirm, dismiss string, content fyne.CanvasObject,
	callback func(bool), parent fyne.Window)

ShowCustomConfirm shows a dialog over the specified application using custom content. The cancel button will have the dismiss text set and the "OK" will use the confirm text. The response callback is called on user action. The MinSize() of the CanvasObject passed will be used to set the size of the window.

func ShowError

func ShowError(err error, parent fyne.Window)

ShowError shows a dialog over the specified window for an application error. The title and message are extracted from the provided error.

func ShowInformation

func ShowInformation(title, message string, parent fyne.Window)

ShowInformation shows a dialog over the specified window for user information. The title is used for the dialog window and message is the content.

Types

type ConfirmDialog

type ConfirmDialog struct {
	// contains filtered or unexported fields
}

ConfirmDialog is like the standard Dialog but with an additional confirmation button

func NewConfirm

func NewConfirm(title, message string, callback func(bool), parent fyne.Window) *ConfirmDialog

NewConfirm creates a dialog over the specified window for user confirmation. The title is used for the ialog window and message is the content. The callback is executed when the user decides. After creation you should call Show().

func (ConfirmDialog) ApplyTheme

func (d ConfirmDialog) ApplyTheme()

func (ConfirmDialog) Layout

func (d ConfirmDialog) Layout(obj []fyne.CanvasObject, size fyne.Size)

func (ConfirmDialog) MinSize

func (d ConfirmDialog) MinSize(obj []fyne.CanvasObject) fyne.Size

func (*ConfirmDialog) SetConfirmText

func (d *ConfirmDialog) SetConfirmText(label string)

SetConfirmText allows custom text to be set in the confirmation button

func (ConfirmDialog) SetDismissText

func (d ConfirmDialog) SetDismissText(label string)

SetDismissText allows custom text to be set in the confirmation button

func (ConfirmDialog) Show

func (d ConfirmDialog) Show()

type Dialog

type Dialog interface {
	Show()
	SetDismissText(label string)
}

Dialog is the common API for any dialog window with a single dismiss button

func NewInformation

func NewInformation(title, message string, parent fyne.Window) Dialog

NewInformation creates a dialog over the specified window for user information. The title is used for the ialog window and message is the content. After creation you should call Show().

type ProgressDialog

type ProgressDialog struct {
	// contains filtered or unexported fields
}

ProgressDialog is a simple dialog window that displays text and a progress bar.

func NewProgress

func NewProgress(title, message string, parent fyne.Window) *ProgressDialog

NewProgress creates a progress dialog and returns the handle. Using the returned type you should call Show() and then set it's value through SetValue().

func (ProgressDialog) ApplyTheme

func (d ProgressDialog) ApplyTheme()

func (ProgressDialog) Layout

func (d ProgressDialog) Layout(obj []fyne.CanvasObject, size fyne.Size)

func (ProgressDialog) MinSize

func (d ProgressDialog) MinSize(obj []fyne.CanvasObject) fyne.Size

func (ProgressDialog) SetDismissText

func (d ProgressDialog) SetDismissText(label string)

SetDismissText allows custom text to be set in the confirmation button

func (*ProgressDialog) SetValue

func (p *ProgressDialog) SetValue(v float64)

SetValue updates the value of the progress bar - this should be between 0.0 and 1.0.

func (ProgressDialog) Show

func (d ProgressDialog) Show()