123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911 |
- <?xml version="1.0" encoding="UTF-8" ?>
- <class name="OS" inherits="Object" category="Core" version="3.0.alpha.custom_build">
- <brief_description>
- Operating System functions.
- </brief_description>
- <description>
- Operating System functions. OS Wraps the most common functionality to communicate with the host Operating System, such as: mouse grabbing, mouse cursors, clipboard, video mode, date and time, timers, environment variables, execution of binaries, command line, etc.
- </description>
- <tutorials>
- </tutorials>
- <demos>
- </demos>
- <methods>
- <method name="alert">
- <return type="void">
- </return>
- <argument index="0" name="text" type="String">
- </argument>
- <argument index="1" name="title" type="String" default=""Alert!"">
- </argument>
- <description>
- Displays a modal dialog box utilizing the host OS.
- </description>
- </method>
- <method name="can_draw" qualifiers="const">
- <return type="bool">
- </return>
- <description>
- Returns [code]true[/code] if the host OS allows drawing.
- </description>
- </method>
- <method name="can_use_threads" qualifiers="const">
- <return type="bool">
- </return>
- <description>
- Returns [code]true[/code] if the current host platform is using multiple threads.
- </description>
- </method>
- <method name="delay_msec" qualifiers="const">
- <return type="void">
- </return>
- <argument index="0" name="msec" type="int">
- </argument>
- <description>
- Delay executing of the current thread by given milliseconds.
- </description>
- </method>
- <method name="delay_usec" qualifiers="const">
- <return type="void">
- </return>
- <argument index="0" name="usec" type="int">
- </argument>
- <description>
- Delay executing of the current thread by given microseconds.
- </description>
- </method>
- <method name="dump_memory_to_file">
- <return type="void">
- </return>
- <argument index="0" name="file" type="String">
- </argument>
- <description>
- Dumps the memory allocation ringlist to a file (only works in debug).
- Entry format per line: "Address - Size - Description"
- </description>
- </method>
- <method name="dump_resources_to_file">
- <return type="void">
- </return>
- <argument index="0" name="file" type="String">
- </argument>
- <description>
- Dumps all used resources to file (only works in debug).
- Entry format per line: "Resource Type : Resource Location"
- At the end of the file is a statistic of all used Resource Types.
- </description>
- </method>
- <method name="execute">
- <return type="int">
- </return>
- <argument index="0" name="path" type="String">
- </argument>
- <argument index="1" name="arguments" type="PoolStringArray">
- </argument>
- <argument index="2" name="blocking" type="bool">
- </argument>
- <argument index="3" name="output" type="Array" default="[ ]">
- </argument>
- <description>
- Execute the binary file in given path, optionally blocking until it returns. A process ID is returned.
- </description>
- </method>
- <method name="find_scancode_from_string" qualifiers="const">
- <return type="int">
- </return>
- <argument index="0" name="string" type="String">
- </argument>
- <description>
- Returns the scancode of the given string (e.g. "Escape")
- </description>
- </method>
- <method name="get_borderless_window" qualifiers="const">
- <return type="bool">
- </return>
- <description>
- Returns true if the current window is borderless.
- </description>
- </method>
- <method name="get_clipboard" qualifiers="const">
- <return type="String">
- </return>
- <description>
- Get clipboard from the host OS.
- </description>
- </method>
- <method name="get_cmdline_args">
- <return type="PoolStringArray">
- </return>
- <description>
- Returns the command line arguments passed to the engine.
- </description>
- </method>
- <method name="get_current_screen" qualifiers="const">
- <return type="int">
- </return>
- <description>
- Returns the current screen index (0 padded).
- </description>
- </method>
- <method name="get_data_dir" qualifiers="const">
- <return type="String">
- </return>
- <description>
- Returns the absolute directory path of user data path([user://]).
- </description>
- </method>
- <method name="get_date" qualifiers="const">
- <return type="Dictionary">
- </return>
- <argument index="0" name="utc" type="bool" default="false">
- </argument>
- <description>
- Returns current date as a dictionary of keys: year, month, day, weekday, dst (daylight savings time).
- </description>
- </method>
- <method name="get_datetime" qualifiers="const">
- <return type="Dictionary">
- </return>
- <argument index="0" name="utc" type="bool" default="false">
- </argument>
- <description>
- Returns current datetime as a dictionary of keys: year, month, day, weekday, dst (daylight savings time), hour, minute, second.
- </description>
- </method>
- <method name="get_datetime_from_unix_time" qualifiers="const">
- <return type="Dictionary">
- </return>
- <argument index="0" name="unix_time_val" type="int">
- </argument>
- <description>
- Get a dictionary of time values when given epoch time.
- Dictionary Time values will be a union of values from [method get_time] and [method get_date] dictionaries (with the exception of dst = day light standard time, as it cannot be determined from epoch).
- </description>
- </method>
- <method name="get_dynamic_memory_usage" qualifiers="const">
- <return type="int">
- </return>
- <description>
- Returns the total amount of dynamic memory used (only works in debug).
- </description>
- </method>
- <method name="get_environment" qualifiers="const">
- <return type="String">
- </return>
- <argument index="0" name="environment" type="String">
- </argument>
- <description>
- Returns an environment variable.
- </description>
- </method>
- <method name="get_executable_path" qualifiers="const">
- <return type="String">
- </return>
- <description>
- Returns the path to the current engine executable.
- </description>
- </method>
- <method name="get_exit_code" qualifiers="const">
- <return type="int">
- </return>
- <description>
- </description>
- </method>
- <method name="get_latin_keyboard_variant" qualifiers="const">
- <return type="String">
- </return>
- <description>
- Returns the current latin keyboard variant as a String.
- Possible return values are: "QWERTY", "AZERTY", "QZERTY", "DVORAK", "NEO", "COLEMAK" or "ERROR".
- </description>
- </method>
- <method name="get_locale" qualifiers="const">
- <return type="String">
- </return>
- <description>
- Returns the host OS locale.
- </description>
- </method>
- <method name="get_model_name" qualifiers="const">
- <return type="String">
- </return>
- <description>
- Returns the model name of the current device.
- </description>
- </method>
- <method name="get_name" qualifiers="const">
- <return type="String">
- </return>
- <description>
- Returns the name of the host OS. Possible values are: "Android", "Haiku", "iOS", "HTML5", "OSX", "Server", "Windows", "UWP", "X11".
- </description>
- </method>
- <method name="get_power_percent_left">
- <return type="int">
- </return>
- <description>
- Returns the amount of battery left in the device as a percentage.
- </description>
- </method>
- <method name="get_power_seconds_left">
- <return type="int">
- </return>
- <description>
- Returns the time in seconds before the device runs out of battery.
- </description>
- </method>
- <method name="get_power_state">
- <return type="int" enum="OS.PowerState">
- </return>
- <description>
- Returns the current state of the device regarding battery and power. See [code]POWERSTATE_*[/code] constants.
- </description>
- </method>
- <method name="get_process_id" qualifiers="const">
- <return type="int">
- </return>
- <description>
- Returns the game process ID
- </description>
- </method>
- <method name="get_processor_count" qualifiers="const">
- <return type="int">
- </return>
- <description>
- Returns the number of cores available in the host machine.
- </description>
- </method>
- <method name="get_scancode_string" qualifiers="const">
- <return type="String">
- </return>
- <argument index="0" name="code" type="int">
- </argument>
- <description>
- Returns the given scancode as a string (e.g. Return values: "Escape", "Shift+Escape").
- </description>
- </method>
- <method name="get_screen_count" qualifiers="const">
- <return type="int">
- </return>
- <description>
- Returns the number of displays attached to the host machine.
- </description>
- </method>
- <method name="get_screen_dpi" qualifiers="const">
- <return type="int">
- </return>
- <argument index="0" name="screen" type="int" default="-1">
- </argument>
- <description>
- Returns the dots per inch density of the specified screen.
- On Android Devices, the actual screen densities are grouped into six generalized densities:
- ldpi - 120 dpi
- mdpi - 160 dpi
- hdpi - 240 dpi
- xhdpi - 320 dpi
- xxhdpi - 480 dpi
- xxxhdpi - 640 dpi
- </description>
- </method>
- <method name="get_screen_orientation" qualifiers="const">
- <return type="int" enum="OS.ScreenOrientation">
- </return>
- <description>
- Returns the current screen orientation, the return value will be one of the SCREEN_ORIENTATION constants in this class.
- </description>
- </method>
- <method name="get_screen_position" qualifiers="const">
- <return type="Vector2">
- </return>
- <argument index="0" name="screen" type="int" default="-1">
- </argument>
- <description>
- Returns the position of the specified screen by index. If no screen index is provided, the current screen will be used.
- </description>
- </method>
- <method name="get_screen_size" qualifiers="const">
- <return type="Vector2">
- </return>
- <argument index="0" name="screen" type="int" default="-1">
- </argument>
- <description>
- Returns the dimensions in pixels of the specified screen.
- </description>
- </method>
- <method name="get_splash_tick_msec" qualifiers="const">
- <return type="int">
- </return>
- <description>
- </description>
- </method>
- <method name="get_static_memory_peak_usage" qualifiers="const">
- <return type="int">
- </return>
- <description>
- Returns the max amount of static memory used (only works in debug).
- </description>
- </method>
- <method name="get_static_memory_usage" qualifiers="const">
- <return type="int">
- </return>
- <description>
- Returns the amount of static memory being used by the program in bytes.
- </description>
- </method>
- <method name="get_system_dir" qualifiers="const">
- <return type="String">
- </return>
- <argument index="0" name="dir" type="int" enum="OS.SystemDir">
- </argument>
- <description>
- Returns the actual path to commonly used folders across different platforms. Available locations are specified in [OS.SystemDir].
- </description>
- </method>
- <method name="get_system_time_secs" qualifiers="const">
- <return type="int">
- </return>
- <description>
- Returns the epoch time of the operating system in seconds.
- </description>
- </method>
- <method name="get_ticks_msec" qualifiers="const">
- <return type="int">
- </return>
- <description>
- Returns the amount of time passed in milliseconds since the engine started.
- </description>
- </method>
- <method name="get_time" qualifiers="const">
- <return type="Dictionary">
- </return>
- <argument index="0" name="utc" type="bool" default="false">
- </argument>
- <description>
- Returns current time as a dictionary of keys: hour, minute, second.
- </description>
- </method>
- <method name="get_time_zone_info" qualifiers="const">
- <return type="Dictionary">
- </return>
- <description>
- Returns the current time zone as a dictionary with the keys: bias and name.
- </description>
- </method>
- <method name="get_unique_id" qualifiers="const">
- <return type="String">
- </return>
- <description>
- Returns a string that is unique to the device. Currently only works on Android and iOS. Returns empty string on other platforms.
- </description>
- </method>
- <method name="get_unix_time" qualifiers="const">
- <return type="int">
- </return>
- <description>
- Return the current unix timestamp.
- </description>
- </method>
- <method name="get_unix_time_from_datetime" qualifiers="const">
- <return type="int">
- </return>
- <argument index="0" name="datetime" type="Dictionary">
- </argument>
- <description>
- Get an epoch time value from a dictionary of time values.
- [code]datetime[/code] must be populated with the following keys: year, month, day, hour, minute, second.
- You can pass the output from [method get_datetime_from_unix_time] directly into this function. Daylight savings time (dst), if present, is ignored.
- </description>
- </method>
- <method name="get_virtual_keyboard_height">
- <return type="int">
- </return>
- <description>
- </description>
- </method>
- <method name="get_window_position" qualifiers="const">
- <return type="Vector2">
- </return>
- <description>
- Returns the window position relative to the screen, the origin is the top left corner, +Y axis goes to the bottom and +X axis goes to the right.
- </description>
- </method>
- <method name="get_window_size" qualifiers="const">
- <return type="Vector2">
- </return>
- <description>
- Returns the size of the window (without counting window manager decorations).
- </description>
- </method>
- <method name="has_environment" qualifiers="const">
- <return type="bool">
- </return>
- <argument index="0" name="environment" type="String">
- </argument>
- <description>
- Returns [code]true[/code] if an environment variable exists.
- </description>
- </method>
- <method name="has_feature" qualifiers="const">
- <return type="bool">
- </return>
- <argument index="0" name="tag_name" type="String">
- </argument>
- <description>
- </description>
- </method>
- <method name="has_touchscreen_ui_hint" qualifiers="const">
- <return type="bool">
- </return>
- <description>
- Returns [code]true[/code] if the device has a touchscreen or emulates one.
- </description>
- </method>
- <method name="has_virtual_keyboard" qualifiers="const">
- <return type="bool">
- </return>
- <description>
- Returns [code]true[/code] if the platform has a virtual keyboard, [code]false[/code] otherwise.
- </description>
- </method>
- <method name="hide_virtual_keyboard">
- <return type="void">
- </return>
- <description>
- Hides the virtual keyboard if it is shown, does nothing otherwise.
- </description>
- </method>
- <method name="is_debug_build" qualifiers="const">
- <return type="bool">
- </return>
- <description>
- Returns [code]true[/code] if the build is a debug build.
- Returns [code]true[/code] when running in the editor.
- Returns [code]false[/code] if the build is a release build.
- </description>
- </method>
- <method name="is_in_low_processor_usage_mode" qualifiers="const">
- <return type="bool">
- </return>
- <description>
- Returns [code]true[/code] if low cpu usage mode is enabled.
- </description>
- </method>
- <method name="is_keep_screen_on" qualifiers="const">
- <return type="bool">
- </return>
- <description>
- Returns [code]true[/code] if the screen is being kept on.
- </description>
- </method>
- <method name="is_ok_left_and_cancel_right" qualifiers="const">
- <return type="bool">
- </return>
- <description>
- Returns [code]true[/code] if the "Okay" button should appear on the left and "Cancel" on the right.
- </description>
- </method>
- <method name="is_scancode_unicode" qualifiers="const">
- <return type="bool">
- </return>
- <argument index="0" name="code" type="int">
- </argument>
- <description>
- Returns [code]true[/code] if the input code has a unicode character.
- </description>
- </method>
- <method name="is_stdout_verbose" qualifiers="const">
- <return type="bool">
- </return>
- <description>
- Returns [code]true[/code] if the engine was executed with -v (verbose stdout).
- </description>
- </method>
- <method name="is_userfs_persistent" qualifiers="const">
- <return type="bool">
- </return>
- <description>
- If [code]true[/code], the [code]user://[/code] file system is persistent, so that its state is the same after a player quits and starts the game again. Relevant to the HTML5 platform, where this persistence may be unavailable.
- </description>
- </method>
- <method name="is_vsync_enabled" qualifiers="const">
- <return type="bool">
- </return>
- <description>
- Returns [code]true[/code] if synchronizing the framerate to the monitor's refresh rate is enabled.
- </description>
- </method>
- <method name="is_window_fullscreen" qualifiers="const">
- <return type="bool">
- </return>
- <description>
- Returns [code]true[/code] if the window is in fullscreen mode.
- </description>
- </method>
- <method name="is_window_maximized" qualifiers="const">
- <return type="bool">
- </return>
- <description>
- Returns [code]true[/code] if the window is maximized.
- </description>
- </method>
- <method name="is_window_minimized" qualifiers="const">
- <return type="bool">
- </return>
- <description>
- Returns [code]true[/code] if the window is minimized.
- </description>
- </method>
- <method name="is_window_resizable" qualifiers="const">
- <return type="bool">
- </return>
- <description>
- Returns [code]true[/code] if the window is resizable.
- </description>
- </method>
- <method name="kill">
- <return type="int" enum="Error">
- </return>
- <argument index="0" name="pid" type="int">
- </argument>
- <description>
- Kill a process ID (this method can be used to kill processes that were not spawned by the game).
- </description>
- </method>
- <method name="native_video_is_playing">
- <return type="bool">
- </return>
- <description>
- Returns [code]true[/code] if native video is playing.
- </description>
- </method>
- <method name="native_video_pause">
- <return type="void">
- </return>
- <description>
- Pauses native video playback.
- </description>
- </method>
- <method name="native_video_play">
- <return type="int" enum="Error">
- </return>
- <argument index="0" name="path" type="String">
- </argument>
- <argument index="1" name="volume" type="float">
- </argument>
- <argument index="2" name="audio_track" type="String">
- </argument>
- <argument index="3" name="subtitle_track" type="String">
- </argument>
- <description>
- Plays native video from the specified path, at the given volume and with audio and subtitle tracks.
- </description>
- </method>
- <method name="native_video_stop">
- <return type="void">
- </return>
- <description>
- Stops native video playback.
- </description>
- </method>
- <method name="native_video_unpause">
- <return type="void">
- </return>
- <description>
- Resumes native video playback.
- </description>
- </method>
- <method name="print_all_resources">
- <return type="void">
- </return>
- <argument index="0" name="tofile" type="String" default="""">
- </argument>
- <description>
- Shows all resources in the game. Optionally the list can be written to a file.
- </description>
- </method>
- <method name="print_all_textures_by_size">
- <return type="void">
- </return>
- <description>
- Shows the list of loaded textures sorted by size in memory.
- </description>
- </method>
- <method name="print_resources_by_type">
- <return type="void">
- </return>
- <argument index="0" name="types" type="PoolStringArray">
- </argument>
- <description>
- Shows the number of resources loaded by the game of the given types.
- </description>
- </method>
- <method name="print_resources_in_use">
- <return type="void">
- </return>
- <argument index="0" name="short" type="bool" default="false">
- </argument>
- <description>
- Shows all resources currently used by the game.
- </description>
- </method>
- <method name="request_attention">
- <return type="void">
- </return>
- <description>
- Request the user attention to the window. It'll flash the taskbar button on Windows or bounce the dock icon on OSX.
- </description>
- </method>
- <method name="set_borderless_window">
- <return type="void">
- </return>
- <argument index="0" name="borderless" type="bool">
- </argument>
- <description>
- Removes the window frame.
- </description>
- </method>
- <method name="set_clipboard">
- <return type="void">
- </return>
- <argument index="0" name="clipboard" type="String">
- </argument>
- <description>
- Sets clipboard to the OS.
- </description>
- </method>
- <method name="set_current_screen">
- <return type="void">
- </return>
- <argument index="0" name="screen" type="int">
- </argument>
- <description>
- Sets the current screen by index.
- </description>
- </method>
- <method name="set_exit_code">
- <return type="void">
- </return>
- <argument index="0" name="code" type="int">
- </argument>
- <description>
- Sets the exit code that will be returned by the game.
- </description>
- </method>
- <method name="set_icon">
- <return type="void">
- </return>
- <argument index="0" name="icon" type="Image">
- </argument>
- <description>
- Sets the game's icon.
- </description>
- </method>
- <method name="set_ime_position">
- <return type="void">
- </return>
- <argument index="0" name="position" type="Vector2">
- </argument>
- <description>
- </description>
- </method>
- <method name="set_keep_screen_on">
- <return type="void">
- </return>
- <argument index="0" name="enabled" type="bool">
- </argument>
- <description>
- Sets keep screen on if true, or goes to sleep by device setting if false. (for Android/iOS)
- </description>
- </method>
- <method name="set_low_processor_usage_mode">
- <return type="void">
- </return>
- <argument index="0" name="enable" type="bool">
- </argument>
- <description>
- Set to [code]true[/code] to enable the low cpu usage mode. In this mode, the screen only redraws when there are changes, and a considerable sleep time is inserted between frames. Use this in tool mode to reduce CPU usage.
- </description>
- </method>
- <method name="set_screen_orientation">
- <return type="void">
- </return>
- <argument index="0" name="orientation" type="int" enum="OS.ScreenOrientation">
- </argument>
- <description>
- Sets the current screen orientation, the argument value must be one of the SCREEN_ORIENTATION constants in this class.
- </description>
- </method>
- <method name="set_thread_name">
- <return type="int" enum="Error">
- </return>
- <argument index="0" name="name" type="String">
- </argument>
- <description>
- Sets the name of the current thread.
- </description>
- </method>
- <method name="set_use_file_access_save_and_swap">
- <return type="void">
- </return>
- <argument index="0" name="enabled" type="bool">
- </argument>
- <description>
- Enables backup saves if [code]enabled[/code] is [code]true[/code].
- </description>
- </method>
- <method name="set_use_vsync">
- <return type="void">
- </return>
- <argument index="0" name="enable" type="bool">
- </argument>
- <description>
- If [code]true[/code] the framerate will synchronize to the monitor's refresh rate.
- </description>
- </method>
- <method name="set_window_fullscreen">
- <return type="void">
- </return>
- <argument index="0" name="enabled" type="bool">
- </argument>
- <description>
- Sets window fullscreen mode to the [i]enabled[/i] argument, [i]enabled[/i] is a toggle for the fullscreen mode, calling the function with [i]enabled[/i] true when the screen is not on fullscreen mode will cause the screen to go to fullscreen mode, calling the function with [i]enabled[/i] false when the screen is in fullscreen mode will cause the window to exit the fullscreen mode.
- </description>
- </method>
- <method name="set_window_maximized">
- <return type="void">
- </return>
- <argument index="0" name="enabled" type="bool">
- </argument>
- <description>
- Set [code]true[/code] to maximize the window.
- </description>
- </method>
- <method name="set_window_minimized">
- <return type="void">
- </return>
- <argument index="0" name="enabled" type="bool">
- </argument>
- <description>
- Set [code]true[/code] to minimize the window.
- </description>
- </method>
- <method name="set_window_position">
- <return type="void">
- </return>
- <argument index="0" name="position" type="Vector2">
- </argument>
- <description>
- Sets the position of the window to the specified position (this function could be restricted by the window manager, meaning that there could be some unreachable areas of the screen).
- </description>
- </method>
- <method name="set_window_resizable">
- <return type="void">
- </return>
- <argument index="0" name="enabled" type="bool">
- </argument>
- <description>
- Sets the window resizable state, if the window is not resizable it will preserve the dimensions specified in the project settings.
- </description>
- </method>
- <method name="set_window_size">
- <return type="void">
- </return>
- <argument index="0" name="size" type="Vector2">
- </argument>
- <description>
- Sets the window size to the specified size.
- </description>
- </method>
- <method name="set_window_title">
- <return type="void">
- </return>
- <argument index="0" name="title" type="String">
- </argument>
- <description>
- Sets the window title to the specified string.
- </description>
- </method>
- <method name="shell_open">
- <return type="int" enum="Error">
- </return>
- <argument index="0" name="uri" type="String">
- </argument>
- <description>
- Requests the OS to open a resource with the most appropriate program. For example.
- [code]OS.shell_open("C:\\Users\name\Downloads")[/code] on Windows opens the file explorer at the downloads folders of the user.
- [code]OS.shell_open("http://godotengine.org")[/code] opens the default web browser on the official Godot website.
- </description>
- </method>
- <method name="show_virtual_keyboard">
- <return type="void">
- </return>
- <argument index="0" name="existing_text" type="String" default="""">
- </argument>
- <description>
- Shows the virtual keyboard if the platform has one. The [i]existing_text[/i] parameter is useful for implementing your own LineEdit, as it tells the virtual keyboard what text has already been typed (the virtual keyboard uses it for auto-correct and predictions).
- </description>
- </method>
- </methods>
- <constants>
- <constant name="DAY_SUNDAY" value="0">
- </constant>
- <constant name="DAY_MONDAY" value="1">
- </constant>
- <constant name="DAY_TUESDAY" value="2">
- </constant>
- <constant name="DAY_WEDNESDAY" value="3">
- </constant>
- <constant name="DAY_THURSDAY" value="4">
- </constant>
- <constant name="DAY_FRIDAY" value="5">
- </constant>
- <constant name="DAY_SATURDAY" value="6">
- </constant>
- <constant name="MONTH_JANUARY" value="1">
- </constant>
- <constant name="MONTH_FEBRUARY" value="2">
- </constant>
- <constant name="MONTH_MARCH" value="3">
- </constant>
- <constant name="MONTH_APRIL" value="4">
- </constant>
- <constant name="MONTH_MAY" value="5">
- </constant>
- <constant name="MONTH_JUNE" value="6">
- </constant>
- <constant name="MONTH_JULY" value="7">
- </constant>
- <constant name="MONTH_AUGUST" value="8">
- </constant>
- <constant name="MONTH_SEPTEMBER" value="9">
- </constant>
- <constant name="MONTH_OCTOBER" value="10">
- </constant>
- <constant name="MONTH_NOVEMBER" value="11">
- </constant>
- <constant name="MONTH_DECEMBER" value="12">
- </constant>
- <constant name="SCREEN_ORIENTATION_LANDSCAPE" value="0">
- </constant>
- <constant name="SCREEN_ORIENTATION_PORTRAIT" value="1">
- </constant>
- <constant name="SCREEN_ORIENTATION_REVERSE_LANDSCAPE" value="2">
- </constant>
- <constant name="SCREEN_ORIENTATION_REVERSE_PORTRAIT" value="3">
- </constant>
- <constant name="SCREEN_ORIENTATION_SENSOR_LANDSCAPE" value="4">
- </constant>
- <constant name="SCREEN_ORIENTATION_SENSOR_PORTRAIT" value="5">
- </constant>
- <constant name="SCREEN_ORIENTATION_SENSOR" value="6">
- </constant>
- <constant name="SYSTEM_DIR_DESKTOP" value="0">
- </constant>
- <constant name="SYSTEM_DIR_DCIM" value="1">
- </constant>
- <constant name="SYSTEM_DIR_DOCUMENTS" value="2">
- </constant>
- <constant name="SYSTEM_DIR_DOWNLOADS" value="3">
- </constant>
- <constant name="SYSTEM_DIR_MOVIES" value="4">
- </constant>
- <constant name="SYSTEM_DIR_MUSIC" value="5">
- </constant>
- <constant name="SYSTEM_DIR_PICTURES" value="6">
- </constant>
- <constant name="SYSTEM_DIR_RINGTONES" value="7">
- </constant>
- <constant name="POWERSTATE_UNKNOWN" value="0">
- </constant>
- <constant name="POWERSTATE_ON_BATTERY" value="1">
- </constant>
- <constant name="POWERSTATE_NO_BATTERY" value="2">
- </constant>
- <constant name="POWERSTATE_CHARGING" value="3">
- </constant>
- <constant name="POWERSTATE_CHARGED" value="4">
- </constant>
- </constants>
- </class>
|