ryujinx/GtkSharp
1
0
Fork 0
mirror of https://github.com/Ryujinx/GtkSharp.git synced 2024-12-24 01:05:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

* en/Gnome/CanvasWidget.xml:

Browse source 
* en/Gnome/CanvasRect.xml:
* en/Gnome/CanvasRE.xml:
* en/Gnome/CanvasPolygon.xml:
* en/Gnome/CanvasPixbuf.xml:
* en/Gnome/CanvasLine.xml:
* en/Gnome/CanvasItem.xml:
* en/Gnome/CanvasGroup.xml:
* en/Gnome/CanvasEllipse.xml:
* en/Gnome/CanvasClipgroup.xml:
* en/Gnome/CanvasBpath.xml:
* en/Gnome/Canvas.xml: fully documented.

svn path=/trunk/gtk-sharp/; revision=16875
This commit is contained in:
Duncan Mak 2003-07-30 06:34:41 +00:00
parent 51ae478c43
commit b9b7cf319b
13 changed files with 1303 additions and 879 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
doc/ChangeLog
View file

@ -1,3 +1,18 @@
2003-07-30 Duncan Mak <duncan@ximian.com>
* en/Gnome/CanvasWidget.xml:
* en/Gnome/CanvasRect.xml:
* en/Gnome/CanvasRE.xml:
* en/Gnome/CanvasPolygon.xml:
* en/Gnome/CanvasPixbuf.xml:
* en/Gnome/CanvasLine.xml:
* en/Gnome/CanvasItem.xml:
* en/Gnome/CanvasGroup.xml:
* en/Gnome/CanvasEllipse.xml:
* en/Gnome/CanvasClipgroup.xml:
* en/Gnome/CanvasBpath.xml:
* en/Gnome/Canvas.xml: fully documented.
2003-07-29 Duncan Mak <duncan@ximian.com>
* en/Gtk/Label.xml: Finished documentation for the Gtk.Label

801
doc/en/Gnome/Canvas.xml
View file

File diff suppressed because it is too large Load diff

52
doc/en/Gnome/CanvasBpath.xml
View file

@ -7,8 +7,13 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Bezier path canvas item</summary>
<remarks>
<para>
A canvas item type for creating a "path" from curve and line
segments.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gnome.CanvasShape</BaseTypeName>
@ -40,8 +45,8 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">Pointer to the C object.</param>
@ -67,13 +72,16 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="group" Type="Gnome.CanvasGroup" />
</Parameters>
<Parameter Name="group" Type="Gnome.CanvasGroup" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="group">To be added: an object of type 'Gnome.CanvasGroup'</param>
<returns>To be added: an object of type 'Gnome.CanvasBpath'</returns>
<remarks>To be added</remarks>
<summary>Creates a new Bezier path</summary>
<param name="group">
The <see cref="T:Gnome.CanvasGroup" /> that this item
belongs to.
</param>
<returns>the newly-created <see cref="T:Gnome.CanvasBpath" /> object</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -94,13 +102,19 @@
<ReturnValue>
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'IntPtr'</returns>
<remarks>To be added</remarks>
<summary>Pointer to a GnomeCanvasPathDef structure.</summary>
<param name="value">
Pointer to a <see cref="T:Gnome.CanvasPathDef" /> structure.
</param>
<returns>Pointer to a GnomeCanvasPathDef structure.</returns>
<remarks>
<para>
Pointer to a <see cref="T:Gnome.CanvasPathDef" /> structure. This can be
created by a call to the <see cref="C:Gnome.CanvasPathDef" /> constructor.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -108,8 +122,8 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param>
@ -120,4 +134,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

65
doc/en/Gnome/CanvasClipgroup.xml
View file

@ -7,8 +7,11 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Canvas group that implements clipping</summary>
<remarks>
A canvas group object that clips the view of its children to a
shape defined by a <see cref="T:Gnome.CanvasPathDef" />.
</remarks>
</Docs>
<Base>
<BaseTypeName>Gnome.CanvasGroup</BaseTypeName>
@ -40,8 +43,8 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">Pointer to the C object.</param>
@ -67,13 +70,16 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="group" Type="Gnome.CanvasGroup" />
</Parameters>
<Parameter Name="group" Type="Gnome.CanvasGroup" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="group">To be added: an object of type 'Gnome.CanvasGroup'</param>
<returns>To be added: an object of type 'Gnome.CanvasClipgroup'</returns>
<remarks>To be added</remarks>
<summary>Create new <see cref="T:Gnome.CanvasClipgroup" /></summary>
<param name="group">
The <see cref="T:Gnome.CanvasGroup" /> that this <see cref="T:Gnome.CanvasClipgroup" />
belongs to.
</param>
<returns>The newly-created <see cref="T:Gnome.Canvas.Clipgroup" /> object</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -94,28 +100,33 @@
<ReturnValue>
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'IntPtr'</returns>
<remarks>To be added</remarks>
<summary>Pointer to a GnomeCanvasPathDef structure.</summary>
<param name="value">
Pointer to a <see cref="T:Gnome.CanvasPathDef" /> structure.
</param>
<returns>Pointer to a GnomeCanvasPathDef structure.</returns>
<remarks>
<para>
Pointer to a <see cref="T:Gnome.CanvasPathDef" /> structure. This can be
created by a call to the <see cref="C:Gnome.CanvasPathDef" /> constructor.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Wind">
<MemberSignature Language="C#" Value="public uint Wind { set; get; };" />
<MemberSignature Language="C#" Value="public Art.WindRule Wind { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
<ReturnType>Art.WindRule</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'uint'</param>
<returns>To be added: an object of type 'uint'</returns>
<remarks>To be added</remarks>
<summary>Winding rule for defining the clipping intersection rule</summary>
<param name="value">the winding rule</param>
<returns>Winding rule for defining the clipping intersection rule</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -123,8 +134,8 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param>
@ -135,4 +146,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

39
doc/en/Gnome/CanvasEllipse.xml
View file

@ -7,8 +7,14 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Canvas item for drawing ellipses and circles</summary>
<remarks>
<para>
A canvas item for drawing ellipses and circles. The parameters
are defined in the parent classes including <see cref="T:Gnome.CanvasRE" />
which is shared with <see cref="T:Gnome.CanvasRect" /> items as well.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gnome.CanvasRE</BaseTypeName>
@ -40,8 +46,8 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">Pointer to the C object.</param>
@ -67,13 +73,20 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="group" Type="Gnome.CanvasGroup" />
</Parameters>
<Parameter Name="group" Type="Gnome.CanvasGroup" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="group">To be added: an object of type 'Gnome.CanvasGroup'</param>
<returns>To be added: an object of type 'Gnome.CanvasEllipse'</returns>
<remarks>To be added</remarks>
<summary>
Create a new <see cref="T:Gnome.CanvasEllipse" /> object
</summary>
<param name="group">
The <see cref="T:Gnome.CanvasGroup" /> that this <see cref="T:Gnome.CanvasEllipse" />
belongs to.
</param>
<returns>
The newly-created <see cref="T:Gnome.CanvasEllipse" /> object
</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -93,8 +106,8 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param>
@ -105,4 +118,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

52
doc/en/Gnome/CanvasGroup.xml
View file

@ -7,8 +7,18 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Canvas item group</summary>
<remarks>
<para>
A canvas item that groups other canvas items. A canvas group
is used for organization, determining drawing stacking order,
and for applying transforms on all items in the group.
</para>
<para>
The GnomeCanvas widget contains a toplevel root group which
can be obtained with the <see cref="M:Gnome.Canvas.Root" /> property.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gnome.CanvasItem</BaseTypeName>
@ -40,8 +50,8 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">Pointer to the C object.</param>
@ -67,9 +77,9 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="group" Type="Gnome.CanvasGroup" />
<Parameter Name="type" Type="System.UInt32" />
</Parameters>
<Parameter Name="group" Type="Gnome.CanvasGroup" />
<Parameter Name="type" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="group">To be added: an object of type 'Gnome.CanvasGroup'</param>
@ -96,13 +106,12 @@
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
<summary>X coordinate of the group's origin.</summary>
<param name="value">X coordinate of the group's origin.</param>
<returns>X coordinate of the group's origin.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="X">
@ -111,13 +120,12 @@
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
<summary>Y coordinate of the group's origin</summary>
<param name="value">Y coordinate of the group's origin</param>
<returns>Y coordinate of the group's origin</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -125,8 +133,8 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param>
@ -137,4 +145,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

436
doc/en/Gnome/CanvasItem.xml
View file

@ -7,8 +7,78 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Base class for all canvas items</summary>
<remarks>
<para>
This is the base class for all canvas items. Canvas items are
the drawing elements of a GnomeCanvas. Example items include
lines, ellipses, polygons, images, text, curves and even
arbitrary GTK+ widgets.
</para>
<para>
Canvas items use the GObject property system to query and set
parameters. Properties are inherited so, for example, a
<see cref="P:Gnome.CanvasPolygon" /> has a
<see cref="P:Gnome.CanvasPolygon.FillColor" /> property that is
inherited from its parent class object
<see cref="P:Gnome.CanvasShape" />. So be
sure to check the parent classes of
<see cref="T:Gnome.CanvasItem" /> objects
when looking for item properties.
</para>
<para>
To create a new canvas item use the
<see cref="C:Gnome.CanvasItem" /> constructor which
takes a parent <see cref="T:Gnome.CanvasGroup" />,
<see cref="T:GLib.Type" /> of the item to create,
and a <see langword="null" /> terminated list of name/value GObject properties to
set for the new item.
</para>
<para>
There are several methods to change the drawing stacking
order of an item. Call <see cref="M:Gnome.CanvasItem.Raise" /> to raise an
item a specified number of positions or
<see cref="M:Gnome.CanvasItem.Lower" /> to lower it. To raise an item to the
top call <see cref="M:Gnome.CanvasItem.RaiseToTop" />. The
<see cref="M:Gnome.CanvasItem.LowerToBottom" /> methods will put it at
the bottom.
</para>
<para>
To show an item call <see cref="M:Gnome.CanvasItem.Show" />. Note that
canvas item's are shown by default and so do not need to be
explicitly shown after creation (contrary to GTK+ widget
behavior). Call <see cref="M:Gnome.CanvasItem.Hide" /> to hide an item.
</para>
<para>
To move an item relative to its current position (item
coordinates) call <see cref="M:Gnome.CanvasItem.Move" /> or
<see cref="M:Gnome.CanvasItem.AffineRelative" /> for more complex
transforms. <see cref="M:Gnome.CanvasItem.AffineAbsolute" /> can be used to
set an item's transform to specific values (not offsets).
</para>
<para>
To convert between world and item coordinate systems call
<see cref="M:Gnome.CanvasItem.W2i" />, and to convert in the other direction
call <see cref="M:Gnome.CanvasItem.I2w" />. To get the transform for
converting from item to world coordinates use
<see cref="M:M:Gnome.CanvasItem.I2wAffine" /> or for converting item to
canvas coordinates, <see cref="M:Gnome.CanvasItem.I2cAffine" />.
</para>
<para>
Handling user input for interactive items is accomplished
through a few functions and the "event" signals. To grab the
mouse cursor call <see cref="M:Gnome.CanvasItem.Grab" />, it can be
ungrabbed with <see cref="M:Gnome.CanvasItem.Ungrab" /> (see
<see cref="M:Gdk.Pointer.Grab" /> of the GTK+ library for details). To grab
keyboard focus call <see cref="M:Gnome.CanvasItem.GrabFocus" />. Received
events will be signaled via the "event" signal.
</para>
<para>
Some other useful functions include a reparenting routine,
<see cref="M:Gnome.CanvasItem.Reparent" />, and a function to query the
bounding box of an item (a minumum rectangular area containing
all parts of the item), <see cref="M:Gnome.CanvasItem.Getbounds" /></para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Object</BaseTypeName>
@ -24,18 +94,21 @@
<Attributes />
<Members>
<Member MemberName="AffineRelative">
<MemberSignature Language="C#" Value="public void AffineRelative (double [] affine);" />
<MemberSignature Language="C#" Value="public void AffineRelative (out double [] affine);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="affine" Type="System.Double []" />
</Parameters>
<Parameter Name="affine" Type="System.Double []&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="affine">To be added: an object of type 'double []'</param>
<remarks>To be added</remarks>
<summary>
Combines the specified affine transformation matrix with the
item's current transformation.
</summary>
<param name="affine">Return value for an affine transformation matrix.</param>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Lower">
@ -45,12 +118,17 @@
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="positions" Type="System.Int32" />
</Parameters>
<Parameter Name="positions" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="positions">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
<summary>
Lowers the item in its parent's stack by the specified
number of positions. If the number of positions is greater
than the distance to the bottom of the stack, then the item
is put at the bottom.
</summary>
<param name="positions">Number of steps to lower the item.</param>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Show">
@ -61,8 +139,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Shows a canvas item. If the item was already shown, then no action is taken.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="RequestRedrawSvp">
@ -72,12 +150,16 @@
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="svp" Type="Art.SVP" />
</Parameters>
<Parameter Name="svp" Type="Art.SVP" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="svp">To be added: an object of type 'Art.SVP'</param>
<remarks>To be added</remarks>
<summary>Request redraw of <see paramref="svp" /> if in aa mode, or the entire item in in xlib mode.</summary>
<param name="svp">The svp that needs to be redrawn</param>
<remarks>
<para>
This item must contain <see paramref="svp" />.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="GrabFocus">
@ -88,8 +170,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>
Makes the specified item take the keyboard focus, so all
keyboard events will be sent to it. If the canvas widget
itself did not have the focus, it grabs it as well.
</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="LowerToBottom">
@ -100,8 +186,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Lowers an item to the bottom of its parent's stack.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Hide">
@ -112,8 +198,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Hides a canvas item. If the item was already hidden, then no action is taken.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="RaiseToTop">
@ -124,25 +210,30 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Raises an item to the top of its parent's stack.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="W2i">
<MemberSignature Language="C#" Value="public void W2i (double x, double y);" />
<MemberSignature Language="C#" Value="public void W2i (ref double x, ref double y);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="x" Type="System.Double" />
<Parameter Name="y" Type="System.Double" />
</Parameters>
<Parameter Name="x" Type="System.Double&amp;" RefType="ref" />
<Parameter Name="y" Type="System.Double&amp;" RefType="ref" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="x">To be added: an object of type 'double'</param>
<param name="y">To be added: an object of type 'double'</param>
<remarks>To be added</remarks>
<summary>Converts a coordinate pair from world coordinates to item-relative coordinates.</summary>
<param name="x">X coordinate to convert (input/output value).</param>
<param name="y">Y coordinate to convert (input/output value).</param>
<remarks>
<para>
The parameters <see paramref="x" /> and <see paramref="y" />
are used as both in and out parameters.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="UpdateSvp">
@ -152,50 +243,14 @@
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="p_svp" Type="Art.SVP" />
<Parameter Name="new_svp" Type="Art.SVP" />
</Parameters>
<Parameter Name="p_svp" Type="Art.SVP" />
<Parameter Name="new_svp" Type="Art.SVP" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="p_svp">To be added: an object of type 'Art.SVP'</param>
<param name="new_svp">To be added: an object of type 'Art.SVP'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetValist">
<MemberSignature Language="C#" Value="public void SetValist (string first_arg_name, IntPtr args);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="first_arg_name" Type="System.String" />
<Parameter Name="args" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="first_arg_name">To be added: an object of type 'string'</param>
<param name="args">To be added: an object of type 'IntPtr'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Construct">
<MemberSignature Language="C#" Value="public void Construct (Gnome.CanvasGroup parent, string first_arg_name, IntPtr args);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="parent" Type="Gnome.CanvasGroup" />
<Parameter Name="first_arg_name" Type="System.String" />
<Parameter Name="args" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="parent">To be added: an object of type 'Gnome.CanvasGroup'</param>
<param name="first_arg_name">To be added: an object of type 'string'</param>
<param name="args">To be added: an object of type 'IntPtr'</param>
<remarks>To be added</remarks>
<summary>Sets the svp to the new value, requesting repaint on what's changed</summary>
<param name="p_svp">the existing SVP</param>
<param name="new_svp">the new SVP</param>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="UpdateSvpClip">
@ -205,16 +260,16 @@
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="p_svp" Type="Art.SVP" />
<Parameter Name="new_svp" Type="Art.SVP" />
<Parameter Name="clip_svp" Type="Art.SVP" />
</Parameters>
<Parameter Name="p_svp" Type="Art.SVP" />
<Parameter Name="new_svp" Type="Art.SVP" />
<Parameter Name="clip_svp" Type="Art.SVP" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="p_svp">To be added: an object of type 'Art.SVP'</param>
<param name="new_svp">To be added: an object of type 'Art.SVP'</param>
<param name="clip_svp">To be added: an object of type 'Art.SVP'</param>
<remarks>To be added</remarks>
<summary>Sets the svp to the new value, clipping if necessary, and requesting repaint on what's changed.</summary>
<param name="p_svp">the old SVP</param>
<param name="new_svp">the new SVP</param>
<param name="clip_svp">a clip path</param>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetBounds">
@ -224,33 +279,40 @@
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="x1" Type="System.Double&amp;" RefType="out" />
<Parameter Name="y1" Type="System.Double&amp;" RefType="out" />
<Parameter Name="x2" Type="System.Double&amp;" RefType="out" />
<Parameter Name="y2" Type="System.Double&amp;" RefType="out" />
</Parameters>
<Parameter Name="x1" Type="System.Double&amp;" RefType="out" />
<Parameter Name="y1" Type="System.Double&amp;" RefType="out" />
<Parameter Name="x2" Type="System.Double&amp;" RefType="out" />
<Parameter Name="y2" Type="System.Double&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="x1">To be added: an object of type 'double&amp;'</param>
<param name="y1">To be added: an object of type 'double&amp;'</param>
<param name="x2">To be added: an object of type 'double&amp;'</param>
<param name="y2">To be added: an object of type 'double&amp;'</param>
<remarks>To be added</remarks>
<summary>
Queries the bounding box of a canvas item. The bounds are
returned in the coordinate system of the item's
parent.
</summary>
<param name="x1">Return value for the leftmost edge of the bounding box</param>
<param name="y1">Return value for the upper edge of the bounding box</param>
<param name="x2">Return value for the rightmost edge of the bounding box</param>
<param name="y2">Return value for the lower edge of the bounding box</param>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="AffineAbsolute">
<MemberSignature Language="C#" Value="public void AffineAbsolute (double [] affine);" />
<MemberSignature Language="C#" Value="public void AffineAbsolute (out double [] affine);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="affine" Type="System.Double []" />
</Parameters>
<Parameter Name="affine" Type="System.Double []&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="affine">To be added: an object of type 'double []'</param>
<remarks>To be added</remarks>
<summary>
Makes the item's affine transformation matrix be equal to
the specified matrix.
</summary>
<param name="affine">Return value for an affine transformation matrix.</param>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Reparent">
@ -260,27 +322,32 @@
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="new_group" Type="Gnome.CanvasGroup" />
</Parameters>
<Parameter Name="new_group" Type="Gnome.CanvasGroup" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="new_group">To be added: an object of type 'Gnome.CanvasGroup'</param>
<remarks>To be added</remarks>
<summary>
Changes the parent of the specified item to be the new
group. The item keeps its group-relative coordinates as for
its old parent, so the item may change its absolute position
within the canvas.
</summary>
<param name="new_group">A canvas group.</param>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="I2wAffine">
<MemberSignature Language="C#" Value="public void I2wAffine (double [] affine);" />
<MemberSignature Language="C#" Value="public void I2wAffine (out double [] affine);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="affine" Type="System.Double []" />
</Parameters>
<Parameter Name="affine" Type="System.Double []&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="affine">To be added: an object of type 'double []'</param>
<remarks>To be added</remarks>
<summary>Gets the affine transform that converts from the item's coordinate system to world coordinates.</summary>
<param name="affine">Return value for an affine transformation matrix</param>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Ungrab">
@ -290,28 +357,26 @@
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="etime" Type="System.UInt32" />
</Parameters>
<Parameter Name="etime" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="etime">To be added: an object of type 'uint'</param>
<remarks>To be added</remarks>
<summary>Ungrabs the item, which must have been grabbed in the canvas, and ungrabs the mouse.</summary>
<param name="etime">The timestamp for ungrabbing the mouse.</param>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="I2cAffine">
<MemberSignature Language="C#" Value="public void I2cAffine (double [] affine);" />
<MemberSignature Language="C#" Value="public void I2cAffine (out double [] affine);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="affine" Type="System.Double []" />
</Parameters>
<Parameter Name="affine" Type="System.Double []&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="affine">To be added: an object of type 'double []'</param>
<remarks>To be added</remarks>
</Docs>
<summary>Gets the affine transform that converts from item-relative coordinates to canvas pixel coordinates.</summary>/
<param name="affine">Return value for an affine transformation matrix (return value).</param><remarks></remarks></Docs>
</Member>
<Member MemberName="Raise">
<MemberSignature Language="C#" Value="public void Raise (int positions);" />
@ -320,29 +385,39 @@
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="positions" Type="System.Int32" />
</Parameters>
<Parameter Name="positions" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="positions">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
<summary>
Raises the item in its parent's stack by the specified
number of positions. If the number of positions is greater
than the distance to the top of the stack, then the item is
put at the top.
</summary>
<param name="positions">Number of steps to raise the item.</param>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="I2w">
<MemberSignature Language="C#" Value="public void I2w (double x, double y);" />
<MemberSignature Language="C#" Value="public void I2w (ref double x, ref double y);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="x" Type="System.Double" />
<Parameter Name="y" Type="System.Double" />
</Parameters>
<Parameter Name="x" Type="System.Double&amp;" RefType="ref" />
<Parameter Name="y" Type="System.Double&amp;" RefType="ref" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="x">To be added: an object of type 'double'</param>
<param name="y">To be added: an object of type 'double'</param>
<remarks>To be added</remarks>
<summary>Converts a coordinate pair from item-relative coordinates to world coordinates.</summary>
<param name="x">X coordinate to convert (input/output value).</param>
<param name="y">Y coordinate to convert (input/output value).</param>
<remarks>
<para>
The parameters <see paramref="x" /> and <see paramref="y" />
are used as both in and out parameters.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Move">
@ -352,14 +427,20 @@
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dx" Type="System.Double" />
<Parameter Name="dy" Type="System.Double" />
</Parameters>
<Parameter Name="dx" Type="System.Double" />
<Parameter Name="dy" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="dx">To be added: an object of type 'double'</param>
<param name="dy">To be added: an object of type 'double'</param>
<remarks>To be added</remarks>
<summary>
Moves a canvas item by creating an affine transformation
matrix for translation by using the specified values. This
happens in item local coordinate system, so if you have
nontrivial transform, it most probably does not do, what you
want.
</summary>
<param name="dx">Horizontal offset.</param>
<param name="dy">Vertical offset.</param>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="RequestUpdate">
@ -370,8 +451,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>To be used only by item implementations. Requests that the canvas queue an update for the specified item.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="ResetBounds">
@ -382,8 +463,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Resets the bounding box of a canvas item to an empty rectangle.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
@ -403,8 +484,8 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">Pointer to the C object.</param>
@ -425,22 +506,6 @@
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CanvasItem (Gnome.CanvasGroup group, uint type);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="group" Type="Gnome.CanvasGroup" />
<Parameter Name="type" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="group">To be added: an object of type 'Gnome.CanvasGroup'</param>
<param name="type">To be added: an object of type 'uint'</param>
<returns>To be added: an object of type 'Gnome.CanvasItem'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static uint GType { get; };" />
<MemberType>Property</MemberType>
@ -471,23 +536,30 @@
<ReturnValue>
<ReturnType>Gnome.CanvasItem</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gnome.CanvasItem'</param>
<returns>To be added: an object of type 'Gnome.CanvasItem'</returns>
<remarks>To be added</remarks>
<summary>The parent item</summary>
<param name="value">the parent item</param>
<returns>the parent item</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="CanvasEvent">
<MemberSignature Language="C#" Value="public event GnomeSharp.CanvasEventHandler CanvasEvent;" />
<MemberType>Event</MemberType>
<ReturnValue><ReturnType>GnomeSharp.CanvasEventHandler</ReturnType></ReturnValue>
<ReturnValue>
<ReturnType>GnomeSharp.CanvasEventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>
Signals mouse button clicks, motion, enter/leave, and key
press events on canvas items. Use this to create user
interactive items. The x and y coordinates in the
<see cref="F:GtkSharp.CanvasEventArgs.Event" />
field have been converted to canvas world coordinates.
</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -495,8 +567,8 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param>
@ -507,4 +579,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

231
doc/en/Gnome/CanvasLine.xml
View file

@ -7,8 +7,12 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Line canvas item</summary>
<remarks>
A canvas item for drawing lines. This canvas item uses a
<see cref="T:Gnome.CanvasPoints" /> structure so one or multiple joined lined
segments can be drawn with a single <see cref="T:Gnome.CanvasLine" /> item.
</remarks>
</Docs>
<Base>
<BaseTypeName>Gnome.CanvasItem</BaseTypeName>
@ -40,8 +44,8 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">Pointer to the C object.</param>
@ -67,13 +71,16 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="group" Type="Gnome.CanvasGroup" />
</Parameters>
<Parameter Name="group" Type="Gnome.CanvasGroup" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="group">To be added: an object of type 'Gnome.CanvasGroup'</param>
<returns>To be added: an object of type 'Gnome.CanvasLine'</returns>
<remarks>To be added</remarks>
<summary>Creates a new line</summary>
<param name="group">
The <see cref="T:Gnome.CanvasGroup" /> that this item
belongs to.
</param>
<returns>the newly-created <see cref="T:Gnome.CanvasLine" /> object</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -94,13 +101,12 @@
<ReturnValue>
<ReturnType>Gdk.Drawable</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Drawable'</param>
<returns>To be added: an object of type 'Gdk.Drawable'</returns>
<remarks>To be added</remarks>
<summary>Stipple pattern for the line.</summary>
<param name="value">Stipple pattern for the line.</param>
<returns>Stipple pattern for the line.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="ArrowShapeB">
@ -109,13 +115,15 @@
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
<summary>
Distance from tip of arrowhead to trailing point, measured
along the shaft.
</summary>
<param name="value">Distance from tip of arrowhead to trailing point, measured along shaft.</param>
<returns>Distance from tip of arrowhead to trailing point, measured along shaft.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="ArrowShapeA">
@ -124,13 +132,12 @@
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
<summary>Distance from tip of arrowhead to center.</summary>
<param name="value">Distance from tip of arrowhead to center.</param>
<returns>Distance from tip of arrowhead to center.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Smooth">
@ -139,13 +146,13 @@
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Specifies whether to smooth the line using parabolic splines.</summary>
<param name="value">
<see langword="true" /> to smooth the line</param>
<returns>Whether to smooth the line using parabolic splines</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="LineStyle">
@ -154,13 +161,12 @@
<ReturnValue>
<ReturnType>Gdk.LineStyle</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.LineStyle'</param>
<returns>To be added: an object of type 'Gdk.LineStyle'</returns>
<remarks>To be added</remarks>
<summary>Line dash style.</summary>
<param name="value">Line dash style</param>
<returns>Line dash style</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Points">
@ -169,13 +175,14 @@
<ReturnValue>
<ReturnType>Gnome.CanvasPoints</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gnome.CanvasPoints'</param>
<returns>To be added: an object of type 'Gnome.CanvasPoints'</returns>
<remarks>To be added</remarks>
<summary>a <see cref="T:Gnome.CanvasPoints" /> pointer. This
can be created by a call to the <see cref="C:Gnome.CanvasPoints" /> constructor.
</summary>
<param name="value">a <see cref="T:Gnome.CanvasPoints" /> pointer.</param>
<returns>a <see cref="T:Gnome.CanvasPoints" /> pointer.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="FirstArrowhead">
@ -184,13 +191,13 @@
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Specifies whether to draw an arrowhead on the first point of the line.</summary>
<param name="value">
<see langword="true" /> to draw an arrowhead</param>
<returns>whether to draw an arrowhead on the first point of the line.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="SplineSteps">
@ -199,13 +206,12 @@
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'uint'</param>
<returns>To be added: an object of type 'uint'</returns>
<remarks>To be added</remarks>
<summary>Specifies the number of steps to use when rendering curves.</summary>
<param name="value">the number of steps to use when rendering curves.</param>
<returns>the number of steps to use when rendering curves.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="LastArrowhead">
@ -214,12 +220,12 @@
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<summary>Specifies whether to draw an arrowhead on the last point of the line.</summary>
<param name="value">
<see langword="true" /> to draw an arrowhead</param>
<returns>whether to draw an arrowhead on the last point of the line.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -229,13 +235,12 @@
<ReturnValue>
<ReturnType>Gdk.CapStyle</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.CapStyle'</param>
<returns>To be added: an object of type 'Gdk.CapStyle'</returns>
<remarks>To be added</remarks>
<summary>Determines how the ends of lines are drawn (the line cap style).</summary>
<param name="value">the line cap style.</param>
<returns>the line cap style</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="JoinStyle">
@ -244,13 +249,19 @@
<ReturnValue>
<ReturnType>Gdk.JoinStyle</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.JoinStyle'</param>
<returns>To be added: an object of type 'Gdk.JoinStyle'</returns>
<remarks>To be added</remarks>
<summary>Vertex join style for line segments</summary>
<param name="value">the vertext join style</param>
<returns>Vertex join style</returns>
<remarks>
<para>
(<see cref="F:Gdk.JoinStyle.Miter" /> to join by extending
each line to meet at an angle, <see cref="F:Gdk.JoinStyle.Round" /> to join by a circular arc,
and <see cref="F:Gdk.JoinStyle.Bevel" /> to join by a
straight line which makes an equal angle with each line)
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="FillColorRgba">
@ -259,13 +270,12 @@
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'uint'</param>
<returns>To be added: an object of type 'uint'</returns>
<remarks>To be added</remarks>
<summary>Line color with an alpha component (in the format 0xRRGGBBAA).</summary>
<param name="value">line color with alpha component</param>
<returns>the line color</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="FillColorGdk">
@ -274,13 +284,12 @@
<ReturnValue>
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Color'</param>
<returns>To be added: an object of type 'Gdk.Color'</returns>
<remarks>To be added</remarks>
<summary>The <see cref="T:Gdk.Color" /> to draw the line with.</summary>
<param name="value">the line color</param>
<returns>the line color</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="WidthUnits">
@ -289,13 +298,12 @@
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
<summary>Width of the line in canvas units. The line width will be scaled when the canvas zoom factor changes.</summary>
<param name="value">width of the line</param>
<returns>width of the line in canvas units</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="ArrowShapeC">
@ -304,13 +312,12 @@
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
<summary>Distance of arrowhead trailing points from outside edge of shaft.</summary>
<param name="value">distance of the arrowing trailing points</param>
<returns>Distance of arrowhead trailing points from outside edge of shaft.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="WidthPixels">
@ -319,12 +326,11 @@
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'uint'</param>
<returns>To be added: an object of type 'uint'</returns>
<summary>Width of the line in pixels. The line width will not be scaled when the canvas zoom factor changes.</summary>
<param name="value">width of the line</param>
<returns>width of the line in pixels.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -334,13 +340,12 @@
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
<summary>X color specification for line.</summary>
<param name="value">X color specification for the line</param>
<returns>X color specification for the line</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -348,8 +353,8 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param>
@ -360,4 +365,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

194
doc/en/Gnome/CanvasPixbuf.xml
View file

@ -7,8 +7,12 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Pixbuf image canvas item</summary>
<remarks>
<para>
A canvas item for drawing pixbuf images.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gnome.CanvasItem</BaseTypeName>
@ -40,8 +44,8 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">Pointer to the C object.</param>
@ -67,8 +71,8 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="group" Type="Gnome.CanvasGroup" />
</Parameters>
<Parameter Name="group" Type="Gnome.CanvasGroup" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="group">To be added: an object of type 'Gnome.CanvasGroup'</param>
@ -94,13 +98,12 @@
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
<summary>Pixbuf height.</summary>
<param name="value">the height of this item</param>
<returns>the height of this item</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Pixbuf">
@ -109,13 +112,12 @@
<ReturnValue>
<ReturnType>Gdk.Pixbuf</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Pixbuf'</param>
<returns>To be added: an object of type 'Gdk.Pixbuf'</returns>
<remarks>To be added</remarks>
<summary>The pixbuf image to draw.</summary>
<param name="value">The pixbuf image to draw.</param>
<returns>the pixbuf image</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="WidthInPixels">
@ -124,13 +126,14 @@
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>The unit used by the <see cref="P:Gnome.CanvasPixbuf.Pixels" /> property</summary>
<param name="value">
<see langword="true" /> if it is in pixel units, <see langword="false" /> for canvas world units.
</param>
<returns>The unit used by the <see cref="P:Gnome.CanvasPixbuf.Pixels" /> property</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Anchor">
@ -139,13 +142,16 @@
<ReturnValue>
<ReturnType>Gtk.AnchorType</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gtk.AnchorType'</param>
<returns>To be added: an object of type 'Gtk.AnchorType'</returns>
<remarks>To be added</remarks>
<summary>
Anchor (handle) position within the pixbuf, defaults to
<see cref="F:Gtk.AnchorType.NW" /> (top left hand corner). The anchor is the
point of reference for positioning the image.
</summary>
<param name="value">anchor (handle) position within the pixbuf</param>
<returns>Anchor (handle) position within the pixbuf</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Width">
@ -154,13 +160,12 @@
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
<summary>Pixbuf width.</summary>
<param name="value">Pixbuf width</param>
<returns>the pixbuf's width</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="WidthSet">
@ -169,13 +174,22 @@
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>
Whether or not the <see cref="Gnome.CanvasPixbuf.Width" />
should be used
</summary>
<param name="value">
<see langword="true" /> if the <see cref="Gnome.CanvasPixbuf.Width" /> parameter is set and
should be used as the pixbuf width, <see langword="false" /> to use the actual
width of the image.
</param>
<returns>
Whether or not the <see cref="Gnome.CanvasPixbuf.Width" />
should be used
</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Y">
@ -184,13 +198,12 @@
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
<summary>The y coordinate of the position to place the pixbuf</summary>
<param name="value">Y coordinate</param>
<returns>the y coordinate of the position to place the pixbuf</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="X">
@ -199,13 +212,12 @@
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
<summary>The x coordinate of the position to place the pixbuf</summary>
<param name="value">X coordinate</param>
<returns>the x coordinate of the position to place the pixbuf</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="HeightInPixels">
@ -214,13 +226,22 @@
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>
Whether or not the <see cref="Gnome.CanvasPixbuf.Height" />
should be used
</summary>
<param name="value">
<see langword="true" /> if the <see cref="Gnome.CanvasPixbuf.Height" /> parameter is set and
should be used as the pixbuf width, <see langword="false" /> to use the actual
width of the image.
</param>
<returns>
Whether or not the <see cref="Gnome.CanvasPixbuf.Height" />
should be used
</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="HeightSet">
@ -229,13 +250,22 @@
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>
Whether or not the <see cref="Gnome.CanvasPixbuf.Height" />
should be used
</summary>
<param name="value">
<see langword="true" /> if the <see cref="Gnome.CanvasPixbuf.Height" /> parameter is set and
should be used as the pixbuf width, <see langword="false" /> to use the actual
width of the image.
</param>
<returns>
Whether or not the <see cref="Gnome.CanvasPixbuf.Height" />
should be used
</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="XInPixels">
@ -244,13 +274,14 @@
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>The unit used by the <see cref="P:Gnome.CanvasPixbuf.Pixels" /> property</summary>
<param name="value">
<see langword="true" /> if it is in pixel units, <see langword="false" /> for canvas world units.
</param>
<returns>The unit used by the <see cref="P:Gnome.CanvasPixbuf.Pixels" /> property</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="YInPixels">
@ -259,13 +290,14 @@
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>The unit used by the <see cref="P:Gnome.CanvasPixbuf.Pixels" /> property</summary>
<param name="value">
<see langword="true" /> if it is in pixel units, <see langword="false" /> for canvas world units.
</param>
<returns>The unit used by the <see cref="P:Gnome.CanvasPixbuf.Pixels" /> property</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -273,8 +305,8 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param>
@ -285,4 +317,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

74
doc/en/Gnome/CanvasPolygon.xml
View file

@ -7,8 +7,12 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Polygon canvas item</summary>
<remarks>
<para>
A canvas item for drawing polygon (multi sided) shapes.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gnome.CanvasShape</BaseTypeName>
@ -30,19 +34,23 @@
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="poly" Type="System.Double" />
<Parameter Name="num_points" Type="System.Int32" />
<Parameter Name="x" Type="System.Double" />
<Parameter Name="y" Type="System.Double" />
</Parameters>
<Parameter Name="poly" Type="System.Double" />
<Parameter Name="num_points" Type="System.Int32" />
<Parameter Name="x" Type="System.Double" />
<Parameter Name="y" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="poly">To be added: an object of type 'double'</param>
<param name="num_points">To be added: an object of type 'int'</param>
<param name="x">To be added: an object of type 'double'</param>
<param name="y">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
<summary>Computes the distance between a point and a polygon.</summary>
<param name="poly">
FIXME
Vertices of the polygon. X coordinates are in the even
indices, and Y coordinates are in the odd indices
</param>
<param name="num_points">Number of points in the polygon</param>
<param name="x">X coordinate of the point</param>
<param name="y">Y coordinate of the point</param>
<returns>The distance from the point to the polygon, or zero if the point is inside the polygon.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
@ -62,8 +70,8 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">Pointer to the C object.</param>
@ -89,13 +97,16 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="group" Type="Gnome.CanvasGroup" />
</Parameters>
<Parameter Name="group" Type="Gnome.CanvasGroup" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="group">To be added: an object of type 'Gnome.CanvasGroup'</param>
<returns>To be added: an object of type 'Gnome.CanvasPolygon'</returns>
<remarks>To be added</remarks>
<summary>Creates a new polygon</summary>
<param name="group">
The <see cref="T:Gnome.CanvasGroup" /> that this item
belongs to.
</param>
<returns>the newly-created <see cref="T:Gnome.CanvasPolygon" /> object</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -116,13 +127,14 @@
<ReturnValue>
<ReturnType>Gnome.CanvasPoints</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gnome.CanvasPoints'</param>
<returns>To be added: an object of type 'Gnome.CanvasPoints'</returns>
<remarks>To be added</remarks>
<summary>a <see cref="T:Gnome.CanvasPoints" /> pointer. This
can be created by a call to the <see cref="C:Gnome.CanvasPoints" /> constructor.
</summary>
<param name="value">a <see cref="T:Gnome.CanvasPoints" /> pointer.</param>
<returns>a <see cref="T:Gnome.CanvasPoints" /> pointer.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -130,8 +142,8 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param>
@ -142,4 +154,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

69
doc/en/Gnome/CanvasRE.xml
View file

@ -7,8 +7,13 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Base class for rectangle and ellipse items</summary>
<remarks>
<para>
This forms a base class for rectangle and ellipse canvas
items.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gnome.CanvasShape</BaseTypeName>
@ -40,8 +45,8 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">Pointer to the C object.</param>
@ -67,9 +72,9 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="group" Type="Gnome.CanvasGroup" />
<Parameter Name="type" Type="System.UInt32" />
</Parameters>
<Parameter Name="group" Type="Gnome.CanvasGroup" />
<Parameter Name="type" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="group">To be added: an object of type 'Gnome.CanvasGroup'</param>
@ -96,13 +101,12 @@
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
<summary>Rightmost coordinate of rectangle or ellipse.</summary>
<param name="value">Rightmost coordinate of rectangle or ellipse.</param>
<returns>Rightmost coordinate of rectangle or ellipse.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="X1">
@ -111,13 +115,12 @@
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
<summary>Leftmost coordinate of rectangle or ellipse.</summary>
<param name="value">Leftmost coordinate of rectangle or ellipse.</param>
<returns>Leftmost coordinate of rectangle or ellipse.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Y2">
@ -126,13 +129,12 @@
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
<summary>Bottommost coordinate of rectangle or ellipse.</summary>
<param name="value">Bottommost coordinate of rectangle or ellipse.</param>
<returns>Bottommost coordinate of rectangle or ellipse.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Y1">
@ -141,13 +143,12 @@
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
<summary>Topmost coordinate of rectangle or ellipse.</summary>
<param name="value">Topmost coordinate of rectangle or ellipse.</param>
<returns>Topmost coordinate of rectangle or ellipse.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -155,8 +156,8 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param>
@ -167,4 +168,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

37
doc/en/Gnome/CanvasRect.xml
View file

@ -7,8 +7,16 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Rectangle canvas item</summary>
<remarks>
<para>
A canvas item for drawing rectangles and squares. The
parameters are defined in the parent classes including
<see cref="T:Gnome.CanvasRE" /> which is shared with
<see cref="T:Gnome.CanvasEllipse" /> items as
well.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gnome.CanvasRE</BaseTypeName>
@ -40,8 +48,8 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">Pointer to the C object.</param>
@ -67,13 +75,16 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="group" Type="Gnome.CanvasGroup" />
</Parameters>
<Parameter Name="group" Type="Gnome.CanvasGroup" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="group">To be added: an object of type 'Gnome.CanvasGroup'</param>
<returns>To be added: an object of type 'Gnome.CanvasRect'</returns>
<remarks>To be added</remarks>
<summary>Creates a new rectangle</summary>
<param name="group">
The <see cref="T:Gnome.CanvasGroup" /> that this item
belongs to.
</param>
<returns>the newly-created <see cref="T:Gnome.CanvasRect" /> object</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -93,8 +104,8 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param>
@ -105,4 +116,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

117
doc/en/Gnome/CanvasWidget.xml
View file

@ -7,8 +7,13 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Widget canvas item</summary>
<remarks>
<para>
A canvas item for placing arbitrary <see cref="T:Gtk.Widget" /> objects onto a
canvas.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gnome.CanvasItem</BaseTypeName>
@ -40,8 +45,8 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">Pointer to the C object.</param>
@ -67,13 +72,16 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="group" Type="Gnome.CanvasGroup" />
</Parameters>
<Parameter Name="group" Type="Gnome.CanvasGroup" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="group">To be added: an object of type 'Gnome.CanvasGroup'</param>
<returns>To be added: an object of type 'Gnome.CanvasWidget'</returns>
<remarks>To be added</remarks>
<summary>Creates a new Widget container</summary>
<param name="group">
The <see cref="T:Gnome.CanvasGroup" /> that this item
belongs to.
</param>
<returns>the newly-created <see cref="T:Gnome.CanvasWidget" /> object</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -94,13 +102,14 @@
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
<summary>
Width of widget (units specified by <see cref="P:Gnome.CanvasWidget.SizePixels" /> property).
</summary>
<param name="value">the width of the widget</param>
<returns>the width of the widget</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Height">
@ -109,13 +118,14 @@
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
<summary>
Height of widget (units specified by <see cref="P:Gnome.CanvasWidget.SizePixels" /> property).
</summary>
<param name="value">the height of the widget</param>
<returns>the height of the widget</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Anchor">
@ -124,13 +134,12 @@
<ReturnValue>
<ReturnType>Gtk.AnchorType</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gtk.AnchorType'</param>
<returns>To be added: an object of type 'Gtk.AnchorType'</returns>
<remarks>To be added</remarks>
<summary>Anchor position for widget.</summary>
<param name="value">the anchor's position</param>
<returns>anchor position for the widget</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Widget">
@ -139,13 +148,12 @@
<ReturnValue>
<ReturnType>Gtk.Widget</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gtk.Widget'</param>
<returns>To be added: an object of type 'Gtk.Widget'</returns>
<remarks>To be added</remarks>
<summary>The embedded widget</summary>
<param name="value">The embedded widget</param>
<returns>the embedded widget</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="SizePixels">
@ -154,13 +162,14 @@
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Whether the widget size is specified in pixels or canvas units.</summary>
<param name="value">
<see langword="true" /> to use pixels unit, <see langword="false" /> to use canvas units
</param>
<returns>whether the widget size is specified in pixels or canvas units.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Y">
@ -169,13 +178,12 @@
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
<summary>Y coordinate of anchor point.</summary>
<param name="value">Y coordinate of anchor point.</param>
<returns>Y coordinate of anchor point.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="X">
@ -184,13 +192,12 @@
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
<summary>X coordinate of anchor point.</summary>
<param name="value">X coordinate of anchor point.</param>
<returns>X coordinate of anchor point.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -198,8 +205,8 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param>
@ -210,4 +217,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>