godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/MenuButton.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

102 lines
5.9 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-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb).
2023-07-06 08:08:05 +00:00
<class name="MenuButton" inherits="Button" 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-12 20:42:36 +00:00
<brief_description>
Overhaul the top sections of the class reference (GUI classes)
2023-04-30 14:26:09 +00:00
A button that brings up a [PopupMenu] when clicked.
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-12 20:42:36 +00:00
</brief_description>
<description>
Overhaul the top sections of the class reference (GUI classes)
2023-04-30 14:26:09 +00:00
A button that brings up a [PopupMenu] when clicked. To create new items inside this [PopupMenu], use [code]get_popup().add_item("My Item Name")[/code]. You can also create them directly from Godot editor's inspector.
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-23 21:34:28 +00: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-12 20:42:36 +00:00
</description>
<tutorials>
</tutorials>
<methods>
Made MenuButton and ColorPickerButton's "get_popup" methods return constant.
2017-12-25 16:03:53 +00:00
<method name="get_popup" 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 13:28:05 +00:00
<return type="PopupMenu" />
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-12 20:42:36 +00: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 02:15:43 +00:00
Returns the [PopupMenu] contained in this button.
Add warnings to methods that give access to internal nodes
2021-10-10 19:28:56 +00:00
[b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member Window.visible] property.
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-12 20:42:36 +00:00
</description>
</method>
doc: Sync classref with current source
2018-01-03 12:45:03 +00:00
<method name="set_disable_shortcuts">
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 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="disabled" type="bool" />
doc: Sync classref with current source
2018-01-03 12:45:03 +00:00
<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 10:14:14 +00: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 12:45:03 +00:00
</description>
</method>
Improve MenuButton and OptionButton * MenuButton + OptionButton: Add method `show_popup()` which performs required popup setup before showing (prefer use of this over `get_popup()->popup()`, otherwise GH #66308 occurs) * MenuButton: Ensure that the menu can be opened with a shortcut, if one is set for the button. (GH #66403). Ensure that popupmenu item shortcuts are checked first before the MenuButton shortcut.
2022-10-02 06:46:37 +00:00
<method name="show_popup">
<return type="void" />
<description>
Adjusts popup position and sizing for the [MenuButton], then shows the [PopupMenu]. Prefer this over using [code]get_popup().popup()[/code].
</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-12 20:42:36 +00:00
</methods>
Make opening menus with the same parent on mouse focus explicit
2018-07-29 22:26:43 +00:00
<members>
Make overridden properties link to parent definition Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com>
2021-12-02 19:38:49 +00:00
<member name="action_mode" type="int" setter="set_action_mode" getter="get_action_mode" overrides="BaseButton" enum="BaseButton.ActionMode" default="0" />
<member name="flat" type="bool" setter="set_flat" getter="is_flat" overrides="Button" default="true" />
<member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" overrides="Control" enum="Control.FocusMode" default="0" />
Rename "items_count" property to "item_count"
2021-12-07 03:09:31 +00:00
<member name="item_count" type="int" setter="set_item_count" getter="get_item_count" default="0">
Implement inspector property array for `PopupMenu` and `MenuButton`
2021-11-03 02:08:58 +00:00
The number of items currently in the list.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00: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 10:14:14 +00: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-29 22:26:43 +00:00
</member>
Make overridden properties link to parent definition Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com>
2021-12-02 19:38:49 +00:00
<member name="toggle_mode" type="bool" setter="set_toggle_mode" getter="is_toggle_mode" overrides="BaseButton" default="true" />
Make opening menus with the same parent on mouse focus explicit
2018-07-29 22:26:43 +00: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-12 20:42:36 +00:00
<signals>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00: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-12 20:42:36 +00:00
<description>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00: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-12 20:42:36 +00:00
</description>
</signal>
</signals>
<theme_items>
Improve the default project theme The new default project theme uses StyleBoxFlat extensively for a more modern design and better scalability to multiple resolutions. SVG icons are now used in place of PNG icons. While this does not allow for true vector-based icon drawing (icons are still rasterized at load-time), this makes the design work easier for contributors and opens the door to vector drawing in the future (e.g. with polygons or SDFs). Like for editor icons, the SVG header file is now built automatically when a SVG file is changed. This removing the need for running `make_header.py` manually (TODO). The "Use Hidpi" project setting has been removed in favor of a "Default Theme Scale" project setting, which allows creating the default theme at a higher/lower scale than the default. This can be used when designing GUIs with a high base resolution to ensure crisp visuals. Co-authored-by: Yuri Sizov <yuris@humnom.net>
2021-12-30 16:22:06 +00:00
<theme_item name="font_color" data_type="color" type="Color" default="Color(0.875, 0.875, 0.875, 1)">
Completes doc for button classes
2020-02-04 07:46:01 +00: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-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="font_disabled_color" data_type="color" type="Color" default="Color(1, 1, 1, 0.3)">
Completes doc for button classes
2020-02-04 07:46:01 +00: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-12 20:42:36 +00:00
</theme_item>
Improve the default project theme The new default project theme uses StyleBoxFlat extensively for a more modern design and better scalability to multiple resolutions. SVG icons are now used in place of PNG icons. While this does not allow for true vector-based icon drawing (icons are still rasterized at load-time), this makes the design work easier for contributors and opens the door to vector drawing in the future (e.g. with polygons or SDFs). Like for editor icons, the SVG header file is now built automatically when a SVG file is changed. This removing the need for running `make_header.py` manually (TODO). The "Use Hidpi" project setting has been removed in favor of a "Default Theme Scale" project setting, which allows creating the default theme at a higher/lower scale than the default. This can be used when designing GUIs with a high base resolution to ensure crisp visuals. Co-authored-by: Yuri Sizov <yuris@humnom.net>
2021-12-30 16:22:06 +00:00
<theme_item name="font_focus_color" data_type="color" type="Color" default="Color(0.95, 0.95, 0.95, 1)">
Add focus font color to Button and derivatives
2021-10-26 14:28:12 +00:00
Text [Color] used when the [MenuButton] is focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color.
</theme_item>
Improve the default project theme The new default project theme uses StyleBoxFlat extensively for a more modern design and better scalability to multiple resolutions. SVG icons are now used in place of PNG icons. While this does not allow for true vector-based icon drawing (icons are still rasterized at load-time), this makes the design work easier for contributors and opens the door to vector drawing in the future (e.g. with polygons or SDFs). Like for editor icons, the SVG header file is now built automatically when a SVG file is changed. This removing the need for running `make_header.py` manually (TODO). The "Use Hidpi" project setting has been removed in favor of a "Default Theme Scale" project setting, which allows creating the default theme at a higher/lower scale than the default. This can be used when designing GUIs with a high base resolution to ensure crisp visuals. Co-authored-by: Yuri Sizov <yuris@humnom.net>
2021-12-30 16:22:06 +00:00
<theme_item name="font_hover_color" data_type="color" type="Color" default="Color(0.95, 0.95, 0.95, 1)">
Completes doc for button classes
2020-02-04 07:46:01 +00: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-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="font_outline_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
[CTL] Add missing font outline drawing routines and theme constants.
2020-12-25 21:45:28 +00:00
The tint of text outline of the [MenuButton].
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="font_pressed_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
Completes doc for button classes
2020-02-04 07:46:01 +00: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-12 20:42:36 +00:00
</theme_item>
Further separate icon from text of buttons in both editor and default themes
2023-08-05 04:13:48 +00:00
<theme_item name="h_separation" data_type="constant" type="int" default="4">
Fix case where `h_separation` might not work in `Button` This patch mainly solves two things: 1. The typo of `h_separation`; 2. Negative values of `h_separation` will be treated as `0` when used, to prevent the button's minimum `width` from being reduced by `h_separation`.
2022-08-12 11:39:22 +00:00
The horizontal space between [MenuButton]'s icon and text. Negative values will be treated as [code]0[/code] when used.
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 18:02:20 +00:00
</theme_item>
<theme_item name="outline_size" data_type="constant" type="int" default="0">
The size of the text outline.
Document MDSF font outlines may require `msdf_pixel_range` adjustments
2022-12-19 16:15:44 +00:00
[b]Note:[/b] If using a font with [member FontFile.multichannel_signed_distance_field] enabled, its [member FontFile.msdf_pixel_range] must be set to at least [i]twice[/i] the value of [theme_item outline_size] for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended.
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 18:02:20 +00:00
</theme_item>
<theme_item name="font" data_type="font" type="Font">
[Font] of the [MenuButton]'s text.
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="font_size" data_type="font_size" type="int">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
Font size of the [MenuButton]'s text.
</theme_item>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 18:02:20 +00:00
<theme_item name="disabled" data_type="style" type="StyleBox">
[StyleBox] used when the [MenuButton] is disabled.
</theme_item>
<theme_item name="focus" data_type="style" type="StyleBox">
Document that transparent StyleBoxes/textures should be used for UI focus
2021-11-20 16:43:34 +00:00
[StyleBox] used when the [MenuButton] is focused. The [code]focus[/code] [StyleBox] is displayed [i]over[/i] the base [StyleBox], so a partially transparent [StyleBox] should be used to ensure the base [StyleBox] remains visible. A [StyleBox] that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a [StyleBoxEmpty] resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons.
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 18:02:20 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="hover" data_type="style" type="StyleBox">
Completes doc for button classes
2020-02-04 07:46:01 +00: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-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="normal" data_type="style" type="StyleBox">
Completes doc for button classes
2020-02-04 07:46:01 +00: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-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="pressed" data_type="style" type="StyleBox">
Completes doc for button classes
2020-02-04 07:46:01 +00: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-12 20:42:36 +00:00
</theme_item>
</theme_items>
</class>