mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-12-21 10:25:24 +08:00
Code Issues Packages Projects Releases Wiki Activity
e8520044e7
godot/doc/classes/BaseButton.xml

129 lines
6.8 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 21:18:53 +08:00
<class name="BaseButton" inherits="Control" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<brief_description>
[DOCS] BaseButton
2017-10-23 06:17:02 +08:00
Base class for different kinds of buttons.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</brief_description>
<description>
[DOCS] BaseButton
2017-10-23 06:17:02 +08:00
BaseButton is the abstract base class for buttons, so it shouldn't be used directly (it doesn't display anything). Other types of buttons inherit from it.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
<tutorials>
</tutorials>
<methods>
<method name="_pressed" qualifiers="virtual">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Mention `toggled` signal for pressed state in BaseButton documentation This closes #40455.
2020-07-17 06:01:24 +08:00
Called when the button is pressed. If you need to know the button's pressed state (and [member toggle_mode] is active), use [method _toggled] instead.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="_toggled" qualifiers="virtual">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
<argument index="0" name="button_pressed" type="bool" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
doc: Markup fixes for enums and constants
2019-12-07 06:09:20 +08:00
Called when the button is toggled (only if [member toggle_mode] is active).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="get_draw_mode" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="int" enum="BaseButton.DrawMode" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
doc: Markup fixes for enums and constants
2019-12-07 06:09:20 +08:00
Returns the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the [enum DrawMode] enum.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="is_hovered" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="bool" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Change "Return" to "Returns" where necessary in XML documentation In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867
2019-05-24 10:15:43 +08:00
Returns [code]true[/code] if the mouse has entered the button and has not left it yet.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
Add set_pressed_no_signal method to BaseButton
2021-05-06 20:33:44 +08:00
<method name="set_pressed_no_signal">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
<argument index="0" name="pressed" type="bool" />
Add set_pressed_no_signal method to BaseButton
2021-05-06 20:33:44 +08:00
<description>
BaseButton: Rename `pressed` property to `button_pressed` This fixes a conflict with the `pressed` signal. The new name is temporary and only intended to solve the conflict for upcoming alpha builds. Discussions are still ongoing regarding the BaseButton API and how to rename and refactor more of its properties, signals and methods to have a clearer API in 4.0.
2022-01-24 04:33:58 +08:00
Changes the [member button_pressed] state of the button, without emitting [signal toggled]. Use when you just want to change the state of the button without sending the pressed event (e.g. when initializing scene). Only works if [member toggle_mode] is [code]true[/code].
Add set_pressed_no_signal method to BaseButton
2021-05-06 20:33:44 +08:00
[b]Note:[/b] This method doesn't unpress other buttons in [member button_group].
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</methods>
<members>
Create GDExtension clases for PhysicsServer3D * Allows creating a GDExtension based 3D Physics Server (for Bullet, PhysX, etc. support) * Some changes on native struct binding for PhysicsServer This allows a 3D Physics server created entirely from GDExtension. Once it works, the idea is to port the 2D one to it.
2022-03-14 22:52:03 +08:00
<member name="action_mode" type="int" setter="set_action_mode" getter="get_action_mode" enum="BaseButton.ActionMode">
doc: Markup fixes for enums and constants
2019-12-07 06:09:20 +08:00
Determines when the button is considered clicked, one of the [enum ActionMode] constants.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
Rename button group property to button_group
2020-10-24 13:19:18 +08:00
<member name="button_group" type="ButtonGroup" setter="set_button_group" getter="get_button_group">
The [ButtonGroup] associated with the button. Not to be confused with node groups.
</member>
Create GDExtension clases for PhysicsServer3D * Allows creating a GDExtension based 3D Physics Server (for Bullet, PhysX, etc. support) * Some changes on native struct binding for PhysicsServer This allows a 3D Physics server created entirely from GDExtension. Once it works, the idea is to port the 2D one to it.
2022-03-14 22:52:03 +08:00
<member name="button_mask" type="int" setter="set_button_mask" getter="get_button_mask" enum="MouseButton">
Add a binary mask to allow configuration of which mouse buttons the BaseButton will respond to.
2018-03-12 01:19:18 +08:00
Binary mask to choose which mouse buttons this button will respond to.
Rename ButtonList enum and members to MouseButton
2021-01-08 11:37:37 +08:00
To allow both left-click and right-click, use [code]MOUSE_BUTTON_MASK_LEFT | MOUSE_BUTTON_MASK_RIGHT[/code].
Add a binary mask to allow configuration of which mouse buttons the BaseButton will respond to.
2018-03-12 01:19:18 +08:00
</member>
Create GDExtension clases for PhysicsServer3D * Allows creating a GDExtension based 3D Physics Server (for Bullet, PhysX, etc. support) * Some changes on native struct binding for PhysicsServer This allows a 3D Physics server created entirely from GDExtension. Once it works, the idea is to port the 2D one to it.
2022-03-14 22:52:03 +08:00
<member name="button_pressed" type="bool" setter="set_pressed" getter="is_pressed">
BaseButton: Rename `pressed` property to `button_pressed` This fixes a conflict with the `pressed` signal. The new name is temporary and only intended to solve the conflict for upcoming alpha builds. Discussions are still ongoing regarding the BaseButton API and how to rename and refactor more of its properties, signals and methods to have a clearer API in 4.0.
2022-01-24 04:33:58 +08:00
If [code]true[/code], the button's state is pressed. Means the button is pressed down or toggled (if [member toggle_mode] is active). Only works if [member toggle_mode] is [code]true[/code].
[b]Note:[/b] Setting [member button_pressed] will result in [signal toggled] to be emitted. If you want to change the pressed state without emitting that signal, use [method set_pressed_no_signal].
</member>
Create GDExtension clases for PhysicsServer3D * Allows creating a GDExtension based 3D Physics Server (for Bullet, PhysX, etc. support) * Some changes on native struct binding for PhysicsServer This allows a 3D Physics server created entirely from GDExtension. Once it works, the idea is to port the 2D one to it.
2022-03-14 22:52:03 +08:00
<member name="disabled" type="bool" setter="set_disabled" getter="is_disabled">
doc: Add missing commas after "If true/false"
2018-12-20 20:46:54 +08:00
If [code]true[/code], the button is in disabled state and can't be clicked or toggled.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
Create GDExtension clases for PhysicsServer3D * Allows creating a GDExtension based 3D Physics Server (for Bullet, PhysX, etc. support) * Some changes on native struct binding for PhysicsServer This allows a 3D Physics server created entirely from GDExtension. Once it works, the idea is to port the 2D one to it.
2022-03-14 22:52:03 +08:00
<member name="keep_pressed_outside" type="bool" setter="set_keep_pressed_outside" getter="is_keep_pressed_outside">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 21:24:23 +08:00
If [code]true[/code], the button stays pressed when moving the cursor outside the button while pressing it.
Mention `keep_pressed_outside` caveat in the BaseButton documentation This closes #37790.
2020-04-14 03:56:47 +08:00
[b]Note:[/b] This property only affects the button's visual appearance. Signals will be emitted at the same moment regardless of this property's value.
doc: Sync classref with current source
2019-05-15 18:51:58 +08:00
</member>
Rename ShortCut to Shortcut which is more grammatically correct See https://github.com/godotengine/godot/issues/16863#issuecomment-685236980.
2020-09-10 03:53:24 +08:00
<member name="shortcut" type="Shortcut" setter="set_shortcut" getter="get_shortcut">
[Shortcut] associated to the button.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
Exposed shortcut_context property to scripting and added documentation. I didn't expose this as a property or add documentation in the original PR #42109.
2020-11-29 22:11:40 +08:00
<member name="shortcut_context" type="Node" setter="set_shortcut_context" getter="get_shortcut_context">
The [Node] which must be a parent of the focused GUI [Control] for the shortcut to be activated. If [code]null[/code], the shortcut can be activated when any control is focused (a global shortcut). This allows shortcuts to be accepted only when the user has a certain area of the GUI focused.
</member>
Create GDExtension clases for PhysicsServer3D * Allows creating a GDExtension based 3D Physics Server (for Bullet, PhysX, etc. support) * Some changes on native struct binding for PhysicsServer This allows a 3D Physics server created entirely from GDExtension. Once it works, the idea is to port the 2D one to it.
2022-03-14 22:52:03 +08:00
<member name="shortcut_in_tooltip" type="bool" setter="set_shortcut_in_tooltip" getter="is_shortcut_in_tooltip_enabled">
doc: Add missing commas after "If true/false"
2018-12-20 20:46:54 +08:00
If [code]true[/code], the button will add information about its shortcut in the tooltip.
BaseButton: add shortcut_in_tooltip This flag disables the input related information in the tooltip. It is exposed as a member variable in gdscript.
2018-11-19 21:30:59 +08:00
</member>
Create GDExtension clases for PhysicsServer3D * Allows creating a GDExtension based 3D Physics Server (for Bullet, PhysX, etc. support) * Some changes on native struct binding for PhysicsServer This allows a 3D Physics server created entirely from GDExtension. Once it works, the idea is to port the 2D one to it.
2022-03-14 22:52:03 +08:00
<member name="toggle_mode" type="bool" setter="set_toggle_mode" getter="is_toggle_mode">
doc: Add missing commas after "If true/false"
2018-12-20 20:46:54 +08:00
If [code]true[/code], the button is in toggle mode. Makes the button flip state between pressed and unpressed each time its area is clicked.
doc: Sync classref with current source
2018-11-23 08:06:24 +08:00
</member>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</members>
<signals>
<signal name="button_down">
<description>
Emitted when the button starts being held down.
</description>
</signal>
<signal name="button_up">
<description>
Emitted when the button stops being held down.
</description>
</signal>
<signal name="pressed">
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 07:04:47 +08:00
Emitted when the button is toggled or pressed. This is on [signal button_down] if [member action_mode] is [constant ACTION_MODE_BUTTON_PRESS] and on [signal button_up] otherwise.
Mention `toggled` signal for pressed state in BaseButton documentation This closes #40455.
2020-07-17 06:01:24 +08:00
If you need to know the button's pressed state (and [member toggle_mode] is active), use [signal toggled] instead.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</signal>
<signal name="toggled">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<argument index="0" name="button_pressed" type="bool" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 07:04:47 +08:00
Emitted when the button was just toggled between pressed and normal states (only if [member toggle_mode] is active). The new state is contained in the [code]button_pressed[/code] argument.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</signal>
</signals>
<constants>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="DRAW_NORMAL" value="0" enum="DrawMode">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
The normal state (i.e. not pressed, not hovered, not toggled and enabled) of buttons.
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="DRAW_PRESSED" value="1" enum="DrawMode">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
The state of buttons are pressed.
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="DRAW_HOVER" value="2" enum="DrawMode">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
The state of buttons are hovered.
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="DRAW_DISABLED" value="3" enum="DrawMode">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
The state of buttons are disabled.
</constant>
Update class documentation xml
2018-10-07 21:52:07 +08:00
<constant name="DRAW_HOVER_PRESSED" value="4" enum="DrawMode">
Complete documentation of some more classes
2020-01-14 06:08:42 +08:00
The state of buttons are both hovered and pressed.
Update class documentation xml
2018-10-07 21:52:07 +08:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="ACTION_MODE_BUTTON_PRESS" value="0" enum="ActionMode">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
Require just a press to consider the button clicked.
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="ACTION_MODE_BUTTON_RELEASE" value="1" enum="ActionMode">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
Require a press and a subsequent release before considering the button clicked.
</constant>
</constants>
</class>
Reference in New Issue Copy Permalink