From 3e0226515eec5f904701fce36c7856617d3ca6b8 Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Wed, 9 Sep 2020 21:53:24 +0200 Subject: Rename ShortCut to Shortcut which is more grammatically correct See https://github.com/godotengine/godot/issues/16863#issuecomment-685236980. --- doc/classes/BaseButton.xml | 4 ++-- doc/classes/PopupMenu.xml | 32 ++++++++++++++++---------------- doc/classes/ShortCut.xml | 45 --------------------------------------------- doc/classes/Shortcut.xml | 45 +++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 63 insertions(+), 63 deletions(-) delete mode 100644 doc/classes/ShortCut.xml create mode 100644 doc/classes/Shortcut.xml (limited to 'doc/classes') diff --git a/doc/classes/BaseButton.xml b/doc/classes/BaseButton.xml index 3812b45b13..bf4d9383ac 100644 --- a/doc/classes/BaseButton.xml +++ b/doc/classes/BaseButton.xml @@ -65,8 +65,8 @@ If [code]true[/code], the button's state is pressed. Means the button is pressed down or toggled (if [member toggle_mode] is active). - - [ShortCut] associated to the button. + + [Shortcut] associated to the button. If [code]true[/code], the button will add information about its shortcut in the tooltip. diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index 2af0f500a0..b1ec9a222a 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -29,14 +29,14 @@ - + - Adds a new checkable item and assigns the specified [ShortCut] to it. Sets the label of the checkbox to the [ShortCut]'s name. + Adds a new checkable item and assigns the specified [Shortcut] to it. Sets the label of the checkbox to the [Shortcut]'s name. An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index. [b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See [method set_item_checked] for more info on how to control it. @@ -63,14 +63,14 @@ - + - Adds a new checkable item and assigns the specified [ShortCut] and icon [code]texture[/code] to it. Sets the label of the checkbox to the [ShortCut]'s name. + Adds a new checkable item and assigns the specified [Shortcut] and icon [code]texture[/code] to it. Sets the label of the checkbox to the [Shortcut]'s name. An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index. [b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See [method set_item_checked] for more info on how to control it. @@ -111,7 +111,7 @@ - + @@ -126,14 +126,14 @@ - + - Adds a new item and assigns the specified [ShortCut] and icon [code]texture[/code] to it. Sets the label of the checkbox to the [ShortCut]'s name. + Adds a new item and assigns the specified [Shortcut] and icon [code]texture[/code] to it. Sets the label of the checkbox to the [Shortcut]'s name. An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index. @@ -188,14 +188,14 @@ - + - Adds a new radio check button and assigns a [ShortCut] to it. Sets the label of the checkbox to the [ShortCut]'s name. + Adds a new radio check button and assigns a [Shortcut] to it. Sets the label of the checkbox to the [Shortcut]'s name. An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index. [b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See [method set_item_checked] for more info on how to control it. @@ -212,14 +212,14 @@ - + - Adds a [ShortCut]. + Adds a [Shortcut]. An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index. @@ -303,12 +303,12 @@ - + - Returns the [ShortCut] associated with the specified [code]idx[/code] item. + Returns the [Shortcut] associated with the specified [code]idx[/code] item. @@ -521,12 +521,12 @@ - + - Sets a [ShortCut] for the specified item [code]idx[/code]. + Sets a [Shortcut] for the specified item [code]idx[/code]. @@ -537,7 +537,7 @@ - Disables the [ShortCut] of the specified index [code]idx[/code]. + Disables the [Shortcut] of the specified index [code]idx[/code]. diff --git a/doc/classes/ShortCut.xml b/doc/classes/ShortCut.xml deleted file mode 100644 index 9a2a761969..0000000000 --- a/doc/classes/ShortCut.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - A shortcut for binding input. - - - A shortcut for binding input. - Shortcuts are commonly used for interacting with a [Control] element from a [InputEvent]. - - - - - - - - - Returns the shortcut's [InputEvent] as a [String]. - - - - - - - - - Returns [code]true[/code] if the shortcut's [InputEvent] equals [code]event[/code]. - - - - - - - If [code]true[/code], this shortcut is valid. - - - - - - The shortcut's [InputEvent]. - Generally the [InputEvent] is a keyboard key, though it can be any [InputEvent]. - - - - - diff --git a/doc/classes/Shortcut.xml b/doc/classes/Shortcut.xml new file mode 100644 index 0000000000..55bbb083c9 --- /dev/null +++ b/doc/classes/Shortcut.xml @@ -0,0 +1,45 @@ + + + + A shortcut for binding input. + + + A shortcut for binding input. + Shortcuts are commonly used for interacting with a [Control] element from a [InputEvent]. + + + + + + + + + Returns the shortcut's [InputEvent] as a [String]. + + + + + + + + + Returns [code]true[/code] if the shortcut's [InputEvent] equals [code]event[/code]. + + + + + + + If [code]true[/code], this shortcut is valid. + + + + + + The shortcut's [InputEvent]. + Generally the [InputEvent] is a keyboard key, though it can be any [InputEvent]. + + + + + -- cgit v1.2.3