pygtk r3106 - trunk/docs/reference
- From: gianmt svn gnome org
- To: svn-commits-list gnome org
- Subject: pygtk r3106 - trunk/docs/reference
- Date: Thu, 5 Mar 2009 21:44:42 +0000 (UTC)
Author: gianmt
Date: Thu Mar 5 21:44:42 2009
New Revision: 3106
URL: http://svn.gnome.org/viewvc/pygtk?rev=3106&view=rev
Log:
2009-03-05 Gian Mario Tagliaretti <gianmt gnome org>
* pygtk-gdkwindow.xml:
* pygtk-gdkscreen.xml: Update docs to 2.14
Modified:
trunk/docs/reference/ChangeLog
trunk/docs/reference/pygtk-gdkscreen.xml
trunk/docs/reference/pygtk-gdkwindow.xml
Modified: trunk/docs/reference/pygtk-gdkscreen.xml
==============================================================================
--- trunk/docs/reference/pygtk-gdkscreen.xml (original)
+++ trunk/docs/reference/pygtk-gdkscreen.xml Thu Mar 5 21:44:42 2009
@@ -110,6 +110,18 @@
<methodname><link linkend="method-gdkscreen--get-rgba-visual">get_rgba_visual</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gdkscreen--get-monitor-height-mm">get_monitor_height_mm</link></methodname>
+ <methodparam><parameter role="keyword">monitor_num</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gdkscreen--get-monitor-width-mm">get_monitor_width_mm</link></methodname>
+ <methodparam><parameter role="keyword">monitor_num</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gdkscreen--get-monitor-plug-name">get_monitor_plug_name</link></methodname>
+ <methodparam><parameter role="keyword">monitor_num</parameter></methodparam>
+ </methodsynopsis>
</classsynopsis>
<programlisting>
@@ -158,6 +170,18 @@
</listitem>
</varlistentry>
</variablelist>
+ <variablelist>
+ <varlistentry>
+ <term>"<link linkend="signal-gdkscreen--monitors-changed">monitors-changed</link>"</term>
+ <listitem>
+ <methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>screen</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
@@ -870,6 +894,95 @@
</refsect2>
+ <refsect2 id="method-gdkscreen--get-monitor-height-mm">
+ <title>gtk.gdk.Screen.get_monitor_height_mm</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_monitor_height_mm</methodname>
+ <methodparam><parameter role="keyword">monitor_num</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">monitor_num</parameter> :</term>
+ <listitem><simpara>Number of the monitor.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>The height of the monitor, or -1 if not available.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_monitor_height_mm</methodname>() method gets the height
+ in millimeters of the specified monitor.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gdkscreen--get-monitor-width-mm">
+ <title>gtk.gdk.Screen.get_monitor_width_mm</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_monitor_width_mm</methodname>
+ <methodparam><parameter role="keyword">monitor_num</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">monitor_num</parameter> :</term>
+ <listitem><simpara>Number of the monitor.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>The width of the monitor, or -1 if not available.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_monitor_width_mm</methodname>() method gets the width
+ in millimeters of the specified monitor.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gdkscreen--get-monitor-plug-name">
+ <title>gtk.gdk.Screen.get_monitor_plug_name</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_monitor_plug_name</methodname>
+ <methodparam><parameter role="keyword">monitor_num</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">monitor_num</parameter> :</term>
+ <listitem><simpara>Number of the monitor.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A newly-allocated string containing the name of the monitor,
+ or <literal>None</literal> if the name cannot be determined.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_monitor_plug_name</methodname>() method returns the output
+ name of the specified monitor. Usually something like VGA, DVI, or TV, not the
+ actual product name of the display device.
+ </para>
+
+ </refsect2>
+
</refsect1>
<refsect1>
@@ -1023,6 +1136,46 @@
</refsect2>
+ <refsect2 id="signal-gdkscreen--monitor-changed">
+ <title>The "monitor-changed" gtk.gdk.Screen Signal</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>callback</methodname>
+ <methodparam><parameter>screen</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>screen</parameter> :</term>
+ <listitem><simpara>the screen that received the
+signal</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_param1</parameter> :</term>
+ <listitem><simpara>the first user parameter (if any) specified
+with the <link
+linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
+method</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>...</parameter> :</term>
+ <listitem><simpara>additional user parameters (if
+any)</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The "monitor-changed" signal is emitted when the number, size or position
+ of the monitors attached to the screen change.
+ </para>
+ <para>
+ Only for X for now. Future implementations for Win32 and OS X may be a possibility.
+ </para>
+
+
+ </refsect2>
</refsect1>
</refentry>
Modified: trunk/docs/reference/pygtk-gdkwindow.xml
==============================================================================
--- trunk/docs/reference/pygtk-gdkwindow.xml (original)
+++ trunk/docs/reference/pygtk-gdkwindow.xml Thu Mar 5 21:44:42 2009
@@ -686,6 +686,24 @@
<methodname><link linkend="method-gdkwindow--set-startup-id">set_startup_id</link></methodname>
<methodparam><parameter role="keyword">startup_id</parameter></methodparam>
</methodsynopsis>
+
+ <!-- NOT IMPLEMENTED
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gdkwindow- -redirect-to-drawable">redirect_to_drawable</link></methodname>
+ <methodparam><parameter role="keyword">drawable</parameter></methodparam>
+ <methodparam><parameter role="keyword">src_x</parameter></methodparam>
+ <methodparam><parameter role="keyword">src_y</parameter></methodparam>
+ <methodparam><parameter role="keyword">dest_x</parameter></methodparam>
+ <methodparam><parameter role="keyword">dest_y</parameter></methodparam>
+ <methodparam><parameter role="keyword">width</parameter></methodparam>
+ <methodparam><parameter role="keyword">height</parameter></methodparam>
+ </methodsynopsis>
+ END NOT IMPLEMENTED -->
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gdkwindow--remove-redirection">remove_redirection</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
</classsynopsis>
<programlisting>
@@ -4407,6 +4425,104 @@
</para>
</refsect2>
+
+ <!-- NOT IMPLEMENTED
+ <refsect2 id="method-gdkwindow- -redirect-to-drawable">
+ <title>gtk.gdk.Window.redirect_to_drawable</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>redirect_to_drawable</methodname>
+ <methodparam><parameter role="keyword">drawable</parameter></methodparam>
+ <methodparam><parameter role="keyword">src_x</parameter></methodparam>
+ <methodparam><parameter role="keyword">src_y</parameter></methodparam>
+ <methodparam><parameter role="keyword">dest_x</parameter></methodparam>
+ <methodparam><parameter role="keyword">dest_y</parameter></methodparam>
+ <methodparam><parameter role="keyword">width</parameter></methodparam>
+ <methodparam><parameter role="keyword">height</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter
+ role="keyword">drawable</parameter> :</term>
+ <listitem><simpara><link linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter
+ role="keyword">src_x</parameter> :</term>
+ <listitem><simpara>x position in window</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter
+ role="keyword">src_y</parameter> :</term>
+ <listitem><simpara>y position in window</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter
+ role="keyword">dest_x</parameter> :</term>
+ <listitem><simpara>x position in drawable</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter
+ role="keyword">dest_y</parameter> :</term>
+ <listitem><simpara>y position in drawable </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter
+ role="keyword">width</parameter> :</term>
+ <listitem><simpara>width of redirection </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter
+ role="keyword">height</parameter> :</term>
+ <listitem><simpara>height of redirection </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>input_shape_combine_region</methodname>() method redirects drawing
+ into window so that drawing to the window in the rectangle specified by src_x, src_y, width
+ and height is also drawn into drawable at dest_x, dest_y.
+ </para>
+ <para>
+ Only drawing between
+ <methodname><link linkend="method-gdkwindow--begin-paint-region">gtk.gdk.Window.begin_paint_region</link></methodname>()
+ or
+ <methodname><link linkend="method-gdkwindow--begin-paint-region">gtk.gdk.Window.begin_paint_rect</link></methodname>()
+ and
+ <methodname><link linkend="method-gdkwindow--end-paint">gtk.gdk.Window.end_paint</link></methodname>()
+ is redirected.
+ </para>
+
+ </refsect2>
+ END NOT IMPLEMENTED -->
+
+ <refsect2 id="method-gdkwindow--remove-redirection">
+ <title>gtk.gdk.Window.remove_redirection</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>remove_redirection</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ When using GTK+, typically you should use
+ <methodname><link linkend="method-gtkwindow--set-startup-id">gtk.Window.set_startup_id</link></methodname>()
+ instead of this low-level function.
+ </para>
+
+ </refsect2>
</refsect1>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
