[gnomeweb-wml] Update PyDia documentation, include generated output
- From: Hans Breuer <hans src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [gnomeweb-wml] Update PyDia documentation, include generated output
- Date: Sat, 30 Jan 2010 15:44:46 +0000 (UTC)
commit 6839c7b680a76602702efeb78018c1395cab36c5
Author: Hans Breuer <hans breuer org>
Date: Sat Jan 30 16:20:00 2010 +0100
Update PyDia documentation, include generated output
projects.gnome.org/dia/Makefile.am | 1 +
projects.gnome.org/dia/pydia.html | 793 ++++++++++++++++++++++++++++++++++++
projects.gnome.org/dia/python.html | 4 +-
3 files changed, 796 insertions(+), 2 deletions(-)
---
diff --git a/projects.gnome.org/dia/Makefile.am b/projects.gnome.org/dia/Makefile.am
index 3fdfb40..a4d93a4 100644
--- a/projects.gnome.org/dia/Makefile.am
+++ b/projects.gnome.org/dia/Makefile.am
@@ -19,6 +19,7 @@ page_SCRIPTS = \
mainwin.html \
menu.html \
news.html \
+ pydia.html \
python.html \
right_bar.html \
scrshot.html \
diff --git a/projects.gnome.org/dia/pydia.html b/projects.gnome.org/dia/pydia.html
new file mode 100644
index 0000000..ff26312
--- /dev/null
+++ b/projects.gnome.org/dia/pydia.html
@@ -0,0 +1,793 @@
+
+<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<html><head><title>Python: module dia</title>
+</head><body bgcolor="#f0f0f8">
+
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
+<tr bgcolor="#7799ee">
+<td valign=bottom> <br>
+<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong>dia</strong></big></big></font></td
+><td align=right valign=bottom
+><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br>(built-in)</font></td></tr></table>
+ <p><tt>The dia module allows to write Python plug-ins for Dia [<a href="http://live.gnome.org/Dia/Python";>http://live.gnome.org/Dia/Python</a>]<br>
+ <br>
+This modules is designed to run Python scripts embedded in Dia. To make your script accessible<br>
+to Dia you have to put it into $HOME/.dia/python and let it call one of the register_*() functions.<br>
+It is possible to write import filters [<a href="#-register_import">register_import</a>()] and export filters [<a href="#-register_export">register_export</a>()], as well as scripts to manipulate existing diagrams or create new ones [<a href="#-register_action">register_action</a>()].<br>
+ <br>
+For stand-alone Python bindings to Dia see <a href="http://mail.gnome.org/archives/dia-list/2007-March/msg00092.html";>http://mail.gnome.org/archives/dia-list/2007-March/msg00092.html</a></tt></p>
+<p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#ee77aa">
+<td colspan=3 valign=bottom> <br>
+<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
+
+<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
+<td width="100%"><dl>
+<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
+</font></dt><dd>
+<dl>
+<dt><font face="helvetica, arial"><a href="dia.html#Arrow">Arrow</a>
+</font></dt><dt><font face="helvetica, arial"><a href="dia.html#BezPoint">BezPoint</a>
+</font></dt><dt><font face="helvetica, arial"><a href="dia.html#ConnectionPoint">ConnectionPoint</a>
+</font></dt><dt><font face="helvetica, arial"><a href="dia.html#Diagram">Diagram</a>
+</font></dt><dt><font face="helvetica, arial"><a href="dia.html#DiagramData">DiagramData</a>
+</font></dt><dt><font face="helvetica, arial"><a href="dia.html#Display">Display</a>
+</font></dt><dt><font face="helvetica, arial"><a href="dia.html#ExportFilter">ExportFilter</a>
+</font></dt><dt><font face="helvetica, arial"><a href="dia.html#Font">Font</a>
+</font></dt><dt><font face="helvetica, arial"><a href="dia.html#Handle">Handle</a>
+</font></dt><dt><font face="helvetica, arial"><a href="dia.html#Image">Image</a>
+</font></dt><dt><font face="helvetica, arial"><a href="dia.html#Layer">Layer</a>
+</font></dt><dt><font face="helvetica, arial"><a href="dia.html#Object">Object</a>
+</font></dt><dt><font face="helvetica, arial"><a href="dia.html#ObjectType">ObjectType</a>
+</font></dt><dt><font face="helvetica, arial"><a href="dia.html#Paperinfo">Paperinfo</a>
+</font></dt><dt><font face="helvetica, arial"><a href="dia.html#Point">Point</a>
+</font></dt><dt><font face="helvetica, arial"><a href="dia.html#Properties">Properties</a>
+</font></dt><dt><font face="helvetica, arial"><a href="dia.html#Property">Property</a>
+</font></dt><dt><font face="helvetica, arial"><a href="dia.html#Rectangle">Rectangle</a>
+</font></dt><dt><font face="helvetica, arial"><a href="dia.html#Text">Text</a>
+</font></dt></dl>
+</dd>
+</dl>
+ <p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#ffc8d8">
+<td colspan=3 valign=bottom> <br>
+<font color="#000000" face="helvetica, arial"><a name="Arrow">class <strong>Arrow</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
+
+<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
+<td colspan=2><tt>Dia's line objects usually ends with an dia.<a href="#Arrow">Arrow</a><br> </tt></td></tr>
+<tr><td> </td>
+<td width="100%">Methods defined here:<br>
+<dl><dt><a name="Arrow-__cmp__"><strong>__cmp__</strong></a>(...)</dt><dd><tt>x.<a href="#Arrow-__cmp__">__cmp__</a>(y) <==> cmp(x,y)</tt></dd></dl>
+
+<dl><dt><a name="Arrow-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#Arrow-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>
+
+<dl><dt><a name="Arrow-__hash__"><strong>__hash__</strong></a>(...)</dt><dd><tt>x.<a href="#Arrow-__hash__">__hash__</a>() <==> hash(x)</tt></dd></dl>
+
+<dl><dt><a name="Arrow-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#Arrow-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
+
+<hr>
+Data descriptors defined here:<br>
+<dl><dt><strong>length</strong></dt>
+<dd><tt>double: length along the line</tt></dd>
+</dl>
+<dl><dt><strong>type</strong></dt>
+<dd><tt>int: the shape of the arrow</tt></dd>
+</dl>
+<dl><dt><strong>width</strong></dt>
+<dd><tt>double: corresponding to line width</tt></dd>
+</dl>
+</td></tr></table> <p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#ffc8d8">
+<td colspan=3 valign=bottom> <br>
+<font color="#000000" face="helvetica, arial"><a name="BezPoint">class <strong>BezPoint</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
+
+<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
+<td colspan=2><tt>A dia.<a href="#Point">Point</a>, a bezier type and two control points (dia.<a href="#Point">Point</a>) make a bezier point.<br> </tt></td></tr>
+<tr><td> </td>
+<td width="100%">Methods defined here:<br>
+<dl><dt><a name="BezPoint-__cmp__"><strong>__cmp__</strong></a>(...)</dt><dd><tt>x.<a href="#BezPoint-__cmp__">__cmp__</a>(y) <==> cmp(x,y)</tt></dd></dl>
+
+<dl><dt><a name="BezPoint-__hash__"><strong>__hash__</strong></a>(...)</dt><dd><tt>x.<a href="#BezPoint-__hash__">__hash__</a>() <==> hash(x)</tt></dd></dl>
+
+<dl><dt><a name="BezPoint-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#BezPoint-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
+
+<hr>
+Data descriptors defined here:<br>
+<dl><dt><strong>p1</strong></dt>
+<dd><tt>Point: first control point for CURVETO</tt></dd>
+</dl>
+<dl><dt><strong>p2</strong></dt>
+<dd><tt>Point: second control point for CURVETO</tt></dd>
+</dl>
+<dl><dt><strong>p3</strong></dt>
+<dd><tt>Point: target point for CURVETO</tt></dd>
+</dl>
+<dl><dt><strong>type</strong></dt>
+<dd><tt>int: MOVETO, LINETO using p1 only; CURVETO all 3 points</tt></dd>
+</dl>
+</td></tr></table> <p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#ffc8d8">
+<td colspan=3 valign=bottom> <br>
+<font color="#000000" face="helvetica, arial"><a name="ConnectionPoint">class <strong>ConnectionPoint</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
+
+<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
+<td colspan=2><tt>One of the major features of Dia are connectable objects. They work by this type accesible through dia.<a href="#Object">Object</a>.connections[].<br> </tt></td></tr>
+<tr><td> </td>
+<td width="100%">Methods defined here:<br>
+<dl><dt><a name="ConnectionPoint-__cmp__"><strong>__cmp__</strong></a>(...)</dt><dd><tt>x.<a href="#ConnectionPoint-__cmp__">__cmp__</a>(y) <==> cmp(x,y)</tt></dd></dl>
+
+<dl><dt><a name="ConnectionPoint-__hash__"><strong>__hash__</strong></a>(...)</dt><dd><tt>x.<a href="#ConnectionPoint-__hash__">__hash__</a>() <==> hash(x)</tt></dd></dl>
+
+<hr>
+Data descriptors defined here:<br>
+<dl><dt><strong>connected</strong></dt>
+<dd><tt>List of Object: read-only list of connected objects</tt></dd>
+</dl>
+<dl><dt><strong>object</strong></dt>
+<dd><tt>Object: the object owning this connection point</tt></dd>
+</dl>
+<dl><dt><strong>pos</strong></dt>
+<dd><tt>Point: read-only position of the connection point</tt></dd>
+</dl>
+</td></tr></table> <p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#ffc8d8">
+<td colspan=3 valign=bottom> <br>
+<font color="#000000" face="helvetica, arial"><a name="Diagram">class <strong>Diagram</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
+
+<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
+<td colspan=2><tt>Subclass of dia.<a href="#DiagramData">DiagramData</a> (at least in the C implementation) adding interfacing the GUI elements.<br> </tt></td></tr>
+<tr><td> </td>
+<td width="100%">Methods defined here:<br>
+<dl><dt><a name="Diagram-__cmp__"><strong>__cmp__</strong></a>(...)</dt><dd><tt>x.<a href="#Diagram-__cmp__">__cmp__</a>(y) <==> cmp(x,y)</tt></dd></dl>
+
+<dl><dt><a name="Diagram-__hash__"><strong>__hash__</strong></a>(...)</dt><dd><tt>x.<a href="#Diagram-__hash__">__hash__</a>() <==> hash(x)</tt></dd></dl>
+
+<dl><dt><a name="Diagram-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#Diagram-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
+
+<dl><dt><a name="Diagram-add_update"><strong>add_update</strong></a>(...)</dt><dd><tt><a href="#Diagram-add_update">add_update</a>(real: top, real: left, real: bottom, real: right) -> None. Add the given rectangle to the update queue.</tt></dd></dl>
+
+<dl><dt><a name="Diagram-add_update_all"><strong>add_update_all</strong></a>(...)</dt><dd><tt><a href="#Diagram-add_update_all">add_update_all</a>() -> None. Add the diagram visible area to the update queue.</tt></dd></dl>
+
+<dl><dt><a name="Diagram-connect_after"><strong>connect_after</strong></a>(...)</dt><dd><tt><a href="#Diagram-connect_after">connect_after</a>(string: signal_name, Callback: func) -> None. Listen to diagram events in ['removed', 'selection_changed'].</tt></dd></dl>
+
+<dl><dt><a name="Diagram-display"><strong>display</strong></a>(...)</dt><dd><tt><a href="#Diagram-display">display</a>() -> <a href="#Display">Display</a>. Create a new display of the diagram.</tt></dd></dl>
+
+<dl><dt><a name="Diagram-find_clicked_object"><strong>find_clicked_object</strong></a>(...)</dt><dd><tt><a href="#Diagram-find_clicked_object">find_clicked_object</a>(real[2]: point, real: distance) -> <a href="#Object">Object</a>. Find an <a href="__builtin__.html#object">object</a> in the given distance of the given point.</tt></dd></dl>
+
+<dl><dt><a name="Diagram-find_closest_connectionpoint"><strong>find_closest_connectionpoint</strong></a>(...)</dt><dd><tt><a href="#Diagram-find_closest_connectionpoint">find_closest_connectionpoint</a>(real: x, real: y[, <a href="#Object">Object</a>: o]) -> (real: dist, <a href="#ConnectionPoint">ConnectionPoint</a>: cp). Given a point and an optional <a href="__builtin__.html#object">object</a> to exclude, return the distance and closest connection point or None.</tt></dd></dl>
+
+<dl><dt><a name="Diagram-find_closest_handle"><strong>find_closest_handle</strong></a>(...)</dt><dd><tt><a href="#Diagram-find_closest_handle">find_closest_handle</a>(real[2]: point) -> (real: distance, <a href="#Handle">Handle</a>: h, <a href="#Object">Object</a>: o). Find the closest handle from point and return a tuple of the search results. <a href="#Handle">Handle</a> and <a href="#Object">Object</a> might be None.</tt></dd></dl>
+
+<dl><dt><a name="Diagram-flush"><strong>flush</strong></a>(...)</dt><dd><tt><a href="#Diagram-flush">flush</a>() -> None. If no display update is queued, queue update.</tt></dd></dl>
+
+<dl><dt><a name="Diagram-get_sorted_selected"><strong>get_sorted_selected</strong></a>(...)</dt><dd><tt><a href="#Diagram-get_sorted_selected">get_sorted_selected</a>() -> list. Return the current selection sorted by Z-Order.</tt></dd></dl>
+
+<dl><dt><a name="Diagram-get_sorted_selected_remove"><strong>get_sorted_selected_remove</strong></a>(...)</dt><dd><tt><a href="#Diagram-get_sorted_selected_remove">get_sorted_selected_remove</a>() -> list. Return sorted selection and remove it from the diagram.</tt></dd></dl>
+
+<dl><dt><a name="Diagram-group_selected"><strong>group_selected</strong></a>(...)</dt><dd><tt><a href="#Diagram-group_selected">group_selected</a>() -> None. Turn the current selection into a group <a href="__builtin__.html#object">object</a>.</tt></dd></dl>
+
+<dl><dt><a name="Diagram-is_selected"><strong>is_selected</strong></a>(...)</dt><dd><tt><a href="#Diagram-is_selected">is_selected</a>(<a href="#Object">Object</a>: o) -> bool. True if the given <a href="__builtin__.html#object">object</a> is already selected.</tt></dd></dl>
+
+<dl><dt><a name="Diagram-remove_all_selected"><strong>remove_all_selected</strong></a>(...)</dt><dd><tt><a href="#Diagram-remove_all_selected">remove_all_selected</a>() -> None. Delete all selected objects.</tt></dd></dl>
+
+<dl><dt><a name="Diagram-save"><strong>save</strong></a>(...)</dt><dd><tt><a href="#Diagram-save">save</a>(string: filename) -> None. Save the diagram under the given filename.</tt></dd></dl>
+
+<dl><dt><a name="Diagram-select"><strong>select</strong></a>(...)</dt><dd><tt><a href="#Diagram-select">select</a>(<a href="#Object">Object</a>: o) -> None. Add the given <a href="__builtin__.html#object">object</a> to the selection.</tt></dd></dl>
+
+<dl><dt><a name="Diagram-ungroup_selected"><strong>ungroup_selected</strong></a>(...)</dt><dd><tt><a href="#Diagram-ungroup_selected">ungroup_selected</a>() -> None. Split all groups in the current selection into single objects.</tt></dd></dl>
+
+<dl><dt><a name="Diagram-unselect"><strong>unselect</strong></a>(...)</dt><dd><tt><a href="#Diagram-unselect">unselect</a>(<a href="#Object">Object</a>: o) -> None. Remove the given <a href="__builtin__.html#object">object</a> from the selection)</tt></dd></dl>
+
+<dl><dt><a name="Diagram-update_connections"><strong>update_connections</strong></a>(...)</dt><dd><tt><a href="#Diagram-update_connections">update_connections</a>(<a href="#Object">Object</a>: o) -> None. Update all connections of the given <a href="__builtin__.html#object">object</a>. Might move connected objects.</tt></dd></dl>
+
+<dl><dt><a name="Diagram-update_extents"><strong>update_extents</strong></a>(...)</dt><dd><tt><a href="#Diagram-update_extents">update_extents</a>() -> None. Force recaculation of the diagram extents.</tt></dd></dl>
+
+<hr>
+Data descriptors defined here:<br>
+<dl><dt><strong>data</strong></dt>
+<dd><tt>Backward-compatible base-class access</tt></dd>
+</dl>
+<dl><dt><strong>displays</strong></dt>
+<dd><tt>The list of current displays of this diagram.</tt></dd>
+</dl>
+<dl><dt><strong>filename</strong></dt>
+<dd><tt>Filename in utf-8 encoding.</tt></dd>
+</dl>
+<dl><dt><strong>modified</strong></dt>
+<dd><tt>Modification state.</tt></dd>
+</dl>
+<dl><dt><strong>selected</strong></dt>
+<dd><tt>The current object selection.</tt></dd>
+</dl>
+<dl><dt><strong>unsaved</strong></dt>
+<dd><tt>True if the diagram was not saved yet.</tt></dd>
+</dl>
+</td></tr></table> <p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#ffc8d8">
+<td colspan=3 valign=bottom> <br>
+<font color="#000000" face="helvetica, arial"><a name="DiagramData">class <strong>DiagramData</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
+
+<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
+<td colspan=2><tt>The 'low level' diagram <a href="__builtin__.html#object">object</a>. It contains everything to manipulate diagrams from im- and export filters as well as from the UI. It does not provide any access to GUI elements related to the diagram.Use the subclass dia.<a href="#Diagram">Diagram</a> <a href="__builtin__.html#object">object</a> for such matters.<br> </tt></td></tr>
+<tr><td> </td>
+<td width="100%">Methods defined here:<br>
+<dl><dt><a name="DiagramData-__cmp__"><strong>__cmp__</strong></a>(...)</dt><dd><tt>x.<a href="#DiagramData-__cmp__">__cmp__</a>(y) <==> cmp(x,y)</tt></dd></dl>
+
+<dl><dt><a name="DiagramData-__hash__"><strong>__hash__</strong></a>(...)</dt><dd><tt>x.<a href="#DiagramData-__hash__">__hash__</a>() <==> hash(x)</tt></dd></dl>
+
+<dl><dt><a name="DiagramData-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#DiagramData-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
+
+<dl><dt><a name="DiagramData-add_layer"><strong>add_layer</strong></a>(...)</dt><dd><tt><a href="#DiagramData-add_layer">add_layer</a>(<a href="#Layer">Layer</a>: layer[, int: position]) -> <a href="#Layer">Layer</a>. Add a layer to the diagram at the top or the given position counting from bottom.</tt></dd></dl>
+
+<dl><dt><a name="DiagramData-connect_after"><strong>connect_after</strong></a>(...)</dt><dd><tt><a href="#DiagramData-connect_after">connect_after</a>(string: signal_name, Callback: func) -> None. Listen to diagram events in ['object_add', 'object_remove'].</tt></dd></dl>
+
+<dl><dt><a name="DiagramData-delete_layer"><strong>delete_layer</strong></a>(...)</dt><dd><tt><a href="#DiagramData-delete_layer">delete_layer</a>(<a href="#Layer">Layer</a>: layer) -> None. Remove the given layer from the diagram.</tt></dd></dl>
+
+<dl><dt><a name="DiagramData-get_sorted_selected"><strong>get_sorted_selected</strong></a>(...)</dt><dd><tt><a href="#DiagramData-get_sorted_selected">get_sorted_selected</a>() -> list. Return the current selection sorted by Z-Order.</tt></dd></dl>
+
+<dl><dt><a name="DiagramData-lower_layer"><strong>lower_layer</strong></a>(...)</dt><dd><tt><a href="#DiagramData-lower_layer">lower_layer</a>() -> None. Move the layer towards the bottom.</tt></dd></dl>
+
+<dl><dt><a name="DiagramData-raise_layer"><strong>raise_layer</strong></a>(...)</dt><dd><tt><a href="#DiagramData-raise_layer">raise_layer</a>() -> None. Move the layer towards the top.</tt></dd></dl>
+
+<dl><dt><a name="DiagramData-set_active_layer"><strong>set_active_layer</strong></a>(...)</dt><dd><tt><a href="#DiagramData-set_active_layer">set_active_layer</a>(<a href="#Layer">Layer</a>: layer) -> None. Make the given layer the active one.</tt></dd></dl>
+
+<dl><dt><a name="DiagramData-update_extents"><strong>update_extents</strong></a>(...)</dt><dd><tt><a href="#DiagramData-update_extents">update_extents</a>() -> None. Recalculation of the diagram extents.</tt></dd></dl>
+
+<hr>
+Data descriptors defined here:<br>
+<dl><dt><strong>active_layer</strong></dt>
+<dd><tt>Layer currently active in the diagram.</tt></dd>
+</dl>
+<dl><dt><strong>bg_color</strong></dt>
+<dd><tt>Color of the diagram's background.</tt></dd>
+</dl>
+<dl><dt><strong>extents</strong></dt>
+<dd><tt>Rectangle covering all object's bounding boxes.</tt></dd>
+</dl>
+<dl><dt><strong>grid_visible</strong></dt>
+<dd><tt>bool: visibility of the grid.</tt></dd>
+</dl>
+<dl><dt><strong>grid_width</strong></dt>
+<dd><tt>Tuple(real: x, real: y) : describing the grid size.</tt></dd>
+</dl>
+<dl><dt><strong>hguides</strong></dt>
+<dd><tt>List of real: horizontal guides.</tt></dd>
+</dl>
+<dl><dt><strong>layers</strong></dt>
+<dd><tt>Read-only list of the diagrams layers.</tt></dd>
+</dl>
+<dl><dt><strong>paper</strong></dt>
+<dd><tt>Paperinfo of the diagram.</tt></dd>
+</dl>
+<dl><dt><strong>selected</strong></dt>
+<dd><tt>List of Object: current selection.</tt></dd>
+</dl>
+<dl><dt><strong>vguides</strong></dt>
+<dd><tt>List of real: vertical guides.</tt></dd>
+</dl>
+</td></tr></table> <p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#ffc8d8">
+<td colspan=3 valign=bottom> <br>
+<font color="#000000" face="helvetica, arial"><a name="Display">class <strong>Display</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
+
+<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
+<td colspan=2><tt>A <a href="#Diagram">Diagram</a> can have multiple displays but every <a href="#Display">Display</a> has just one <a href="#Diagram">Diagram</a>.<br> </tt></td></tr>
+<tr><td> </td>
+<td width="100%">Methods defined here:<br>
+<dl><dt><a name="Display-__cmp__"><strong>__cmp__</strong></a>(...)</dt><dd><tt>x.<a href="#Display-__cmp__">__cmp__</a>(y) <==> cmp(x,y)</tt></dd></dl>
+
+<dl><dt><a name="Display-__hash__"><strong>__hash__</strong></a>(...)</dt><dd><tt>x.<a href="#Display-__hash__">__hash__</a>() <==> hash(x)</tt></dd></dl>
+
+<dl><dt><a name="Display-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#Display-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
+
+<dl><dt><a name="Display-add_update_all"><strong>add_update_all</strong></a>(...)</dt><dd><tt><a href="#Display-add_update_all">add_update_all</a>() -> None. Add the diagram visible area to the update queue.</tt></dd></dl>
+
+<dl><dt><a name="Display-close"><strong>close</strong></a>(...)</dt><dd><tt><a href="#Display-close">close</a>() -> None. Close the display possibly asking to save.</tt></dd></dl>
+
+<dl><dt><a name="Display-flush"><strong>flush</strong></a>(...)</dt><dd><tt><a href="#Display-flush">flush</a>() -> None. If no display update is queued, queue update.</tt></dd></dl>
+
+<dl><dt><a name="Display-resize_canvas"><strong>resize_canvas</strong></a>(...)</dt><dd><tt><a href="#Display-resize_canvas">resize_canvas</a>(int: width, int: height) -> None. BEWARE: Changing the drawing area but not the window size.</tt></dd></dl>
+
+<dl><dt><a name="Display-scroll"><strong>scroll</strong></a>(...)</dt><dd><tt><a href="#Display-scroll">scroll</a>(real: dx, real: dy) -> None. Scroll the visible area by the given delta.</tt></dd></dl>
+
+<dl><dt><a name="Display-scroll_down"><strong>scroll_down</strong></a>(...)</dt><dd><tt><a href="#Display-scroll_down">scroll_down</a>() -> None. Scroll downwards by a fixed amount.</tt></dd></dl>
+
+<dl><dt><a name="Display-scroll_left"><strong>scroll_left</strong></a>(...)</dt><dd><tt><a href="#Display-scroll_left">scroll_left</a>() -> None. Scroll to the left by a fixed amount.</tt></dd></dl>
+
+<dl><dt><a name="Display-scroll_right"><strong>scroll_right</strong></a>(...)</dt><dd><tt><a href="#Display-scroll_right">scroll_right</a>() -> None. Scroll to the right by a fixed amount.</tt></dd></dl>
+
+<dl><dt><a name="Display-scroll_up"><strong>scroll_up</strong></a>(...)</dt><dd><tt><a href="#Display-scroll_up">scroll_up</a>() -> None. Scroll upwards by a fixed amount.</tt></dd></dl>
+
+<dl><dt><a name="Display-set_origion"><strong>set_origion</strong></a>(...)</dt><dd><tt><a href="#Display-set_origion">set_origion</a>(real: x, real, y) -> None. Move the given diagram point to the top-left corner of the visible area.</tt></dd></dl>
+
+<dl><dt><a name="Display-set_title"><strong>set_title</strong></a>(...)</dt><dd><tt><a href="#Display-set_title">set_title</a>(string: title) -> None. Temporary change of the diagram title.</tt></dd></dl>
+
+<dl><dt><a name="Display-zoom"><strong>zoom</strong></a>(...)</dt><dd><tt><a href="#Display-zoom">zoom</a>(real[2]: point, real: factor) -> None. Zoom around the given point.</tt></dd></dl>
+
+<hr>
+Data descriptors defined here:<br>
+<dl><dt><strong>diagram</strong></dt>
+<dd><tt>Diagram displayed.</tt></dd>
+</dl>
+<dl><dt><strong>origin</strong></dt>
+<dd><tt>Point in diagram coordinates of the top-left corner of the visible area.</tt></dd>
+</dl>
+<dl><dt><strong>visible</strong></dt>
+<dd><tt>Tuple(real: top, real: left, real: bottom, real: right) : visible area</tt></dd>
+</dl>
+<dl><dt><strong>zoom_factor</strong></dt>
+<dd><tt>Real: zoom-factor</tt></dd>
+</dl>
+</td></tr></table> <p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#ffc8d8">
+<td colspan=3 valign=bottom> <br>
+<font color="#000000" face="helvetica, arial"><a name="ExportFilter">class <strong>ExportFilter</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
+
+<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
+<td colspan=2><tt>returned by dia.<a href="#-register_export">register_export</a>() but not used otherwise yet.<br> </tt></td></tr>
+<tr><td> </td>
+<td width="100%">Methods defined here:<br>
+<dl><dt><a name="ExportFilter-__cmp__"><strong>__cmp__</strong></a>(...)</dt><dd><tt>x.<a href="#ExportFilter-__cmp__">__cmp__</a>(y) <==> cmp(x,y)</tt></dd></dl>
+
+<dl><dt><a name="ExportFilter-__hash__"><strong>__hash__</strong></a>(...)</dt><dd><tt>x.<a href="#ExportFilter-__hash__">__hash__</a>() <==> hash(x)</tt></dd></dl>
+
+<dl><dt><a name="ExportFilter-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#ExportFilter-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
+
+<hr>
+Data descriptors defined here:<br>
+<dl><dt><strong>name</strong></dt>
+<dd><tt>The description for the filter.</tt></dd>
+</dl>
+<dl><dt><strong>unique_name</strong></dt>
+<dd><tt>A uniqe name within filters to allow disambiguation.</tt></dd>
+</dl>
+</td></tr></table> <p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#ffc8d8">
+<td colspan=3 valign=bottom> <br>
+<font color="#000000" face="helvetica, arial"><a name="Font">class <strong>Font</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
+
+<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
+<td colspan=2><tt>Provides access to some objects font property.<br> </tt></td></tr>
+<tr><td> </td>
+<td width="100%">Methods defined here:<br>
+<dl><dt><a name="Font-__cmp__"><strong>__cmp__</strong></a>(...)</dt><dd><tt>x.<a href="#Font-__cmp__">__cmp__</a>(y) <==> cmp(x,y)</tt></dd></dl>
+
+<dl><dt><a name="Font-__hash__"><strong>__hash__</strong></a>(...)</dt><dd><tt>x.<a href="#Font-__hash__">__hash__</a>() <==> hash(x)</tt></dd></dl>
+
+<dl><dt><a name="Font-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#Font-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
+
+<hr>
+Data descriptors defined here:<br>
+<dl><dt><strong>family</strong></dt>
+<dd><tt>string: family name of the font</tt></dd>
+</dl>
+<dl><dt><strong>name</strong></dt>
+<dd><tt>string: legacy name of the font</tt></dd>
+</dl>
+<dl><dt><strong>style</strong></dt>
+<dd><tt>int: style flags</tt></dd>
+</dl>
+</td></tr></table> <p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#ffc8d8">
+<td colspan=3 valign=bottom> <br>
+<font color="#000000" face="helvetica, arial"><a name="Handle">class <strong>Handle</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
+
+<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
+<td colspan=2><tt>A handle is used to connect objects or for <a href="__builtin__.html#object">object</a> resizing.<br> </tt></td></tr>
+<tr><td> </td>
+<td width="100%">Methods defined here:<br>
+<dl><dt><a name="Handle-__cmp__"><strong>__cmp__</strong></a>(...)</dt><dd><tt>x.<a href="#Handle-__cmp__">__cmp__</a>(y) <==> cmp(x,y)</tt></dd></dl>
+
+<dl><dt><a name="Handle-__hash__"><strong>__hash__</strong></a>(...)</dt><dd><tt>x.<a href="#Handle-__hash__">__hash__</a>() <==> hash(x)</tt></dd></dl>
+
+<dl><dt><a name="Handle-connect"><strong>connect</strong></a>(...)</dt><dd><tt><a href="#Handle-connect">connect</a>(<a href="#ConnectionPoint">ConnectionPoint</a>: cp) -> None. Connect <a href="__builtin__.html#object">object</a> A's handle with <a href="__builtin__.html#object">object</a> B's connection point. To disconnect a handle pass in None.</tt></dd></dl>
+
+<hr>
+Data descriptors defined here:<br>
+<dl><dt><strong>connect_type</strong></dt>
+<dd><tt>NONCONNECTABLE=0.</tt></dd>
+</dl>
+<dl><dt><strong>connected_to</strong></dt>
+<dd><tt>The connected ConnectionPoint object or None.</tt></dd>
+</dl>
+<dl><dt><strong>id</strong></dt>
+<dd><tt>Can be used to derive preferred directions from it.</tt></dd>
+</dl>
+<dl><dt><strong>pos</strong></dt>
+<dd><tt>The position of the connection point.</tt></dd>
+</dl>
+<dl><dt><strong>type</strong></dt>
+<dd><tt>NON_MOVABLE=0, MAJOR_CONTROL=1, MINOR_CONTROL=2</tt></dd>
+</dl>
+</td></tr></table> <p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#ffc8d8">
+<td colspan=3 valign=bottom> <br>
+<font color="#000000" face="helvetica, arial"><a name="Image">class <strong>Image</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
+
+<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
+<td colspan=2><tt>dia.<a href="#Image">Image</a> gets passed into DiaRenderer.draw_image<br> </tt></td></tr>
+<tr><td> </td>
+<td width="100%">Methods defined here:<br>
+<dl><dt><a name="Image-__cmp__"><strong>__cmp__</strong></a>(...)</dt><dd><tt>x.<a href="#Image-__cmp__">__cmp__</a>(y) <==> cmp(x,y)</tt></dd></dl>
+
+<dl><dt><a name="Image-__hash__"><strong>__hash__</strong></a>(...)</dt><dd><tt>x.<a href="#Image-__hash__">__hash__</a>() <==> hash(x)</tt></dd></dl>
+
+<dl><dt><a name="Image-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#Image-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
+
+<hr>
+Data descriptors defined here:<br>
+<dl><dt><strong>filename</strong></dt>
+<dd><tt>string: utf-8 encoded filename of the image</tt></dd>
+</dl>
+<dl><dt><strong>height</strong></dt>
+<dd><tt>int: pixel height of the image</tt></dd>
+</dl>
+<dl><dt><strong>mask_data</strong></dt>
+<dd><tt>string: array of alpha pixel values</tt></dd>
+</dl>
+<dl><dt><strong>rgb_data</strong></dt>
+<dd><tt>string: array of packed rgb pixel values</tt></dd>
+</dl>
+<dl><dt><strong>uri</strong></dt>
+<dd><tt>string: Uniform Resource Identifier of the image</tt></dd>
+</dl>
+<dl><dt><strong>width</strong></dt>
+<dd><tt>int: pixel width of the image</tt></dd>
+</dl>
+</td></tr></table> <p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#ffc8d8">
+<td colspan=3 valign=bottom> <br>
+<font color="#000000" face="helvetica, arial"><a name="Layer">class <strong>Layer</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
+
+<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
+<td colspan=2><tt>A <a href="#Layer">Layer</a> is part of a <a href="#Diagram">Diagram</a> and can contain objects.<br> </tt></td></tr>
+<tr><td> </td>
+<td width="100%">Methods defined here:<br>
+<dl><dt><a name="Layer-__cmp__"><strong>__cmp__</strong></a>(...)</dt><dd><tt>x.<a href="#Layer-__cmp__">__cmp__</a>(y) <==> cmp(x,y)</tt></dd></dl>
+
+<dl><dt><a name="Layer-__hash__"><strong>__hash__</strong></a>(...)</dt><dd><tt>x.<a href="#Layer-__hash__">__hash__</a>() <==> hash(x)</tt></dd></dl>
+
+<dl><dt><a name="Layer-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#Layer-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
+
+<dl><dt><a name="Layer-add_object"><strong>add_object</strong></a>(...)</dt><dd><tt><a href="#Layer-add_object">add_object</a>(<a href="#Object">Object</a>: o[, int: position]) -> None. Add the <a href="__builtin__.html#object">object</a> to the layer at the top or the given position counting from bottom.</tt></dd></dl>
+
+<dl><dt><a name="Layer-destroy"><strong>destroy</strong></a>(...)</dt><dd><tt>Release the layer. Must not be called when already added to a diagram.</tt></dd></dl>
+
+<dl><dt><a name="Layer-find_closest_connection_point"><strong>find_closest_connection_point</strong></a>(...)</dt><dd><tt>find_closest_connectionpoint(real: x, real: y[, <a href="#Object">Object</a>: o]) -> (real: dist, <a href="#ConnectionPoint">ConnectionPoint</a>: cp). Given a point and an optional <a href="__builtin__.html#object">object</a> to exclude return the distance and the closest connection point or None.</tt></dd></dl>
+
+<dl><dt><a name="Layer-find_closest_object"><strong>find_closest_object</strong></a>(...)</dt><dd><tt><a href="#Layer-find_closest_object">find_closest_object</a>(real: x, real: y, real: maxdist) -> <a href="#Object">Object</a>. Find an <a href="__builtin__.html#object">object</a> in the given maximum distance of the given point.</tt></dd></dl>
+
+<dl><dt><a name="Layer-find_objects_in_rectangle"><strong>find_objects_in_rectangle</strong></a>(...)</dt><dd><tt><a href="#Layer-find_objects_in_rectangle">find_objects_in_rectangle</a>(real: top, real left, real: bottom, real: right) -> Objects Returns a list of objects found in the given rectangle.</tt></dd></dl>
+
+<dl><dt><a name="Layer-object_get_index"><strong>object_get_index</strong></a>(...)</dt><dd><tt><a href="#Layer-object_get_index">object_get_index</a>(<a href="#Object">Object</a>: o) -> int. Returns the index of the <a href="__builtin__.html#object">object</a> in the layers list of objects.</tt></dd></dl>
+
+<dl><dt><a name="Layer-remove_object"><strong>remove_object</strong></a>(...)</dt><dd><tt><a href="#Layer-remove_object">remove_object</a>(<a href="#Object">Object</a>: o) -> None Remove the <a href="__builtin__.html#object">object</a> from the layer and delete it.</tt></dd></dl>
+
+<dl><dt><a name="Layer-update_extents"><strong>update_extents</strong></a>(...)</dt><dd><tt><a href="#Layer-update_extents">update_extents</a>() -> None. Force recaculation of the layer extents.</tt></dd></dl>
+
+<hr>
+Data descriptors defined here:<br>
+<dl><dt><strong>extents</strong></dt>
+<dd><tt>Rectangle covering all object's bounding boxes.</tt></dd>
+</dl>
+<dl><dt><strong>name</strong></dt>
+<dd><tt>The name of the layer.</tt></dd>
+</dl>
+<dl><dt><strong>objects</strong></dt>
+<dd><tt>The list of objects in the layer.</tt></dd>
+</dl>
+<dl><dt><strong>visible</strong></dt>
+<dd><tt>The visibility of the layer.</tt></dd>
+</dl>
+</td></tr></table> <p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#ffc8d8">
+<td colspan=3 valign=bottom> <br>
+<font color="#000000" face="helvetica, arial"><a name="Object">class <strong>Object</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
+
+<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
+<td colspan=2><tt>The main building block of diagrams.<br> </tt></td></tr>
+<tr><td> </td>
+<td width="100%">Methods defined here:<br>
+<dl><dt><a name="Object-__cmp__"><strong>__cmp__</strong></a>(...)</dt><dd><tt>x.<a href="#Object-__cmp__">__cmp__</a>(y) <==> cmp(x,y)</tt></dd></dl>
+
+<dl><dt><a name="Object-__hash__"><strong>__hash__</strong></a>(...)</dt><dd><tt>x.<a href="#Object-__hash__">__hash__</a>() <==> hash(x)</tt></dd></dl>
+
+<dl><dt><a name="Object-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#Object-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>
+
+<dl><dt><a name="Object-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#Object-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
+
+<dl><dt><a name="Object-copy"><strong>copy</strong></a>(...)</dt><dd><tt><a href="#Object-copy">copy</a>() -> <a href="#Object">Object</a>. Create a new <a href="__builtin__.html#object">object</a> copy.</tt></dd></dl>
+
+<dl><dt><a name="Object-destroy"><strong>destroy</strong></a>(...)</dt><dd><tt><a href="#Object-destroy">destroy</a>() -> None. Release the <a href="__builtin__.html#object">object</a>. Must not be called when already added to a group or layer.</tt></dd></dl>
+
+<dl><dt><a name="Object-distance_from"><strong>distance_from</strong></a>(...)</dt><dd><tt><a href="#Object-distance_from">distance_from</a>(real: x, real: y) -> real. Calculate the <a href="__builtin__.html#object">object</a>'s distance from the given point.</tt></dd></dl>
+
+<dl><dt><a name="Object-move"><strong>move</strong></a>(...)</dt><dd><tt><a href="#Object-move">move</a>(real: x, real: y) -> None. Move the entire <a href="__builtin__.html#object">object</a>. The given point is the new <a href="__builtin__.html#object">object</a>.obj_pos.</tt></dd></dl>
+
+<dl><dt><a name="Object-move_handle"><strong>move_handle</strong></a>(...)</dt><dd><tt><a href="#Object-move_handle">move_handle</a>(<a href="#Handle">Handle</a>: h, (real: x, real: y)[int: reason, int: modifiers]) -> None. Move the given handle of the <a href="__builtin__.html#object">object</a> to the given position</tt></dd></dl>
+
+<hr>
+Data descriptors defined here:<br>
+<dl><dt><strong>bounding_box</strong></dt>
+<dd><tt>Box covering all the object.</tt></dd>
+</dl>
+<dl><dt><strong>connections</strong></dt>
+<dd><tt>Vector of connection points.</tt></dd>
+</dl>
+<dl><dt><strong>handles</strong></dt>
+<dd><tt>Vector of handles.</tt></dd>
+</dl>
+<dl><dt><strong>parent</strong></dt>
+<dd><tt>The parent object when parenting is in place, None otherwise.</tt></dd>
+</dl>
+<dl><dt><strong>properties</strong></dt>
+<dd><tt>Dictionary of object properties.</tt></dd>
+</dl>
+<dl><dt><strong>type</strong></dt>
+<dd><tt>The dia.ObjectType of the object</tt></dd>
+</dl>
+</td></tr></table> <p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#ffc8d8">
+<td colspan=3 valign=bottom> <br>
+<font color="#000000" face="helvetica, arial"><a name="ObjectType">class <strong>ObjectType</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
+
+<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
+<td colspan=2><tt>The dia.<a href="#Object">Object</a> factory. Allows to create objects of the specific type. Use: factory = <a href="#-get_object_type">get_object_type</a>(<type name>) to get a grip on it.<br> </tt></td></tr>
+<tr><td> </td>
+<td width="100%">Methods defined here:<br>
+<dl><dt><a name="ObjectType-__cmp__"><strong>__cmp__</strong></a>(...)</dt><dd><tt>x.<a href="#ObjectType-__cmp__">__cmp__</a>(y) <==> cmp(x,y)</tt></dd></dl>
+
+<dl><dt><a name="ObjectType-__hash__"><strong>__hash__</strong></a>(...)</dt><dd><tt>x.<a href="#ObjectType-__hash__">__hash__</a>() <==> hash(x)</tt></dd></dl>
+
+<dl><dt><a name="ObjectType-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#ObjectType-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>
+
+<dl><dt><a name="ObjectType-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#ObjectType-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
+
+<dl><dt><a name="ObjectType-create"><strong>create</strong></a>(...)</dt><dd><tt><a href="#ObjectType-create">create</a>(real: x, real: y) -> (<a href="#Object">Object</a>: o, <a href="#Handle">Handle</a>: h1, <a href="#Handle">Handle</a>: h2) Create a new <a href="__builtin__.html#object">object</a> of this type. Returns a tuple containing the new <a href="__builtin__.html#object">object</a> and up to two handles.</tt></dd></dl>
+
+<hr>
+Data descriptors defined here:<br>
+<dl><dt><strong>name</strong></dt>
+<dd><tt>string: the unique type indentifier of the object type.</tt></dd>
+</dl>
+<dl><dt><strong>version</strong></dt>
+<dd><tt>int: version number</tt></dd>
+</dl>
+</td></tr></table> <p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#ffc8d8">
+<td colspan=3 valign=bottom> <br>
+<font color="#000000" face="helvetica, arial"><a name="Paperinfo">class <strong>Paperinfo</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
+
+<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
+<td colspan=2><tt>dia.<a href="#Paperinfo">Paperinfo</a> is part of dia.<a href="#DiagramData">DiagramData</a> describing the paper<br> </tt></td></tr>
+<tr><td> </td>
+<td width="100%">Methods defined here:<br>
+<dl><dt><a name="Paperinfo-__cmp__"><strong>__cmp__</strong></a>(...)</dt><dd><tt>x.<a href="#Paperinfo-__cmp__">__cmp__</a>(y) <==> cmp(x,y)</tt></dd></dl>
+
+<dl><dt><a name="Paperinfo-__hash__"><strong>__hash__</strong></a>(...)</dt><dd><tt>x.<a href="#Paperinfo-__hash__">__hash__</a>() <==> hash(x)</tt></dd></dl>
+
+<dl><dt><a name="Paperinfo-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#Paperinfo-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
+
+<hr>
+Data descriptors defined here:<br>
+<dl><dt><strong>height</strong></dt>
+<dd><tt>real: height of the drawable area (sans margins)</tt></dd>
+</dl>
+<dl><dt><strong>is_portrait</strong></dt>
+<dd><tt>int: paper orientation</tt></dd>
+</dl>
+<dl><dt><strong>name</strong></dt>
+<dd><tt>string: paper name, e.g. A4 or Letter</tt></dd>
+</dl>
+<dl><dt><strong>scaling</strong></dt>
+<dd><tt>real: factor to zoom the diagram on the paper</tt></dd>
+</dl>
+<dl><dt><strong>width</strong></dt>
+<dd><tt>real: width of the drawable area (sans margins)</tt></dd>
+</dl>
+</td></tr></table> <p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#ffc8d8">
+<td colspan=3 valign=bottom> <br>
+<font color="#000000" face="helvetica, arial"><a name="Point">class <strong>Point</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
+
+<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
+<td colspan=2><tt>The dia.<a href="#Point">Point</a> does not only provide access trough it's members but also via a sequence interface.<br> </tt></td></tr>
+<tr><td> </td>
+<td width="100%">Methods defined here:<br>
+<dl><dt><a name="Point-__cmp__"><strong>__cmp__</strong></a>(...)</dt><dd><tt>x.<a href="#Point-__cmp__">__cmp__</a>(y) <==> cmp(x,y)</tt></dd></dl>
+
+<dl><dt><a name="Point-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#Point-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>
+
+<dl><dt><a name="Point-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#Point-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>
+
+<dl><dt><a name="Point-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#Point-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br>
+ <br>
+Use of negative indices is not supported.</tt></dd></dl>
+
+<dl><dt><a name="Point-__hash__"><strong>__hash__</strong></a>(...)</dt><dd><tt>x.<a href="#Point-__hash__">__hash__</a>() <==> hash(x)</tt></dd></dl>
+
+<dl><dt><a name="Point-__len__"><strong>__len__</strong></a>(...)</dt><dd><tt>x.<a href="#Point-__len__">__len__</a>() <==> len(x)</tt></dd></dl>
+
+<dl><dt><a name="Point-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#Point-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
+
+<hr>
+Data descriptors defined here:<br>
+<dl><dt><strong>x</strong></dt>
+<dd><tt>double: coordinate horizontal part</tt></dd>
+</dl>
+<dl><dt><strong>y</strong></dt>
+<dd><tt>double: coordinate vertical part</tt></dd>
+</dl>
+</td></tr></table> <p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#ffc8d8">
+<td colspan=3 valign=bottom> <br>
+<font color="#000000" face="helvetica, arial"><a name="Properties">class <strong>Properties</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
+
+<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
+<td colspan=2><tt>A dictionary interface to dia.<a href="#Object">Object</a>'s standard properties. Many propertiescan be get and set through this. If there is a specific method to change anobjects property like o.move() or o.move_handle() use that instead.<br> </tt></td></tr>
+<tr><td> </td>
+<td width="100%">Methods defined here:<br>
+<dl><dt><a name="Properties-__cmp__"><strong>__cmp__</strong></a>(...)</dt><dd><tt>x.<a href="#Properties-__cmp__">__cmp__</a>(y) <==> cmp(x,y)</tt></dd></dl>
+
+<dl><dt><a name="Properties-__delitem__"><strong>__delitem__</strong></a>(...)</dt><dd><tt>x.<a href="#Properties-__delitem__">__delitem__</a>(y) <==> del x[y]</tt></dd></dl>
+
+<dl><dt><a name="Properties-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#Properties-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>
+
+<dl><dt><a name="Properties-__hash__"><strong>__hash__</strong></a>(...)</dt><dd><tt>x.<a href="#Properties-__hash__">__hash__</a>() <==> hash(x)</tt></dd></dl>
+
+<dl><dt><a name="Properties-__len__"><strong>__len__</strong></a>(...)</dt><dd><tt>x.<a href="#Properties-__len__">__len__</a>() <==> len(x)</tt></dd></dl>
+
+<dl><dt><a name="Properties-__setitem__"><strong>__setitem__</strong></a>(...)</dt><dd><tt>x.<a href="#Properties-__setitem__">__setitem__</a>(i, y) <==> x[i]=y</tt></dd></dl>
+
+<dl><dt><a name="Properties-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#Properties-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
+
+<dl><dt><a name="Properties-get"><strong>get</strong></a>(...)</dt></dl>
+
+<dl><dt><a name="Properties-has_key"><strong>has_key</strong></a>(...)</dt></dl>
+
+<dl><dt><a name="Properties-keys"><strong>keys</strong></a>(...)</dt></dl>
+
+</td></tr></table> <p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#ffc8d8">
+<td colspan=3 valign=bottom> <br>
+<font color="#000000" face="helvetica, arial"><a name="Property">class <strong>Property</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
+
+<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
+<td colspan=2><tt>Interface to so called StdProps, the mechanism to control most of Dia's canvas objects properties.<br> </tt></td></tr>
+<tr><td> </td>
+<td width="100%">Methods defined here:<br>
+<dl><dt><a name="Property-__cmp__"><strong>__cmp__</strong></a>(...)</dt><dd><tt>x.<a href="#Property-__cmp__">__cmp__</a>(y) <==> cmp(x,y)</tt></dd></dl>
+
+<dl><dt><a name="Property-__hash__"><strong>__hash__</strong></a>(...)</dt><dd><tt>x.<a href="#Property-__hash__">__hash__</a>() <==> hash(x)</tt></dd></dl>
+
+<dl><dt><a name="Property-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#Property-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
+
+<hr>
+Data descriptors defined here:<br>
+<dl><dt><strong>name</strong></dt>
+<dd><tt>string: the name of the property</tt></dd>
+</dl>
+<dl><dt><strong>type</strong></dt>
+<dd><tt>string: the type name of the object</tt></dd>
+</dl>
+<dl><dt><strong>value</strong></dt>
+<dd><tt>various: the value is of type char, bool, dict, int, real, string, Text, Point, BezPoint, Rect, Arrow, Color or a tuple or list, possibly containing tuple of varying types.</tt></dd>
+</dl>
+<dl><dt><strong>visible</strong></dt>
+<dd><tt>bool: visibility of the property</tt></dd>
+</dl>
+</td></tr></table> <p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#ffc8d8">
+<td colspan=3 valign=bottom> <br>
+<font color="#000000" face="helvetica, arial"><a name="Rectangle">class <strong>Rectangle</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
+
+<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
+<td colspan=2><tt>The dia.<a href="#Rectangle">Rectangle</a> does not only provide access trough it's members but also via a sequence interface.<br> </tt></td></tr>
+<tr><td> </td>
+<td width="100%">Methods defined here:<br>
+<dl><dt><a name="Rectangle-__cmp__"><strong>__cmp__</strong></a>(...)</dt><dd><tt>x.<a href="#Rectangle-__cmp__">__cmp__</a>(y) <==> cmp(x,y)</tt></dd></dl>
+
+<dl><dt><a name="Rectangle-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#Rectangle-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>
+
+<dl><dt><a name="Rectangle-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#Rectangle-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br>
+ <br>
+Use of negative indices is not supported.</tt></dd></dl>
+
+<dl><dt><a name="Rectangle-__hash__"><strong>__hash__</strong></a>(...)</dt><dd><tt>x.<a href="#Rectangle-__hash__">__hash__</a>() <==> hash(x)</tt></dd></dl>
+
+<dl><dt><a name="Rectangle-__len__"><strong>__len__</strong></a>(...)</dt><dd><tt>x.<a href="#Rectangle-__len__">__len__</a>() <==> len(x)</tt></dd></dl>
+
+<dl><dt><a name="Rectangle-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#Rectangle-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
+
+<hr>
+Data descriptors defined here:<br>
+<dl><dt><strong>bottom</strong></dt>
+<dd><tt>int or double: lower edge y coordinate</tt></dd>
+</dl>
+<dl><dt><strong>left</strong></dt>
+<dd><tt>int or double: left edge x coordinate</tt></dd>
+</dl>
+<dl><dt><strong>right</strong></dt>
+<dd><tt>int or double: right edge x coordinate</tt></dd>
+</dl>
+<dl><dt><strong>top</strong></dt>
+<dd><tt>int or double: upper edge y coordinate</tt></dd>
+</dl>
+</td></tr></table> <p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#ffc8d8">
+<td colspan=3 valign=bottom> <br>
+<font color="#000000" face="helvetica, arial"><a name="Text">class <strong>Text</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
+
+<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
+<td colspan=2><tt>Many objects (dia.<a href="#Object">Object</a>) having text to display provide this property.<br> </tt></td></tr>
+<tr><td> </td>
+<td width="100%">Methods defined here:<br>
+<dl><dt><a name="Text-__cmp__"><strong>__cmp__</strong></a>(...)</dt><dd><tt>x.<a href="#Text-__cmp__">__cmp__</a>(y) <==> cmp(x,y)</tt></dd></dl>
+
+<dl><dt><a name="Text-__hash__"><strong>__hash__</strong></a>(...)</dt><dd><tt>x.<a href="#Text-__hash__">__hash__</a>() <==> hash(x)</tt></dd></dl>
+
+<dl><dt><a name="Text-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#Text-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
+
+<hr>
+Data descriptors defined here:<br>
+<dl><dt><strong>alignment</strong></dt>
+<dd><tt>int: alignment out of LEFT=0, CENTER=1, RIGHT=2</tt></dd>
+</dl>
+<dl><dt><strong>color</strong></dt>
+<dd><tt>Color: color of the text</tt></dd>
+</dl>
+<dl><dt><strong>font</strong></dt>
+<dd><tt>Font: read-only reference to font used</tt></dd>
+</dl>
+<dl><dt><strong>height</strong></dt>
+<dd><tt>real: height of the font</tt></dd>
+</dl>
+<dl><dt><strong>position</strong></dt>
+<dd><tt>Point: alignment position of the text</tt></dd>
+</dl>
+<dl><dt><strong>text</strong></dt>
+<dd><tt>string: text data</tt></dd>
+</dl>
+</td></tr></table></td></tr></table><p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#eeaa77">
+<td colspan=3 valign=bottom> <br>
+<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
+
+<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
+<td width="100%"><dl><dt><a name="-active_display"><strong>active_display</strong></a>(...)</dt><dd><tt><a href="#-active_display">active_display</a>() -> <a href="#Display">Display</a>. Delivers the currently active display 'dia.<a href="#Display">Display</a>' or None</tt></dd></dl>
+ <dl><dt><a name="-diagrams"><strong>diagrams</strong></a>(...)</dt><dd><tt><a href="#-diagrams">diagrams</a>() -> List of <a href="#Diagram">Diagram</a>. Returns the list of currently open diagrams</tt></dd></dl>
+ <dl><dt><a name="-get_object_type"><strong>get_object_type</strong></a>(...)</dt><dd><tt><a href="#-get_object_type">get_object_type</a>(string: type) -> <a href="#ObjectType">ObjectType</a>. From a type name like "Standard - Line" return the factory to create objects of that type, see: DiaObjectType</tt></dd></dl>
+ <dl><dt><a name="-group_create"><strong>group_create</strong></a>(...)</dt><dd><tt><a href="#-group_create">group_create</a>(List of <a href="#Object">Object</a>: objs) -> <a href="#Object">Object</a>. Create a group containing the given list of dia.<a href="#Object">Object</a>(s)</tt></dd></dl>
+ <dl><dt><a name="-load"><strong>load</strong></a>(...)</dt><dd><tt><a href="#-load">load</a>(string: name) -> <a href="#Diagram">Diagram</a>. Loads a diagram from the given filename</tt></dd></dl>
+ <dl><dt><a name="-message"><strong>message</strong></a>(...)</dt><dd><tt><a href="#-message">message</a>(int: type, string: msg) -> None. Popup a dialog with given message</tt></dd></dl>
+ <dl><dt><a name="-new"><strong>new</strong></a>(...)</dt><dd><tt><a href="#-new">new</a>(string: name) -> <a href="#Diagram">Diagram</a>. Create an empty diagram</tt></dd></dl>
+ <dl><dt><a name="-register_action"><strong>register_action</strong></a>(...)</dt><dd><tt><a href="#-register_action">register_action</a>(string: action, string: description, string: menupath, Callback: func) -> None. Register a callback function which appears in the menu. Depending on the menu path used during registrationthe callback gets called with the current DiaDiagramData <a href="__builtin__.html#object">object</a></tt></dd></dl>
+ <dl><dt><a name="-register_callback"><strong>register_callback</strong></a>(...)</dt><dd><tt><a href="#-register_callback">register_callback</a>(string: description, string: menupath, Callback: func) -> None. Register a callback function which appears in the menu. Depending on the menu path used during registrationthe callback gets called with the current DiaDiagramData <a href="__builtin__.html#object">object</a></tt></dd></dl>
+ <dl><dt><a name="-register_export"><strong>register_export</strong></a>(...)</dt><dd><tt><a href="#-register_export">register_export</a>(string: name, string: extension, Renderer: r) -> None. Allows to register an export filter written in Python. It needs to conform to the DiaRenderer interface.</tt></dd></dl>
+ <dl><dt><a name="-register_import"><strong>register_import</strong></a>(...)</dt><dd><tt><a href="#-register_import">register_import</a>(string: name, string: extension, Callback: func) -> None. Allows to register an import filter written in Python, that is mainly a callback function which fills thegiven DiaDiagramData from the given filename</tt></dd></dl>
+ <dl><dt><a name="-register_plugin"><strong>register_plugin</strong></a>(...)</dt><dd><tt><a href="#-register_plugin">register_plugin</a>(string: filename) -> None. Registers a single plug-in given its filename, that is load a dynamic module.</tt></dd></dl>
+ <dl><dt><a name="-registered_types"><strong>registered_types</strong></a>(...)</dt><dd><tt><a href="#-registered_types">registered_types</a>() -> Dict of <a href="#ObjectType">ObjectType</a> indexed by their name. A dictionary of all registered <a href="__builtin__.html#object">object</a> factories, aka. DiaObjectType</tt></dd></dl>
+ <dl><dt><a name="-update_all"><strong>update_all</strong></a>(...)</dt><dd><tt><a href="#-update_all">update_all</a>() -> None. Force an asynchronous update of all existing diagram displays</tt></dd></dl>
+</td></tr></table>
+</body></html>
\ No newline at end of file
diff --git a/projects.gnome.org/dia/python.html b/projects.gnome.org/dia/python.html
index a7c2f04..30c47d0 100644
--- a/projects.gnome.org/dia/python.html
+++ b/projects.gnome.org/dia/python.html
@@ -71,8 +71,8 @@ from Hans Breuer on the Python plug-in</a> object structure and syntax.
<p>
Nowadays there are a lot more Python plug-ins provided with Dia. Some of them
-are presented here.
-
+are presented here. Also there is documentation integrated with the bindings -
+updatable with e.g. <i>Help/PyDia HTML Docs</i> (<a href="pydia.html">/tmp/dia.html</a>)
<h2>pydiadoc.py</h2>
generates a new diagram which contains all objects
of dir(dia). Now fills attributes and operations by using
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
