Skip to content
This repository has been archived by the owner on Nov 17, 2020. It is now read-only.

Commit

Permalink
Document g_type_class_peek_static.
Browse files Browse the repository at this point in the history
Sat Jan 10 01:36:01 2004  Matthias Clasen  <maclas@gmx.de>

	* gobject/tmpl/gtype.sgml: Document g_type_class_peek_static.

Sat Jan 10 01:23:58 2004  Matthias Clasen  <maclas@gmx.de>

	* gobject/gobject-sections.txt: Add g_type_class_peek_static,
	G_DEFINE_TYPE, G_DEFINE_TYPE_WITH_CODE, G_DEFINE_ABSTRACT_TYPE,
	G_DEFINE_ABSTRACT_TYPE_WITH_CODE, G_IMPLEMENT_INTERFACE.


Sat Jan 10 01:23:01 2004  Matthias Clasen  <maclas@gmx.de>

	* gobject/tmpl/objects.sgml: Update docs of g_object_connect.

Fri Jan  9 23:40:23 2004  Matthias Clasen  <maclas@gmx.de>

	* gobject/tmpl/gboxed.sgml:
	* gobject/gobject-sections.txt: Add G_TYPE_STRV and GStrv.
  • Loading branch information
Matthias Clasen authored and Matthias Clasen committed Jan 10, 2004
1 parent b4f769e commit f05c39a
Show file tree
Hide file tree
Showing 5 changed files with 107 additions and 12 deletions.
15 changes: 15 additions & 0 deletions docs/reference/ChangeLog
@@ -1,3 +1,18 @@
Sat Jan 10 01:36:01 2004 Matthias Clasen <maclas@gmx.de>

* gobject/tmpl/gtype.sgml: Document g_type_class_peek_static.

Sat Jan 10 01:23:58 2004 Matthias Clasen <maclas@gmx.de>

* gobject/gobject-sections.txt: Add g_type_class_peek_static,
G_DEFINE_TYPE, G_DEFINE_TYPE_WITH_CODE, G_DEFINE_ABSTRACT_TYPE,
G_DEFINE_ABSTRACT_TYPE_WITH_CODE, G_IMPLEMENT_INTERFACE.


Sat Jan 10 01:23:01 2004 Matthias Clasen <maclas@gmx.de>

* gobject/tmpl/objects.sgml: Update docs of g_object_connect.

Fri Jan 9 23:40:23 2004 Matthias Clasen <maclas@gmx.de>

* gobject/tmpl/gboxed.sgml:
Expand Down
9 changes: 8 additions & 1 deletion docs/reference/gobject/gobject-sections.txt
Expand Up @@ -24,7 +24,6 @@ GTypeInfo
GTypeFundamentalInfo
GInterfaceInfo
GTypeValueTable
<TITLE>GType</TITLE>
G_TYPE_FROM_INSTANCE
G_TYPE_FROM_CLASS
G_TYPE_FROM_INTERFACE
Expand All @@ -51,6 +50,7 @@ g_type_next_base
g_type_is_a
g_type_class_ref
g_type_class_peek
g_type_class_peek_static
g_type_class_unref
g_type_class_peek_parent
g_type_class_add_private
Expand Down Expand Up @@ -95,6 +95,12 @@ g_type_add_interface_check
g_type_remove_interface_check
GTypeInterfaceCheckFunc
g_type_value_table_peek

G_DEFINE_TYPE
G_DEFINE_TYPE_WITH_CODE
G_DEFINE_ABSTRACT_TYPE
G_DEFINE_ABSTRACT_TYPE_WITH_CODE
G_IMPLEMENT_INTERFACE
<SUBSECTION Private>
G_TYPE_FUNDAMENTAL_SHIFT
g_type_check_instance
Expand All @@ -109,6 +115,7 @@ g_type_instance_get_private
g_type_test_flags
g_type_name_from_instance
g_type_name_from_class
G_DEFINE_TYPE_INTERNAL

<SUBSECTION>
G_TYPE_INVALID
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/gobject/tmpl/gboxed.sgml
Expand Up @@ -113,8 +113,10 @@ g_strfreev (writers);

@Since: 2.4


<!-- ##### TYPEDEF GStrv ##### -->
<para>
A C representable type name for #G_TYPE_STRV.
</para>


64 changes: 64 additions & 0 deletions docs/reference/gobject/tmpl/gtype.sgml
Expand Up @@ -730,6 +730,18 @@ exist (hasn't been referenced before).
if the class does not currently exist.


<!-- ##### FUNCTION g_type_class_peek_static ##### -->
<para>
A more efficient version of g_type_class_peek() which works only for
static types.
</para>

@type: Type ID of a classed type.
@Returns: The #GTypeClass structure for the given type ID or %NULL
if the class does not currently exist or is dynamically loaded.
@Since: 2.4


<!-- ##### FUNCTION g_type_class_unref ##### -->
<para>
Decrements the reference count of the class structure being passed in.
Expand Down Expand Up @@ -1448,6 +1460,58 @@ that implements or has internal knowledge of the implementation of
%NULL if there is no #GTypeValueTable associated with @type.


<!-- ##### MACRO G_DEFINE_TYPE ##### -->
<para>
A convenience macro for type implementations.
</para>

@TypeName: The name of the new type, in Camel case.
@type_name: The name of the new type, in lowercase, with words
separated by '_'.
@TYPE_PARENT: The #GType of the parent type.


<!-- ##### MACRO G_DEFINE_TYPE_WITH_CODE ##### -->
<para>

</para>

@TN:
@t_n:
@T_P:
@_C_:


<!-- ##### MACRO G_DEFINE_ABSTRACT_TYPE ##### -->
<para>

</para>

@TN:
@t_n:
@T_P:


<!-- ##### MACRO G_DEFINE_ABSTRACT_TYPE_WITH_CODE ##### -->
<para>

</para>

@TN:
@t_n:
@T_P:
@_C_:


<!-- ##### MACRO G_IMPLEMENT_INTERFACE ##### -->
<para>

</para>

@TYPE_IFACE:
@iface_init:


<!-- ##### MACRO G_TYPE_INVALID ##### -->
<para>
An invalid #GType, used as error return value in some functions which return
Expand Down
29 changes: 18 additions & 11 deletions docs/reference/gobject/tmpl/objects.sgml
Expand Up @@ -21,6 +21,17 @@ to the #GObject implementation and should never be accessed directly.
</para>


<!-- ##### SIGNAL GObject::notify ##### -->
<para>
The notify signal is emitted on an object when one of its properties
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
the setter for the property is called to reinstate the previous value.
</para>

@gobject: the object which received the signal.
@pspec: the #GParamSpec of the property which changed

<!-- ##### STRUCT GObjectClass ##### -->
<para>
The class structure for the <structname>GObject</structname> type.
Expand Down Expand Up @@ -437,42 +448,49 @@ equivalent to <literal>g_signal_connect_data (...)</literal>
</varlistentry>
<varlistentry>
<term>object_signal</term>
<term>object-signal</term>
<listitem><para>
equivalent to <literal>g_signal_connect_object (...)</literal>
</para></listitem>
</varlistentry>
<varlistentry>
<term>swapped_signal</term>
<term>swapped-signal</term>
<listitem><para>
equivalent to <literal>g_signal_connect_data (..., G_CONNECT_SWAPPED)</literal>
</para></listitem>
</varlistentry>
<varlistentry>
<term>swapped_object_signal</term>
<term>swapped-object-signal</term>
<listitem><para>
equivalent to <literal>g_signal_connect_object (..., G_CONNECT_SWAPPED)</literal>
</para></listitem>
</varlistentry>
<varlistentry>
<term>signal_after</term>
<term>signal-after</term>
<listitem><para>
equivalent to <literal>g_signal_connect_data (..., G_CONNECT_AFTER)</literal>
</para></listitem>
</varlistentry>
<varlistentry>
<term>object_signal_after</term>
<term>object-signal-after</term>
<listitem><para>
equivalent to <literal>g_signal_connect_object (..., G_CONNECT_AFTER)</literal>
</para></listitem>
</varlistentry>
<varlistentry>
<term>swapped_signal_after</term>
<term>swapped-signal-after</term>
<listitem><para>
equivalent to <literal>g_signal_connect_data (..., G_CONNECT_SWAPPED | G_CONNECT_AFTER)</literal>
</para></listitem>
</varlistentry>
<varlistentry>
<term>swapped_object_signal_after</term>
<term>swapped-object-signal-after</term>
<listitem><para>
equivalent to <literal>g_signal_connect_object (..., G_CONNECT_SWAPPED | G_CONNECT_AFTER)</literal>
</para></listitem>
Expand Down Expand Up @@ -848,14 +866,3 @@ properties in set_property() and get_property() implementations.
@pspec: the #GParamSpec of the property


<!-- ##### SIGNAL GObject::notify ##### -->
<para>
The notify signal is emitted on an object when one of its properties
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
the setter for the property is called to reinstate the previous value.
</para>

@gobject: the object which received the signal.
@pspec: the #GParamSpec of the property which changed

0 comments on commit f05c39a

Please sign in to comment.