Application:set: Difference between revisions

From GiderosMobile
No edit summary
 
(10 intermediate revisions by 3 users not shown)
Line 5: Line 5:
=== Description ===
=== Description ===
Sets the state of the desktop setting provided as string parameter.
Sets the state of the desktop setting provided as string parameter.
<source lang="lua">
<syntaxhighlight lang="lua">
application:set(setting, value)
application:set(setting,value)
</source>
</syntaxhighlight>
 


'''new''' Gideros 2023.11: implement '''application:set("statusBar")''' for Android and iOS</br>
'''new''' Gideros 2022.1: implement '''application:set("wintabMode")'''
'''new''' Gideros 2022.1: implement '''application:set("wintabMode")'''


Line 15: Line 15:
'''setting''': (string) the desktop setting<br/>
'''setting''': (string) the desktop setting<br/>
'''value''': (varies) the new setting value(s)<br/>
'''value''': (varies) the new setting value(s)<br/>
=== '''Compatibility table''' ===
{| class="wikitable" style="text-align: center;"
!!!QT!!Win32!!UWP!!Android!!Apple MacOS!!Apple iOS!!Apple tvOS!!Linux!!HTML
|-
|clipboard||X||X||||||||||||X||
|-
|cursor||X||X||X||||X||||||X||X
|-
|cursorPosition||X||X||||||||||||||
|-
|documentDirectory||X||X||||||||||||X||
|-
|maximumSize||X||||||||||||||||
|-
|minimumSize||X||||||||||||||||
|-
|mkDir||||X||||||||||||X||
|-
|statusBar||||||||X||||X||||||
|-
|temporaryDirectory||X||X||||||||||||X||
|-
|windowColor||X||||||||||||||||
|-
|windowModel||X||||||||||||||||
|-
|windowPosition||X||X||||||||||||X||
|-
|windowSize||X||X||||||||||||X||
|-
|windowTitle||X||X||||||||||||X||X
|-
|wintabMode||X||||||||||||||||
|}


=== List of available parameters and settings ===
=== List of available parameters and settings ===
To get a list of parameters that can be set use:
To get a list of parameters that can be set use:
<source lang="lua">
<syntaxhighlight lang="lua">
print(application:set("help"))
print(application:set("help"))
--[[
--[[
Line 35: Line 70:
- temporaryDirectory(path)
- temporaryDirectory(path)
]]
]]
</source>
</syntaxhighlight>


To get help for individual settings use:
To get help for individual settings use:
<source lang="lua">
<syntaxhighlight lang="lua">
print(application:set("cursor","help")) -- eg: cursor
print(application:set("cursor","help")) -- eg: cursor
--[[
--[[
Line 65: Line 100:
- dragLink -- not available on win32
- dragLink -- not available on win32
]]
]]
</source>
</syntaxhighlight>


<source lang="lua">
<syntaxhighlight lang="lua">
print(application:set("windowModel","help")) -- eg: window mode
print(application:set("windowModel","help")) -- eg: window mode
--[[
--[[
Line 85: Line 120:
- helpButton
- helpButton
]]
]]
</source>
</syntaxhighlight>


=== Examples ===
=== Examples ===
<source lang="lua">
<syntaxhighlight lang="lua">
application:set("windowPosition", 64, 64)
application:set("windowPosition", 64, 64)
application:set("windowColor", 0, 0, 0)
application:set("windowColor", 0, 0, 0)
application:set("windowTitle", "My lovely window title")
application:set("windowTitle", "My lovely window title")
application:set("cursor", "openHand")
application:set("cursor", "openHand")
</source>


<source lang="lua">
-- hide the cursor (Windows, Mac)
application:set("cursor", "blank")
</syntaxhighlight>
 
<syntaxhighlight lang="lua">
-- global app size
-- global app size
myappleft, myapptop, myappright, myappbot = application:getLogicalBounds()
myappleft, myapptop, myappright, myappbot = application:getLogicalBounds()
Line 109: Line 147:
application:set("windowColor", 0, 0, 0)
application:set("windowColor", 0, 0, 0)
end
end
</source>
</syntaxhighlight>
 
<syntaxhighlight lang="lua">
-- \\dirName on Win32 (could be \/ on Linux - not tested), doesn't work with Windows Qt :-(
application:set("mkDir", application:get("directory","executable").."\\dirName")
</syntaxhighlight>


<source lang="lua">
'''Bonus'''
application:set("mkDir", application:get("directory","executable").."|dirName")
<syntaxhighlight lang="lua">
</source>
-- to open a directory
os.execute("start "..application:get("directory", "pictures"))
-- to open a sub directory
local sep = "\\" -- for Win32
--local sep = "/" -- for Qt
os.execute("start "..application:get("directory", "pictures")..sep.."myfolder")
</syntaxhighlight>


{{Application}}
{{Application}}

Latest revision as of 08:36, 27 September 2026

Available since: Gideros 2015.7
Class: Application

Description

Sets the state of the desktop setting provided as string parameter.

application:set(setting,value)

new Gideros 2023.11: implement application:set("statusBar") for Android and iOS
new Gideros 2022.1: implement application:set("wintabMode")

Parameters

setting: (string) the desktop setting
value: (varies) the new setting value(s)

Compatibility table

QT Win32 UWP Android Apple MacOS Apple iOS Apple tvOS Linux HTML
clipboard X X X
cursor X X X X X X
cursorPosition X X
documentDirectory X X X
maximumSize X
minimumSize X
mkDir X X
statusBar X X
temporaryDirectory X X X
windowColor X
windowModel X
windowPosition X X X
windowSize X X X
windowTitle X X X X
wintabMode X

List of available parameters and settings

To get a list of parameters that can be set use:

print(application:set("help"))
--[[
- windowPosition(x,y)
- windowSize(w,h)
- minimumSize(w,h)
- maximumSize(w,h)
- windowColor(r,g,b)
- windowTitle(text)
- windowModel(type//help)
- cursor(type//help)
- cursorPosition(x,y)
- clipboard(text)
- mkdir(path|dirName//help)
- documentDirectory(path)
- temporaryDirectory(path)
]]

To get help for individual settings use:

print(application:set("cursor","help")) -- eg: cursor
--[[
Accepted value for cursor :
- arrow
- upArrow
- cross
- wait
- IBeam
- sizeVer
- sizeHor
- sizeBDiag
- sizeFDiag
- sizeAll
- blank -- not available on win32
- splitV
- splitH
- pointingHand
- forbidden
- whatsThis
- busy
- openHand -- not available on win32
- closedHand -- not available on win32
- dragCopy -- not available on win32
- dragMove -- not available on win32
- dragLink -- not available on win32
]]
print(application:set("windowModel","help")) -- eg: window mode
--[[
Accepted value for windowModel :
- reset
- stayOnTop
- stayOnBottom
- frameless
- noTitleBar
- noButton
- onlyMinimize
- onlyMaximize
- onlyClose
- noMinimize
- noMaximize
- noClose
- helpButton
]]

Examples

application:set("windowPosition", 64, 64)
application:set("windowColor", 0, 0, 0)
application:set("windowTitle", "My lovely window title")
application:set("cursor", "openHand")

-- hide the cursor (Windows, Mac)
application:set("cursor", "blank")
-- global app size
myappleft, myapptop, myappright, myappbot = application:getLogicalBounds()
myappwidth, myappheight = myappright - myappleft, myappbot - myapptop

if application:getDeviceInfo() == "Windows" and not application:isPlayerMode() then
	application:set("windowPosition", myappwidth * 1.2, 16)
	application:set("windowModel", "onlyClose")
--	application:set("windowModel", "noMaximize") -- doesn't work for me!
	application:set("windowTitle", "App Title")
	application:set("minimumSize", myappwidth, myappheight)
	application:set("maximumSize", myappwidth, myappheight)
	application:set("windowColor", 0, 0, 0)
end
-- \\dirName on Win32 (could be \/ on Linux - not tested), doesn't work with Windows Qt :-(
application:set("mkDir", application:get("directory","executable").."\\dirName")

Bonus

-- to open a directory
os.execute("start "..application:get("directory", "pictures"))
-- to open a sub directory
local sep = "\\" -- for Win32
--local sep = "/" -- for Qt
os.execute("start "..application:get("directory", "pictures")..sep.."myfolder")