interfaces

Documentation

Index

• type AppConfig
• type BindingManager
• type CallbackFunc
• type EventManager
• type IPCManager
• type Renderer
• type Runtime

Types

type AppConfig

type AppConfig interface {
	GetWidth() int
	GetHeight() int
	GetTitle() string
	GetMinWidth() int
	GetMinHeight() int
	GetMaxWidth() int
	GetMaxHeight() int
	GetResizable() bool
	GetHTML() string
	GetDisableInspector() bool
	GetColour() string
	GetCSS() string
	GetJS() string
}

AppConfig is the application config interface

type BindingManager

type BindingManager interface {
	Bind(object interface{})
	Start(renderer Renderer, runtime Runtime) error
	ProcessCall(callData *messages.CallData) (result interface{}, err error)
	Shutdown()
}

BindingManager is the binding manager interface

type CallbackFunc

type CallbackFunc func(string) error

CallbackFunc defines the signature of a function required to be provided to the Dispatch function so that the response may be returned

type EventManager

type EventManager interface {
	PushEvent(*messages.EventData)
	Emit(eventName string, optionalData ...interface{})
	OnMultiple(eventName string, callback func(...interface{}), counter uint)
	Once(eventName string, callback func(...interface{}))
	On(eventName string, callback func(...interface{}))
	Start(Renderer)
	Shutdown()
}

EventManager is the event manager interface

type IPCManager

type IPCManager interface {
	BindRenderer(Renderer)
	Dispatch(message string, f CallbackFunc)
	Start(eventManager EventManager, bindingManager BindingManager)
	Shutdown()
}

IPCManager is the event manager interface

type Renderer

type Renderer interface {
	Initialise(AppConfig, IPCManager, EventManager) error
	Run() error

	// Binding
	NewBinding(bindingName string) error

	// Events
	NotifyEvent(eventData *messages.EventData) error

	// Dialog Runtime
	SelectFile(title string, filter string) string
	SelectDirectory() string
	SelectSaveFile(title string, filter string) string

	// Window Runtime
	SetColour(string) error

	SetMinSize(width, height int)
	SetMaxSize(width, height int)

	Fullscreen()
	UnFullscreen()
	SetTitle(title string)
	Close()
}

Renderer is an interface describing a Wails target to render the app to

type Runtime

type Runtime interface{}

Runtime interface