scrollarea

Documentation

Index

• type ScrollArea
  • func New() *ScrollArea
  • func (s *ScrollArea) BackgroundInk() draw.Ink
  • func (s *ScrollArea) Content() *ux.Panel
  • func (s *ScrollArea) ContentSize(horizontal bool) float64
  • func (s *ScrollArea) DefaultDraw(gc draw.Context, dirty geom.Rect, inLiveResize bool)
  • func (s *ScrollArea) DefaultFocusGained()
  • func (s *ScrollArea) DefaultFocusLost()
  • func (s *ScrollArea) DefaultFrameChangeInChildHierarchy(panel *ux.Panel)
  • func (s *ScrollArea) DefaultKeyDown(keyCode int, ch rune, mod keys.Modifiers, repeat bool) bool
  • func (s *ScrollArea) DefaultMouseWheel(where, delta geom.Point, mod keys.Modifiers) bool
  • func (s *ScrollArea) DefaultScrollRectIntoView(rect geom.Rect) bool
  • func (s *ScrollArea) FocusedBorder() border.Border
  • func (s *ScrollArea) ScrollAmount(horizontal, towardsStart, page bool) float64
  • func (s *ScrollArea) ScrollBar(horizontal bool) *scrollbar.ScrollBar
  • func (s *ScrollArea) ScrolledPosition(horizontal bool) float64
  • func (s *ScrollArea) SetBackgroundInk(value draw.Ink) *ScrollArea
  • func (s *ScrollArea) SetBorder(value border.Border) *ScrollArea
  • func (s *ScrollArea) SetContent(content *ux.Panel, behave behavior.Behavior) *ScrollArea
  • func (s *ScrollArea) SetEnabled(enabled bool) *ScrollArea
  • func (s *ScrollArea) SetFocusable(focusable bool) *ScrollArea
  • func (s *ScrollArea) SetFocusedBorder(value border.Border) *ScrollArea
  • func (s *ScrollArea) SetScrolledPosition(horizontal bool, position float64)
  • func (s *ScrollArea) SetUnfocusedBorder(value border.Border) *ScrollArea
  • func (s *ScrollArea) UnfocusedBorder() border.Border
  • func (s *ScrollArea) VisibleSize(horizontal bool) float64

Types

type ScrollArea

type ScrollArea struct {
	ux.Panel
	// contains filtered or unexported fields
}

ScrollArea provides a panel that can hold another panel and show it through a scrollable viewport.

func New

func New() *ScrollArea

New creates a new, empty ScrollArea.

func (*ScrollArea) BackgroundInk

func (s *ScrollArea) BackgroundInk() draw.Ink

BackgroundInk returns the ink that will be used for the background.

func (*ScrollArea) Content

func (s *ScrollArea) Content() *ux.Panel

Content returns the content panel. May be nil.

func (*ScrollArea) ContentSize

func (s *ScrollArea) ContentSize(horizontal bool) float64

ContentSize implements the Scrollable interface.

func (*ScrollArea) DefaultDraw

func (s *ScrollArea) DefaultDraw(gc draw.Context, dirty geom.Rect, inLiveResize bool)

DefaultDraw provides the default drawing.

func (*ScrollArea) DefaultFocusGained

func (s *ScrollArea) DefaultFocusGained()

DefaultFocusGained provides the default focus gained handling.

func (*ScrollArea) DefaultFocusLost

func (s *ScrollArea) DefaultFocusLost()

DefaultFocusLost provides the default focus lost handling.

func (*ScrollArea) DefaultFrameChangeInChildHierarchy

func (s *ScrollArea) DefaultFrameChangeInChildHierarchy(panel *ux.Panel)

DefaultFrameChangeInChildHierarchy provides the default frame change in child hierarchy handling.

func (*ScrollArea) DefaultKeyDown

func (s *ScrollArea) DefaultKeyDown(keyCode int, ch rune, mod keys.Modifiers, repeat bool) bool

DefaultKeyDown provides the default key down handling.

func (*ScrollArea) DefaultMouseWheel

func (s *ScrollArea) DefaultMouseWheel(where, delta geom.Point, mod keys.Modifiers) bool

DefaultMouseWheel provides the default mouse wheel handling.

func (*ScrollArea) DefaultScrollRectIntoView

func (s *ScrollArea) DefaultScrollRectIntoView(rect geom.Rect) bool

DefaultScrollRectIntoView provides the default scroll rect into view handling.

func (*ScrollArea) FocusedBorder

func (s *ScrollArea) FocusedBorder() border.Border

FocusedBorder returns the border to use when focused. Note that the border should present the same insets as the unfocused border or the display will not appear correct.

func (*ScrollArea) ScrollAmount

func (s *ScrollArea) ScrollAmount(horizontal, towardsStart, page bool) float64

ScrollAmount implements the ScrollPager interface.

func (*ScrollArea) ScrollBar

func (s *ScrollArea) ScrollBar(horizontal bool) *scrollbar.ScrollBar

ScrollBar returns the scrollbar for the given axis.

func (*ScrollArea) ScrolledPosition

func (s *ScrollArea) ScrolledPosition(horizontal bool) float64

ScrolledPosition implements the Scrollable interface.

func (*ScrollArea) SetBackgroundInk

func (s *ScrollArea) SetBackgroundInk(value draw.Ink) *ScrollArea

SetBackgroundInk sets the ink that will be used for the background. Pass in nil to use the default.

func (*ScrollArea) SetBorder

func (s *ScrollArea) SetBorder(value border.Border) *ScrollArea

SetBorder sets the border. May be nil.

func (*ScrollArea) SetContent

func (s *ScrollArea) SetContent(content *ux.Panel, behave behavior.Behavior) *ScrollArea

SetContent sets the content panel, replacing any existing one.

func (*ScrollArea) SetEnabled

func (s *ScrollArea) SetEnabled(enabled bool) *ScrollArea

SetEnabled sets enabled state.

func (*ScrollArea) SetFocusable

func (s *ScrollArea) SetFocusable(focusable bool) *ScrollArea

SetFocusable whether it can have the keyboard focus.

func (*ScrollArea) SetFocusedBorder

func (s *ScrollArea) SetFocusedBorder(value border.Border) *ScrollArea

SetFocusedBorder sets the border to use when focused. Note that the border should present the same insets as the unfocused border or the display will not appear correct. Pass in nil to use the default.

func (*ScrollArea) SetScrolledPosition

func (s *ScrollArea) SetScrolledPosition(horizontal bool, position float64)

SetScrolledPosition implements the Scrollable interface.

func (*ScrollArea) SetUnfocusedBorder

func (s *ScrollArea) SetUnfocusedBorder(value border.Border) *ScrollArea

SetUnfocusedBorder sets the border to use when not focused. Note that the border should present the same insets as the focused border or the display will not appear correct. Pass in nil to use the default.

func (*ScrollArea) UnfocusedBorder

func (s *ScrollArea) UnfocusedBorder() border.Border

UnfocusedBorder returns the border to use when not focused. Note that the border should present the same insets as the focused border or the display will not appear correct.

func (*ScrollArea) VisibleSize

func (s *ScrollArea) VisibleSize(horizontal bool) float64

VisibleSize implements the Scrollable interface.