summaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
authorDave Davenport <qball@gmpclient.org>2018-06-12 12:00:00 +0200
committerDave Davenport <qball@gmpclient.org>2018-06-12 12:00:00 +0200
commitb8592f8b99c25dcdd1f3b5ef2f00412c29b4bc73 (patch)
treed65584a430b377fcefd1eb722acc1645a9da2569 /include
parentb837c3fdffa74b7524db22bbbb03da2c87a13d3f (diff)
Documentation updates.
* theme, * view, * textbox * helper
Diffstat (limited to 'include')
-rw-r--r--include/theme.h9
-rw-r--r--include/view-internal.h4
-rw-r--r--include/widgets/textbox.h7
3 files changed, 20 insertions, 0 deletions
diff --git a/include/theme.h b/include/theme.h
index feb6d06b..7d98eeec 100644
--- a/include/theme.h
+++ b/include/theme.h
@@ -280,6 +280,15 @@ ThemeWidget *rofi_theme_find_widget ( const char *name, const char *state, gbool
*/
Property *rofi_theme_find_property ( ThemeWidget *widget, PropertyType type, const char *property, gboolean exact );
+/**
+ * @param widget The widget to query
+ * @param property The property to query.
+ * @param pad The default value.
+ *
+ * Obtain list of elements (strings) of the widget.
+ *
+ * @returns a GList holding the names in the list of this property for this widget.
+ */
GList *rofi_theme_get_list ( const widget *widget, const char * property, const char *defaults );
/**
* Checks if a theme is set, or is empty.
diff --git a/include/view-internal.h b/include/view-internal.h
index 9bf84b5e..a00bd147 100644
--- a/include/view-internal.h
+++ b/include/view-internal.h
@@ -119,10 +119,14 @@ struct RofiViewState
/** Y position of the view */
int y;
+ /** Position and target of the mouse. */
struct
{
+ /** X position */
int x;
+ /** Y position */
int y;
+ /** Widget being targetted. */
widget *motion_target;
} mouse;
diff --git a/include/widgets/textbox.h b/include/widgets/textbox.h
index 0eb1feb7..a592bfde 100644
--- a/include/widgets/textbox.h
+++ b/include/widgets/textbox.h
@@ -319,6 +319,13 @@ PangoAttrList *textbox_get_pango_attributes ( textbox *tb );
* @returns the visible text.
*/
const char *textbox_get_visible_text ( const textbox *tb );
+/**
+ * @param wid The handle to the textbox.
+ *
+ * TODO: is this deprecated by widget::get_desired_width
+ *
+ * @returns the desired width of the textbox.
+ */
int textbox_get_desired_width ( widget *wid );
/**