From 3c0fdcc8acfadb124fbfa914532868948561c351 Mon Sep 17 00:00:00 2001 From: Aaron Franke Date: Fri, 13 Aug 2021 16:31:57 -0500 Subject: Use "enum class" for input enums --- doc/classes/@GlobalScope.xml | 14 +++++++------- doc/classes/BaseButton.xml | 2 +- doc/classes/Input.xml | 2 +- doc/classes/InputEventKey.xml | 4 ++-- doc/classes/InputEventMouse.xml | 2 +- doc/classes/OS.xml | 4 ++-- doc/classes/PopupMenu.xml | 18 +++++++++--------- 7 files changed, 23 insertions(+), 23 deletions(-) (limited to 'doc/classes') diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index 345a769ca5..21b5147386 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -1251,7 +1251,7 @@ Aligns bottom of the inline object (e.g. image, table) to the bottom of the text. Equvalent to [code]INLINE_ALIGN_BOTTOM_TO | INLINE_ALIGN_TO_BOTTOM[/code]. - + Keycodes with this bit applied are non-printable. @@ -2016,12 +2016,6 @@ Middle mouse button. - - Extra mouse button 1 (only present on some mice). - - - Extra mouse button 2 (only present on some mice). - Mouse wheel up. @@ -2034,6 +2028,12 @@ Mouse wheel right button (only present on some mice). + + Extra mouse button 1 (only present on some mice). + + + Extra mouse button 2 (only present on some mice). + Left mouse button mask. diff --git a/doc/classes/BaseButton.xml b/doc/classes/BaseButton.xml index 889c703b07..981b3167d9 100644 --- a/doc/classes/BaseButton.xml +++ b/doc/classes/BaseButton.xml @@ -50,7 +50,7 @@ The [ButtonGroup] associated with the button. Not to be confused with node groups. - + Binary mask to choose which mouse buttons this button will respond to. To allow both left-click and right-click, use [code]MOUSE_BUTTON_MASK_LEFT | MOUSE_BUTTON_MASK_RIGHT[/code]. diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index 1fded42db2..684207e9bd 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -155,7 +155,7 @@ - + Returns mouse buttons as a bitmask. If multiple mouse buttons are pressed at the same time, the bits are added together. diff --git a/doc/classes/InputEventKey.xml b/doc/classes/InputEventKey.xml index 9cf6872655..0353c5f0e0 100644 --- a/doc/classes/InputEventKey.xml +++ b/doc/classes/InputEventKey.xml @@ -11,14 +11,14 @@ - + Returns the keycode combined with modifier keys such as [kbd]Shift[/kbd] or [kbd]Alt[/kbd]. See also [InputEventWithModifiers]. To get a human-readable representation of the [InputEventKey] with modifiers, use [code]OS.get_keycode_string(event.get_keycode_with_modifiers())[/code] where [code]event[/code] is the [InputEventKey]. - + Returns the physical keycode combined with modifier keys such as [kbd]Shift[/kbd] or [kbd]Alt[/kbd]. See also [InputEventWithModifiers]. To get a human-readable representation of the [InputEventKey] with modifiers, use [code]OS.get_keycode_string(event.get_physical_keycode_with_modifiers())[/code] where [code]event[/code] is the [InputEventKey]. diff --git a/doc/classes/InputEventMouse.xml b/doc/classes/InputEventMouse.xml index b06068aff3..a248f1abd9 100644 --- a/doc/classes/InputEventMouse.xml +++ b/doc/classes/InputEventMouse.xml @@ -10,7 +10,7 @@ https://docs.godotengine.org/en/latest/tutorials/inputs/inputevent.html - + The mouse button mask identifier, one of or a bitwise combination of the [enum MouseButton] button masks. diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index f4d48f5db2..dcd41e46f0 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -133,7 +133,7 @@ - + Returns the keycode of the given string (e.g. "Escape"). @@ -222,7 +222,7 @@ - + Returns the given keycode as a string (e.g. Return values: [code]"Escape"[/code], [code]"Shift+Escape"[/code]). See also [member InputEventKey.keycode] and [method InputEventKey.get_keycode_with_modifiers]. diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index 044325afbe..4eb3ef34b4 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -15,7 +15,7 @@ - + Adds a new checkable item with text [code]label[/code]. An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators. @@ -38,7 +38,7 @@ - + Adds a new checkable item with text [code]label[/code] and icon [code]texture[/code]. An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators. @@ -62,7 +62,7 @@ - + Adds a new item with text [code]label[/code] and icon [code]texture[/code]. An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators. @@ -73,7 +73,7 @@ - + Same as [method add_icon_check_item], but uses a radio check button. @@ -103,7 +103,7 @@ - + Adds a new item with text [code]label[/code]. An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators. @@ -115,7 +115,7 @@ - + Adds a new multistate item with text [code]label[/code]. Contrarily to normal binary items, multistate items can have more than two states, as defined by [code]max_states[/code]. Each press or activate of the item will increase the state by one. The default value is defined by [code]default_state[/code]. @@ -126,7 +126,7 @@ - + Adds a new radio check button with text [code]label[/code]. An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators. @@ -193,7 +193,7 @@ - + Returns the accelerator of the item at index [code]idx[/code]. Accelerators are special combinations of keys that activate the item, no matter which control is focused. @@ -333,7 +333,7 @@ - + Sets the accelerator of the item at index [code]idx[/code]. Accelerators are special combinations of keys that activate the item, no matter which control is focused. -- cgit v1.2.3