UI: Difference between revisions

From GiderosMobile
No edit summary
No edit summary
 
(12 intermediate revisions by the same user not shown)
Line 3: Line 3:
'''Available since:''' Gideros 2023.1<br/>
'''Available since:''' Gideros 2023.1<br/>


=== Description ===
A UI Library for Gideros made of a plethora of widgets.
'''UI.Builder''' allows for building complex UI layouts.


   In order to use Gideros UI Library, you have to link or include the two following folders to your project:
   In order to use Gideros UI Library, you have to link or include the two following folders to your project:
Line 9: Line 13:
   The folders are available in your '''Gideros installation folder''' (UI Library depends on luashaders)
   The folders are available in your '''Gideros installation folder''' (UI Library depends on luashaders)


=== Description ===
=== Example ===
A UI Library for Gideros made of a plethora of widgets.
 
'''UI.Builder''' allows for building complex UI layouts.
 
=== Examples ===
'''In init.lua'''
'''In init.lua'''
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
UI=UI or {}
UI=UI or {}


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


UI.Default = {
UI.Default = {
TTF=fontfilebold,
TTF=fontfile,
Fonts={
["font"]={ ttf=fontfile, size=0.8 },
["font.small"]={ ttf=fontfile, size=0.5 },
["font.bold"]={ ttf=fontfilebold },
}
}
}
</syntaxhighlight>
</syntaxhighlight>
Line 43: Line 48:


stage:addChild(button)
stage:addChild(button)
</syntaxhighlight>
'''Sliders'''
<syntaxhighlight lang="lua">
--Sliders give value from 0 to 1
local sliderA=UI.Slider.new()
sliderA:setDimensions(200,50)
sliderA:setPosition(250,50)
sliderA.name="Slider A"
local sliderB=UI.Slider.new()
sliderB:setDimensions(200,50)
sliderB:setPosition(250,150)
--This slider center is in the middle of the range
sliderB:setCenter(.5)
--Initial value is .6
sliderB:setKnobPosition(.6)
--Discrete steps of .1
sliderB:setResolution(.1)
sliderB.name="Slider B"
stage:addChild(sliderA)
stage:addChild(sliderB)
--Here we put the WidgetAction listener on stage.
--It will be propagated from each button up to stage through the sprite tree
--First parameter of event listeners are always the source widget of the event
function stage:onWidgetChange(w,v)
print(w.name.." value is "..v)
end
</syntaxhighlight>
</syntaxhighlight>


Line 94: Line 69:
[[UI.Panel]] ''creates a Panel widget''<br/>
[[UI.Panel]] ''creates a Panel widget''<br/>
[[UI.Progress]] ''creates Progress widgets''<br/>
[[UI.Progress]] ''creates Progress widgets''<br/>
[[UI.Slider]] ''creates Slider widgets''<br/>
[[UI.Spinner]] ''creates a Spinner widget''<br/>
[[UI.Splitpane]] ''creates a Splitpane widget''<br/>
[[UI.TabbedPane]] ''creates a TabbedPane widget''<br/>
[[UI.Table]] ''creates a Table widget''<br/>
[[UI.TextField]] ''creates TextField widgets''<br/>
[[UI.TimePicker]] ''creates a TimePicker widget''<br/>
[[UI.Toolbox]] ''creates a Toolbox widget''<br/>
[[UI.Tree]] ''creates a Tree widget''<br/>
[[UI.Viewport]] ''creates a Viewport widget''<br/>
[[UI.WeekSchedule]] ''creates a WeekSchedule widget''<br/>


| style="width: 50%; vertical-align:top;"|
| style="width: 50%; vertical-align:top;"|

Latest revision as of 19:39, 17 October 2023

Supported platforms:
Available since: Gideros 2023.1

Description

A UI Library for Gideros made of a plethora of widgets.

UI.Builder allows for building complex UI layouts.

  In order to use Gideros UI Library, you have to link or include the two following folders to your project:
  * Library/ui
  * Library/luashaders
  The folders are available in your Gideros installation folder (UI Library depends on luashaders)

Example

In init.lua

UI=UI or {}

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

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

In your game

--UI.Style:setDefault(UI.Theme.PointCore_Base)
--UI.Style:setDefault(UI.Theme.PointCore_Red)
UI.Style:setDefault(UI.Theme.PointCore_Pink)

-- a Button
local button=UI.Button.new()
button:setDimensions(64, 48)
button:setPosition(50,50)
button:setText("Button")

function button:onWidgetAction()
	print("Hello Gideros UI")
end

stage:addChild(button)

Widgets

UI.Accordion creates a UI accordion
UI.Animation creates UI animations
UI.Bar creates a Bar widget
UI.Behavior manages widget behavior
UI.Border creates a Border widget
UI.BreadCrumbs creates a BreadCrumbs widget
UI.Builder builds layout interfaces
UI.Button creates Button widgets
UI.Calendar creates Calendar widgets
UI.Checkbox creates Checkbox widgets
UI.Combobox creates Combobox widgets
UI.ImageText creates an ImageText widget
UI.Keyboard creates a Keyboard widget
UI.Label creates a Label widget
UI.Panel creates a Panel widget
UI.Progress creates Progress widgets
UI.Slider creates Slider widgets
UI.Spinner creates a Spinner widget
UI.Splitpane creates a Splitpane widget
UI.TabbedPane creates a TabbedPane widget
UI.Table creates a Table widget
UI.TextField creates TextField widgets
UI.TimePicker creates a TimePicker widget
UI.Toolbox creates a Toolbox widget
UI.Tree creates a Tree widget
UI.Viewport creates a Viewport widget
UI.WeekSchedule creates a WeekSchedule widget