| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159 |
- :github_url: hide
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the Button.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_Button:
- Button
- ======
- **Inherits:** :ref:`BaseButton<class_BaseButton>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
- **Inherited By:** :ref:`CheckBox<class_CheckBox>`, :ref:`CheckButton<class_CheckButton>`, :ref:`ColorPickerButton<class_ColorPickerButton>`, :ref:`MenuButton<class_MenuButton>`, :ref:`OptionButton<class_OptionButton>`, :ref:`ToolButton<class_ToolButton>`
- **Category:** Core
- Brief Description
- -----------------
- Standard themed Button.
- Properties
- ----------
- +-----------------------------------------+---------------------------------------------------+
- | :ref:`TextAlign<enum_Button_TextAlign>` | :ref:`align<class_Button_property_align>` |
- +-----------------------------------------+---------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`clip_text<class_Button_property_clip_text>` |
- +-----------------------------------------+---------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`flat<class_Button_property_flat>` |
- +-----------------------------------------+---------------------------------------------------+
- | :ref:`Texture<class_Texture>` | :ref:`icon<class_Button_property_icon>` |
- +-----------------------------------------+---------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`text<class_Button_property_text>` |
- +-----------------------------------------+---------------------------------------------------+
- Theme Properties
- ----------------
- +---------------------------------+---------------------+
- | :ref:`StyleBox<class_StyleBox>` | disabled |
- +---------------------------------+---------------------+
- | :ref:`StyleBox<class_StyleBox>` | focus |
- +---------------------------------+---------------------+
- | :ref:`Font<class_Font>` | font |
- +---------------------------------+---------------------+
- | :ref:`Color<class_Color>` | font_color |
- +---------------------------------+---------------------+
- | :ref:`Color<class_Color>` | font_color_disabled |
- +---------------------------------+---------------------+
- | :ref:`Color<class_Color>` | font_color_hover |
- +---------------------------------+---------------------+
- | :ref:`Color<class_Color>` | font_color_pressed |
- +---------------------------------+---------------------+
- | :ref:`StyleBox<class_StyleBox>` | hover |
- +---------------------------------+---------------------+
- | :ref:`int<class_int>` | hseparation |
- +---------------------------------+---------------------+
- | :ref:`StyleBox<class_StyleBox>` | normal |
- +---------------------------------+---------------------+
- | :ref:`StyleBox<class_StyleBox>` | pressed |
- +---------------------------------+---------------------+
- Enumerations
- ------------
- .. _enum_Button_TextAlign:
- .. _class_Button_constant_ALIGN_LEFT:
- .. _class_Button_constant_ALIGN_CENTER:
- .. _class_Button_constant_ALIGN_RIGHT:
- enum **TextAlign**:
- - **ALIGN_LEFT** = **0** --- Align the text to the left.
- - **ALIGN_CENTER** = **1** --- Align the text to the center.
- - **ALIGN_RIGHT** = **2** --- Align the text to the right.
- Description
- -----------
- Button is the standard themed button. It can contain text and an icon, and will display them according to the current :ref:`Theme<class_Theme>`.
- Property Descriptions
- ---------------------
- .. _class_Button_property_align:
- - :ref:`TextAlign<enum_Button_TextAlign>` **align**
- +----------+-----------------------+
- | *Setter* | set_text_align(value) |
- +----------+-----------------------+
- | *Getter* | get_text_align() |
- +----------+-----------------------+
- Text alignment policy for the button's text, use one of the ALIGN\_\* constants.
- ----
- .. _class_Button_property_clip_text:
- - :ref:`bool<class_bool>` **clip_text**
- +----------+----------------------+
- | *Setter* | set_clip_text(value) |
- +----------+----------------------+
- | *Getter* | get_clip_text() |
- +----------+----------------------+
- When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text. This property is disabled by default.
- ----
- .. _class_Button_property_flat:
- - :ref:`bool<class_bool>` **flat**
- +----------+-----------------+
- | *Setter* | set_flat(value) |
- +----------+-----------------+
- | *Getter* | is_flat() |
- +----------+-----------------+
- Flat buttons don't display decoration.
- ----
- .. _class_Button_property_icon:
- - :ref:`Texture<class_Texture>` **icon**
- +----------+------------------------+
- | *Setter* | set_button_icon(value) |
- +----------+------------------------+
- | *Getter* | get_button_icon() |
- +----------+------------------------+
- Button's icon, if text is present the icon will be placed before the text.
- ----
- .. _class_Button_property_text:
- - :ref:`String<class_String>` **text**
- +----------+-----------------+
- | *Setter* | set_text(value) |
- +----------+-----------------+
- | *Getter* | get_text() |
- +----------+-----------------+
- The button's text that will be displayed inside the button's area.
|
