class_linkbutton.rst 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the LinkButton.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_LinkButton:
  5. LinkButton
  6. ==========
  7. **Inherits:** :ref:`BaseButton<class_basebutton>` **<** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Simple button used to represent a link to some resource.
  12. Member Variables
  13. ----------------
  14. .. _class_LinkButton_text:
  15. - :ref:`String<class_string>` **text**
  16. .. _class_LinkButton_underline:
  17. - :ref:`UnderlineMode<enum_linkbutton_underlinemode>` **underline**
  18. Enums
  19. -----
  20. .. _enum_LinkButton_UnderlineMode:
  21. enum **UnderlineMode**
  22. - **UNDERLINE_MODE_ALWAYS** = **0** --- The LinkButton will always show an underline at the bottom of its text
  23. - **UNDERLINE_MODE_ON_HOVER** = **1** --- The LinkButton will show an underline at the bottom of its text when the mouse cursor is over it.
  24. - **UNDERLINE_MODE_NEVER** = **2** --- The LinkButton will never show an underline at the bottom of its text.
  25. Description
  26. -----------
  27. This kind of buttons are primarily used when the interaction with the button causes a context change (like linking to a web page).