Split the functionality of tomo.go into multiple files
This commit is contained in:
parent
972f4d3af7
commit
ddf48d2333
100
element.go
Normal file
100
element.go
Normal file
@ -0,0 +1,100 @@
|
||||
package tomo
|
||||
|
||||
// ParentHooks is a struct that contains callbacks that let child elements send
|
||||
// information to their parent element without the child element knowing
|
||||
// anything about the parent element or containing any reference to it. When a
|
||||
// parent element adopts a child element, it must set these callbacks.
|
||||
type ParentHooks struct {
|
||||
// Draw is called when a part of the child element's surface is updated.
|
||||
// The updated region will be passed to the callback as a sub-image.
|
||||
Draw func (region Canvas)
|
||||
|
||||
// MinimumSizeChange is called when the child element's minimum width
|
||||
// and/or height changes. When this function is called, the element will
|
||||
// have already been resized and there is no need to send it a resize
|
||||
// event.
|
||||
MinimumSizeChange func (width, height int)
|
||||
|
||||
// SelectabilityChange is called when the chid element becomes
|
||||
// selectable or non-selectable.
|
||||
SelectabilityChange func (selectable bool)
|
||||
|
||||
// SelectionRequest is called when the child element element wants
|
||||
// itself to be selected. If the parent element chooses to grant the
|
||||
// request, it must send the child element a selection event and return
|
||||
// true.
|
||||
SelectionRequest func () (granted bool)
|
||||
}
|
||||
|
||||
// RunDraw runs the Draw hook if it is not nil. If it is nil, it does nothing.
|
||||
func (hooks ParentHooks) RunDraw (region Canvas) {
|
||||
if hooks.Draw != nil {
|
||||
hooks.Draw(region)
|
||||
}
|
||||
}
|
||||
|
||||
// RunMinimumSizeChange runs the MinimumSizeChange hook if it is not nil. If it
|
||||
// is nil, it does nothing.
|
||||
func (hooks ParentHooks) RunMinimumSizeChange (width, height int) {
|
||||
if hooks.MinimumSizeChange != nil {
|
||||
hooks.MinimumSizeChange(width, height)
|
||||
}
|
||||
}
|
||||
|
||||
// RunSelectionRequest runs the SelectionRequest hook if it is not nil. If it is
|
||||
// nil, it does nothing.
|
||||
func (hooks ParentHooks) RunSelectionRequest () (granted bool) {
|
||||
if hooks.SelectionRequest != nil {
|
||||
granted = hooks.SelectionRequest()
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
// RunSelectabilityChange runs the SelectionRequest hook if it is not nil. If it
|
||||
// is nil, it does nothing.
|
||||
func (hooks ParentHooks) RunSelectabilityChange (selectable bool) {
|
||||
if hooks.SelectabilityChange != nil {
|
||||
hooks.SelectabilityChange(selectable)
|
||||
}
|
||||
}
|
||||
|
||||
// Element represents a basic on-screen object.
|
||||
type Element interface {
|
||||
// Element must implement the Canvas interface. Elements should start
|
||||
// out with a completely blank buffer, and only allocate memory and draw
|
||||
// on it for the first time when sent an EventResize event.
|
||||
Canvas
|
||||
|
||||
// Handle handles an event, propagating it to children if necessary.
|
||||
Handle (event Event)
|
||||
|
||||
// Selectable returns whether this element can be selected. If this
|
||||
// element contains other selectable elements, it must return true.
|
||||
Selectable () (selectable bool)
|
||||
|
||||
// Selected returns whether or not this element is currently selected.
|
||||
// This will always return false if it is not selectable.
|
||||
Selected () (selected bool)
|
||||
|
||||
// If this element contains other elements, and one is selected, this
|
||||
// method will advance the selection in the specified direction. If
|
||||
// the element contains selectable elements but none of them are
|
||||
// selected, it will select the first selectable element. If there are
|
||||
// no more children to be selected in the specified direction, the
|
||||
// element will return false. If the selection could be advanced, it
|
||||
// will return true. If the element contains no selectable child
|
||||
// elements, it will always return false.
|
||||
AdvanceSelection (direction int) (ok bool)
|
||||
|
||||
// SetParentHooks gives the element callbacks that let it send
|
||||
// information to its parent element without it knowing anything about
|
||||
// the parent element or containing any reference to it. When a parent
|
||||
// element adopts a child element, it must set these callbacks.
|
||||
SetParentHooks (callbacks ParentHooks)
|
||||
|
||||
// MinimumSize specifies the minimum amount of pixels this element's
|
||||
// width and height may be set to. If the element is given a resize
|
||||
// event with dimensions smaller than this, it will use its minimum
|
||||
// instead of the offending dimension(s).
|
||||
MinimumSize () (width, height int)
|
||||
}
|
||||
25
layout.go
Normal file
25
layout.go
Normal file
@ -0,0 +1,25 @@
|
||||
package tomo
|
||||
|
||||
import "image"
|
||||
|
||||
// LayoutEntry associates an element with layout and positioning information so
|
||||
// it can be arranged by a Layout.
|
||||
type LayoutEntry struct {
|
||||
Element
|
||||
Position image.Point
|
||||
Expand bool
|
||||
}
|
||||
|
||||
// Layout is capable of arranging elements within a container. It is also able
|
||||
// to determine the minimum amount of room it needs to do so.
|
||||
type Layout interface {
|
||||
// Arrange takes in a slice of entries and a bounding width and height,
|
||||
// and changes the position of the entiries in the slice so that they
|
||||
// are properly laid out. The given width and height should not be less
|
||||
// than what is returned by MinimumSize.
|
||||
Arrange (entries []LayoutEntry, width, height int)
|
||||
|
||||
// MinimumSize returns the minimum width and height that the layout
|
||||
// needs to properly arrange the given slice of layout entries.
|
||||
MinimumSize (entries []LayoutEntry) (width, height int)
|
||||
}
|
||||
158
tomo.go
158
tomo.go
@ -1,165 +1,7 @@
|
||||
package tomo
|
||||
|
||||
import "image"
|
||||
import "errors"
|
||||
|
||||
// ParentHooks is a struct that contains callbacks that let child elements send
|
||||
// information to their parent element without the child element knowing
|
||||
// anything about the parent element or containing any reference to it. When a
|
||||
// parent element adopts a child element, it must set these callbacks.
|
||||
type ParentHooks struct {
|
||||
// Draw is called when a part of the child element's surface is updated.
|
||||
// The updated region will be passed to the callback as a sub-image.
|
||||
Draw func (region Canvas)
|
||||
|
||||
// MinimumSizeChange is called when the child element's minimum width
|
||||
// and/or height changes. When this function is called, the element will
|
||||
// have already been resized and there is no need to send it a resize
|
||||
// event.
|
||||
MinimumSizeChange func (width, height int)
|
||||
|
||||
// SelectabilityChange is called when the chid element becomes
|
||||
// selectable or non-selectable.
|
||||
SelectabilityChange func (selectable bool)
|
||||
|
||||
// SelectionRequest is called when the child element element wants
|
||||
// itself to be selected. If the parent element chooses to grant the
|
||||
// request, it must send the child element a selection event and return
|
||||
// true.
|
||||
SelectionRequest func () (granted bool)
|
||||
}
|
||||
|
||||
// RunDraw runs the Draw hook if it is not nil. If it is nil, it does nothing.
|
||||
func (hooks ParentHooks) RunDraw (region Canvas) {
|
||||
if hooks.Draw != nil {
|
||||
hooks.Draw(region)
|
||||
}
|
||||
}
|
||||
|
||||
// RunMinimumSizeChange runs the MinimumSizeChange hook if it is not nil. If it
|
||||
// is nil, it does nothing.
|
||||
func (hooks ParentHooks) RunMinimumSizeChange (width, height int) {
|
||||
if hooks.MinimumSizeChange != nil {
|
||||
hooks.MinimumSizeChange(width, height)
|
||||
}
|
||||
}
|
||||
|
||||
// RunSelectionRequest runs the SelectionRequest hook if it is not nil. If it is
|
||||
// nil, it does nothing.
|
||||
func (hooks ParentHooks) RunSelectionRequest () (granted bool) {
|
||||
if hooks.SelectionRequest != nil {
|
||||
granted = hooks.SelectionRequest()
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
// RunSelectabilityChange runs the SelectionRequest hook if it is not nil. If it
|
||||
// is nil, it does nothing.
|
||||
func (hooks ParentHooks) RunSelectabilityChange (selectable bool) {
|
||||
if hooks.SelectabilityChange != nil {
|
||||
hooks.SelectabilityChange(selectable)
|
||||
}
|
||||
}
|
||||
|
||||
// Element represents a basic on-screen object.
|
||||
type Element interface {
|
||||
// Element must implement the Canvas interface. Elements should start
|
||||
// out with a completely blank buffer, and only allocate memory and draw
|
||||
// on it for the first time when sent an EventResize event.
|
||||
Canvas
|
||||
|
||||
// Handle handles an event, propagating it to children if necessary.
|
||||
Handle (event Event)
|
||||
|
||||
// Selectable returns whether this element can be selected. If this
|
||||
// element contains other selectable elements, it must return true.
|
||||
Selectable () (selectable bool)
|
||||
|
||||
// Selected returns whether or not this element is currently selected.
|
||||
// This will always return false if it is not selectable.
|
||||
Selected () (selected bool)
|
||||
|
||||
// If this element contains other elements, and one is selected, this
|
||||
// method will advance the selection in the specified direction. If
|
||||
// the element contains selectable elements but none of them are
|
||||
// selected, it will select the first selectable element. If there are
|
||||
// no more children to be selected in the specified direction, the
|
||||
// element will return false. If the selection could be advanced, it
|
||||
// will return true. If the element contains no selectable child
|
||||
// elements, it will always return false.
|
||||
AdvanceSelection (direction int) (ok bool)
|
||||
|
||||
// SetParentHooks gives the element callbacks that let it send
|
||||
// information to its parent element without it knowing anything about
|
||||
// the parent element or containing any reference to it. When a parent
|
||||
// element adopts a child element, it must set these callbacks.
|
||||
SetParentHooks (callbacks ParentHooks)
|
||||
|
||||
// MinimumSize specifies the minimum amount of pixels this element's
|
||||
// width and height may be set to. If the element is given a resize
|
||||
// event with dimensions smaller than this, it will use its minimum
|
||||
// instead of the offending dimension(s).
|
||||
MinimumSize () (width, height int)
|
||||
}
|
||||
|
||||
// Window represents a top-level container generated by the currently running
|
||||
// backend. It can contain a single element. It is hidden by default, and must
|
||||
// be explicitly shown with the Show() method. If it contains no element, it
|
||||
// displays a black (or transprent) background.
|
||||
type Window interface {
|
||||
// Adopt sets the root element of the window. There can only be one of
|
||||
// these at one time.
|
||||
Adopt (child Element)
|
||||
|
||||
// Child returns the root element of the window.
|
||||
Child () (child Element)
|
||||
|
||||
// SetTitle sets the title that appears on the window's title bar. This
|
||||
// method might have no effect with some backends.
|
||||
SetTitle (title string)
|
||||
|
||||
// SetIcon taks in a list different sizes of the same icon and selects
|
||||
// the best one to display on the window title bar, dock, or whatever is
|
||||
// applicable for the given backend. This method might have no effect
|
||||
// for some backends.
|
||||
SetIcon (sizes []image.Image)
|
||||
|
||||
// Show shows the window. The window starts off hidden, so this must be
|
||||
// called after initial setup to make sure it is visible.
|
||||
Show ()
|
||||
|
||||
// Hide hides the window.
|
||||
Hide ()
|
||||
|
||||
// Close closes the window.
|
||||
Close ()
|
||||
|
||||
// OnClose specifies a function to be called when the window is closed.
|
||||
OnClose (func ())
|
||||
}
|
||||
|
||||
// LayoutEntry associates an element with layout and positioning information so
|
||||
// it can be arranged by a Layout.
|
||||
type LayoutEntry struct {
|
||||
Element
|
||||
Position image.Point
|
||||
Expand bool
|
||||
}
|
||||
|
||||
// Layout is capable of arranging elements within a container. It is also able
|
||||
// to determine the minimum amount of room it needs to do so.
|
||||
type Layout interface {
|
||||
// Arrange takes in a slice of entries and a bounding width and height,
|
||||
// and changes the position of the entiries in the slice so that they
|
||||
// are properly laid out. The given width and height should not be less
|
||||
// than what is returned by MinimumSize.
|
||||
Arrange (entries []LayoutEntry, width, height int)
|
||||
|
||||
// MinimumSize returns the minimum width and height that the layout
|
||||
// needs to properly arrange the given slice of layout entries.
|
||||
MinimumSize (entries []LayoutEntry) (width, height int)
|
||||
}
|
||||
|
||||
var backend Backend
|
||||
|
||||
// Run initializes a backend, calls the callback function, and begins the event
|
||||
|
||||
39
window.go
Normal file
39
window.go
Normal file
@ -0,0 +1,39 @@
|
||||
package tomo
|
||||
|
||||
import "image"
|
||||
|
||||
// Window represents a top-level container generated by the currently running
|
||||
// backend. It can contain a single element. It is hidden by default, and must
|
||||
// be explicitly shown with the Show() method. If it contains no element, it
|
||||
// displays a black (or transprent) background.
|
||||
type Window interface {
|
||||
// Adopt sets the root element of the window. There can only be one of
|
||||
// these at one time.
|
||||
Adopt (child Element)
|
||||
|
||||
// Child returns the root element of the window.
|
||||
Child () (child Element)
|
||||
|
||||
// SetTitle sets the title that appears on the window's title bar. This
|
||||
// method might have no effect with some backends.
|
||||
SetTitle (title string)
|
||||
|
||||
// SetIcon taks in a list different sizes of the same icon and selects
|
||||
// the best one to display on the window title bar, dock, or whatever is
|
||||
// applicable for the given backend. This method might have no effect
|
||||
// for some backends.
|
||||
SetIcon (sizes []image.Image)
|
||||
|
||||
// Show shows the window. The window starts off hidden, so this must be
|
||||
// called after initial setup to make sure it is visible.
|
||||
Show ()
|
||||
|
||||
// Hide hides the window.
|
||||
Hide ()
|
||||
|
||||
// Close closes the window.
|
||||
Close ()
|
||||
|
||||
// OnClose specifies a function to be called when the window is closed.
|
||||
OnClose (func ())
|
||||
}
|
||||
Reference in New Issue
Block a user