app

type ChangeArg struct {
	Value  string
	Target DOMElement
}

type Componer interface {
	// Render should returns a markup.
	// The markup can be a template string following the text/template standard
	// package rules.
	Render() string
}

type ContextMenu Menu

type Contexter interface {
	Elementer

	// Mount mounts the component c into the context. The context is displayed
	// with the default appearance of the component.
	//
	// Driver implementation:
	// - Should call markup.Mount()
	Mount(c Componer)

	// Component returns the component mounted with Mount().
	// Returns nil if there is no component mounted.
	Component() Componer

	// Render renders the DOM node targeted into the sync description s.
	// s contains info specifying if the node and its children should be
	// replaced or just updated.
	// Should be called in a driver implementation.
	Render(s markup.Sync)
}

type DOMElement struct {
	Tag   string // The tag of the element. e.g. div.
	ID    string // The id attribute.
	Class string // the class attribute.
	Value string // The value attribute.
	Index string // The data-murlok-index attribute.
}

type DeltaMode uint64

type Dismounter interface {
	OnDismount()
}

type Docker interface {
	Contexter

	// SetIcon set the dock icon to the image targeted by imageName.
	SetIcon(imageName string)

	// SetBadge set the dock badge with the string value of v.
	SetBadge(v interface{})
}

type Driver interface {
	// Run runs the application.
	//
	// Driver implementation:
	// - Should start the app loop.
	Run()

	// NewElement create an app element. e should be a struct describing the
	// element (e.g. Window, ContextMenu).
	//
	// Driver implementation:
	// - Should check the type of e and then create the native element
	//   described.
	NewElement(e interface{}) Elementer

	// MenuBar returns the element that represents the menu bar.
	// ok will be false if there is no menubar available.
	//
	// Driver implementation:
	// - Should be created in a driver.
	MenuBar() (menu Contexter, ok bool)

	// Dock returns the element that represents the dock.
	// ok will be false if there is no dock available.
	//
	// Driver implementation:
	// - Should be created in the driver implementation.
	Dock() (d Docker, ok bool)

	// Resources returns the location of the resources directory.
	Resources() string

	// Storage returns the location of the app storage directory.
	Storage() string

	// JavascriptBridge is the javascript function to call when a driver want to
	// pass data to the native platform.
	JavascriptBridge() string
}

type ElementStorer interface {
	// Add adds an element in the store.
	// Should be called in a driver implementation when a native element is
	// created.
	Add(e Elementer)

	// Remove removes an element from the store.
	// Should be called in a driver implementation when a native element is
	// closed or removed.
	Remove(e Elementer)

	// Len returns the numbers of element in use.
	Len() int

	// Get returns the element with id.
	// ok will be false if there is no element with id.
	Get(id uuid.UUID) (e Elementer, ok bool)
}

type Elementer interface {
	// ID returns the identifier of the element.
	ID() uuid.UUID
}

type EventArg struct {
	Target DOMElement
}

type FilePicker struct {
	MultipleSelection bool
	NoDir             bool
	NoFile            bool
	OnPick            func(filenames []string)
}

type HTMLContext struct {
	ID       uuid.UUID
	Title    string
	Lang     string
	MurlokJS string
	JS       []string
	CSS      []string
}

type Hrefer interface {
	OnHref(URL *url.URL)
}

type KeyCode uint8

type KeyLocation uint8

type KeyboardArg struct {
	CharCode rune
	KeyCode  KeyCode
	Location KeyLocation
	AltKey   bool
	CtrlKey  bool
	MetaKey  bool
	ShiftKey bool
	Target   DOMElement
}

type Menu struct{}

type Mounter interface {
	OnMount()
}

type MouseArg struct {
	ClientX  float64
	ClientY  float64
	PageX    float64
	PageY    float64
	ScreenX  float64
	ScreenY  float64
	Button   int
	Detail   int
	AltKey   bool
	CtrlKey  bool
	MetaKey  bool
	ShiftKey bool
	Target   DOMElement
}

type Share struct {
	Value interface{}
}

type TemplateFuncMapper interface {
	// Allows to add custom functions to the template used to render the
	// component.
	// Note that funcs named json and time are already implemented to handle
	// structs as prop and time format. Overloads of these will be ignored.
	// See https://golang.org/pkg/text/template/#Template.Funcs for more details.
	FuncMaps() template.FuncMap
}

type Vibrancy uint8

type WheelArg struct {
	DeltaX    float64
	DeltaY    float64
	DeltaZ    float64
	DeltaMode DeltaMode
	Target    DOMElement
}

type Window struct {
	Title           string
	Lang            string
	X               float64
	Y               float64
	Width           float64
	Height          float64
	MinWidth        float64
	MinHeight       float64
	MaxWidth        float64
	MaxHeight       float64
	BackgroundColor string
	Vibrancy        Vibrancy
	Borderless      bool
	FixedSize       bool
	CloseHidden     bool
	MinimizeHidden  bool
	TitlebarHidden  bool

	OnMinimize       func()
	OnDeminimize     func()
	OnFullScreen     func()
	OnExitFullScreen func()
	OnMove           func(x float64, y float64)
	OnResize         func(width float64, height float64)
	OnFocus          func()
	OnBlur           func()
	OnClose          func() bool
}

type Windower interface {
	Contexter

	// Position returns the position of the window.
	Position() (x float64, y float64)

	Move(x float64, y float64)

	// Size returns the size of the window.
	Size() (width float64, height float64)

	// Resize resizes the window.
	Resize(width float64, height float64)

	// Close close`s the window.
	//
	// Driver implementation:
	// - Close should call the native way to close a window.
	// - Native windows often have a handler that is called before a window
	//   is destroyed. This handler should be implemented and call
	//   Elements().Remove() to free resources allocated on go side.
	//   markup.Dismount() should be also called to release the components
	//   mounted.
	Close()
}