Entities must support all behaviors

This commit is contained in:
Sasha Koshka 2023-05-02 22:00:28 -04:00 committed by Sasha Koshka
parent 8e5ad8f385
commit b51eb79033
4 changed files with 83 additions and 126 deletions

View File

@ -1,6 +0,0 @@
// Package ability defines extended interfaces that elements and entities can
// support.
//
// Note that backends must give an entity that satisfies the corresponding
// entity interface to an element satisfying a given element interface.
package ability

View File

@ -1,3 +1,4 @@
// Package ability defines extended interfaces that elements can support.
package ability
import "image"

View File

@ -1,120 +0,0 @@
package ability
import "image"
import "git.tebibyte.media/sashakoshka/tomo"
// LayoutEntity is given to elements that support the Layoutable interface.
type LayoutEntity interface {
tomo.Entity
// InvalidateLayout marks the element's layout as invalid. At the end of
// every event, the backend will ask all invalid elements to recalculate
// their layouts.
InvalidateLayout ()
}
// ContainerEntity is given to elements that support the Container interface.
type ContainerEntity interface {
tomo.Entity
LayoutEntity
// Adopt adds an element as a child.
Adopt (child tomo.Element)
// Insert inserts an element in the child list at the specified
// location.
Insert (index int, child tomo.Element)
// Disown removes the child at the specified index.
Disown (index int)
// IndexOf returns the index of the specified child.
IndexOf (child tomo.Element) int
// Child returns the child at the specified index.
Child (index int) tomo.Element
// CountChildren returns the amount of children the element has.
CountChildren () int
// PlaceChild sets the size and position of the child at the specified
// index to a bounding rectangle.
PlaceChild (index int, bounds image.Rectangle)
// SelectChild marks a child as selected or unselected, if it is
// selectable.
SelectChild (index int, selected bool)
// ChildMinimumSize returns the minimum size of the child at the
// specified index.
ChildMinimumSize (index int) (width, height int)
}
// FocusableEntity is given to elements that support the Focusable interface.
type FocusableEntity interface {
tomo.Entity
// Focused returns whether the element currently has input focus.
Focused () bool
// Focus sets this element as focused. If this succeeds, the element will
// recieve a HandleFocus call.
Focus ()
// FocusNext causes the focus to move to the next element. If this
// succeeds, the element will recieve a HandleUnfocus call.
FocusNext ()
// FocusPrevious causes the focus to move to the next element. If this
// succeeds, the element will recieve a HandleUnfocus call.
FocusPrevious ()
}
// SelectableEntity is given to elements that support the Selectable interface.
type SelectableEntity interface {
tomo.Entity
// Selected returns whether this element is currently selected.
Selected () bool
}
// FlexibleEntity is given to elements that support the Flexible interface.
type FlexibleEntity interface {
tomo.Entity
// NotifyFlexibleHeightChange notifies the system that the parameters
// affecting the element's flexible height have changed. This method is
// expected to be called by flexible elements when their content changes.
NotifyFlexibleHeightChange ()
}
// ScrollableEntity is given to elements that support the Scrollable interface.
type ScrollableEntity interface {
tomo.Entity
// NotifyScrollBoundsChange notifies the system that the element's
// scroll content bounds or viewport bounds have changed. This is
// expected to be called by scrollable elements when they change their
// supported scroll axes, their scroll position (either autonomously or
// as a result of a call to ScrollTo()), or their content size.
NotifyScrollBoundsChange ()
}
// ThemeableEntity is given to elements that support the Themeable interface.
type ThemeableEntity interface {
tomo.Entity
// Theme returns the currently active theme. When this value changes,
// the HandleThemeChange method of the element is called.
Theme () tomo.Theme
}
// ConfigurableEntity is given to elements that support the Configurable
// interface.
type ConfigurableEntity interface {
tomo.Entity
// Config returns the currently active config. When this value changes,
// the HandleThemeChange method of the element is called.
Config () tomo.Config
}

View File

@ -11,6 +11,11 @@ type Entity interface {
// themselves.
Invalidate ()
// InvalidateLayout marks the element's layout as invalid. At the end of
// every event, the backend will ask all invalid elements to recalculate
// their layouts.
InvalidateLayout ()
// Bounds returns the bounds of the element to be used for drawing and
// layout.
Bounds () image.Rectangle
@ -29,4 +34,81 @@ type Entity interface {
// directly inside of the window), the backend will draw a default
// background pattern.
DrawBackground (artist.Canvas)
// --- Behaviors relating to parenting ---
// Adopt adds an element as a child.
Adopt (child Element)
// Insert inserts an element in the child list at the specified
// location.
Insert (index int, child Element)
// Disown removes the child at the specified index.
Disown (index int)
// IndexOf returns the index of the specified child.
IndexOf (child Element) int
// Child returns the child at the specified index.
Child (index int) Element
// CountChildren returns the amount of children the element has.
CountChildren () int
// PlaceChild sets the size and position of the child at the specified
// index to a bounding rectangle.
PlaceChild (index int, bounds image.Rectangle)
// SelectChild marks a child as selected or unselected, if it is
// selectable.
SelectChild (index int, selected bool)
// ChildMinimumSize returns the minimum size of the child at the
// specified index.
ChildMinimumSize (index int) (width, height int)
// --- Behaviors relating to input focus ---
// Focused returns whether the element currently has input focus.
Focused () bool
// Focus sets this element as focused. If this succeeds, the element will
// recieve a HandleFocus call.
Focus ()
// FocusNext causes the focus to move to the next element. If this
// succeeds, the element will recieve a HandleUnfocus call.
FocusNext ()
// FocusPrevious causes the focus to move to the next element. If this
// succeeds, the element will recieve a HandleUnfocus call.
FocusPrevious ()
// Selected returns whether this element is currently selected.
Selected () bool
// --- Behaviors relating to scrolling --- //
// NotifyFlexibleHeightChange notifies the system that the parameters
// affecting the element's flexible height have changed. This method is
// expected to be called by flexible elements when their content changes.
NotifyFlexibleHeightChange ()
// NotifyScrollBoundsChange notifies the system that the element's
// scroll content bounds or viewport bounds have changed. This is
// expected to be called by scrollable elements when they change their
// supported scroll axes, their scroll position (either autonomously or
// as a result of a call to ScrollTo()), or their content size.
NotifyScrollBoundsChange ()
// --- Behaviors relating to themeing ---
// Theme returns the currently active theme. When this value changes,
// the HandleThemeChange method of the element is called.
Theme () Theme
// Config returns the currently active config. When this value changes,
// the HandleThemeChange method of the element is called.
Config () Config
}