Jelajahi Sumber

Merge pull request #12330 from Jerome67000/docs_basebutton

[DOCS] BaseButton

[ci skip]
Rémi Verschelde 8 tahun lalu
induk
melakukan
5b53cd1fc4
1 mengubah file dengan 9 tambahan dan 2 penghapusan
  1. 9 2
      doc/classes/BaseButton.xml

+ 9 - 2
doc/classes/BaseButton.xml

@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="BaseButton" inherits="Control" category="Core" version="3.0.alpha.custom_build">
 <class name="BaseButton" inherits="Control" category="Core" version="3.0.alpha.custom_build">
 	<brief_description>
 	<brief_description>
-		Provides a base class for different kinds of buttons.
+		Base class for different kinds of buttons.
 	</brief_description>
 	</brief_description>
 	<description>
 	<description>
-		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.
+		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.
 	</description>
 	</description>
 	<tutorials>
 	<tutorials>
 	</tutorials>
 	</tutorials>
@@ -152,18 +152,25 @@
 	</methods>
 	</methods>
 	<members>
 	<members>
 		<member name="action_mode" type="int" setter="set_action_mode" getter="get_action_mode" enum="BaseButton.ActionMode">
 		<member name="action_mode" type="int" setter="set_action_mode" getter="get_action_mode" enum="BaseButton.ActionMode">
+			Determines when the button is considered clicked, one of the ACTION_MODE_* constants.
 		</member>
 		</member>
 		<member name="disabled" type="bool" setter="set_disabled" getter="is_disabled">
 		<member name="disabled" type="bool" setter="set_disabled" getter="is_disabled">
+			If [code]true[/code] the button is in disabled state and can't be clicked or toggled.
 		</member>
 		</member>
 		<member name="enabled_focus_mode" type="int" setter="set_enabled_focus_mode" getter="get_enabled_focus_mode" enum="Control.FocusMode">
 		<member name="enabled_focus_mode" type="int" setter="set_enabled_focus_mode" getter="get_enabled_focus_mode" enum="Control.FocusMode">
+			Focus access mode to use when switching between enabled/disabled (see [method Control.set_focus_mode] and [member disabled]).
 		</member>
 		</member>
 		<member name="group" type="ButtonGroup" setter="set_button_group" getter="get_button_group">
 		<member name="group" type="ButtonGroup" setter="set_button_group" getter="get_button_group">
+			[ButtonGroup] associated to the button.
 		</member>
 		</member>
 		<member name="pressed" type="bool" setter="set_pressed" getter="is_pressed">
 		<member name="pressed" type="bool" setter="set_pressed" getter="is_pressed">
+			If [code]true[/code] the button's state is pressed. Means the button is pressed down or toggled (if toggle_mode is active).
 		</member>
 		</member>
 		<member name="shortcut" type="ShortCut" setter="set_shortcut" getter="get_shortcut">
 		<member name="shortcut" type="ShortCut" setter="set_shortcut" getter="get_shortcut">
+			[Shortcut] associated to the button.
 		</member>
 		</member>
 		<member name="toggle_mode" type="bool" setter="set_toggle_mode" getter="is_toggle_mode">
 		<member name="toggle_mode" type="bool" setter="set_toggle_mode" getter="is_toggle_mode">
+			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.
 		</member>
 		</member>
 	</members>
 	</members>
 	<signals>
 	<signals>