Documentation
¶
Index ¶
- type BaseFormField
- type Form
- type FormField
- type RestrictInput
- type SelectEntryField
- type SelectEntryFormField
- func (s *SelectEntryFormField) CreateRenderer() fyne.WidgetRenderer
- func (s *SelectEntryFormField) Reset()
- func (s *SelectEntryFormField) Save()
- func (s *SelectEntryFormField) SetOptions(options []string)
- func (s *SelectEntryFormField) SetText(text string)
- func (s *SelectEntryFormField) Text() string
- func (s *SelectEntryFormField) Validate() error
- func (s *SelectEntryFormField) ValidationError() error
- type SelectField
- func (s *SelectField) CreateRenderer() fyne.WidgetRenderer
- func (s *SelectField) FocusGained()
- func (s *SelectField) FocusLost()
- func (s *SelectField) MinSize() fyne.Size
- func (s *SelectField) MouseIn(ev *desktop.MouseEvent)
- func (s *SelectField) MouseOut()
- func (s *SelectField) Tapped(ev *fyne.PointEvent)
- type SelectFormField
- func (s *SelectFormField) CreateRenderer() fyne.WidgetRenderer
- func (s *SelectFormField) Reset()
- func (s *SelectFormField) Save()
- func (s *SelectFormField) Selected() string
- func (s *SelectFormField) SetSelected(text string)
- func (s *SelectFormField) Validate() error
- func (s *SelectFormField) ValidationError() error
- type TextField
- type TextFormField
- func NewMaskedTextFormField(label, initialText, mask, placeHolder string) *TextFormField
- func NewMultiLineTextFormField(label, initialText string) *TextFormField
- func NewPasswordTextFormField(label, initialText string) *TextFormField
- func NewRestrictTextFormField(label, initialText string, input RestrictInput) *TextFormField
- func NewTextFormField(label, initialText string) *TextFormField
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BaseFormField ¶
type BaseFormField struct {
widget.DisableableWidget
Label string
Hint string
// contains filtered or unexported fields
}
BaseFormField defines a base form field.
func (*BaseFormField) CreateBaseRenderer ¶
func (b *BaseFormField) CreateBaseRenderer( labelText, hintText string, fieldWidget fyne.Widget, isFieldEmpty func() bool, isFieldFocused func() bool, updateInternalField func(), ) fyne.WidgetRenderer
CreateBaseRenderer creates a base form field renderer.
func (*BaseFormField) ExtendBaseFormField ¶
func (b *BaseFormField) ExtendBaseFormField(w fyne.Widget)
ExtendBaseFormField extends a base form field.
type Form ¶
type Form struct {
widget.BaseWidget
OnChanged func()
OnValidationChanged func(valid bool)
// contains filtered or unexported fields
}
Form defines form widget.
func NewCustomForm ¶
func NewCustomForm(cont *fyne.Container) *Form
NewCustomForm creates a new custom form from a container. Internally, it will extract the form fields from the container and attach them to this form.
func (*Form) CreateRenderer ¶
func (f *Form) CreateRenderer() fyne.WidgetRenderer
CreateRenderer implements fyne.WidgetRenderer.
func (*Form) CreateResetButton ¶
CreateResetButton creates a new form reset button.
func (*Form) CreateSubmitButton ¶
CreateSubmitButton creates a new form submit button.
type FormField ¶
type FormField interface {
fyne.Widget
Reset()
Save()
ValidationError() error
Validate() error
// contains filtered or unexported methods
}
FormField defines a widget that can be used inside a Form.
type RestrictInput ¶
type RestrictInput int
RestrictInput defines input type for Restricted TextFields.
const ( RestrictInputText RestrictInput = iota RestrictInputInteger RestrictInputFloat RestrictInputEmail )
RestrictInput options
type SelectEntryField ¶
type SelectEntryField struct {
widget.SelectEntry
// contains filtered or unexported fields
}
SelectEntryField defines a select entry field widget.
func NewSelectEntryField ¶
func NewSelectEntryField(options []string) *SelectEntryField
NewSelectEntryField creates a new select entry field.
func (*SelectEntryField) FocusGained ¶
func (s *SelectEntryField) FocusGained()
FocusGained overrides widget.Select method.
func (*SelectEntryField) FocusLost ¶
func (s *SelectEntryField) FocusLost()
FocusLost overrides widget.Select method.
func (*SelectEntryField) MinSize ¶
func (s *SelectEntryField) MinSize() fyne.Size
MinSize implements fyne.CanvasObject.
type SelectEntryFormField ¶
type SelectEntryFormField struct {
BaseFormField
TextStyle fyne.TextStyle
Placeholder string
Wrapping fyne.TextWrap
Validator fyne.StringValidator
OnChanged func(string) `json:"-"`
OnSaved func(s string)
// contains filtered or unexported fields
}
SelectEntryFormField defines a special select entry field for Forms.
func NewSelectEntryFormField ¶
func NewSelectEntryFormField(label, initialValue string, options []string) *SelectEntryFormField
NewSelectEntryFormField creates a new select entry form field.
func (*SelectEntryFormField) CreateRenderer ¶
func (s *SelectEntryFormField) CreateRenderer() fyne.WidgetRenderer
CreateRenderer implements fyne.Widget.
func (*SelectEntryFormField) Reset ¶
func (s *SelectEntryFormField) Reset()
Reset resets the text value to the initial value.
func (*SelectEntryFormField) Save ¶
func (s *SelectEntryFormField) Save()
Save triggers the OnSaved callback.
func (*SelectEntryFormField) SetOptions ¶
func (s *SelectEntryFormField) SetOptions(options []string)
SetOptions sets the options the user might select from.
func (*SelectEntryFormField) SetText ¶
func (s *SelectEntryFormField) SetText(text string)
SetText manually sets the text of the TextFormField to the given text value.
func (*SelectEntryFormField) Text ¶
func (s *SelectEntryFormField) Text() string
Text returns the current text value.
func (*SelectEntryFormField) Validate ¶
func (s *SelectEntryFormField) Validate() error
Validate validates the field.
func (*SelectEntryFormField) ValidationError ¶
func (s *SelectEntryFormField) ValidationError() error
ValidationError returns the underlying validation error.
type SelectField ¶
SelectField defines a select field widget.
func NewSelectField ¶
func NewSelectField(options []string, changed func(string)) *SelectField
NewSelectField creates a new select field widget.
func (*SelectField) CreateRenderer ¶
func (s *SelectField) CreateRenderer() fyne.WidgetRenderer
CreateRenderer implements fyne.Widget.
func (*SelectField) FocusGained ¶
func (s *SelectField) FocusGained()
FocusGained overrides widget.Select method.
func (*SelectField) FocusLost ¶
func (s *SelectField) FocusLost()
FocusLost overrides widget.Select method.
func (*SelectField) MinSize ¶
func (s *SelectField) MinSize() fyne.Size
MinSize implements fyne.CanvasObject.
func (*SelectField) MouseIn ¶
func (s *SelectField) MouseIn(ev *desktop.MouseEvent)
MouseIn overrides widget.Select method.
func (*SelectField) MouseOut ¶
func (s *SelectField) MouseOut()
MouseOut overrides widget.Select method.
func (*SelectField) Tapped ¶
func (s *SelectField) Tapped(ev *fyne.PointEvent)
Tapped overrides widget.Select method.
type SelectFormField ¶
type SelectFormField struct {
BaseFormField
Options []string
Placeholder string
Validator fyne.StringValidator
OnChanged func(string) `json:"-"`
OnSaved func(s string)
// contains filtered or unexported fields
}
SelectFormField defines a special select field for Forms.
func NewSelectFormField ¶
func NewSelectFormField(label, initialValue string, options []string) *SelectFormField
NewSelectFormField creates a new select form field.
func (*SelectFormField) CreateRenderer ¶
func (s *SelectFormField) CreateRenderer() fyne.WidgetRenderer
CreateRenderer implements fyne.Widget.
func (*SelectFormField) Reset ¶
func (s *SelectFormField) Reset()
Reset resets the text value to the initial value.
func (*SelectFormField) Selected ¶
func (s *SelectFormField) Selected() string
Selected returns the selected value.
func (*SelectFormField) SetSelected ¶
func (s *SelectFormField) SetSelected(text string)
SetSelected sets the current option.
func (*SelectFormField) Validate ¶
func (s *SelectFormField) Validate() error
Validate validates the field.
func (*SelectFormField) ValidationError ¶
func (s *SelectFormField) ValidationError() error
ValidationError returns the underlying validation error.
type TextField ¶
TextField defines a basic editable text widget.
func NewMaskedTextField ¶
NewMaskedTextField creates a new text field with a mask. Mask definitions:
9: Represents a numeric character (0-9) a: Represents an alpha character (A-Z,a-z) *: Represents an alphanumeric character (A-Z,a-z,0-9)
func NewPasswordTextField ¶
func NewPasswordTextField() *TextField
NewPasswordTextField creates a new password text field.
func NewRestrictTextField ¶
func NewRestrictTextField(input RestrictInput) *TextField
NewRestrictTextField creates a new text field that accepts an input type.
func (*TextField) FocusGained ¶
func (t *TextField) FocusGained()
FocusGained overrides widget.Entry method.
func (*TextField) FocusLost ¶
func (t *TextField) FocusLost()
FocusLost overrides widget.Entry method.
type TextFormField ¶
type TextFormField struct {
BaseFormField
TextStyle fyne.TextStyle
Placeholder string
Wrapping fyne.TextWrap
Validator fyne.StringValidator
// ActionItem is a small item which is displayed at the outer right of the entry (like a password revealer)
ActionItem fyne.CanvasObject
MaxLength int
OnChanged func(s string)
OnSaved func(s string)
// contains filtered or unexported fields
}
TextFormField defines a special text field for Forms.
func NewMaskedTextFormField ¶
func NewMaskedTextFormField(label, initialText, mask, placeHolder string) *TextFormField
NewMaskedTextFormField creates a new text form field with a mask. Mask definitions:
9: Represents a numeric character (0-9) a: Represents an alpha character (A-Z,a-z) *: Represents an alphanumeric character (A-Z,a-z,0-9)
func NewMultiLineTextFormField ¶
func NewMultiLineTextFormField(label, initialText string) *TextFormField
NewMultiLineTextFormField creates a new special multiline text field for Forms.
func NewPasswordTextFormField ¶
func NewPasswordTextFormField(label, initialText string) *TextFormField
NewPasswordTextFormField creates a new password text field.
func NewRestrictTextFormField ¶
func NewRestrictTextFormField(label, initialText string, input RestrictInput) *TextFormField
NewRestrictTextFormField creates a new text form field that accepts an input type.
func NewTextFormField ¶
func NewTextFormField(label, initialText string) *TextFormField
NewTextFormField creates a new special text field for Forms.
func (*TextFormField) CreateRenderer ¶
func (t *TextFormField) CreateRenderer() fyne.WidgetRenderer
CreateRenderer implements fyne.Widget.
func (*TextFormField) Reset ¶
func (t *TextFormField) Reset()
Reset resets the text value to the initial value.
func (*TextFormField) SetText ¶
func (t *TextFormField) SetText(text string)
SetText manually sets the text of the TextFormField to the given text value.
func (*TextFormField) Text ¶
func (t *TextFormField) Text() string
Text returns the current text value.
func (*TextFormField) Validate ¶
func (t *TextFormField) Validate() error
Validate validates the field.
func (*TextFormField) ValidationError ¶
func (t *TextFormField) ValidationError() error
ValidationError returns the underlying validation error.
Source Files