diff options
Diffstat (limited to 'doc/classes/BaseButton.xml')
| -rw-r--r-- | doc/classes/BaseButton.xml | 122 |
1 files changed, 7 insertions, 115 deletions
diff --git a/doc/classes/BaseButton.xml b/doc/classes/BaseButton.xml index 26939143b6..7f1aaa6822 100644 --- a/doc/classes/BaseButton.xml +++ b/doc/classes/BaseButton.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="BaseButton" inherits="Control" category="Core" version="3.0-alpha"> +<class name="BaseButton" inherits="Control" category="Core" version="3.0-beta"> <brief_description> Base class for different kinds of buttons. </brief_description> @@ -27,19 +27,6 @@ Called when button is toggled (only if toggle_mode is active). </description> </method> - <method name="get_action_mode" qualifiers="const"> - <return type="int" enum="BaseButton.ActionMode"> - </return> - <description> - Return the current mode of action (see [method set_action_mode]) (one of the ACTION_MODE_* constants). - </description> - </method> - <method name="get_button_group" qualifiers="const"> - <return type="ButtonGroup"> - </return> - <description> - </description> - </method> <method name="get_draw_mode" qualifiers="const"> <return type="int" enum="BaseButton.DrawMode"> </return> @@ -47,26 +34,6 @@ Return 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 DRAW_* enum. </description> </method> - <method name="get_enabled_focus_mode" qualifiers="const"> - <return type="int" enum="Control.FocusMode"> - </return> - <description> - Returns focus access mode used when switching between enabled/disabled (see [method Control.set_focus_mode] and [method set_disabled]). - </description> - </method> - <method name="get_shortcut" qualifiers="const"> - <return type="ShortCut"> - </return> - <description> - </description> - </method> - <method name="is_disabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether the button is in disabled state (see [method set_disabled]). - </description> - </method> <method name="is_hovered" qualifiers="const"> <return type="bool"> </return> @@ -74,81 +41,6 @@ Return true if mouse entered the button before it exit. </description> </method> - <method name="is_pressed" qualifiers="const"> - <return type="bool"> - </return> - <description> - If toggle_mode is active, return whether the button is toggled. If toggle_mode is not active, return whether the button is pressed down. - </description> - </method> - <method name="is_toggle_mode" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return the toggle_mode property (see [method set_toggle_mode]). - </description> - </method> - <method name="set_action_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="BaseButton.ActionMode"> - </argument> - <description> - Set the current mode of action, determining when the button is considered clicked (see the ACTION_MODE_* constants). - </description> - </method> - <method name="set_button_group"> - <return type="void"> - </return> - <argument index="0" name="button_group" type="ButtonGroup"> - </argument> - <description> - </description> - </method> - <method name="set_disabled"> - <return type="void"> - </return> - <argument index="0" name="disabled" type="bool"> - </argument> - <description> - Set the button into disabled state. When a button is disabled, it can't be clicked or toggled. - </description> - </method> - <method name="set_enabled_focus_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="Control.FocusMode"> - </argument> - <description> - Sets the focus access mode to use when switching between enabled/disabled (see [method Control.set_focus_mode] and [method set_disabled]). - </description> - </method> - <method name="set_pressed"> - <return type="void"> - </return> - <argument index="0" name="pressed" type="bool"> - </argument> - <description> - Set the button to pressed state (only if toggle_mode is active). - </description> - </method> - <method name="set_shortcut"> - <return type="void"> - </return> - <argument index="0" name="shortcut" type="ShortCut"> - </argument> - <description> - </description> - </method> - <method name="set_toggle_mode"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - Set the button toggle_mode property. Toggle mode makes the button flip state between pressed and unpressed each time its area is clicked. - </description> - </method> </methods> <members> <member name="action_mode" type="int" setter="set_action_mode" getter="get_action_mode" enum="BaseButton.ActionMode"> @@ -198,22 +90,22 @@ </signal> </signals> <constants> - <constant name="DRAW_NORMAL" value="0"> + <constant name="DRAW_NORMAL" value="0" enum="DrawMode"> The normal state (i.e. not pressed, not hovered, not toggled and enabled) of buttons. </constant> - <constant name="DRAW_PRESSED" value="1"> + <constant name="DRAW_PRESSED" value="1" enum="DrawMode"> The state of buttons are pressed. </constant> - <constant name="DRAW_HOVER" value="2"> + <constant name="DRAW_HOVER" value="2" enum="DrawMode"> The state of buttons are hovered. </constant> - <constant name="DRAW_DISABLED" value="3"> + <constant name="DRAW_DISABLED" value="3" enum="DrawMode"> The state of buttons are disabled. </constant> - <constant name="ACTION_MODE_BUTTON_PRESS" value="0"> + <constant name="ACTION_MODE_BUTTON_PRESS" value="0" enum="ActionMode"> Require just a press to consider the button clicked. </constant> - <constant name="ACTION_MODE_BUTTON_RELEASE" value="1"> + <constant name="ACTION_MODE_BUTTON_RELEASE" value="1" enum="ActionMode"> Require a press and a subsequent release before considering the button clicked. </constant> </constants> |