[prev in list] [next in list] [prev in thread] [next in thread] 

List:       pear-doc
Subject:    [PEAR-DOC] cvs: peardoc /en/package/gtk2 vardump.xml  /en/package/gtk2/vardump reusing.xml
From:       "Christian Weiske" <cweiske () php ! net>
Date:       2006-10-27 16:47:53
Message-ID: cvscweiske1161967673 () cvsserver
[Download RAW message or body]

cweiske		Fri Oct 27 16:47:53 2006 UTC

  Added files:                 
    /peardoc/en/package/gtk2/vardump	reusing.xml 

  Modified files:              
    /peardoc/en/package/gtk2	vardump.xml 
  Log:
  Extending Gtk2_VarDump docs with
  chapter about re-using the classes
  
  
http://cvs.php.net/viewvc.cgi/peardoc/en/package/gtk2/vardump.xml?r1=1.3&r2=1.4&diff_format=u
Index: peardoc/en/package/gtk2/vardump.xml
diff -u peardoc/en/package/gtk2/vardump.xml:1.3 peardoc/en/package/gtk2/vardump.xml:1.4
--- peardoc/en/package/gtk2/vardump.xml:1.3	Mon Aug 28 07:49:39 2006
+++ peardoc/en/package/gtk2/vardump.xml	Fri Oct 27 16:47:53 2006
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
 
 <sect1 id="package.gtk2.vardump">
  <title>Gtk2_VarDump</title>
@@ -10,6 +10,7 @@
  </para>
 
  &package.gtk2.vardump.intro;
+ &package.gtk2.vardump.reusing;
 
 </sect1>
 

http://cvs.php.net/viewvc.cgi/peardoc/en/package/gtk2/vardump/reusing.xml?view=markup&rev=1.1
Index: peardoc/en/package/gtk2/vardump/reusing.xml
+++ peardoc/en/package/gtk2/vardump/reusing.xml
<?xml version="1.0" encoding="iso-8859-1" ?>
<!-- $Revision: 1.1 $ -->

<refentry id="package.gtk2.vardump.reusing">
 <refnamediv>
  <refname>Re-using Gtk2_VarDump</refname>
  <refpurpose>Embedding it in own applications</refpurpose>
 </refnamediv>
 <refsect1>
  <title>Re-using Gtk2_VarDump</title>
  <para>
   Gtk2_VarDump consists of two main parts: A tree on the left,
   displaying the structure of the variable-to-dump, and a list
   on the right side, showing the keys and their values.
   They are arranged on a pane, which itself is contained in the
   main window.
  </para>
  <para>
   Now you might want to dump some variables yourself, but integrate
   this display directly into your own application - without opening
   a new window for that. Gtk2_VarDump is prepared for that; you can
   re-use the existing classes.
  </para>

  <refsect2>
   <title>Gtk2_VarDump_Pane</title>
   <para>
    <classname>Gtk2_VarDump_Pane</classname> is the container for
    both tree and list. You can use instantiate it, add it to your
    interface and call the
    <function>setVariable</function> method
    to display the contents of the variable. The method takes the variable
    as first parameter, and a user-definable title as optional second
    parameter.
   </para>
  </refsect2>

  <refsect2>
   <title>Gtk2_VarDump_Tree</title>
   <para>
    <classname>Gtk2_VarDump_Tree</classname> is an descendant of
    <classname>GtkTreeView</classname>, and as usual without any
    scrollbars. Remember to add it to a
    <classname>GtkScrolledWindow</classname>.
    The class has, as <classname>Gtk2_VarDump_Pane</classname> does,
    a <function>setVariable</function>
    method that takes the variable to be displayed and an optional
    title that is used for the root element.
   </para>
   <para>
    The tree has another method: <function>setList</function> is used
    to set the list widget that shall display the values.
    Be sure that the list widget also provides a
    <function>setVariable</function> method. Whenever the selection
    in the tree changes, the list's <function>setVariable</function>
    method is called.
   </para>
  </refsect2>

  <refsect2>
   <title>Gtk2_VarDump_List</title>
   <para>
    <classname>Gtk2_VarDump_List</classname> is a descendant of
    <classname>GtkTreeView</classname> and simply displays plain
    key-value pairs. It has, like the other two classes, a
    <function>setVariable</function>
    method that takes the variable to display as first parameter,
    and an optional title as second parameter.
   </para>
  </refsect2>

 </refsect1>
</refentry>

-- 
PEAR Documentation List Mailing List (http://pear.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php

[prev in list] [next in list] [prev in thread] [next in thread]