summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel J. Ramirez <djrmuv@gmail.com>2016-05-03 17:09:42 -0500
committerDaniel J. Ramirez <djrmuv@gmail.com>2016-05-05 11:23:25 -0500
commitf558b4003b010a81884b95eea37470da1cffa38c (patch)
tree9fe60b0102a65c2968b514ce8b49b62f0751e55b
parent9487a9b3c25f23942561eba20edce24f4be6f148 (diff)
Documented LinkButton
-rw-r--r--doc/base/classes.xml8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml
index cba5425d3f..affe73c222 100644
--- a/doc/base/classes.xml
+++ b/doc/base/classes.xml
@@ -17963,39 +17963,47 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
</class>
<class name="LinkButton" inherits="BaseButton" category="Core">
<brief_description>
+ Simple button used to represent a link to some resource
</brief_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>
<methods>
<method name="set_text">
<argument index="0" name="text" type="String">
</argument>
<description>
+ Sets the text of the button.
</description>
</method>
<method name="get_text" qualifiers="const">
<return type="String">
</return>
<description>
+ Returns the text of the button.
</description>
</method>
<method name="set_underline_mode">
<argument index="0" name="underline_mode" type="int">
</argument>
<description>
+ Sets the underline mode for this button, the argument must be one of the [LinkButton] constants (see constants section).
</description>
</method>
<method name="get_underline_mode" qualifiers="const">
<return type="int">
</return>
<description>
+ Returns the underline mode for this button.
</description>
</method>
</methods>
<constants>
<constant name="UNDERLINE_MODE_ALWAYS" value="0">
+ The LinkButton will always show an underline at the bottom of its text
</constant>
<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>
</constants>
<theme_items>