diff options
Diffstat (limited to 'docs/reference/pygtk-gtkaspectframe.xml')
| -rw-r--r-- | docs/reference/pygtk-gtkaspectframe.xml | 293 |
1 files changed, 0 insertions, 293 deletions
diff --git a/docs/reference/pygtk-gtkaspectframe.xml b/docs/reference/pygtk-gtkaspectframe.xml deleted file mode 100644 index d5975a0a..00000000 --- a/docs/reference/pygtk-gtkaspectframe.xml +++ /dev/null @@ -1,293 +0,0 @@ -<?xml version="1.0" standalone="no"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> - -<refentry id="class-gtkaspectframe"> - <refnamediv> - <refname>gtk.AspectFrame</refname> - <refpurpose>A frame that constrains its child to a particular aspect -ratio.</refpurpose> - </refnamediv> - - <refsect1> - <title>Synopsis</title> - - <classsynopsis language="python"> - <ooclass><classname>gtk.AspectFrame</classname></ooclass> - <ooclass><classname><link -linkend="class-gtkframe">gtk.Frame</link></classname></ooclass> - <constructorsynopsis language="python"> - <methodname><link linkend="constructor-gtkaspectframe">gtk.AspectFrame</link></methodname> - <methodparam><parameter - role="keyword">label</parameter><initializer>None</initializer></methodparam> - <methodparam><parameter - role="keyword">xalign</parameter><initializer>0.5</initializer></methodparam> - <methodparam><parameter - role="keyword">yalign</parameter><initializer>0.5</initializer></methodparam> - <methodparam><parameter - role="keyword">ratio</parameter><initializer>1.0</initializer></methodparam> - <methodparam><parameter - role="keyword">obey_child</parameter><initializer>True</initializer></methodparam> - </constructorsynopsis> - <methodsynopsis language="python"> - <methodname><link -linkend="method-gtkaspectframe--set">set</link></methodname> - <methodparam><parameter - role="keyword">xalign</parameter><initializer>0.0</initializer></methodparam> - <methodparam><parameter - role="keyword">yalign</parameter><initializer>0.0</initializer></methodparam> - <methodparam><parameter - role="keyword">ratio</parameter><initializer>1.0</initializer></methodparam> - <methodparam><parameter - role="keyword">obey_child</parameter><initializer>True</initializer></methodparam> - </methodsynopsis> - </classsynopsis> - - </refsect1> - - <refsect1> - <title>Ancestry</title> - -<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link> - +-- <link linkend="class-gtkobject">gtk.Object</link> - +-- <link linkend="class-gtkwidget">gtk.Widget</link> - +-- <link linkend="class-gtkcontainer">gtk.Container</link> - +-- <link linkend="class-gtkbin">gtk.Bin</link> - +-- <link linkend="class-gtkframe">gtk.Frame</link> - +-- <link linkend="class-gtkaspectframe">gtk.AspectFrame</link> -</synopsis> - - </refsect1> - - <refsect1 id="properties-gtkaspectframe"> - <title>gtk.AspectFrame Properties</title> - - <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para> - <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para> - <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para> - <para><link linkend="properties-gtkframe">gtk.Frame Properties</link></para> - <blockquote role="properties"> - <informaltable pgwide="1" frame="none"> - <tgroup cols="3"> - <colspec column="1" colwidth="1in"/> - <colspec column="2" colwidth="1in"/> - <colspec column="3" colwidth="4.5in"/> - <tbody> - - <row valign="top"> - <entry>"obey-child"</entry> - <entry>Read/Write</entry> - <entry>Make aspect ratio match that of the child widget</entry> - </row> - - <row valign="top"> - <entry>"xalign"</entry> - <entry>Read/Write</entry> - <entry>The fraction of horizontal <emphasis>free</emphasis> space - to the left of the child. 0.0 means no <emphasis>free</emphasis> - space to the left, 1.0 means all <emphasis>free</emphasis> space - to the left.</entry> - </row> - - <row valign="top"> - <entry>"ratio"</entry> - <entry>Read/Write</entry> - <entry>The aspect ratio of the widget in the range of 0.0001 to - 10000.0 if "obey-child" is <literal>False</literal>.</entry> - </row> - - <row valign="top"> - <entry>"yalign"</entry> - <entry>Read/Write</entry> - <entry>The fraction of vertical <emphasis>free</emphasis> space - above the child. 0.0 means no <emphasis>free</emphasis> space - above, 1.0 means all <emphasis>free</emphasis> space - above.</entry> - </row> - - </tbody> - </tgroup> - </informaltable> - </blockquote> - - </refsect1> - - <refsect1 id="style-properties-gtkaspectframe"> - <title>gtk.AspectFrame Style Properties</title> - - <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> - - - </refsect1> - - <refsect1 id="signal-prototypes-gtkaspectframe"> - <title>gtk.AspectFrame Signal Prototypes</title> - - <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> - <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para> - <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para> - <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para> -</refsect1> - - <refsect1> - <title>Description</title> - - <para>The <link -linkend="class-gtkaspectframe"><classname>gtk.AspectFrame</classname></link> -packs a widget so that it can resize but always retains the same aspect -ratio. For instance, one might be drawing a small preview of a larger image. -<link -linkend="class-gtkaspectframe"><classname>gtk.AspectFrame</classname></link> -derives from <link -linkend="class-gtkframe"><classname>gtk.Frame</classname></link>, so it can -draw a label and a frame around the child. The frame will be -"shrink-wrapped" to the size of the child.</para> - - <para>The aspect frame "ratio" property determines the widget -width:height ratio. An aspect ratio of 0.5 means the width is one half the -height; an aspect ratio of 2.0 means the width is twice the height. The -default value for the "ratio" property is 1.0.</para> - - <para>The align properties are used to place the child widget within the -available area by specifying the fraction of <emphasis>free</emphasis> space -(space in the aspect frame that is not used by the child widget) that is -placed above or to the left of the child widget. The values range from 0.0 -(meaning no <emphasis>free</emphasis> space above or to the left of the -child) to 1.0 (meaning all <emphasis>free</emphasis> space above or to the -left of the child) . The default value for both align properties is -0.5.</para> - - <para>If the "obey-child" property is True (the default value), the -"ratio" property is ignored and the aspect ratio is set by the child -widget.</para> - - </refsect1> - - <refsect1 id="constructor-gtkaspectframe"> - <title>Constructor</title> - - <programlisting><constructorsynopsis language="python"> - <methodname>gtk.AspectFrame</methodname> - <methodparam><parameter - role="keyword">label</parameter><initializer>None</initializer></methodparam> - <methodparam><parameter - role="keyword">xalign</parameter><initializer>0.5</initializer></methodparam> - <methodparam><parameter - role="keyword">yalign</parameter><initializer>0.5</initializer></methodparam> - <methodparam><parameter - role="keyword">ratio</parameter><initializer>1.0</initializer></methodparam> - <methodparam><parameter - role="keyword">obey_child</parameter><initializer>True</initializer></methodparam> - </constructorsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">label</parameter> :</term> - <listitem><simpara>a string used to set the aspect frame -label</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">xalign</parameter> :</term> - <listitem><simpara>The fraction of horizontal -<emphasis>free</emphasis> space to the left of the child. 0.0 means no -<emphasis>free</emphasis> space to the left, 1.0 means all -<emphasis>free</emphasis> space to the left.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">yalign</parameter> :</term> - <listitem><simpara>The fraction of vertical -<emphasis>free</emphasis> space above the child. 0.0 means no -<emphasis>free</emphasis> space above, 1.0 means all -<emphasis>free</emphasis> space above.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">ratio</parameter> :</term> - <listitem><simpara>the ratio of the child width to height (in the -range 0.0001 to 10000.0) if <parameter>obey_child</parameter> is -False</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">obey_child</parameter> :</term> - <listitem><simpara>if True, <parameter>ratio</parameter> is ignored, -and the aspect ratio is taken from the requisition of the -child.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a new aspect frame object</simpara></listitem> - </varlistentry> - </variablelist> - - <para>Creates a new aspect frame object with the specified -<parameter>label</parameter>, <parameter>xalign</parameter> and -<parameter>yalign</parameter> values. The default values are: -<parameter>label</parameter>, None; <parameter>xalign</parameter>, 0.5; and, -<parameter>yalign</parameter>, 0.5. If <parameter>obey_child</parameter> is -True the <parameter>ratio</parameter> value is ignored. If -<parameter>obey_child</parameter> is False, <parameter>ratio</parameter> -sets the aspect ratio for the child widget. The default value for -<parameter>ratio</parameter> is 1.0. The default value for -<parameter>obey_child</parameter> is True.</para> - - </refsect1> - - <refsect1> - <title>Methods</title> - - <refsect2 id="method-gtkaspectframe--set"> - <title>gtk.AspectFrame.set</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set</methodname> - <methodparam><parameter - role="keyword">xalign</parameter><initializer>0.0</initializer></methodparam> - <methodparam><parameter - role="keyword">yalign</parameter><initializer>0.0</initializer></methodparam> - <methodparam><parameter - role="keyword">ratio</parameter><initializer>1.0</initializer></methodparam> - <methodparam><parameter - role="keyword">obey_child</parameter><initializer>True</initializer></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">xalign</parameter> :</term> - <listitem><simpara>The fraction of horizontal -<emphasis>free</emphasis> space to the left of the child. 0.0 means no -<emphasis>free</emphasis> space to the left, 1.0 means all -<emphasis>free</emphasis> space to the left.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">yalign</parameter> :</term> - <listitem><simpara>The fraction of vertical -<emphasis>free</emphasis> space above the child. 0.0 means no -<emphasis>free</emphasis> space above, 1.0 means all -<emphasis>free</emphasis> space above.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">ratio</parameter> :</term> - <listitem><simpara>the ratio of the child width to height (in the -range 0.0001 to 10000.0) if <parameter>obey_child</parameter> is -False</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter -role="keyword">obey_child</parameter> :</term> - <listitem><simpara>if True, <parameter>ratio</parameter> is -ignored, and the aspect ratio is taken from the requisition of the -child</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <methodname>set</methodname>() method changes the aspect -frame properties to the values specified by <parameter>xalign</parameter>, -<parameter>yalign</parameter>, <parameter>ratio</parameter> and -<parameter>obey_child</parameter>. The default values are: -<parameter>xalign</parameter>, 0; <parameter>yalign</parameter>, 0.0; -<parameter>ratio</parameter>, 1.0; and, <parameter>obey_child</parameter>, -True.</para> - - </refsect2> - - </refsect1> - -</refentry> |