From 4f929a0fdfae24b1ca5acf0b732219119090ee43 Mon Sep 17 00:00:00 2001 From: Juan Linietsky Date: Tue, 12 Sep 2017 17:42:36 -0300 Subject: 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. --- doc/classes/BaseButton.xml | 213 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 213 insertions(+) create mode 100644 doc/classes/BaseButton.xml (limited to 'doc/classes/BaseButton.xml') diff --git a/doc/classes/BaseButton.xml b/doc/classes/BaseButton.xml new file mode 100644 index 000000000..2d5a0b450 --- /dev/null +++ b/doc/classes/BaseButton.xml @@ -0,0 +1,213 @@ + + + + Provides a base class for different kinds of buttons. + + + 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. + + + + + + + + + + + Called when button is pressed. + + + + + + + + + Called when button is toggled (only if toggle_mode is active). + + + + + + + Return the current mode of action (see [method set_action_mode]) (one of the ACTION_MODE_* constants). + + + + + + + + + + + + + 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. + + + + + + + Returns focus access mode used when switching between enabled/disabled (see [method Control.set_focus_mode] and [method set_disabled]). + + + + + + + + + + + + + Return whether the button is in disabled state (see [method set_disabled]). + + + + + + + Return true if mouse entered the button before it exit. + + + + + + + If toggle_mode is active, return whether the button is toggled. If toggle_mode is not active, return whether the button is pressed down. + + + + + + + Return the toggle_mode property (see [method set_toggle_mode]). + + + + + + + + + Set the current mode of action, determining when the button is considered clicked (see the ACTION_MODE_* constants). + + + + + + + + + + + + + + + + + Set the button into disabled state. When a button is disabled, it can't be clicked or toggled. + + + + + + + + + Sets the focus access mode to use when switching between enabled/disabled (see [method Control.set_focus_mode] and [method set_disabled]). + + + + + + + + + Set the button to pressed state (only if toggle_mode is active). + + + + + + + + + + + + + + + + + Set the button toggle_mode property. Toggle mode makes the button flip state between pressed and unpressed each time its area is clicked. + + + + + + + + + + + + + + + + + + + + + + + Emitted when the button starts being held down. + + + + + Emitted when the button stops being held down. + + + + + This signal is emitted every time the button is toggled or pressed (i.e. activated, so on [code]button_down[/code] if "Click on press" is active and on [code]button_up[/code] otherwise). + + + + + + + This signal is emitted when the button was just toggled between pressed and normal states (only if toggle_mode is active). The new state is contained in the [i]pressed[/i] argument. + + + + + + The normal state (i.e. not pressed, not hovered, not toggled and enabled) of buttons. + + + The state of buttons are pressed. + + + The state of buttons are hovered. + + + The state of buttons are disabled. + + + Require just a press to consider the button clicked. + + + Require a press and a subsequent release before considering the button clicked. + + + -- cgit v1.2.3-70-g09d2