summaryrefslogtreecommitdiff
path: root/client/widgets/lineedit.h
diff options
context:
space:
mode:
Diffstat (limited to 'client/widgets/lineedit.h')
-rw-r--r--client/widgets/lineedit.h18
1 files changed, 13 insertions, 5 deletions
diff --git a/client/widgets/lineedit.h b/client/widgets/lineedit.h
index 5dbdc6b..650924c 100644
--- a/client/widgets/lineedit.h
+++ b/client/widgets/lineedit.h
@@ -36,9 +36,9 @@
* @tag lineedit
* @extends widget
* @screenshot
- * The lineedit tag is used to insert a lineedit into the macro. It is used to
- * gather textual input from the user, who using the keyboard will be able to
- * express him or herself in plaintext.
+ * The lineedit is a single line textual input field.
+ * @att readonly Make the lineedit readonly (not changeable by the user), but
+ * still able to select and copy text.
*/
class QLineEdit;
@@ -74,12 +74,20 @@ private:
QStringList suggestions;
};
+/***
+ * @method nil clearSuggestions()
+ * This method clears the suggestion list.
+ */
int lin_clear_suggestions(lua_State *L);
+/***
+ * @method nil showSuggestions()
+ * This method forces showing of the suggestion list.
+ */
int lin_show_suggestions(lua_State *L);
/***
- * @method isSuggested(value)
+ * @method boolean isSuggested(string value, boolean joker)
* This method makes a lookup in the suggestion list, searching for value.
* @param value A string containing the text to look for in the suggestion list.
* @return a boolean with the value true if the string was found, false
@@ -88,7 +96,7 @@ int lin_show_suggestions(lua_State *L);
int lin_is_suggested(lua_State *L);
/***
- * @method addSuggestion(suggestion)
+ * @method nil addSuggestion(string suggestion)
* Adds a suggestion to the suggestion list. The list is popped up each time
* a character is entered into the lineedit by the user, or it is explicitly
* opened by calling @ref showSuggestions().