Difference between revisions of "Application"

From GiderosMobile
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
<!-- GIDEROSOBJ:Application -->
 
<!-- GIDEROSOBJ:Application -->
'''Supported platforms:''' [[File:Platform android.png]][[File:Platform ios.png]][[File:Platform mac.png]][[File:Platform pc.png]][[File:Platform html5.png]][[File:Platform winrt.png]][[File:Platform win32.png]]<br/>
+
'''Supported platforms:''' [[File:Platform android.png]][[File:Platform ios.png]][[File:Platform mac.png]][[File:Platform pc.png]][[File:Platform html5.png]][[File:Platform winrt.png]][[File:Platform win32.png]][[File:Platform linux.png]]<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Inherits from:''' [[Object|Object]]<br/>
 
'''Inherits from:''' [[Object|Object]]<br/>
  
 
=== Description ===
 
=== Description ===
The Application class contains the common functions that are available to the current application. There is a global variable ''application'' of type Application to access these functions.
+
The Application class contains the common functions that are available to the current application.
 +
 
 +
There is a global variable '''''application''''' of type Application to access these functions.
  
 
{|-
 
{|-
Line 14: Line 16:
 
[[Application:checkPermission]] ''checks android permission''<br/><!--GIDEROSMTD:Application:checkPermission(permission) checks android permission-->
 
[[Application:checkPermission]] ''checks android permission''<br/><!--GIDEROSMTD:Application:checkPermission(permission) checks android permission-->
 
[[Application:configureFrustum]] ''configures the projection for 3D perspective''<br/><!--GIDEROSMTD:Application:configureFrustum(fov,farplane) configures the projection for 3D perspective-->
 
[[Application:configureFrustum]] ''configures the projection for 3D perspective''<br/><!--GIDEROSMTD:Application:configureFrustum(fov,farplane) configures the projection for 3D perspective-->
 +
[[Application:enableDrawInfo]] ''shows or hides Gideros info layer''<br/><!--GIDEROSMTD:Application:enableDrawInfo(color) shows or hides Gideros info layer-->
 +
[[Application:enableOnDemandDraw]] ''enable or disable on-demand rendering''<br/><!--GIDEROSMTD:Application:enableOnDemandDraw(enable) enable or disable on-demand rendering-->
 
[[Application:exit]] ''terminates the application''<br/><!--GIDEROSMTD:Application:exit() terminates the application-->
 
[[Application:exit]] ''terminates the application''<br/><!--GIDEROSMTD:Application:exit() terminates the application-->
 
[[Application:get]] ''returns state of desktop setting''<br/><!--GIDEROSMTD:Application:get(setting) returns state of desktop setting-->
 
[[Application:get]] ''returns state of desktop setting''<br/><!--GIDEROSMTD:Application:get(setting) returns state of desktop setting-->
Line 25: Line 29:
 
[[Application:getDeviceWidth]] ''returns the physical width of the device''<br/><!--GIDEROSMTD:Application:getDeviceWidth() returns the physical width of the device in pixels-->
 
[[Application:getDeviceWidth]] ''returns the physical width of the device''<br/><!--GIDEROSMTD:Application:getDeviceWidth() returns the physical width of the device in pixels-->
 
[[Application:getDeviceInfo]] ''returns information about device''<br/><!--GIDEROSMTD:Application:getDeviceInfo() returns information about device-->
 
[[Application:getDeviceInfo]] ''returns information about device''<br/><!--GIDEROSMTD:Application:getDeviceInfo() returns information about device-->
 +
[[Application:getDeviceName]] ''returns the device name''<br/><!--GIDEROSMTD:Application:getDeviceName() returns the device name-->
 
[[Application:getDeviceOrientation]] ''gets the device orientation''<br/><!--GIDEROSMTD:Application:getDeviceOrientation() gets the device orientation-->
 
[[Application:getDeviceOrientation]] ''gets the device orientation''<br/><!--GIDEROSMTD:Application:getDeviceOrientation() gets the device orientation-->
 
[[Application:getDeviceSafeArea]] ''returns the safe display area bounds''<br/><!--GIDEROSMTD:Application:getDeviceSafeArea(logical) returns the safe display area bounds-->
 
[[Application:getDeviceSafeArea]] ''returns the safe display area bounds''<br/><!--GIDEROSMTD:Application:getDeviceSafeArea(logical) returns the safe display area bounds-->
Line 40: Line 45:
 
[[Application:getNativePath]] ''returns the system path for a given resource''<br/><!--GIDEROSMTD:Application:getNativePath(path) returns the system path for a given resource-->
 
[[Application:getNativePath]] ''returns the system path for a given resource''<br/><!--GIDEROSMTD:Application:getNativePath(path) returns the system path for a given resource-->
 
[[Application:getOrientation]] ''returns the orientation of the application''<br/><!--GIDEROSMTD:Application:getOrientation() returns the orientation of the application-->
 
[[Application:getOrientation]] ''returns the orientation of the application''<br/><!--GIDEROSMTD:Application:getOrientation() returns the orientation of the application-->
 +
[[Application:getProjectProperties]] ''returns the project properties'' '''new'''<br/><!--GIDEROSMTD:Application:getProjectProperties() returns the project properties-->
 
[[Application:getScaleMode]] ''returns the automatic scale mode of the application''<br/><!--GIDEROSMTD:Application:getScaleMode() returns the automatic scale mode of the application-->
 
[[Application:getScaleMode]] ''returns the automatic scale mode of the application''<br/><!--GIDEROSMTD:Application:getScaleMode() returns the automatic scale mode of the application-->
 
[[Application:getScreenDensity]] ''returns the screen density in pixels per inch''<br/><!--GIDEROSMTD:Application:getScreenDensity() returns the screen density in pixels per inch-->
 
[[Application:getScreenDensity]] ''returns the screen density in pixels per inch''<br/><!--GIDEROSMTD:Application:getScreenDensity() returns the screen density in pixels per inch-->
Line 49: Line 55:
 
[[Application:setBackgroundColor]] ''sets the background color''<br/><!--GIDEROSMTD:Application:setBackgroundColor(color) sets the background color in hexadecimal format-->
 
[[Application:setBackgroundColor]] ''sets the background color''<br/><!--GIDEROSMTD:Application:setBackgroundColor(color) sets the background color in hexadecimal format-->
 
[[Application:setClipboard]] ''stores data to the clipboard''<br/><!--GIDEROSMTD:Application:setClipboard(string) stores data to the clipboard-->
 
[[Application:setClipboard]] ''stores data to the clipboard''<br/><!--GIDEROSMTD:Application:setClipboard(string) stores data to the clipboard-->
 +
[[Application:setEventMerging]] ''allows merging of touch/mouse move events''<br/><!--GIDEROSMTD:Application:setEventMerging(bool) allows merging of touch/mouse move events-->
 
[[Application:setFps]] ''sets the frame rate of the application''<br/><!--GIDEROSMTD:Application:setFps(fps) sets the frame rate of the application-->
 
[[Application:setFps]] ''sets the frame rate of the application''<br/><!--GIDEROSMTD:Application:setFps(fps) sets the frame rate of the application-->
 
[[Application:setFullScreen]] ''full screen or window mode''<br/><!--GIDEROSMTD:Application:setFullScreen(fullscreen) full screen or window mode-->
 
[[Application:setFullScreen]] ''full screen or window mode''<br/><!--GIDEROSMTD:Application:setFullScreen(fullscreen) full screen or window mode-->
Line 63: Line 70:
  
 
=== Events ===
 
=== Events ===
[[Event.APPLICATION_START|Event.APPLICATION_START]]<br/>
+
[[Event.APPLICATION_START]]<br/>
[[Event.APPLICATION_RESIZE|Event.APPLICATION_RESIZE]]<br/>
+
[[Event.APPLICATION_RESIZE]]<br/>
[[Event.APPLICATION_SUSPEND|Event.APPLICATION_SUSPEND]]<br/>
+
[[Event.APPLICATION_SUSPEND]]<br/>
[[Event.APPLICATION_EXIT|Event.APPLICATION_EXIT]]<br/>
+
[[Event.APPLICATION_EXIT]]<br/>
[[Event.APPLICATION_RESUME|Event.APPLICATION_RESUME]]<br/>
+
[[Event.APPLICATION_RESUME]]<br/>
 +
[[Event.APPLICATION_PERMISSION]] '''new'''<br/>
 
=== Constants ===
 
=== Constants ===
 
[[Application.CONSTANTS|Application.LANDSCAPE_LEFT]]<br/><!--GIDEROSCST:Application.LANDSCAPE_LEFT landscapeLeft-->
 
[[Application.CONSTANTS|Application.LANDSCAPE_LEFT]]<br/><!--GIDEROSCST:Application.LANDSCAPE_LEFT landscapeLeft-->

Latest revision as of 19:50, 15 December 2023

Supported platforms: Platform android.pngPlatform ios.pngPlatform mac.pngPlatform pc.pngPlatform html5.pngPlatform winrt.pngPlatform win32.pngPlatform linux.png
Available since: Gideros 2011.6
Inherits from: Object

Description

The Application class contains the common functions that are available to the current application.

There is a global variable application of type Application to access these functions.

Methods

Application:canOpenUrl tests if it is possible to open provided url
Application:checkPermission checks android permission
Application:configureFrustum configures the projection for 3D perspective
Application:enableDrawInfo shows or hides Gideros info layer
Application:enableOnDemandDraw enable or disable on-demand rendering
Application:exit terminates the application
Application:get returns state of desktop setting
Application:getApiVersion returns the API version
Application:getAppId returns the app id or bundle id
Application:getBackgroundColor returns the background color
Application:getClipboard returns content of the clipboard
Application:getContentHeight returns content height
Application:getContentWidth returns content width
Application:getDeviceHeight returns the physical height of the device
Application:getDeviceWidth returns the physical width of the device
Application:getDeviceInfo returns information about device
Application:getDeviceName returns the device name
Application:getDeviceOrientation gets the device orientation
Application:getDeviceSafeArea returns the safe display area bounds
Application:getFps returns the frame rate of the application
Application:getKeyboardModifiers returns the current keyboard modifiers
Application:getLanguage returns the user language
Application:getLocale returns the device locale
Application:getLogicalBounds returns the physical screen bounds in logical space
Application:getLogicalHeight returns the logical height of the application
Application:getLogicalWidth returns the logical width of the application
Application:getLogicalScaleX returns the scaling of automatic screen scaling on the x-axis
Application:getLogicalScaleY returns the scaling of automatic screen scaling on the y-axis
Application:getLogicalTranslateX returns the translation of automatic screen scaling on the x-axis
Application:getLogicalTranslateY returns the translation of automatic screen scaling on the y-axis
Application:getNativePath returns the system path for a given resource
Application:getOrientation returns the orientation of the application
Application:getProjectProperties returns the project properties new
Application:getScaleMode returns the automatic scale mode of the application
Application:getScreenDensity returns the screen density in pixels per inch
Application:getTextureMemoryUsage returns the texture memory usage in Kbytes
Application:isPlayerMode checks if app runs on player
Application:openUrl opens the given URL in the appropriate application
Application:requestPermissions requests an android permission
Application:set sets state of desktop settings
Application:setBackgroundColor sets the background color
Application:setClipboard stores data to the clipboard
Application:setEventMerging allows merging of touch/mouse move events
Application:setFps sets the frame rate of the application
Application:setFullScreen full screen or window mode
Application:setKeepAwake enables/disables screen dimming and device sleeping
Application:setKeyboardVisibility sets the keyboard visibility
Application:setLogicalDimensions sets the logical dimensions of the application
Application:setOrientation sets the orientation of the application
Application:setScaleMode sets the automatic scale mode of the application
Application:setTextInput sets the IME of the android keyboard
Application:setWindowSize sets desktop window to a specific size
Application:vibrate vibrates the device

Events

Event.APPLICATION_START
Event.APPLICATION_RESIZE
Event.APPLICATION_SUSPEND
Event.APPLICATION_EXIT
Event.APPLICATION_RESUME
Event.APPLICATION_PERMISSION new

Constants

Application.LANDSCAPE_LEFT
Application.LANDSCAPE_RIGHT
Application.PORTRAIT
Application.PORTRAIT_UPSIDE_DOWN

Application.CENTER
Application.CROP
Application.FIT_HEIGHT
Application.FIT_WIDTH
Application.LETTERBOX
Application.NO_SCALE
Application.PIXEL_PERFECT
Application.STRETCH

Application.TEXTINPUT_CLASS_NONE
Application.TEXTINPUT_CLASS_TEXT
Application.TEXTINPUT_CLASS_NUMBER
Application.TEXTINPUT_CLASS_PHONE
Application.TEXTINPUT_CLASS_DATE
Application.TEXTINPUT_TVARIANT_URI
Application.TEXTINPUT_TVARIANT_EMAIL
Application.TEXTINPUT_TVARIANT_PASSWORD
Application.TEXTINPUT_DVARIANT_DATE
Application.TEXTINPUT_DVARIANT_TIME
Application.TEXTINPUT_NVARIANT_PASSWORD
Application.TEXTINPUT_TFLAG_CAPCHARACTERS
Application.TEXTINPUT_TFLAG_CAPWORDS
Application.TEXTINPUT_TFLAG_CAPSENTENCES
Application.TEXTINPUT_TFLAG_AUTOCORRECT
Application.TEXTINPUT_TFLAG_MULTILINE
Application.TEXTINPUT_NFLAG_SIGNED
Application.TEXTINPUT_NFLAG_DECIMAL