gtkmm-documentation r32 - in trunk: . docs/tutorial

[murrayc svn gnome org]

Author: murrayc
Date: Mon Feb  4 20:44:54 2008
New Revision: 32
URL: http://svn.gnome.org/viewvc/gtkmm-documentation?rev=32&view=rev

Log:
2008-02-04  Murray Cumming  <murrayc murrayc com>

* docs/tutorial/gtkmm-tut.xml: gmmproc section: Document _CLASS_INTERFACE(), 
including documenting the new optional parameters.

Modified:
   trunk/ChangeLog
   trunk/docs/tutorial/gtkmm-tut.xml

Modified: trunk/docs/tutorial/gtkmm-tut.xml
==============================================================================
--- trunk/docs/tutorial/gtkmm-tut.xml	(original)
+++ trunk/docs/tutorial/gtkmm-tut.xml	Mon Feb  4 20:44:54 2008
@@ -8959,6 +8959,28 @@
 </para>
 </sect3>
 
+<sect3 id="gmmproc-class-interface">
+<title>_CLASS_INTERFACE</title>
+<para>This macro declares a wrapper for a type that is derived from
+    <classname>GObject</classname>, but which is not derived from
+    <classname>GtkObject</classname>.
+</para>
+<para><function>_CLASS_INTERFACE( C++ class, C class, C casting macro, C interface struct, Base C++ class (optional), Base C class (optional) )</function></para>
+<para>
+For instance, from <filename>celleditable.hg</filename>:
+<programlisting>
+  _CLASS_INTERFACE(CellEditable, GtkCellEditable, GTK_CELL_EDITABLE, GtkCellEditableIface)
+</programlisting>
+</para>
+<para>Two extra parameters are optional, for the case that the interface derives from another interface, 
+which should be the case when the GInterface has another GInterface as a prerequisitite. 
+For instance, from <filename>loadableicon.hg</filename>:
+<programlisting>
+  _CLASS_INTERFACE(LoadableIcon, GLoadableIcon, G_LOADABLE_ICON, GLoadableIconIface, Icon, GIcon)
+</programlisting>
+</para>
+</sect3>
+
 
 </sect2>