Difference between revisions of "Application"

(Undo revision 13598 by MoKaLux (talk))
(Tag: Undo)
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
+
<languages />
 
<!-- GIDEROSOBJ:Application -->
 
<!-- GIDEROSOBJ:Application -->
 
+
'''<translate>Supported platforms</translate>:''' [[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]]<br/>
+
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
'''Available since:''' Gideros 2011.6<br/>
+
'''<translate>Inherits from</translate>:''' [[Special:MyLanguage/Object|Object]]<br/>
'''Inherits from:''' [[Object]]<br/>
+
=== <translate>Description</translate> ===
 
+
<translate><br />
=== Description ===
+
[[Special:MyLanguage/Application|Application]] class contains the common functions that&#039;s available to the current application. There is a global variable ''application'' of type [[Special:MyLanguage/Application|Application]] to access these functions.<br />
[[Application]] class contains the common functions that's available to the current application. There is a global variable ''application'' of type [[Application]] to access these functions.
+
<br /></translate>
<br />
 
<br />
 
 
 
 
{|-
 
{|-
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|
 +
=== <translate>Methods</translate> ===
 +
[[Special:MyLanguage/Application:canOpenUrl|Application:canOpenUrl]] ''<translate>Tests if it is possible to open provided url</translate>''<br/><!-- GIDEROSMTD:Application:canOpenUrl(url) Tests if it is possible to open provided url -->
 +
[[Special:MyLanguage/Application:configureFrustum|Application:configureFrustum]] ''<translate>Configure the projection for 3D perspective.</translate>''<br/><!-- GIDEROSMTD:Application:configureFrustum(fov,farplane) Configure the projection for 3D perspective. -->
 +
[[Special:MyLanguage/Application:exit|Application:exit]] ''<translate>terminates the application</translate>''<br/><!-- GIDEROSMTD:Application:exit() terminates the application -->
 +
[[Special:MyLanguage/Application:get|Application:get]] ''<translate>returns state of desktop setting</translate>''<br/><!-- GIDEROSMTD:Application:get(setting) returns state of desktop setting -->
 +
[[Special:MyLanguage/Application:getApiVersion|Application:getApiVersion]] ''<translate>returns the API version</translate>''<br/><!-- GIDEROSMTD:Application:getApiVersion() returns the API version -->
 +
[[Special:MyLanguage/Application:getAppId|Application:getAppId]] ''<translate>returns the app id or bundle id</translate>''<br/><!-- GIDEROSMTD:Application:getAppId() returns the app id or bundle id -->
 +
[[Special:MyLanguage/Application:getBackgroundColor|Application:getBackgroundColor]] ''<translate>returns the background color in hexadecimal format</translate>''<br/><!-- GIDEROSMTD:Application:getBackgroundColor() returns the background color in hexadecimal format -->
 +
[[Special:MyLanguage/Application:getContentHeight|Application:getContentHeight]] ''<translate>returns content height</translate>''<br/><!-- GIDEROSMTD:Application:getContentHeight() returns content height -->
 +
[[Special:MyLanguage/Application:getContentWidth|Application:getContentWidth]] ''<translate>returns content width</translate>''<br/><!-- GIDEROSMTD:Application:getContentWidth() returns content width -->
 +
[[Special:MyLanguage/Application:getDeviceHeight|Application:getDeviceHeight]] ''<translate>returns the physical height of the device in pixels</translate>''<br/><!-- GIDEROSMTD:Application:getDeviceHeight() returns the physical height of the device in pixels -->
 +
[[Special:MyLanguage/Application:getDeviceWidth|Application:getDeviceWidth]] ''<translate>returns the physical width of the device in pixels</translate>''<br/><!-- GIDEROSMTD:Application:getDeviceWidth() returns the physical width of the device in pixels -->
 +
[[Special:MyLanguage/Application:getDeviceInfo|Application:getDeviceInfo]] ''<translate>returns information about device</translate>''<br/><!-- GIDEROSMTD:Application:getDeviceInfo() returns information about device -->
 +
[[Special:MyLanguage/Application:getDeviceOrientation|Application:getDeviceOrientation]] ''<translate>Get the device orientation</translate>''<br/><!-- GIDEROSMTD:Application:getDeviceOrientation() Get the device orientation -->
 +
[[Special:MyLanguage/Application:getDeviceSafeArea|Application:getDeviceSafeArea]] ''<translate>returns the safe display area bounds</translate>''<br/><!-- GIDEROSMTD:Application:getDeviceSafeArea(logical) returns the safe display area bounds -->
  
=== Methods ===
+
[[Special:MyLanguage/Application:getFps|Application:getFps]] ''<translate>returns the frame rate of the application</translate>''<br/><!-- GIDEROSMTD:Application:getFps() returns the frame rate of the application -->
[[Application:canOpenUrl]] ''Tests if it is possible to open provided url''<br/>
+
[[Special:MyLanguage/Application:getKeyboardModifiers|Application:getKeyboardModifiers]] ''<translate>returns the current keyboard modifiers</translate>''<br/><!-- GIDEROSMTD:Application:getKeyboardModifiers() returns the current keyboard modifiers -->
[[Application:configureFrustum]] ''Configure the projection for 3D perspective.''<br/>
+
[[Special:MyLanguage/Application:getLanguage|Application:getLanguage]] ''<translate>returns the user language</translate>''<br/><!-- GIDEROSMTD:Application:getLanguage() returns the user language -->
[[Application:exit]] ''terminates the application''<br/>
+
[[Special:MyLanguage/Application:getLocale|Application:getLocale]] ''<translate>returns the device locale</translate>''<br/><!-- GIDEROSMTD:Application:getLocale() returns the device locale -->
[[Application:get]] ''returns state of desktop setting''<br/>
+
[[Special:MyLanguage/Application:getLogicalBounds|Application:getLogicalBounds]] ''<translate>returns the physical screen bounds in logical space</translate>''<br/><!-- GIDEROSMTD:Application:getLogicalBounds() returns the physical screen bounds in logical space -->
[[Application:getApiVersion]] ''returns the API version''<br/>
+
[[Special:MyLanguage/Application:getLogicalHeight|Application:getLogicalHeight]] ''<translate>returns the logical height of the application</translate>''<br/><!-- GIDEROSMTD:Application:getLogicalHeight() returns the logical height of the application -->
[[Application:getAppId]] ''returns the app id or bundle id''<br/>
+
[[Special:MyLanguage/Application:getLogicalWidth|Application:getLogicalWidth]] ''<translate>returns the logical width of the application</translate>''<br/><!-- GIDEROSMTD:Application:getLogicalWidth() returns the logical width of the application -->
[[Application:getBackgroundColor]] ''returns the background color in hexadecimal format''<br/>
+
[[Special:MyLanguage/Application:getLogicalScaleX|Application:getLogicalScaleX]] ''<translate>returns the scaling of automatic screen scaling on the x-axis</translate>''<br/><!-- GIDEROSMTD:Application:getLogicalScaleX() returns the scaling of automatic screen scaling on the x-axis -->
[[Application:getContentHeight]] ''returns content height''<br/>
+
[[Special:MyLanguage/Application:getLogicalScaleY|Application:getLogicalScaleY]] ''<translate>returns the scaling of automatic screen scaling on the y-axis</translate>''<br/><!-- GIDEROSMTD:Application:getLogicalScaleY() returns the scaling of automatic screen scaling on the y-axis -->
[[Application:getContentWidth]] ''returns content width''<br/>
+
[[Special:MyLanguage/Application:getLogicalTranslateX|Application:getLogicalTranslateX]] ''<translate>returns the translation of automatic screen scaling on the x-axis</translate>''<br/><!-- GIDEROSMTD:Application:getLogicalTranslateX() returns the translation of automatic screen scaling on the x-axis -->
[[Application:getDeviceHeight]] ''returns the physical height of the device in pixels''<br/>
+
[[Special:MyLanguage/Application:getLogicalTranslateY|Application:getLogicalTranslateY]] ''<translate>returns the translation of automatic screen scaling on the y-axis</translate>''<br/><!-- GIDEROSMTD:Application:getLogicalTranslateY() returns the translation of automatic screen scaling on the y-axis -->
[[Application:getDeviceWidth]] ''returns the physical width of the device in pixels''<br/>
 
[[Application:getDeviceInfo]] ''returns information about device''<br/>
 
[[Application:getDeviceOrientation]] ''Get the device orientation''<br/>
 
[[Application:getDeviceSafeArea]] ''returns the safe display area bounds''<br/>
 
[[Application:getFps]] ''returns the frame rate of the application''<br/>
 
[[Application:getKeyboardModifiers]] ''returns the current keyboard modifiers''<br/>
 
[[Application:getLanguage]] ''returns the user language''<br/>
 
[[Application:getLocale]] ''returns the device locale''<br/>
 
[[Application:getLogicalBounds]] ''returns the physical screen bounds in logical space''<br/>
 
[[Application:getLogicalHeight]] ''returns the logical height of the application''<br/>
 
[[Application:getLogicalWidth]] ''returns the logical width of the application''<br/>
 
[[Application:getLogicalScaleX]] ''returns the scaling of automatic screen scaling on the x-axis''<br/>
 
[[Application:getLogicalScaleY]] ''returns the scaling of automatic screen scaling on the y-axis''<br/>
 
[[Application:getLogicalTranslateX]] ''returns the translation of automatic screen scaling on the x-axis''<br/>
 
[[Application:getLogicalTranslateY]] ''returns the translation of automatic screen scaling on the y-axis''<br/>
 
[[Application:getOrientation]] ''returns the orientation of the application''<br/>
 
[[Application:getScaleMode]] ''returns the automatic scale mode of the application''<br/>
 
[[Application:getScreenDensity]] ''returns the screen density in pixels per inch''<br/>
 
[[Application:getTextureMemoryUsage]] ''returns the texture memory usage in Kbytes''<br/>
 
[[Application:isPlayerMode]] ''Check if app runs on player''<br/>
 
[[Application:openUrl]] ''opens the given URL in the appropriate application''<br/>
 
[[Application:set]] ''sets state of desktop settings''<br/>
 
[[Application:setBackgroundColor]] ''sets the background color in hexadecimal format''<br/>
 
[[Application:setFps]] ''sets the frame rate of the application''<br/>
 
[[Application:setFullScreen]] ''Full screen or window mode''<br/>
 
[[Application:setKeepAwake]] ''enables/disables screen dimming and device sleeping''<br/>
 
[[Application:setKeyboardVisibility]] <br/>
 
[[Application:setLogicalDimensions]] ''sets the logical dimensions of the application''<br/>
 
[[Application:setOrientation]] ''sets the orientation of the application''<br/>
 
[[Application:setScaleMode]] ''sets the automatic scale mode of the application''<br/>
 
[[Application:setWindowSize]] ''Sets desktop window to a specific size''<br/>
 
[[Application:vibrate]] ''vibrates the device''<br/>
 
  
 +
[[Special:MyLanguage/Application:getOrientation|Application:getOrientation]] ''<translate>returns the orientation of the application</translate>''<br/><!-- GIDEROSMTD:Application:getOrientation() returns the orientation of the application -->
 +
[[Special:MyLanguage/Application:getScaleMode|Application:getScaleMode]] ''<translate>returns the automatic scale mode of the application</translate>''<br/><!-- GIDEROSMTD:Application:getScaleMode() returns the automatic scale mode of the application -->
 +
[[Special:MyLanguage/Application:getScreenDensity|Application:getScreenDensity]] ''<translate>returns the screen density in pixels per inch</translate>''<br/><!-- GIDEROSMTD:Application:getScreenDensity() returns the screen density in pixels per inch -->
 +
[[Special:MyLanguage/Application:getTextureMemoryUsage|Application:getTextureMemoryUsage]] ''<translate>returns the texture memory usage in Kbytes</translate>''<br/><!-- GIDEROSMTD:Application:getTextureMemoryUsage() returns the texture memory usage in Kbytes -->
 +
[[Special:MyLanguage/Application:isPlayerMode|Application:isPlayerMode]] ''<translate>Check if app runs on player</translate>''<br/><!-- GIDEROSMTD:Application:isPlayerMode() Check if app runs on player -->
 +
[[Special:MyLanguage/Application:openUrl|Application:openUrl]] ''<translate>opens the given URL in the appropriate application</translate>''<br/><!-- GIDEROSMTD:Application:openUrl(url) opens the given URL in the appropriate application -->
 +
[[Special:MyLanguage/Application:set|Application:set]] ''<translate>sets state of desktop settings</translate>''<br/><!-- GIDEROSMTD:Application:set(setting, values) Sets state of desktop settings -->
 +
[[Special:MyLanguage/Application:setBackgroundColor|Application:setBackgroundColor]] ''<translate>sets the background color in hexadecimal format</translate>''<br/><!-- GIDEROSMTD:Application:setBackgroundColor(color) sets the background color in hexadecimal format -->
 +
[[Special:MyLanguage/Application:setFps|Application:setFps]] ''<translate>sets the frame rate of the application</translate>''<br/><!-- GIDEROSMTD:Application:setFps(fps) sets the frame rate of the application -->
 +
[[Special:MyLanguage/Application:setFullScreen|Application:setFullScreen]] ''<translate>Full screen or window mode</translate>''<br/><!-- GIDEROSMTD:Application:setFullScreen(fullscreen) Full screen or window mode -->
 +
[[Special:MyLanguage/Application:setKeepAwake|Application:setKeepAwake]] ''<translate>enables/disables screen dimming and device sleeping</translate>''<br/><!-- GIDEROSMTD:Application:setKeepAwake(keepAwake) enables/disables screen dimming and device sleeping -->
 +
[[Special:MyLanguage/Application:setKeyboardVisibility|Application:setKeyboardVisibility]] <br/><!-- GIDEROSMTD:Application:setKeyboardVisibility(visible)  -->
 +
[[Special:MyLanguage/Application:setLogicalDimensions|Application:setLogicalDimensions]] ''<translate>sets the logical dimensions of the application</translate>''<br/><!-- GIDEROSMTD:Application:setLogicalDimensions(width,height) sets the logical dimensions of the application -->
 +
[[Special:MyLanguage/Application:setOrientation|Application:setOrientation]] ''<translate>sets the orientation of the application</translate>''<br/><!-- GIDEROSMTD:Application:setOrientation(orientation) sets the orientation of the application -->
 +
[[Special:MyLanguage/Application:setScaleMode|Application:setScaleMode]] ''<translate>sets the automatic scale mode of the application</translate>''<br/><!-- GIDEROSMTD:Application:setScaleMode(scaleMode) sets the automatic scale mode of the application -->
 +
[[Special:MyLanguage/Application:setWindowSize|Application:setWindowSize]] ''<translate>Sets desktop window to a specific size</translate>''<br/><!-- GIDEROSMTD:Application:setWindowSize(width,height) Sets desktop window to a specific size -->
 +
[[Special:MyLanguage/Application:vibrate|Application:vibrate]] ''<translate>vibrates the device</translate>''<br/><!-- GIDEROSMTD:Application:vibrate(ms) vibrates the device -->
 +
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|
  
=== Events ===
+
=== <translate>Events</translate> ===
[[Event.APPLICATION_START]]<br/>  
+
[[Special:MyLanguage/Event.APPLICATION_START|Event.APPLICATION_START]]<br/>  
[[Event.APPLICATION_RESIZE]]<br/>  
+
[[Special:MyLanguage/Event.APPLICATION_RESIZE|Event.APPLICATION_RESIZE]]<br/>  
<!-- You must delete this page [[APPLICATION_RESIZE]]<br/> -->
+
[[Special:MyLanguage/Event.APPLICATION_SUSPEND|Event.APPLICATION_SUSPEND]]<br/>  
[[Event.APPLICATION_SUSPEND]]<br/>  
+
[[Special:MyLanguage/Event.APPLICATION_EXIT|Event.APPLICATION_EXIT]]<br/>  
[[Event.APPLICATION_EXIT]]<br/>  
+
[[Special:MyLanguage/Event.APPLICATION_RESUME|Event.APPLICATION_RESUME]]<br/>
[[Event.APPLICATION_RESUME]]<br/>
 
  
=== Constants ===
+
------------------------------------------------------
[[Application.LANDSCAPE_LEFT]]<br/><!-- GIDEROSCST:Application.LANDSCAPE_LEFT landscapeLeft-->
+
You must delete this page[[APPLICATION_RESIZE]]<br/>
[[Application.LANDSCAPE_RIGHT]]<br/><!-- GIDEROSCST:Application.LANDSCAPE_RIGHT landscapeRight-->
 
[[Application.PORTRAIT]]<br/><!-- GIDEROSCST:Application.PORTRAIT portrait-->
 
[[Application.PORTRAIT_UPSIDE_DOWN]]<br/><!-- GIDEROSCST:Application.PORTRAIT_UPSIDE_DOWN portraitUpsideDown-->
 
  
 +
=== <translate>Constants</translate> ===
 +
[[Special:MyLanguage/Application.LANDSCAPE_LEFT|Application.LANDSCAPE_LEFT]]<br/><!-- GIDEROSCST:Application.LANDSCAPE_LEFT landscapeLeft-->
 +
[[Special:MyLanguage/Application.LANDSCAPE_RIGHT|Application.LANDSCAPE_RIGHT]]<br/><!-- GIDEROSCST:Application.LANDSCAPE_RIGHT landscapeRight-->
 +
[[Special:MyLanguage/Application.PORTRAIT|Application.PORTRAIT]]<br/><!-- GIDEROSCST:Application.PORTRAIT portrait-->
 +
[[Special:MyLanguage/Application.PORTRAIT_UPSIDE_DOWN|Application.PORTRAIT_UPSIDE_DOWN]]<br/><!-- GIDEROSCST:Application.PORTRAIT_UPSIDE_DOWN portraitUpsideDown-->
 
|}
 
|}
 
{{Application}}
 

Revision as of 11:01, 4 December 2019


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

Description


Application class contains the common functions that's 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:configureFrustum Configure the projection for 3D perspective.
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 in hexadecimal format
Application:getContentHeight returns content height
Application:getContentWidth returns content width
Application:getDeviceHeight returns the physical height of the device in pixels
Application:getDeviceWidth returns the physical width of the device in pixels
Application:getDeviceInfo returns information about device
Application:getDeviceOrientation Get 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:getOrientation returns the orientation of the application
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 Check if app runs on player
Application:openUrl opens the given URL in the appropriate application
Application:set sets state of desktop settings
Application:setBackgroundColor sets the background color in hexadecimal format
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
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: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


You must delete this pageAPPLICATION_RESIZE

Constants

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