mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-12-15 10:12:40 +08:00
Code Issues Packages Projects Releases Wiki Activity
e3ef50db38
godot/doc/classes/MenuButton.xml

94 lines
4.2 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" ?>
Update docs to version 4.0
2020-02-01 09:03:48 +08:00
<class name="MenuButton" inherits="Button" version="4.0">
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>
Special button that brings up a [PopupMenu] when clicked.
</brief_description>
<description>
doc: Misc updates for AnimationNode* and others - Add some missing descriptions. - Add links to tutorials for ARVR and AnimationTree. - Style fixes. - Engine changes: * Make `AnimationNodeTransition.input_<number>` properties internal so that they don't appear in the docs. They still appear in the inspector based on the actual number of inputs requested. * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D particles in `ParticlesMaterial`, and thus only relevant for `CPUParticles3D`.
2020-01-23 18:14:14 +08:00
Special button that brings up a [PopupMenu] when clicked.
class reference proofreading
2021-03-18 19:04:28 +08:00
New items can be created inside this [PopupMenu] using [code]get_popup().add_item("My Item Name")[/code]. You can also create them directly from the editor. To do so, select the [MenuButton] node, then in the toolbar at the top of the 2D editor, click [b]Items[/b] then click [b]Add[/b] in the popup. You will be able to give each item new properties.
Reference the BaseButton class explicitly in button class documentations Users are sometimes confused as to the `pressed` property not being visible in the Button class documentation. This is because `pressed` is defined in BaseButton.
2020-09-24 05:34:28 +08:00
See also [BaseButton] which contains common properties and methods associated with this node.
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>
Made MenuButton and ColorPickerButton's "get_popup" methods return constant.
2017-12-26 00:03:53 +08:00
<method name="get_popup" qualifiers="const">
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
<return type="PopupMenu">
</return>
<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 the [PopupMenu] contained in this 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
</description>
</method>
doc: Sync classref with current source
2018-01-03 20:45:03 +08:00
<method name="set_disable_shortcuts">
<return type="void">
</return>
<argument index="0" name="disabled" type="bool">
</argument>
<description>
doc: Misc updates for AnimationNode* and others - Add some missing descriptions. - Add links to tutorials for ARVR and AnimationTree. - Style fixes. - Engine changes: * Make `AnimationNodeTransition.input_<number>` properties internal so that they don't appear in the docs. They still appear in the inspector based on the actual number of inputs requested. * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D particles in `ParticlesMaterial`, and thus only relevant for `CPUParticles3D`.
2020-01-23 18:14:14 +08:00
If [code]true[/code], shortcuts are disabled and cannot be used to trigger the button.
doc: Sync classref with current source
2018-01-03 20:45:03 +08:00
</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>
Make opening menus with the same parent on mouse focus explicit
2018-07-30 06:26:43 +08:00
<members>
doc: Fix parsing of self-closing XML tags Follow-up to #31925, `<member />` tags just before `</members>` would cause a parsing issue, and we'd never notice that we're no longer parsing members. Also added space before closing `/>`.
2019-09-24 19:34:03 +08:00
<member name="action_mode" type="int" setter="set_action_mode" getter="get_action_mode" override="true" enum="BaseButton.ActionMode" default="0" />
<member name="flat" type="bool" setter="set_flat" getter="is_flat" override="true" default="true" />
doc: Sync classref with current source And fixups: - Add missing bindings in RenderingServer - Remove duplicate ArrayMesh enum bindings (they're in Mesh already) - Remove redundant _unhandled_key_input binding in Control (it's in Node already)
2020-12-04 22:54:48 +08:00
<member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" override="true" enum="Control.FocusMode" default="0" />
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<member name="switch_on_hover" type="bool" setter="set_switch_on_hover" getter="is_switch_on_hover" default="false">
doc: Misc updates for AnimationNode* and others - Add some missing descriptions. - Add links to tutorials for ARVR and AnimationTree. - Style fixes. - Engine changes: * Make `AnimationNodeTransition.input_<number>` properties internal so that they don't appear in the docs. They still appear in the inspector based on the actual number of inputs requested. * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D particles in `ParticlesMaterial`, and thus only relevant for `CPUParticles3D`.
2020-01-23 18:14:14 +08:00
If [code]true[/code], when the cursor hovers above another [MenuButton] within the same parent which also has [code]switch_on_hover[/code] enabled, it will close the current [MenuButton] and open the other one.
Make opening menus with the same parent on mouse focus explicit
2018-07-30 06:26:43 +08:00
</member>
doc: Fix parsing of self-closing XML tags Follow-up to #31925, `<member />` tags just before `</members>` would cause a parsing issue, and we'd never notice that we're no longer parsing members. Also added space before closing `/>`.
2019-09-24 19:34:03 +08:00
<member name="toggle_mode" type="bool" setter="set_toggle_mode" getter="is_toggle_mode" override="true" default="true" />
Make opening menus with the same parent on mouse focus explicit
2018-07-30 06:26:43 +08:00
</members>
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
<signals>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 17:56:58 +08:00
<signal name="about_to_popup">
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: Sync classref with DisplayServer/Window changes
2020-03-31 17:56:58 +08:00
Emitted when the [PopupMenu] of this MenuButton is about to show.
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>
</constants>
<theme_items>
<theme_item name="disabled" type="StyleBox">
Completes doc for button classes
2020-02-04 15:46:01 +08:00
[StyleBox] used when the [MenuButton] is disabled.
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
</theme_item>
<theme_item name="focus" type="StyleBox">
Completes doc for button classes
2020-02-04 15:46:01 +08:00
[StyleBox] used when the [MenuButton] is focused. It is displayed over the current [StyleBox], so using [StyleBoxEmpty] will just disable the focus visual effect.
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
</theme_item>
<theme_item name="font" type="Font">
Completes doc for button classes
2020-02-04 15:46:01 +08:00
[Font] of the [MenuButton]'s text.
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
</theme_item>
Better format arguments in variant parser
2019-09-25 01:45:03 +08:00
<theme_item name="font_color" type="Color" default="Color(0.88, 0.88, 0.88, 1)">
Completes doc for button classes
2020-02-04 15:46:01 +08:00
Default text [Color] of the [MenuButton].
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
</theme_item>
Better format arguments in variant parser
2019-09-25 01:45:03 +08:00
<theme_item name="font_disabled_color" type="Color" default="Color(1, 1, 1, 0.3)">
Completes doc for button classes
2020-02-04 15:46:01 +08:00
Text [Color] used when the [MenuButton] is disabled.
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
</theme_item>
Better format arguments in variant parser
2019-09-25 01:45:03 +08:00
<theme_item name="font_hover_color" type="Color" default="Color(0.94, 0.94, 0.94, 1)">
Completes doc for button classes
2020-02-04 15:46:01 +08:00
Text [Color] used when the [MenuButton] is being hovered.
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
</theme_item>
Better format arguments in variant parser
2019-09-25 01:45:03 +08:00
<theme_item name="font_outline_color" type="Color" default="Color(1, 1, 1, 1)">
[CTL] Add missing font outline drawing routines and theme constants.
2020-12-26 05:45:28 +08:00
The tint of text outline of the [MenuButton].
</theme_item>
Better format arguments in variant parser
2019-09-25 01:45:03 +08:00
<theme_item name="font_pressed_color" type="Color" default="Color(1, 1, 1, 1)">
Completes doc for button classes
2020-02-04 15:46:01 +08:00
Text [Color] used when the [MenuButton] is being pressed.
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
</theme_item>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<theme_item name="font_size" type="int">
Font size of the [MenuButton]'s text.
</theme_item>
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
<theme_item name="hover" type="StyleBox">
Completes doc for button classes
2020-02-04 15:46:01 +08:00
[StyleBox] used when the [MenuButton] is being hovered.
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
</theme_item>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<theme_item name="hseparation" type="int" default="3">
Completes doc for button classes
2020-02-04 15:46:01 +08:00
The horizontal space between [MenuButton]'s icon and text.
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
</theme_item>
<theme_item name="normal" type="StyleBox">
Completes doc for button classes
2020-02-04 15:46:01 +08:00
Default [StyleBox] for the [MenuButton].
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
</theme_item>
[CTL] Add missing font outline drawing routines and theme constants.
2020-12-26 05:45:28 +08:00
<theme_item name="outline_size" type="int" default="0">
The size of the text outline.
</theme_item>
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
<theme_item name="pressed" type="StyleBox">
Completes doc for button classes
2020-02-04 15:46:01 +08:00
[StyleBox] used when the [MenuButton] is being pressed.
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
</theme_item>
</theme_items>
</class>
Reference in New Issue Copy Permalink