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.
This commit is contained in:
Matthias Clasen 2021-08-31 08:41:45 -04:00
parent a4f067481c
commit fa57b006c9

View File

@ -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