Documented LinkButton

This commit is contained in:
Daniel J. Ramirez 2016-05-03 17:09:42 -05:00
parent 9487a9b3c2
commit f558b4003b

View File

@ -17963,39 +17963,47 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
</class> </class>
<class name="LinkButton" inherits="BaseButton" category="Core"> <class name="LinkButton" inherits="BaseButton" category="Core">
<brief_description> <brief_description>
Simple button used to represent a link to some resource
</brief_description> </brief_description>
<description> <description>
This kind of buttons are primarily used when the interaction with the button causes a context change (like linking to a web page).
</description> </description>
<methods> <methods>
<method name="set_text"> <method name="set_text">
<argument index="0" name="text" type="String"> <argument index="0" name="text" type="String">
</argument> </argument>
<description> <description>
Sets the text of the button.
</description> </description>
</method> </method>
<method name="get_text" qualifiers="const"> <method name="get_text" qualifiers="const">
<return type="String"> <return type="String">
</return> </return>
<description> <description>
Returns the text of the button.
</description> </description>
</method> </method>
<method name="set_underline_mode"> <method name="set_underline_mode">
<argument index="0" name="underline_mode" type="int"> <argument index="0" name="underline_mode" type="int">
</argument> </argument>
<description> <description>
Sets the underline mode for this button, the argument must be one of the [LinkButton] constants (see constants section).
</description> </description>
</method> </method>
<method name="get_underline_mode" qualifiers="const"> <method name="get_underline_mode" qualifiers="const">
<return type="int"> <return type="int">
</return> </return>
<description> <description>
Returns the underline mode for this button.
</description> </description>
</method> </method>
</methods> </methods>
<constants> <constants>
<constant name="UNDERLINE_MODE_ALWAYS" value="0"> <constant name="UNDERLINE_MODE_ALWAYS" value="0">
The LinkButton will always show an underline at the bottom of its text
</constant> </constant>
<constant name="UNDERLINE_MODE_ON_HOVER" value="1"> <constant name="UNDERLINE_MODE_ON_HOVER" value="1">
The LinkButton will show an underline at the bottom of its text when the mouse cursor is over it.
</constant> </constant>
</constants> </constants>
<theme_items> <theme_items>