cvs: php-gtk /docs/en/classes gtkobject.xml

jmoore Wed Mar 14 12:51:23 2001 EDT Modified files: /php-gtk/docs/en/classes gtkobject.xml Log: Begining for outline of object documentation.. This is not complete or necessaryly accurate/correct its just there to work with for now. Index: php-gtk/docs/en/classes/gtkobject.xml diff -u php-gtk/docs/en/classes/gtkobject.xml:1.2 php-gtk/docs/en/classes/gtkobject.xml:1.3 --- php-gtk/docs/en/classes/gtkobject.xml:1.2 Mon Mar 12 10:57:45 2001 +++ php-gtk/docs/en/classes/gtkobject.xml Wed Mar 14 12:51:22 2001 @@ -1,117 +1,47 @@ -<refentry id="gtk.gtkobject"> - <refnamediv> - <refname>GtkObject</refname> - <refpurpose>Base Class of the GTK+ hierarchy</refpurpose> - </refnamediv> - - <refsect1 id="gtk.gtkobject.synopsis"> - <title>Synopsis</title> - - <refsect2 id="gtk.gtkobject.synopsis.name"> - <title>Name</title> - <simpara> - GtkObject - </simpara> - </refsect2> - - <refsect2 id="gtk.gtkobject.synopsis.desc"> - <title>Brief Description</title> - <simpara> - This is the base class of the GTK+ hierarchy. - It is not directly accessible from PHP-GTK. - </simpara> - </refsect2> - - <refsect2 id="gtk.gtkobject.synopsis.hierachy"> - <title>Object Hierarchy</title> - <para> - <literallayout> -GtkObject - </literallayout> - </para> - </refsect2> - - <refsect2 id="gtk.gtkobject.synopsis.object"> - <title>Object Properties and Methods</title> - - <refsect3 id="gtk.gtkobject.synopsis.object.constructor"> - <title>Constructor</title> - <simpara> - None - Not Directly Accessible. - </simpara> - </refsect3> - - <refsect3 id="gtk.gtkobject.synopsis.object.methods"> - <title>Methods</title> - <para> - None - Need to check which are available in php-gtk. - </para> - </refsect3> - - <refsect3 id="gtk.gtkobject.synopsis.object.properties"> - <title>Properties</title> - <para> - None - Need to check which are available in php-gtk - </para> - </refsect3> - - <refsect3 id="gtk.gtkobject.synopsis.object.signals"> - <title>Signals</title> - <para> - <table frame="none"> - <title>GtkObject Signals</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Signal Name</entry> - <entry>Called When</entry> - </row> - </thead> - <tbody> - <row> - <entry>Destroy</entry> - <entry>When an item is destroyed</entry> - </row> - </tbody> - </tgroup> - </table> - </para> - </refsect3> - </refsect2> - </refsect1> - - <refsect1 id="gtk.gtkobject.description"> - <title>Detailed Description</title> - <simpara> - GtkObject is the base class of the whole of the gtk+ hierarchy. - This object's functionality is present in any gtk object. - It is not directly accessible from php-gtk but is - documented for reference purposes. - </simpara> - </refsect1> - - <refsect1 id="gtk.gtkobject.methods"> - <title>Methods</title> - <para> - None at present. - </para> - </refsect1> - - <refsect1 id="gtk.gtkobject.properties"> - <title>Properties</title> - <para> - None at present. - </para> - </refsect1> - - <refsect1 id="gtk.gtkobject.signals"> - <title>Signals</title> - <refsect2 id="gtk.gtkobject.signals.destroy"> - <title>Destory</title> - <simpara> - This signal is sent when an object is destroyed. - </simpara> - </refsect2> - </refsect1> - -</refentry> +<classentry id="gtk.gtkobject"> + <classmeta> + <classtitle>GtkObject</classtitle> + <shortdesc>Base object of GTK hierachy</shortdesc> + <desc> + This object is the object that all other objects + in the GTK hierachy are drived from. This object + is not directly accessible from PHP but is included + here for documentation perpourses + </desc> + </classmeta> + <methods> + <method> + <funcsynopsis> + <funcprototype> + <funcdef> + int <function>user_signal_new</function> + </funcdef> + <paramdef>char <parameter>name</parameter></paramdef> + <paramdef>resource <parameter>signal_flags</parameter></paramdef> + <paramdef>resource <parameter>marshaller</parameter></paramdef> + <paramdef>resource <parameter>return_value</parameter></paramdef> + <paramdef>int <parameter>nparams</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <shortdesc> + Define a signal handler for a new siganl on an already defined object + </shortdesc> + <desc> + Define a signal handler for a new signal on an already defined object. + See signal documentation for more general information. + </desc> + </method> + </methods> + <signals> + <signal> + <signalname>destroy</signalname> + <firedwhen>when an object is destoryed</firedwhen> + <shortdesc>Indicates that an object is being destroyed</shortdesc> + <desc> + This signal is fired when an object is destroyed. See the + signals documentation for information on how to use this + signal. + </desc> + </signal> + </signals> +</classentry>