element.go

package glui

type Element interface {
  RegisterParent(parent Element) // implemented by ElementData

  Parent() Element // implemented by ElementData
  Children() []Element // implemented by ElementData

  Cursor(x, y int) int // defaults to -1 (which in turn defaults to system default, or cursor of parent element)
  Tooltip() string // defaults to empty string

  CalcDepth(stack *ElementStack) // auto generated by gen_element

  // returns actual width and height used
  // maxZIndex is used to normalize Z
  CalcPos(maxWidth, maxHeight, maxZIndex int) (int, int) // ***must be implemented by custom Element***
  Animate(tick uint64) // defaults to passing Animate to children

  Rect() Rect           // implemented by ElementData, needed for focusrect and menu anchors
  ZIndex() int          // implemented by ElementData
  Hit(x, y int) int     // return -1 if no hit, otherwise returns zIndex, implemented by ElementData
  Translate(dx, dy int) // implemented by ElementData

  Visible() bool // implemented by ElementData
  Hide() // implemented by ElementData
  Show() // default implemented by ElementData simply shows children and sets visible to true

  Enable() // implemented by ElementData
  Disable() // implemented by ElementData

  GetEventListener(name string) EventListener // returns nil if no EventListener specified, implemented by ElementData

  Delete() // deallocs all owned tris, implemented by ElementData
  Deleted() bool // implemented by ElementData

  IsFocusable() bool // implemented by ElementData in general case (i.e. hasEvent(e, "focus) && e.Visible())
  
  Crop(r Rect)
}

type Container interface {
  Element

  A(children ...Element) Container
  Padding(p ...int) Container
  Spacing(s int) Container

  ClearChildren()
}

// other utility methods often implemented by Elements, but not part of interface
//  * InitRect(w, h int) (w, h)
//  * A(children ...Element) Element
//  * Size(w, h int) Element
//  * GetSize() (int, int)                       // implement by ElementData
//  * Padding(p ...int) Element
//  * Spacing(s int) Element
//  * On(name string, fn EventListener) Element
//  * ClearChildren()