cvs: php-gtk-doc /manual/en/reference/gtk gtkmisc.xml

scottmattocks		Thu Oct 12 20:24:19 2006 UTC

  Modified files:              
    /php-gtk-doc/manual/en/reference/gtk	gtkmisc.xml 
  Log:
  GtkMisc documentation.
  
http://cvs.php.net/viewvc.cgi/php-gtk-doc/manual/en/reference/gtk/gtkmisc.xml?r1=1.6&r2=1.7&diff_format=u
Index: php-gtk-doc/manual/en/reference/gtk/gtkmisc.xml
diff -u php-gtk-doc/manual/en/reference/gtk/gtkmisc.xml:1.6 php-gtk-doc/manual/en/reference/gtk/gtkmisc.xml:1.7
--- php-gtk-doc/manual/en/reference/gtk/gtkmisc.xml:1.6	Tue Oct 10 06:44:37 2006
+++ php-gtk-doc/manual/en/reference/gtk/gtkmisc.xml	Thu Oct 12 20:24:19 2006
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.6 $ -->
+<!-- $Revision: 1.7 $ -->
 <classentry id="gtk.gtkmisc">
  <classmeta>
   <classtitle>GtkMisc</classtitle>
@@ -17,15 +17,31 @@
   <method id="gtk.gtkmisc.method.get_alignment">
    <funcsynopsis>
     <funcprototype>
-     <funcdef>void <function>get_alignment</function></funcdef>
+     <funcdef>arary <function>get_alignment</function></funcdef>
      <paramdef>void</paramdef>
     </funcprototype>
    </funcsynopsis>
    <shortdesc>
-
+    Returns an array of alignment values for the widget.
    </shortdesc>
    <desc>
     <para>
+     Returns an array containing the alignment values for the widget within
+     its allocation. The first element of the array is the
+     <literal>x</literal> alignment and the second element is the
+     <literal>y</literal> alignment.
+    </para>
+    <para>
+     Alignment values are represented as a percentage of the parent's height
+     or width. For example, an <literal>x</literal> alignment of
+     <literal>.5</literal> aligns the <literal>50%</literal> of the width from
+     the left of the parent widget. A value of <literal>1</literal> aligns the
+     widget as far to the right as possible.
+    </para>
+    <para>
+     The default for both alignment values is <literal>.5</literal>.
+    </para>
+    <para>
      &seealso;
      <function class="GtkMisc">set_alignment</function>
     </para>
@@ -41,10 +57,16 @@
     </funcprototype>
    </funcsynopsis>
    <shortdesc>
-
+    Returns an array containing the horizontal and vertical padding for
+    the widget.
    </shortdesc>
    <desc>
     <para>
+     Returns an array containing the horizontal and vertical padding for the
+     widget in pixels. The first element of the array is the horizontal
+     padding. The second element is the vertical padding.
+    </para>
+    <para>
      &seealso;
      <function class="GtkMisc">set_padding</function>
     </para>
@@ -61,10 +83,27 @@
     </funcprototype>
    </funcsynopsis>
    <shortdesc>
-
+    Sets the alignment for the widget relative to its parent.
    </shortdesc>
    <desc>
     <para>
+     Sets the alignment for the widget relative to its parent. Both values
+     must be between <literal>0</literal> and <literal>1</literal>, inclusive.
+     A value less than <literal>0</literal> will automatically be changed to
+     <literal>0</literal> and a value greater than <literal>1</literal> will
+     automatically be changed to <literal>1</literal>.
+    </para>
+    <para>
+     Alignment values are represented as a percentage of the parent's height
+     or width. For example, an <literal>x</literal> alignment of
+     <literal>.5</literal> aligns the <literal>50%</literal> of the width from
+     the left of the parent widget. A value of <literal>1</literal> aligns the
+     widget as far to the right as possible.
+    </para>
+    <para>
+     The default for both alignment values is <literal>.5</literal>.
+    </para>
+    <para>
      &seealso;
      <function class="GtkMisc">get_alignment</function>
     </para>
@@ -81,10 +120,18 @@
     </funcprototype>
    </funcsynopsis>
    <shortdesc>
-
+    Sets the horizontal and vertical padding for the widget.
    </shortdesc>
    <desc>
     <para>
+     Sets the horizontal and vertical padding for the widget. The values given
+     will be the padding in pixels surrounding the widget. The values should
+     be integers greater than or equal to <literal>0</literal>. Values less
+     than <literal>0</literal> will be automatically changed to
+     <literal>0</literal>. If the value is not an integer it will
+     automatically be rounded down to the nearest integer.
+    </para>
+    <para>
      &seealso;
      <function class="GtkMisc">get_padding</function>
     </para>
@@ -95,3 +142,22 @@
  </methods>
 
 </classentry>
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->