LinkButton.xml 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="LinkButton" inherits="BaseButton" category="Core" version="3.0.alpha.custom_build">
  3. <brief_description>
  4. Simple button used to represent a link to some resource
  5. </brief_description>
  6. <description>
  7. This kind of buttons are primarily used when the interaction with the button causes a context change (like linking to a web page).
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <demos>
  12. </demos>
  13. <methods>
  14. <method name="get_text" qualifiers="const">
  15. <return type="String">
  16. </return>
  17. <description>
  18. Returns the text of the button.
  19. </description>
  20. </method>
  21. <method name="get_underline_mode" qualifiers="const">
  22. <return type="int" enum="LinkButton.UnderlineMode">
  23. </return>
  24. <description>
  25. Returns the underline mode for this button.
  26. </description>
  27. </method>
  28. <method name="set_text">
  29. <return type="void">
  30. </return>
  31. <argument index="0" name="text" type="String">
  32. </argument>
  33. <description>
  34. Sets the text of the button.
  35. </description>
  36. </method>
  37. <method name="set_underline_mode">
  38. <return type="void">
  39. </return>
  40. <argument index="0" name="underline_mode" type="int" enum="LinkButton.UnderlineMode">
  41. </argument>
  42. <description>
  43. Sets the underline mode for this button, the argument must be one of the [LinkButton] constants (see constants section).
  44. </description>
  45. </method>
  46. </methods>
  47. <members>
  48. <member name="text" type="String" setter="set_text" getter="get_text">
  49. </member>
  50. <member name="underline" type="int" setter="set_underline_mode" getter="get_underline_mode" enum="LinkButton.UnderlineMode">
  51. </member>
  52. </members>
  53. <constants>
  54. <constant name="UNDERLINE_MODE_ALWAYS" value="0">
  55. The LinkButton will always show an underline at the bottom of its text
  56. </constant>
  57. <constant name="UNDERLINE_MODE_ON_HOVER" value="1">
  58. The LinkButton will show an underline at the bottom of its text when the mouse cursor is over it.
  59. </constant>
  60. <constant name="UNDERLINE_MODE_NEVER" value="2">
  61. The LinkButton will never show an underline at the bottom of its text.
  62. </constant>
  63. </constants>
  64. <theme_items>
  65. <theme_item name="font" type="Font">
  66. </theme_item>
  67. <theme_item name="font_color" type="Color">
  68. </theme_item>
  69. <theme_item name="font_color_hover" type="Color">
  70. </theme_item>
  71. <theme_item name="font_color_pressed" type="Color">
  72. </theme_item>
  73. <theme_item name="underline_spacing" type="int">
  74. </theme_item>
  75. </theme_items>
  76. </class>