summaryrefslogtreecommitdiff
path: root/gtk/gtkeditable.c
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2021-08-31 08:41:45 -0400
committerMatthias Clasen <mclasen@redhat.com>2021-08-31 08:41:45 -0400
commitfa57b006c9a76dd549571a2f2369717b5fc08812 (patch)
tree317ffbe4bf636a2f9abb86a68734c062f65a116e /gtk/gtkeditable.c
parenta4f067481c53e9eef5172f39fcf5addcf6640bed (diff)
downloadgtk+-fa57b006c9a76dd549571a2f2369717b5fc08812.tar.gz
editable: Clarify the docs
Make it clear that your class must have all the editable properties already before you call the (confusingly named) function gtk_editable_install_properties.
Diffstat (limited to 'gtk/gtkeditable.c')
-rw-r--r--gtk/gtkeditable.c6
1 files changed, 5 insertions, 1 deletions
diff --git a/gtk/gtkeditable.c b/gtk/gtkeditable.c
index c8386afe21..a9517e1c1e 100644
--- a/gtk/gtkeditable.c
+++ b/gtk/gtkeditable.c
@@ -945,11 +945,15 @@ gtk_editable_set_enable_undo (GtkEditable *editable,
* @object_class: a `GObjectClass`
* @first_prop: property ID to use for the first property
*
- * Installs the `GtkEditable` properties for @class.
+ * Overrides the `GtkEditable` properties for @class.
*
* This is a helper function that should be called in class_init,
* after installing your own properties.
*
+ * Note that your class must have "text", "cursor-position",
+ * "selection-bound", "editable", "width-chars", "max-width-chars",
+ * "xalign" and "enable-undo" properties for this function to work.
+ *
* To handle the properties in your set_property and get_property
* functions, you can either use [func@Gtk.Editable.delegate_set_property]
* and [func@Gtk.Editable.delegate_get_property] (if you are using