UI.Viewport

From GiderosMobile
Revision as of 20:55, 17 October 2023 by MoKaLux (talk | contribs) (Created page with "__NOTOC__ '''Available since:''' Gideros 2023.1<br/> '''Class:''' UI<br/> === Description === Creates a Viewport widget. <syntaxhighlight lang="lua"> UI.Viewport.new() </...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Available since: Gideros 2023.1
Class: UI

Description

Creates a Viewport widget.

UI.Viewport.new()

Scrollbars:

  • NONE=0
  • OVER=1
  • AUTO_OVER=2
  • POP_OVER=3
  • ALWAYS=9
  • AUTO=10
  • POP=11
  • DECORATIVE=16, scrollbar is just decorative and cannot be dragged
WARNING: for the scrollbars to work properly, please include your text between [[ ]] with no space at the begining of each lines

Pan modes:

  • AUTO=0, pan on touch, not on click
  • NONE=1, don't pan on user action
  • SCROLLBAR=2, only pan with scrollbars (when they are present)
  • ALWAYS=3, pan by all means, touch, click or scroll

Example

init.lua

local fontfile = "fonts/OpenSans-Regular.ttf"
local fontfilebold = "fonts/OpenSans-Bold.ttf"

UI.Default = {
	TTF=fontfile,
	Fonts={
		["font"]={ ttf=fontfile, size=0.9 },
		["font.small"]={ ttf=fontfile, size=0.5 },
		["font.bold"]={ ttf=fontfilebold },
	}
}

Your code

UI.Style:setDefault(UI.Theme.PointCore_Pink)

local label=UI.Label.new([[
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
]],
	{ flags=FontBase.TLF_BREAKWORDS|FontBase.TLF_REF_LINETOP}
)
label:setLayoutConstraints({fill=1})

local viewport=UI.Viewport.new()
viewport:setContent(label)
viewport:setDimensions(320, 200)
viewport:setColor(0xa9a9a9)
viewport:setPanmode(UI.Viewport.PANMODE.ALWAYS)
viewport:setScrollbar({UI.Viewport.SCROLLBAR.AUTO, UI.Viewport.SCROLLBAR.AUTO})
stage:addChild(viewport)