From f7fced5e00af96ddecd6fbe09f3913c14274bb99 Mon Sep 17 00:00:00 2001 From: Michael Alexsander Date: Sun, 28 May 2023 10:44:38 -0300 Subject: Improve `Window` documentation --- doc/classes/DisplayServer.xml | 126 ++++++++++++++++++++-------------------- doc/classes/OS.xml | 4 +- doc/classes/ProjectSettings.xml | 4 +- doc/classes/Window.xml | 24 +++++--- 4 files changed, 84 insertions(+), 74 deletions(-) (limited to 'doc/classes') diff --git a/doc/classes/DisplayServer.xml b/doc/classes/DisplayServer.xml index 47a7d2c67d..e114361f51 100644 --- a/doc/classes/DisplayServer.xml +++ b/doc/classes/DisplayServer.xml @@ -74,7 +74,7 @@ Shows a text input dialog which uses the operating system's native look-and-feel. [param callback] will be called with a [String] argument equal to the text field's contents when the dialog is closed for any reason. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -85,7 +85,7 @@ Shows a text dialog which uses the operating system's native look-and-feel. [param callback] will be called when the dialog is closed for any reason. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -93,7 +93,7 @@ Allows the [param process_id] PID to steal focus from this window. In other words, this disables the operating system's focus stealing protection for the specified PID. - [b]Note:[/b] This method is implemented on Windows. + [b]Note:[/b] This method is implemented only on Windows. @@ -198,7 +198,7 @@ Returns index of the inserted item, it's not guaranteed to be the same as [param index] value. An [param accelerator] can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The [param accelerator] is generally a combination of [enum KeyModifierMask]s and [enum Key]s using bitwise OR such as [code]KEY_MASK_CTRL | KEY_A[/code] ([kbd]Ctrl + A[/kbd]). [b]Note:[/b] The [param callback] and [param key_callback] Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to [param tag]. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. [b]Supported system menu IDs:[/b] [codeblock] "_main" - Main menu (macOS). @@ -221,7 +221,7 @@ Returns index of the inserted item, it's not guaranteed to be the same as [param index] value. An [param accelerator] can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The [param accelerator] is generally a combination of [enum KeyModifierMask]s and [enum Key]s using bitwise OR such as [code]KEY_MASK_CTRL | KEY_A[/code] ([kbd]Ctrl + A[/kbd]). [b]Note:[/b] The [param callback] and [param key_callback] Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to [param tag]. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. [b]Supported system menu IDs:[/b] [codeblock] "_main" - Main menu (macOS). @@ -244,7 +244,7 @@ Returns index of the inserted item, it's not guaranteed to be the same as [param index] value. An [param accelerator] can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The [param accelerator] is generally a combination of [enum KeyModifierMask]s and [enum Key]s using bitwise OR such as [code]KEY_MASK_CTRL | KEY_A[/code] ([kbd]Ctrl + A[/kbd]). [b]Note:[/b] The [param callback] and [param key_callback] Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to [param tag]. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. [b]Supported system menu IDs:[/b] [codeblock] "_main" - Main menu (macOS). @@ -268,7 +268,7 @@ An [param accelerator] can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The [param accelerator] is generally a combination of [enum KeyModifierMask]s and [enum Key]s using bitwise OR such as [code]KEY_MASK_CTRL | KEY_A[/code] ([kbd]Ctrl + A[/kbd]). [b]Note:[/b] Radio-checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See [method global_menu_set_item_checked] for more info on how to control it. [b]Note:[/b] The [param callback] and [param key_callback] Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to [param tag]. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. [b]Supported system menu IDs:[/b] [codeblock] "_main" - Main menu (macOS). @@ -290,7 +290,7 @@ Returns index of the inserted item, it's not guaranteed to be the same as [param index] value. An [param accelerator] can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The [param accelerator] is generally a combination of [enum KeyModifierMask]s and [enum Key]s using bitwise OR such as [code]KEY_MASK_CTRL | KEY_A[/code] ([kbd]Ctrl + A[/kbd]). [b]Note:[/b] The [param callback] and [param key_callback] Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to [param tag]. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. [b]Supported system menu IDs:[/b] [codeblock] "_main" - Main menu (macOS). @@ -316,7 +316,7 @@ An [param accelerator] can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The [param accelerator] is generally a combination of [enum KeyModifierMask]s and [enum Key]s using bitwise OR such as [code]KEY_MASK_CTRL | KEY_A[/code] ([kbd]Ctrl + A[/kbd]). [b]Note:[/b] By default, there's no indication of the current item state, it should be changed manually. [b]Note:[/b] The [param callback] and [param key_callback] Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to [param tag]. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. [b]Supported system menu IDs:[/b] [codeblock] "_main" - Main menu (macOS). @@ -339,7 +339,7 @@ An [param accelerator] can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The [param accelerator] is generally a combination of [enum KeyModifierMask]s and [enum Key]s using bitwise OR such as [code]KEY_MASK_CTRL | KEY_A[/code] ([kbd]Ctrl + A[/kbd]). [b]Note:[/b] Radio-checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See [method global_menu_set_item_checked] for more info on how to control it. [b]Note:[/b] The [param callback] and [param key_callback] Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to [param tag]. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. [b]Supported system menu IDs:[/b] [codeblock] "_main" - Main menu (macOS). @@ -354,7 +354,7 @@ Adds a separator between items to the global menu with ID [param menu_root]. Separators also occupy an index. Returns index of the inserted item, it's not guaranteed to be the same as [param index] value. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. [b]Supported system menu IDs:[/b] [codeblock] "_main" - Main menu (macOS). @@ -371,7 +371,7 @@ Adds an item that will act as a submenu of the global menu [param menu_root]. The [param submenu] argument is the ID of the global menu root that will be shown when the item is clicked. Returns index of the inserted item, it's not guaranteed to be the same as [param index] value. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. [b]Supported system menu IDs:[/b] [codeblock] "_main" - Main menu (macOS). @@ -384,7 +384,7 @@ Removes all items from the global menu with ID [param menu_root]. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. [b]Supported system menu IDs:[/b] [codeblock] "_main" - Main menu (macOS). @@ -398,7 +398,7 @@ Returns the accelerator of the item at index [param idx]. Accelerators are special combinations of keys that activate the item, no matter which control is focused. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -407,7 +407,7 @@ Returns the callback of the item at index [param idx]. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -415,7 +415,7 @@ Returns number of items in the global menu with ID [param menu_root]. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -424,7 +424,7 @@ Returns the icon of the item at index [param idx]. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -433,7 +433,7 @@ Returns the horizontal offset of the item at the given [param idx]. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -442,7 +442,7 @@ Returns the index of the item with the specified [param tag]. Index is automatically assigned to each item by the engine. Index can not be set manually. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -451,7 +451,7 @@ Returns the index of the item with the specified [param text]. Index is automatically assigned to each item by the engine. Index can not be set manually. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -460,7 +460,7 @@ Returns the callback of the item accelerator at index [param idx]. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -469,7 +469,7 @@ Returns number of states of a multistate item. See [method global_menu_add_multistate_item] for details. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -478,7 +478,7 @@ Returns the state of a multistate item. See [method global_menu_add_multistate_item] for details. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -487,7 +487,7 @@ Returns the submenu ID of the item at index [param idx]. See [method global_menu_add_submenu_item] for more info on how to add a submenu. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -496,7 +496,7 @@ Returns the metadata of the specified item, which might be of any type. You can set it with [method global_menu_set_item_tag], which provides a simple way of assigning context data to items. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -505,7 +505,7 @@ Returns the text of the item at index [param idx]. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -514,7 +514,7 @@ Returns the tooltip associated with the specified index [param idx]. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -523,7 +523,7 @@ Returns [code]true[/code] if the item at index [param idx] is checkable in some way, i.e. if it has a checkbox or radio button. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -532,7 +532,7 @@ Returns [code]true[/code] if the item at index [param idx] is checked. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -542,7 +542,7 @@ Returns [code]true[/code] if the item at index [param idx] is disabled. When it is disabled it can't be selected, or its action invoked. See [method global_menu_set_item_disabled] for more info on how to disable an item. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -552,7 +552,7 @@ Returns [code]true[/code] if the item at index [param idx] has radio button-style checkability. [b]Note:[/b] This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -562,7 +562,7 @@ Removes the item at index [param idx] from the global menu [param menu_root]. [b]Note:[/b] The indices of items after the removed item will be shifted by one. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -572,7 +572,7 @@ Sets the accelerator of the item at index [param idx]. [param keycode] can be a single [enum Key], or a combination of [enum KeyModifierMask]s and [enum Key]s using bitwise OR such as [code]KEY_MASK_CTRL | KEY_A[/code] ([kbd]Ctrl + A[/kbd]). - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -583,7 +583,7 @@ Sets the callback of the item at index [param idx]. Callback is emitted when an item is pressed. [b]Note:[/b] The [param callback] Callable needs to accept exactly one Variant parameter, the parameter passed to the Callable will be the value passed to the [code]tag[/code] parameter when the menu item was created. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -593,7 +593,7 @@ Sets whether the item at index [param idx] has a checkbox. If [code]false[/code], sets the type of the item to plain text. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -603,7 +603,7 @@ Sets the checkstate status of the item at index [param idx]. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -613,7 +613,7 @@ Enables/disables the item at index [param idx]. When it is disabled, it can't be selected and its action can't be invoked. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -623,7 +623,7 @@ Replaces the [Texture2D] icon of the specified [param idx]. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. [b]Note:[/b] This method is not supported by macOS "_dock" menu items. @@ -634,7 +634,7 @@ Sets the horizontal offset of the item at the given [param idx]. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -645,7 +645,7 @@ Sets the callback of the item at index [param idx]. Callback is emitted when its accelerator is activated. [b]Note:[/b] The [param key_callback] Callable needs to accept exactly one Variant parameter, the parameter passed to the Callable will be the value passed to the [code]tag[/code] parameter when the menu item was created. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -655,7 +655,7 @@ Sets number of state of a multistate item. See [method global_menu_add_multistate_item] for details. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -666,7 +666,7 @@ Sets the type of the item at the specified index [param idx] to radio button. If [code]false[/code], sets the type of the item to plain text. [b]Note:[/b] This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -676,7 +676,7 @@ Sets the state of a multistate item. See [method global_menu_add_multistate_item] for details. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -686,7 +686,7 @@ Sets the submenu of the item at index [param idx]. The submenu is the ID of a global menu root that would be shown when the item is clicked. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -696,7 +696,7 @@ Sets the metadata of an item, which may be of any type. You can later get it with [method global_menu_get_item_tag], which provides a simple way of assigning context data to items. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -706,7 +706,7 @@ Sets the text of the item at index [param idx]. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -716,7 +716,7 @@ Sets the [String] tooltip of the item at the specified index [param idx]. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -730,14 +730,14 @@ Returns the text selection in the [url=https://en.wikipedia.org/wiki/Input_method]Input Method Editor[/url] composition string, with the [Vector2i]'s [code]x[/code] component being the caret position and [code]y[/code] being the length of the selection. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. Returns the composition string contained within the [url=https://en.wikipedia.org/wiki/Input_method]Input Method Editor[/url] window. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -869,7 +869,7 @@ Returns the greatest scale factor of all screens. [b]Note:[/b] On macOS returned value is [code]2.0[/code] if there is at least one hiDPI (Retina) screen in the system, and [code]1.0[/code] in all other cases. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -925,7 +925,7 @@ Returns the scale factor of the specified screen by index. [b]Note:[/b] On macOS returned value is [code]2.0[/code] for hiDPI (Retina) screen, and [code]1.0[/code] for all other cases. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -981,14 +981,14 @@ Returns current active tablet driver name. - [b]Note:[/b] This method is implemented on Windows. + [b]Note:[/b] This method is implemented only on Windows. Returns the total number of available tablet drivers. - [b]Note:[/b] This method is implemented on Windows. + [b]Note:[/b] This method is implemented only on Windows. @@ -996,7 +996,7 @@ Returns the tablet driver name for the given index. - [b]Note:[/b] This method is implemented on Windows. + [b]Note:[/b] This method is implemented only on Windows. @@ -1004,7 +1004,7 @@ Set active tablet driver name. - [b]Note:[/b] This method is implemented on Windows. + [b]Note:[/b] This method is implemented only on Windows. @@ -1160,7 +1160,7 @@ - Returns the [method Object.get_instance_id] of the [Window] the [param window_id] is attached to. also [method window_get_attached_instance_id]. + Returns the [method Object.get_instance_id] of the [Window] the [param window_id] is attached to. @@ -1268,14 +1268,14 @@ Returns [code]true[/code], if double-click on a window title should maximize it. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. Returns [code]true[/code], if double-click on a window title should minimize it. - [b]Note:[/b] This method is implemented on macOS. + [b]Note:[/b] This method is implemented only on macOS. @@ -1503,7 +1503,7 @@ When [constant WINDOW_FLAG_EXTEND_TO_TITLE] flag is set, set offset to the center of the first titlebar button. - [b]Note:[/b] This flag is implemented on macOS. + [b]Note:[/b] This flag is implemented only on macOS. @@ -1759,7 +1759,7 @@ Window content is expanded to the full size of the window. Unlike borderless window, the frame is left intact and can be used to resize the window, title bar is transparent, but have minimize/maximize/close buttons. Use [method window_set_window_buttons_offset] to adjust minimize/maximize/close buttons offset. Use [method window_get_safe_title_margins] to determine area under the title bar that is not covered by decorations. - [b]Note:[/b] This flag is implemented on macOS. + [b]Note:[/b] This flag is implemented only on macOS. All mouse events are passed to the underlying window of the same application. @@ -1784,15 +1784,15 @@ Sent when the device "Back" button is pressed, see [method window_set_window_event_callback]. - [b]Note:[/b] This event is implemented on Android. + [b]Note:[/b] This event is implemented only on Android. Sent when the window is moved to the display with different DPI, or display DPI is changed, see [method window_set_window_event_callback]. - [b]Note:[/b] This flag is implemented on macOS. + [b]Note:[/b] This flag is implemented only on macOS. Sent when the window title bar decoration is changed (e.g. [constant WINDOW_FLAG_EXTEND_TO_TITLE] is set or window entered/exited full screen mode), see [method window_set_window_event_callback]. - [b]Note:[/b] This flag is implemented on macOS. + [b]Note:[/b] This flag is implemented only on macOS. No vertical synchronization, which means the engine will display frames as fast as possible (tearing may be visible). Framerate is unlimited (nonwithstanding [member Engine.max_fps]). diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index e64b409551..0fc25e3c80 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -241,7 +241,7 @@ With this function, you can get the list of dangerous permissions that have been granted to the Android application. - [b]Note:[/b] This method is implemented on Android. + [b]Note:[/b] This method is implemented only on Android. @@ -599,7 +599,7 @@ With this function, you can request dangerous permissions since normal permissions are automatically granted at install time in Android applications. - [b]Note:[/b] This method is implemented on Android. + [b]Note:[/b] This method is implemented only on Android. diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index add2faa962..e8c2f57988 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -747,7 +747,7 @@ [b]Note:[/b] This setting is implemented only on macOS. - Main window initial position (in virtual desktop coordinates), this settings is used only if [member display/window/size/initial_position_type] is set to "Absolute" ([code]0[/code]). + Main window initial position (in virtual desktop coordinates), this setting is used only if [member display/window/size/initial_position_type] is set to "Absolute" ([code]0[/code]). Main window initial position. @@ -756,7 +756,7 @@ [code]2[/code] - "Other Screen Center", [member display/window/size/initial_screen] is used to set the screen. - Main window initial screen, this settings is used only if [member display/window/size/initial_position_type] is set to "Other Screen Center" ([code]2[/code]). + Main window initial screen, this setting is used only if [member display/window/size/initial_position_type] is set to "Other Screen Center" ([code]2[/code]). Main window mode. See [enum DisplayServer.WindowMode] for possible values and how each mode behaves. diff --git a/doc/classes/Window.xml b/doc/classes/Window.xml index 3adc0d367d..f9fcc4b4e7 100644 --- a/doc/classes/Window.xml +++ b/doc/classes/Window.xml @@ -570,8 +570,11 @@ If [code]true[/code], the [Window] contents is expanded to the full size of the window, window title bar is transparent. + [b]Note:[/b] This property is implemented only on macOS. + [b]Note:[/b] This property only works with native windows. + Specifies the initial type of position for the [Window]. See [enum WindowInitialPosition] constants. If non-zero, the [Window] can't be resized to be bigger than this size. @@ -584,10 +587,12 @@ Set's the window's current mode. [b]Note:[/b] Fullscreen mode is not exclusive full screen on Windows and Linux. + [b]Note:[/b] This method only works with native windows, i.e. the main window and [Window]-derived nodes when [member Viewport.gui_embed_subwindows] is disabled in the main viewport. If [code]true[/code], all mouse events will be passed to the underlying window of the same application. See also [member mouse_passthrough_polygon]. [b]Note:[/b] This property is implemented on Linux (X11), macOS and Windows. + [b]Note:[/b] This property only works with native windows. Sets a polygonal region of the window which accepts mouse events. Mouse events outside the region will be passed through. @@ -620,10 +625,12 @@ If [code]true[/code], the [Window] will be considered a popup. Popups are sub-windows that don't show as separate windows in system's window manager's window list and will send close request when anything is clicked outside of them (unless [member exclusive] is enabled). + [b]Note:[/b] This property only works with native windows. The window's position in pixels. - If [member ProjectSettings.display/window/subwindows/embed_subwindows] is [code]false[/code], the position is in absolute screen coordinates. This typically applies to editor plugins. If the setting is [code]false[/code], the window's position is in the coordinates of its parent [Viewport]. + If [member ProjectSettings.display/window/subwindows/embed_subwindows] is [code]false[/code], the position is in absolute screen coordinates. This typically applies to editor plugins. If the setting is [code]true[/code], the window's position is in the coordinates of its parent [Viewport]. + [b]Note:[/b] This property only works if [member initial_position] is set to [constant WINDOW_INITIAL_POSITION_ABSOLUTE]. The window's size in pixels. @@ -636,7 +643,7 @@ The name of a theme type variation used by this [Window] to look up its own theme items. See [member Control.theme_type_variation] for more details. - The window's title. If the [Window] is non-embedded, title styles set in [Theme] will have no effect. + The window's title. If the [Window] is native, title styles set in [Theme] will have no effect. If [code]true[/code], the [Window] is transient, i.e. it's considered a child of another [Window]. The transient window will be destroyed with its transient parent and will return focus to their parent when closed. The transient window is displayed on top of a non-exclusive full-screen parent window. Transient windows can't enter full-screen mode. @@ -644,8 +651,8 @@ If [code]true[/code], the [Window]'s background can be transparent. This is best used with embedded windows. - [b]Note:[/b] For native windows, this flag has no effect if [member ProjectSettings.display/window/per_pixel_transparency/allowed] is set to [code]false[/code]. [b]Note:[/b] Transparency support is implemented on Linux, macOS and Windows, but availability might vary depending on GPU driver, display manager, and compositor capabilities. + [b]Note:[/b] This property has no effect if either [member ProjectSettings.display/window/per_pixel_transparency/allowed], or the window's [member Viewport.transparent_bg] is set to [code]false[/code]. If [code]true[/code], the [Window] can't be focused nor interacted with. It can still be visible. @@ -683,7 +690,7 @@ Emitted when files are dragged from the OS file manager and dropped in the game window. The argument is a list of file paths. - Note that this method only works with non-embedded windows, i.e. the main window and [Window]-derived nodes when [member Viewport.gui_embed_subwindows] is disabled in the main viewport. + Note that this method only works with native windows, i.e. the main window and [Window]-derived nodes when [member Viewport.gui_embed_subwindows] is disabled in the main viewport. Example usage: [codeblock] func _ready(): @@ -780,21 +787,24 @@ The window is floating on top of all other windows. This flag is ignored for full-screen windows. Set with [member always_on_top]. - The window background can be transparent. - [b]Note:[/b] This flag has no effect if [member ProjectSettings.display/window/per_pixel_transparency/allowed] is set to [code]false[/code]. Set with [member transparent]. + The window background can be transparent. Set with [member transparent]. + [b]Note:[/b] This flag has no effect if either [member ProjectSettings.display/window/per_pixel_transparency/allowed], or the window's [member Viewport.transparent_bg] is set to [code]false[/code]. The window can't be focused. No-focus window will ignore all input, except mouse clicks. Set with [member unfocusable]. Window is part of menu or [OptionButton] dropdown. This flag can't be changed when the window is visible. An active popup window will exclusively receive all input, without stealing focus from its parent. Popup windows are automatically closed when uses click outside it, or when an application is switched. Popup window must have transient parent set (see [member transient]). + [b]Note:[/b] This flag has no effect in embedded windows (unless said window is a [Popup]). Window content is expanded to the full size of the window. Unlike borderless window, the frame is left intact and can be used to resize the window, title bar is transparent, but have minimize/maximize/close buttons. Set with [member extend_to_title]. - [b]Note:[/b] This flag is implemented on macOS. + [b]Note:[/b] This flag is implemented only on macOS. + [b]Note:[/b] This flag has no effect in embedded windows. All mouse events are passed to the underlying window of the same application. + [b]Note:[/b] This flag has no effect in embedded windows. Max value of the [enum Flags]. -- cgit v1.2.3