pygoocanvas r251 - in trunk: . docs docs/reference
- From: gianmt svn gnome org
- To: svn-commits-list gnome org
- Subject: pygoocanvas r251 - in trunk: . docs docs/reference
- Date: Tue, 17 Mar 2009 22:54:13 +0000 (UTC)
Author: gianmt
Date: Tue Mar 17 22:54:13 2009
New Revision: 251
URL: http://svn.gnome.org/viewvc/pygoocanvas?rev=251&view=rev
Log:
=== 0.14.0 ===
2009-03-17 Gian Mario Tagliaretti <gianmt gnome org>
* NEWS: Update.
* configure.ac: bump version number to 0.14.0
* docs/Makefile.am: use variable PYGOBJECT_PYGDOCS instead of
hardcoding the path.
* docs/reference/pygoocanvas-ellipse.xml
* docs/reference/pygoocanvas-polyline.xml
* docs/reference/pygoocanvas-group.xml
* docs/reference/pygoocanvas-path.xml
* docs/reference/pygoocanvas-item.xml
* docs/reference/pygoocanvas-widget.xml
* docs/reference/pygoocanvas-text.xml: update docs to the new goocanvas
API, some random fixes.
Modified:
trunk/ (props changed)
trunk/ChangeLog
trunk/NEWS
trunk/configure.ac
trunk/docs/Makefile.am
trunk/docs/reference/pygoocanvas-canvas.xml
trunk/docs/reference/pygoocanvas-ellipse.xml
trunk/docs/reference/pygoocanvas-group.xml
trunk/docs/reference/pygoocanvas-item.xml
trunk/docs/reference/pygoocanvas-path.xml
trunk/docs/reference/pygoocanvas-polyline.xml
trunk/docs/reference/pygoocanvas-text.xml
trunk/docs/reference/pygoocanvas-widget.xml
Modified: trunk/NEWS
==============================================================================
--- trunk/NEWS (original)
+++ trunk/NEWS Tue Mar 17 22:54:13 2009
@@ -1,3 +1,9 @@
+PyGooCanvas 0.14.0 (Mar 17 2009)
+==================
+
+ o Update the docs with new goocanvas API and some random fixes (Gian Mario)
+ o Add an export SVG function in the demo (Gian Mario)
+
PyGooCanvas 0.13.1 (Dec 27 2008)
==================
Modified: trunk/configure.ac
==============================================================================
--- trunk/configure.ac (original)
+++ trunk/configure.ac Tue Mar 17 22:54:13 2009
@@ -2,14 +2,14 @@
dnl the pygoocanvas version number
m4_define(pygoocanvas_major_version, 0)
-m4_define(pygoocanvas_minor_version, 13)
-m4_define(pygoocanvas_micro_version, 2)
+m4_define(pygoocanvas_minor_version, 14)
+m4_define(pygoocanvas_micro_version, 0)
m4_define(pygoocanvas_version, pygoocanvas_major_version.pygoocanvas_minor_version.pygoocanvas_micro_version)
dnl versions of packages we require ...
m4_define(pygobject_required_version, 2.10.1)
m4_define(pygtk_required_version, 2.10.0)
-m4_define(goocanvas_required_version, 0.13)
+m4_define(goocanvas_required_version, 0.14)
m4_define(pycairo_required_version, 1.4.0)
AC_INIT(pygoocanvas, pygoocanvas_version, [http://bugzilla.gnome.org/browse.cgi?product=pygoocanvas])
Modified: trunk/docs/Makefile.am
==============================================================================
--- trunk/docs/Makefile.am (original)
+++ trunk/docs/Makefile.am Tue Mar 17 22:54:13 2009
@@ -116,7 +116,7 @@
--stringparam gtkdoc.bookname "pygoocanvas" \
--stringparam gtkdoc.version ${REF_VERSION} \
$(HTML_STYLE) $(srcdir)/reference/pygoocanvas-ref.xml
- $(PYGOBJECT_FIXXREF) -i /usr/share/gtk-doc/html/pygtk/ $(BUILDDIR)/html
+ $(PYGOBJECT_FIXXREF) -i $(PYGOBJECT_PYGDOCS) $(BUILDDIR)/html
touch $@
pdf: $(REFERENCE_DEPS) reference/builddate.xml
Modified: trunk/docs/reference/pygoocanvas-canvas.xml
==============================================================================
--- trunk/docs/reference/pygoocanvas-canvas.xml (original)
+++ trunk/docs/reference/pygoocanvas-canvas.xml Tue Mar 17 22:54:13 2009
@@ -212,7 +212,7 @@
+-- <link linkend="class-gtkobject">gtk.Object</link>
+-- <link linkend="class-gtkwidget">gtk.Widget</link>
+-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-canvas-view">goocanvas.Canvas</link>
+ +-- <link linkend="class-canvas">goocanvas.Canvas</link>
</synopsis>
</refsect1>
Modified: trunk/docs/reference/pygoocanvas-ellipse.xml
==============================================================================
--- trunk/docs/reference/pygoocanvas-ellipse.xml (original)
+++ trunk/docs/reference/pygoocanvas-ellipse.xml Tue Mar 17 22:54:13 2009
@@ -56,6 +56,12 @@
</row>
<row valign="top">
+ <entry>"height"</entry>
+ <entry>Read/Write</entry>
+ <entry>The height of the ellipse. Allowed values: >= 0. Default value: 0.</entry>
+ </row>
+
+ <row valign="top">
<entry>"radius_x"</entry>
<entry>Read/Write</entry>
<entry>The horizontal radius of the ellipse. Allowed values: >= 0. Default value: 0.</entry>
@@ -66,6 +72,24 @@
<entry>Read/Write</entry>
<entry>The vertical radius of the ellipse. Allowed values: >= 0. Default value: 0.</entry>
</row>
+
+ <row valign="top">
+ <entry>"width"</entry>
+ <entry>Read/Write</entry>
+ <entry>The width of the ellipse. Allowed values: >= 0. Default value: 0.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"x"</entry>
+ <entry>Read/Write</entry>
+ <entry>The x coordinate of the left side of the ellipse. Default value: 0.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"y"</entry>
+ <entry>Read/Write</entry>
+ <entry>The y coordinate of the top of the ellipse. Default value: 0.</entry>
+ </row>
</tbody>
</tgroup>
</informaltable>
Modified: trunk/docs/reference/pygoocanvas-group.xml
==============================================================================
--- trunk/docs/reference/pygoocanvas-group.xml (original)
+++ trunk/docs/reference/pygoocanvas-group.xml Tue Mar 17 22:54:13 2009
@@ -32,6 +32,45 @@
</synopsis>
</refsect1>
+
+ <refsect1 id="properties-goocanvasgroup">
+ <title>goocanvas.Group Properties</title>
+
+ <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="3.5in"/>
+ <tbody>
+ <row valign="top">
+ <entry>"height"</entry>
+ <entry>Read/Write</entry>
+ <entry>The height of the group, or -1 to use the default height. Default value: -1.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"width"</entry>
+ <entry>Read/Write</entry>
+ <entry>The width of the group, or -1 to use the default width. Default value: -1.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"x"</entry>
+ <entry>Read/Write</entry>
+ <entry>The x coordinate of the group. Default value: 0.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"y"</entry>
+ <entry>Read/Write</entry>
+ <entry>The y coordinate of the group. Default value: 0.</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </blockquote>
+ </refsect1>
<refsect1>
<title>Implemented Interfaces</title>
Modified: trunk/docs/reference/pygoocanvas-item.xml
==============================================================================
--- trunk/docs/reference/pygoocanvas-item.xml (original)
+++ trunk/docs/reference/pygoocanvas-item.xml Tue Mar 17 22:54:13 2009
@@ -296,13 +296,15 @@
<row valign="top">
<entry>"can-focus"</entry>
<entry>Read/Write</entry>
- <entry>If the item can take the keyboard focus. Default value: False</entry>
+ <entry>If the item can take the keyboard focus.
+ Default value: <literal>False</literal>.</entry>
</row>
<row valign="top">
<entry>"description"</entry>
<entry>Read/Write</entry>
- <entry>A description of the item for use by assistive technologies. Default value: NULL</entry>
+ <entry>A description of the item for use by assistive technologies.
+ Default value: <literal>None</literal>.</entry>
</row>
<row valign="top">
@@ -316,33 +318,39 @@
<entry>Read/Write</entry>
<entry>Specifies when the item receives pointer events. Default value:
goocanvas.EVENTS_VISIBLE_MASK|goocanvas.EVENTS_PAINTED_MASK|
- goocanvas.EVENTS_FILL_MASK|goocanvas.EVENTS_STROKE_MASK</entry>
+ goocanvas.EVENTS_FILL_MASK|goocanvas.EVENTS_STROKE_MASK.</entry>
</row>
<row valign="top">
<entry>"title"</entry>
<entry>Read/Write</entry>
<entry>A short context-rich description of the item for use by
- assistive technologies. Default value: NULL</entry>
+ assistive technologies. Default value: <literal>None</literal>.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"tooltip"</entry>
+ <entry>Read/Write</entry>
+ <entry>The tooltip to display for the item. Default value: <literal>None</literal>.</entry>
</row>
<row valign="top">
<entry>"transform"</entry>
<entry>Read/Write</entry>
- <entry>The transformation matrix of the item. </entry>
+ <entry>The transformation matrix of the item.</entry>
</row>
<row valign="top">
<entry>"visibility"</entry>
<entry>Read/Write</entry>
- <entry>When the canvas item is visible. Default value: GOO_CANVAS_ITEM_VISIBLE.</entry>
+ <entry>When the canvas item is visible. Default value: goocanvas.ITEM_VISIBLE.</entry>
</row>
<row valign="top">
<entry>"visibility-threshold"</entry>
<entry>Read/Write</entry>
<entry>The scale threshold at which the item becomes visible.
- Allowed values: >= 0 Default value: 0</entry>
+ Allowed values: >= 0 Default value: 0.</entry>
</row>
</tbody>
@@ -497,6 +505,32 @@
</methodsynopsis>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><link linkend="signal-goocanvasitem--query-tooltip">"query-tooltip"</link></term>
+ <listitem>
+ <methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>item</parameter></methodparam>
+ <methodparam><parameter>x</parameter></methodparam>
+ <methodparam><parameter>y</parameter></methodparam>
+ <methodparam><parameter>keyboard_mode</parameter></methodparam>
+ <methodparam><parameter>tooltip</parameter></methodparam>
+ <methodparam><parameter>user_param</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><link linkend="signal-goocanvasitem--scroll-event">"scroll-event"</link></term>
+ <listitem>
+ <methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>item</parameter></methodparam>
+ <methodparam><parameter>target_item</parameter></methodparam>
+ <methodparam><parameter>event</parameter></methodparam>
+ <methodparam><parameter>user_param</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis>
+ </listitem>
+ </varlistentry>
</variablelist>
</refsect1>
@@ -1702,7 +1736,9 @@
<varlistentry>
<term><parameter>event</parameter> :</term>
<listitem><simpara>
- The event data, with coordinates translated to canvas coordinates.
+ The event data. The x and y fields contain the mouse position in the
+ item's coordinate space. The root_x and root_y fields contain the same
+ coordinates converted to the canvas coordinate space.
</simpara></listitem>
</varlistentry>
<varlistentry>
@@ -1751,7 +1787,9 @@
<varlistentry>
<term><parameter>event</parameter> :</term>
<listitem><simpara>
- The event data, with coordinates translated to canvas coordinates.
+ The event data. The x and y fields contain the mouse position in the
+ item's coordinate space. The root_x and root_y fields contain the same
+ coordinates converted to the canvas coordinate space.
</simpara></listitem>
</varlistentry>
<varlistentry>
@@ -1841,7 +1879,9 @@
<varlistentry>
<term><parameter>event</parameter> :</term>
<listitem><simpara>
- The event data, with coordinates translated to canvas coordinates.
+ The event data. The x and y fields contain the mouse position in the
+ item's coordinate space. The root_x and root_y fields contain the same
+ coordinates converted to the canvas coordinate space.
</simpara></listitem>
</varlistentry>
<varlistentry>
@@ -2159,7 +2199,9 @@
<varlistentry>
<term><parameter>event</parameter> :</term>
<listitem><simpara>
- The event data, with coordinates translated to canvas coordinates.
+ The event data. The x and y fields contain the mouse position in the
+ item's coordinate space. The root_x and root_y fields contain the same
+ coordinates converted to the canvas coordinate space.
</simpara></listitem>
</varlistentry>
<varlistentry>
@@ -2212,7 +2254,9 @@
<varlistentry>
<term><parameter>event</parameter> :</term>
<listitem><simpara>
- The event data, with coordinates translated to canvas coordinates.
+ The event data. The x and y fields contain the mouse position in the
+ item's coordinate space. The root_x and root_y fields contain the same
+ coordinates converted to the canvas coordinate space.
</simpara></listitem>
</varlistentry>
<varlistentry>
@@ -2237,5 +2281,137 @@
</para>
</refsect2>
+ <refsect2 id="signal-goocanvasitem--query-tooltip">
+ <title>The "query-tooltip" goocanvas.Item Signal</title>
+
+ <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>item</parameter></methodparam>
+ <methodparam><parameter>x</parameter></methodparam>
+ <methodparam><parameter>y</parameter></methodparam>
+ <methodparam><parameter>keyboard_mode</parameter></methodparam>
+ <methodparam><parameter>tooltip</parameter></methodparam>
+ <methodparam><parameter>user_param</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>item</parameter> :</term>
+ <listitem><simpara>
+ The <link linkend="class-canvas-item"><classname>goocanvas.Item</classname></link>
+ that received the signal.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>x</parameter> :</term>
+ <listitem><simpara>
+ the x coordinate of the mouse.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>y</parameter> :</term>
+ <listitem><simpara>
+ the y coordinate of the mouse.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>keyboard_mode</parameter> :</term>
+ <listitem><simpara>
+ <literal>True</literal> if the tooltip was triggered using the keyboard.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>tooltip</parameter> :</term>
+ <listitem><simpara>
+ a <link linkend="class-gtktooltip"><classname>gtk.Tooltip</classname></link>
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_param</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>
+ <varlistentry>
+ <term><parameter>Returns</parameter> :</term>
+ <listitem><simpara>True to stop the signal emission, or False to let it continue.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The "query-tooltip" signal is emitted when the mouse has paused over the
+ item for a certain amount of time, or the tooltip was requested via the keyboard.
+ </para>
+ <para>
+ Note that if keyboard_mode is <literal>True</literal>, the values of
+ x and y are undefined and should not be used.
+ </para>
+ <para>
+ If the item wants to display a tooltip it should update tooltip and return <literal>True</literal>.
+ </para>
+ </refsect2>
+
+ <refsect2 id="signal-goocanvasitem--scroll-event">
+ <title>The "scroll-event" goocanvas.Item Signal</title>
+
+ <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>item</parameter></methodparam>
+ <methodparam><parameter>target_item</parameter></methodparam>
+ <methodparam><parameter>event</parameter></methodparam>
+ <methodparam><parameter>user_param</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>item</parameter> :</term>
+ <listitem><simpara>
+ The <link linkend="class-canvas-item"><classname>goocanvas.Item</classname></link>
+ that received the signal.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>target_item</parameter> :</term>
+ <listitem><simpara>
+ The target of the event.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>event</parameter> :</term>
+ <listitem><simpara>
+ The event data. The x and y fields contain the mouse position in the
+ item's coordinate space. The root_x and root_y fields contain the same
+ coordinates converted to the canvas coordinate space.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_param</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>
+ <varlistentry>
+ <term><parameter>Returns</parameter> :</term>
+ <listitem><simpara>True to stop the signal emission, or False to let it continue.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The "scroll-event" signal is emitted when a button in the 4 to 7 range is pressed.
+ Wheel mice are usually configured to generate button press events for buttons
+ 4 and 5 when the wheel is turned in an item.
+ </para>
+ </refsect2>
+
</refsect1>
</refentry>
Modified: trunk/docs/reference/pygoocanvas-path.xml
==============================================================================
--- trunk/docs/reference/pygoocanvas-path.xml (original)
+++ trunk/docs/reference/pygoocanvas-path.xml Tue Mar 17 22:54:13 2009
@@ -48,7 +48,31 @@
<entry>Write</entry>
<entry>The sequence of path commands, specified as a string using the same syntax as in the
<ulink url="http://www.w3.org/Graphics/SVG/";>Scalable Vector Graphics (SVG)</ulink>
- path element. Default value: NULL.</entry>
+ path element. Default value: NULL.
+ </entry>
+ </row>
+ <row valign="top">
+ <entry>"height"</entry>
+ <entry>Read/Write</entry>
+ <entry>The height of the path. Allowed values: >= 0. Default value: 0.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"width"</entry>
+ <entry>Read/Write</entry>
+ <entry>The width of the path. Allowed values: >= 0. Default value: 0.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"x"</entry>
+ <entry>Read/Write</entry>
+ <entry>The x coordinate of the path. Default value: 0.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"y"</entry>
+ <entry>Read/Write</entry>
+ <entry>The y coordinate of the path. Default value: 0.</entry>
</row>
</tbody>
</tgroup>
Modified: trunk/docs/reference/pygoocanvas-polyline.xml
==============================================================================
--- trunk/docs/reference/pygoocanvas-polyline.xml (original)
+++ trunk/docs/reference/pygoocanvas-polyline.xml Tue Mar 17 22:54:13 2009
@@ -80,6 +80,11 @@
<entry>If an arrow should be displayed at the end of the polyline. Default value: False.</entry>
</row>
<row valign="top">
+ <entry>"height"</entry>
+ <entry>Read/Write</entry>
+ <entry>The height of the polyline. Allowed values: >= 0. Default value: 0.</entry>
+ </row>
+ <row valign="top">
<entry>"points"</entry>
<entry>Read/Write</entry>
<entry>The array of points.</entry>
@@ -89,6 +94,21 @@
<entry>Read/Write</entry>
<entry>If an arrow should be displayed at the start of the polyline. Default value: False.</entry>
</row>
+ <row valign="top">
+ <entry>"width"</entry>
+ <entry>Read/Write</entry>
+ <entry>The width of the polyline. Allowed values: >= 0. Default value: 0.</entry>
+ </row>
+ <row valign="top">
+ <entry>"x"</entry>
+ <entry>Read/Write</entry>
+ <entry>The x coordinate of the left-most point of the polyline. Default value: 0.</entry>
+ </row>
+ <row valign="top">
+ <entry>"y"</entry>
+ <entry>Read/Write</entry>
+ <entry>The y coordinate of the top-most point of the polyline. Default value: 0.</entry>
+ </row>
</tbody>
</tgroup>
</informaltable>
Modified: trunk/docs/reference/pygoocanvas-text.xml
==============================================================================
--- trunk/docs/reference/pygoocanvas-text.xml (original)
+++ trunk/docs/reference/pygoocanvas-text.xml Tue Mar 17 22:54:13 2009
@@ -75,6 +75,12 @@
</row>
<row valign="top">
+ <entry>"height"</entry>
+ <entry>Read/Write</entry>
+ <entry>The height to use to layout the text, or -1 to use the natural height. Default value: -1.</entry>
+ </row>
+
+ <row valign="top">
<entry>"text"</entry>
<entry>Read/Write</entry>
<entry>The text to display. Default value: None.</entry>
Modified: trunk/docs/reference/pygoocanvas-widget.xml
==============================================================================
--- trunk/docs/reference/pygoocanvas-widget.xml (original)
+++ trunk/docs/reference/pygoocanvas-widget.xml Tue Mar 17 22:54:13 2009
@@ -47,7 +47,7 @@
<entry>"anchor"</entry>
<entry>Read/Write</entry>
<entry>How to position the widget relative to the item's x and y coordinate settings.
- Default value: gtk.ANCHOR_NORTH_WEST</entry>
+ Default value: gtk.ANCHOR_NORTH_WEST</entry>
</row>
<row valign="top">
@@ -67,12 +67,12 @@
<entry>Read/Write</entry>
<entry>The width of the widget, or -1 to use its requested width. Default value: -1</entry>
</row>
- <row valign="top">
+ <row valign="top">
<entry>"x"</entry>
<entry>Read/Write</entry>
<entry>The x coordinate of the widget. Default value: 0</entry>
</row>
- <row valign="top">
+ <row valign="top">
<entry>"y"</entry>
<entry>Read/Write</entry>
<entry>he y coordinate of the widget. Default value: 0</entry>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
