luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-02-27 12:42:10 +01:00
Code Issues Packages Projects Releases Wiki Activity

Expand GObject::notify documentation. (#381722, Nickolay V. Shmyrev)

Browse Source 
2006-12-17  Matthias Clasen  <mclasen@redhat.com>

        * gobject/tmpl/objects.sgml: Expand GObject::notify
        documentation.  (#381722, Nickolay V. Shmyrev)

        * gobject/tmpl/gparamspec.sgml: Add canonical-parameter-name id.
This commit is contained in:
Matthias Clasen 2006-12-17 19:59:02 +00:00 committed by Matthias Clasen
parent acd7325895
commit fdfc2fc6fc
3 changed files with 23 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/reference/ChangeLog
View File

@ -1,3 +1,10 @@
2006-12-17 Matthias Clasen <mclasen@redhat.com>
* gobject/tmpl/objects.sgml: Expand GObject::notify
documentation. (#381722, Nickolay V. Shmyrev)
* gobject/tmpl/gparamspec.sgml: Add canonical-parameter-name id.
2006-12-15 Matthias Clasen <mclasen@redhat.com> 2006-12-15 Matthias Clasen <mclasen@redhat.com>
* glib/glib-docs.sgml: Add a "Since 2.14" section. * glib/glib-docs.sgml: Add a "Since 2.14" section.

4
docs/reference/gobject/tmpl/gparamspec.sgml
View File

@ -9,10 +9,12 @@ Metadata for parameter specifications
#GParamSpec is an object structure that encapsulates the metadata #GParamSpec is an object structure that encapsulates the metadata
required to specify parameters, such as e.g. #GObject properties. required to specify parameters, such as e.g. #GObject properties.
</para> </para>
<para> <para id="canonical-parameter-name">
Parameter names need to start with a letter (a-z or A-Z). Subsequent Parameter names need to start with a letter (a-z or A-Z). Subsequent
characters can be letters, numbers or a '-'. characters can be letters, numbers or a '-'.
All other characters are replaced by a '-' during construction. All other characters are replaced by a '-' during construction.
The result of this replacement is called the canonical name of the
parameter.
</para> </para>
<!-- ##### SECTION See_Also ##### --> <!-- ##### SECTION See_Also ##### -->

13
docs/reference/gobject/tmpl/objects.sgml
View File

@ -85,6 +85,19 @@ has been changed. Note that getting this signal doesn't guarantee that the
value of the property has actually changed, it may also be emitted when value of the property has actually changed, it may also be emitted when
the setter for the property is called to reinstate the previous value. the setter for the property is called to reinstate the previous value.
</para> </para>
<para>
This signal is typically used to obtain change notification for a
single property, by specifying the property name as a detail in the
g_signal_connect() call, like this:
<informalexample><programlisting>
g_signal_connect (text_view->buffer, "notify::paste-target-list",
G_CALLBACK (gtk_text_view_target_list_notify),
text_view)
</programlisting></informalexample>
It is important to note that you must use
<link linkend="canonical-parameter-name">canonical</link> parameter names as
detail strings for the notify signal.
</para>
@pspec: the #GParamSpec of the property which changed @pspec: the #GParamSpec of the property which changed
@gobject: the object which received the signal. @gobject: the object which received the signal.