mobile

Documentation

Overview

Package mobile provides mobile specific driver functionality.

Package mobile provides desktop specific mobile functionality.

Index

• Constants
• type Device
• type Driver
• type KeyboardType
• type Keyboardable
• type TouchEvent
• type Touchable

Constants

const (
	// KeyBack represents the back button which may be hardware or software
	KeyBack fyne.KeyName = "Back"
)

Types

type Device

type Device interface {
	// Request that the mobile device show the touch screen keyboard (standard layout)
	ShowVirtualKeyboard()
	// Request that the mobile device show the touch screen keyboard (custom layout)
	ShowVirtualKeyboardType(KeyboardType)
	// Request that the mobile device dismiss the touch screen keyboard
	HideVirtualKeyboard()
}

Device describes functionality only available on mobile

type Driver

type Driver interface {
	// GoBack asks the OS to go to the previous app / activity, where supported
	GoBack()
}

Driver represents the extended capabilities of a mobile driver

Since: 2.4

type KeyboardType

type KeyboardType int32

KeyboardType represents a type of virtual keyboard

const (
	// DefaultKeyboard is the keyboard with default input style and "return" return key
	DefaultKeyboard KeyboardType = iota
	// SingleLineKeyboard is the keyboard with default input style and "Done" return key
	SingleLineKeyboard
	// NumberKeyboard is the keyboard with number input style and "Done" return key
	NumberKeyboard
	// PasswordKeyboard is used to ensure that text is not leaked to 3rd party keyboard providers
	PasswordKeyboard
)

type Keyboardable

type Keyboardable interface {
	fyne.Focusable

	Keyboard() KeyboardType
}

Keyboardable describes any CanvasObject that needs a keyboard

type TouchEvent

type TouchEvent struct {
	fyne.PointEvent
}

TouchEvent contains data relating to mobile touch events

type Touchable

type Touchable interface {
	TouchDown(*TouchEvent)
	TouchUp(*TouchEvent)
	TouchCancel(*TouchEvent)
}

Touchable represents mobile touch events that can be sent to CanvasObjects