← Back to branch summary

~vcs-imports/pygoocanvas/trunk

« back to all changes in this revision

Viewing changes to docs/reference/pygoocanvas-item.xml

  • Committer: gmtagliaretti
  • Date: 2008-05-22 16:16:10 UTC
  • Revision ID: svn-v4:aa6569b5-ad15-0410-a989-d4888eb19b46:trunk:212
Manually wrap goo_canvas_item_update and goo_canvas_item_get_requested_area), docs fixed,

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/pygoocanvas-item.xml
106
106
            <methodsynopsis language="python">
107
107
                <methodname><link linkend="method-goocanvasitem--get-requested-area">get_requested_area</link></methodname>
108
108
                <methodparam><parameter role="keyword">cr</parameter></methodparam>
109
 
                <methodparam><parameter role="keyword">requested_area</parameter></methodparam>
110
109
            </methodsynopsis>
111
110
 
112
111
            <methodsynopsis language="python">
912
911
            <programlisting><methodsynopsis language="python">
913
912
                <methodname>get_requested_area</methodname>
914
913
                <methodparam><parameter role="keyword">cr</parameter></methodparam>
915
 
                <methodparam><parameter role="keyword">requested_area</parameter></methodparam>
916
914
            </methodsynopsis></programlisting>
917
915
 
918
916
            <variablelist>
921
919
                    <listitem><simpara>A cairo context.</simpara></listitem>
922
920
                </varlistentry>
923
921
                <varlistentry>
924
 
                    <term><parameter role="keyword">requested_area</parameter>&nbsp;:</term>
925
 
                    <listitem><simpara>A GooCanvasBounds to return the requested area in, in the
926
 
                                       parent's coordinate space.</simpara></listitem>
927
 
                </varlistentry>
928
 
                <varlistentry>
929
922
                    <term><emphasis>Returns</emphasis>&nbsp;:</term>
930
 
                    <listitem><simpara>True if the item should be allocated space.</simpara></listitem>
 
923
                    <listitem><simpara>A <link linkend="class-canvas-bounds"><classname>goocanvas.Bounds
 
924
                    </classname></link> containing the requested area.</simpara></listitem>
931
925
                </varlistentry>
932
926
            </variablelist>
933
927
 
934
928
            <para>
935
 
                This is used by GooCanvasTable and other layout items to get the requested area of each of their children.
936
 
            </para>
937
 
            <para>
938
 
                FIXME: This method is currently broken, it needs to be manually wrapped returning the bounds instead of True/False.
 
929
                This function is only intended to be used when implementing new canvas items, specifically layout items such as
 
930
                <link linkend="class-canvas-table"><classname>goocanvas.Table</classname></link>.
 
931
                It gets the requested area of a child item.
939
932
            </para>
940
933
        </refsect2>
941
934
 
1565
1558
                <methodname>update</methodname>
1566
1559
                <methodparam><parameter role="keyword">entire_tree</parameter></methodparam>
1567
1560
                <methodparam><parameter role="keyword">cr</parameter></methodparam>
1568
 
                <methodparam><parameter role="keyword">bounds</parameter></methodparam>
1569
1561
            </methodsynopsis></programlisting>
1570
1562
 
1571
1563
            <variablelist>
1578
1570
                    <listitem><simpara>A cairo context.</simpara></listitem>
1579
1571
                </varlistentry>
1580
1572
                <varlistentry>
1581
 
                    <term><parameter role="keyword">bounds</parameter>&nbsp;:</term>
1582
 
                    <listitem><simpara>A GooCanvasBounds to return the new bounds in.</simpara></listitem>
 
1573
                    <term><emphasis>Returns</emphasis>&nbsp;:</term>
 
1574
                    <listitem><simpara>A <link linkend="class-canvas-bounds"><classname>goocanvas.Bounds
 
1575
                    </classname></link> containing the requested area.</simpara></listitem>
1583
1576
                </varlistentry>
1584
1577
            </variablelist>
1585
1578
 
1586
1579
            <para>
1587
 
                Updates the item, if needed, and any children.
 
1580
                This function is only intended to be used when implementing new canvas items, specifically layout items such as
 
1581
                <link linkend="class-canvas-group"><classname>goocanvas.Group</classname></link>.
 
1582
                Updates the item, if needed, and any children, returning the bounding box.
1588
1583
            </para>
1589
1584
        </refsect2>
1590
1585
    </refsect1>