ryujinx-archive/GtkSharp
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

2004-09-25 Shane Landrum <epicene@pobox.com>

Browse source 
* en/Gdk/Drawable.xml
	* en/Gdk/Pixbuf.xml
	* en/Gdk/PixbufAlphaMode.xml
	* en/Gdk/PixbufAniAnim.xml
	* en/Gdk/PixbufAniAnimIter.xml
	* en/Gdk/PixbufAnimation.xml
	* en/Gdk/PixbufAnimationIter.xml: Docs for pixbufs and animations.
	A first pass; see FIXME marks for some API that may need adjustment.

svn path=/trunk/gtk-sharp/; revision=34384
This commit is contained in:
Shane Landrum 2004-09-25 13:52:01 +00:00
parent 9d8263d89d
commit a4e23390b0
8 changed files with 478 additions and 226 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
doc/ChangeLog
View file

@ -1,3 +1,14 @@
2004-09-25 Shane Landrum <epicene@pobox.com>
* en/Gdk/Drawable.xml
* en/Gdk/Pixbuf.xml
* en/Gdk/PixbufAlphaMode.xml
* en/Gdk/PixbufAniAnim.xml
* en/Gdk/PixbufAniAnimIter.xml
* en/Gdk/PixbufAnimation.xml
* en/Gdk/PixbufAnimationIter.xml: Docs for pixbufs and animations.
A first pass; see FIXME marks for some API that may need adjustment.
2004-09-23 Mike Kestner <mkestner@ximian.com> 2004-09-23 Mike Kestner <mkestner@ximian.com>
* en/Gtk/Widget.xml : docs for new OnSetScrollAdjustments VM. * en/Gtk/Widget.xml : docs for new OnSetScrollAdjustments VM.

296
doc/en/Gdk/Drawable.xml
View file

@ -39,11 +39,11 @@
<Parameter Name="npoints" Type="System.Int32" /> <Parameter Name="npoints" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Draws a number of points using the given graphics context.</summary>
<param name="gc">To be added: an object of type 'Gdk.GC'</param> <param name="gc">A <see cref="T:Gdk.GC"/></param>
<param name="points">To be added: an object of type 'Gdk.Point'</param> <param name="points">An array of <see cref="T:Gdk.Point"/> objects.</param>
<param name="npoints">To be added: an object of type 'int'</param> <param name="npoints">A <see cref="T:System.Int32"/></param>
<remarks>To be added</remarks> <remarks>NOTE: Drawable.custom needs to be fixed to implement this properly.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DrawLayoutWithColors"> <Member MemberName="DrawLayoutWithColors">
@ -61,14 +61,18 @@
<Parameter Name="background" Type="Gdk.Color" /> <Parameter Name="background" Type="Gdk.Color" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Render a <see cref="T:Pango.Layout"/> onto the Drawable
<param name="gc">To be added: an object of type 'Gdk.GC'</param> object, overriding the layout's normal colors with
<param name="x">To be added: an object of type 'int'</param> <paramref name="foreground"/> and/or <paramref name="background"/>.
<param name="y">To be added: an object of type 'int'</param> <paramref name="foreground"/> and <paramref name="background"/>
<param name="layout">To be added: an object of type 'Pango.Layout'</param> need not be allocated.</summary>
<param name="foreground">To be added: an object of type 'Gdk.Color'</param> <param name="gc">A <see cref="T:Gdk.GC"/>, the graphics context to use</param>
<param name="background">To be added: an object of type 'Gdk.Color'</param> <param name="x">A <see cref="T:System.Int32"/>, the X position of the left of the layout (in pixels)</param>
<remarks>To be added</remarks> <param name="y">A <see cref="T:System.Int32"/>, the Y position of the top of the layout (in pixels)</param>
<param name="layout">A <see cref="T:Pango.Layout"/>, the layout to render</param>
<param name="foreground">A <see cref="T:Gdk.Color"/>, the foreground color</param>
<param name="background">A <see cref="T:Gdk.Color"/>, the background color</param>
<remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DrawLayoutLine"> <Member MemberName="DrawLayoutLine">
@ -84,12 +88,13 @@
<Parameter Name="line" Type="Pango.LayoutLine" /> <Parameter Name="line" Type="Pango.LayoutLine" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Render a <see cref="T:Pango.LayoutLine"/> onto the Drawable
<param name="gc">To be added: an object of type 'Gdk.GC'</param> object.</summary>
<param name="x">To be added: an object of type 'int'</param> <param name="gc">A <see cref="T:Gdk.GC"/>, the graphics context to use</param>
<param name="y">To be added: an object of type 'int'</param> <param name="x">A <see cref="T:System.Int32"/>, the X position of the start of string (in pixels)</param>
<param name="line">To be added: an object of type 'Pango.LayoutLine'</param> <param name="y">A <see cref="T:System.Int32"/>, the Y position of the baseline (in pixels)</param>
<remarks>To be added</remarks> <param name="line">A <see cref="T:Pango.LayoutLine"/></param>
<remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DrawLayoutLineWithColors"> <Member MemberName="DrawLayoutLineWithColors">
@ -107,14 +112,18 @@
<Parameter Name="background" Type="Gdk.Color" /> <Parameter Name="background" Type="Gdk.Color" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Render a <see cref="T:Pango.LayoutLine"/> onto the Drawable
<param name="gc">To be added: an object of type 'Gdk.GC'</param> object, overriding the layout's normal colors with
<param name="x">To be added: an object of type 'int'</param> <paramref name="foreground"/> and/or <paramref name="background"/>.
<param name="y">To be added: an object of type 'int'</param> <paramref name="foreground"/> and <paramref name="background"/>
<param name="line">To be added: an object of type 'Pango.LayoutLine'</param> need not be allocated.</summary>
<param name="foreground">To be added: an object of type 'Gdk.Color'</param> <param name="gc">A <see cref="T:Gdk.GC"/>, the graphics context to use</param>
<param name="background">To be added: an object of type 'Gdk.Color'</param> <param name="x">A <see cref="T:System.Int32"/>, the X position of the start of string (in pixels)</param>
<remarks>To be added</remarks> <param name="y">A <see cref="T:System.Int32"/>, the Y position of the baseline (in pixels)</param>
<param name="layout">A <see cref="T:Pango.LayoutLine"/>, a line of text to render</param>
<param name="foreground">A <see cref="T:Gdk.Color"/>, the foreground color</param>
<param name="background">A <see cref="T:Gdk.Color"/>, the background color</param>
<remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DrawLayout"> <Member MemberName="DrawLayout">
@ -131,10 +140,10 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Render a <see cref="T:Pango.Layout" /> onto a <see cref="T:Gdk.Drawable" /></summary> <summary>Render a <see cref="T:Pango.Layout" /> onto a <see cref="T:Gdk.Drawable" /></summary>
<param name="gc">To be added: an object of type 'Gdk.GC'</param> <param name="gc">A <see cref="T:Gdk.GC"/></param>
<param name="x">To be added: an object of type 'int'</param> <param name="x">A <see cref="T:System.Int32"/></param>
<param name="y">To be added: an object of type 'int'</param> <param name="y">A <see cref="T:System.Int32"/></param>
<param name="layout">To be added: an object of type 'Pango.Layout'</param> <param name="layout">A <see cref="T:Pango.Layout"/></param>
<remarks>If you are using Gtk, the usual way to obtain a <see cref="T:Pango.Layout" /> is <see cref="M:Gtk.Widget.CreatePangoLayout()" />.</remarks> <remarks>If you are using Gtk, the usual way to obtain a <see cref="T:Pango.Layout" /> is <see cref="M:Gtk.Widget.CreatePangoLayout()" />.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -149,10 +158,18 @@
<Parameter Name="height" Type="System.Int32&amp;" RefType="out" /> <Parameter Name="height" Type="System.Int32&amp;" RefType="out" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Fills <paramref name="width"/> and <paramref name="height"/>
<param name="width">To be added: an object of type 'int&amp;'</param> with the size of the Drawable. <paramref name="width"/> or
<param name="height">To be added: an object of type 'int&amp;'</param> <paramref name="height"/> can be <see langword="null"/> if you
<remarks>To be added</remarks> only want the other one.
</summary>
<param name="width">A <see cref="T:System.Int32&amp;"/></param>
<param name="height">A <see cref="T:System.Int32&amp;"/></param>
<remarks>
On the X11 platform, if this Drawable object is also a <see cref="T:Gdk.Window"/>, the returned
size is the size reported in the most-recently-processed configure
event, rather than the current size on the X server.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DrawSegments"> <Member MemberName="DrawSegments">
@ -167,11 +184,11 @@
<Parameter Name="nsegs" Type="System.Int32" /> <Parameter Name="nsegs" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Draws a number of unconnected lines.</summary>
<param name="gc">To be added: an object of type 'Gdk.GC'</param> <param name="gc">A <see cref="T:Gdk.GC"/></param>
<param name="segs">To be added: an object of type 'Gdk.Segment'</param> <param name="segs">A <see cref="T:Gdk.Segment"/>, a list of segments to draw.</param>
<param name="nsegs">To be added: an object of type 'int'</param> <param name="nsegs">A <see cref="T:System.Int32"/>, the number of segments.</param>
<remarks>To be added</remarks> <remarks>TODO: Drawable.custom needs to be edited to make segs an array of Gdk.Segment objects.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DrawGlyphs"> <Member MemberName="DrawGlyphs">
@ -188,13 +205,21 @@
<Parameter Name="glyphs" Type="Pango.GlyphString" /> <Parameter Name="glyphs" Type="Pango.GlyphString" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<param name="gc">To be added: an object of type 'Gdk.GC'</param> <p>This is a low-level function; 99% of text rendering should be done
<param name="font">To be added: an object of type 'Pango.Font'</param> using <see cref="M:Gdk.Drawable.DrawLayout"/> instead.</p>
<param name="x">To be added: an object of type 'int'</param> <p>A glyph is a character in a font. This function draws a sequence of
<param name="y">To be added: an object of type 'int'</param> glyphs. To obtain a sequence of glyphs you have to understand a
<param name="glyphs">To be added: an object of type 'Pango.GlyphString'</param> lot about internationalized text handling, which you don't want to
<remarks>To be added</remarks> understand; thus, use <see cref="M:Gdk.Drawable.DrawLayout"/> instead of this function,
<see cref="M:Gdk.Drawable.DrawLayout"/> handles the details.</p>
</summary>
<param name="gc">A <see cref="T:Gdk.GC"/></param>
<param name="font">A <see cref="T:Pango.Font"/></param>
<param name="x">A <see cref="T:System.Int32"/></param>
<param name="y">A <see cref="T:System.Int32"/></param>
<param name="glyphs">A <see cref="T:Pango.GlyphString"/></param>
<remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetImage"> <Member MemberName="GetImage">
@ -210,13 +235,54 @@
<Parameter Name="height" Type="System.Int32" /> <Parameter Name="height" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<param name="x">To be added: an object of type 'int'</param> <p>
<param name="y">To be added: an object of type 'int'</param> A <see cref="T:Gdk.Image"/> stores client-side image data (pixels). In contrast,
<param name="width">To be added: an object of type 'int'</param> <see cref="T:Gdk.Pixmap"/> and <see cref="T:Gdk.Window"/> are server-side
<param name="height">To be added: an object of type 'int'</param> objects. This method obtains the pixels from a
<returns>To be added: an object of type 'Gdk.Image'</returns> server-side drawable as a client-side <see cref="T:Gdk.Image"/>.
<remarks>To be added</remarks> </p><p>
The format of a <see cref="T:Gdk.Image"/> depends on
the <see cref="T:Gdk.Visual"/> of the current display, which
makes manipulating <see cref="T:Gdk.Image"/> extremely difficult;
therefore, in
most cases you should use <see cref="M:Gdk.Pixbuf.GetFromDrawable"/>
instead of
this lower-level function. A <see cref="T:Gdk.Pixbuf"/> contains
image data in a canonicalized RGB format, rather than a
display-dependent format. Of course, there's a convenience vs.
speed tradeoff here, so you'll want to think about what makes
sense for your application.
</p>
</summary>
<param name="x">A <see cref="T:System.Int32"/>, X coordinate of the upper left corner of the region to get as a drawable</param>
<param name="y">A <see cref="T:System.Int32"/>, Y coordinate of the upper left corner of the region to get as a drawable.</param>
<param name="width">A <see cref="T:System.Int32"/>, width of the rectangle</param>
<param name="height">A <see cref="T:System.Int32"/>, height of the rectangle.</param>
<returns>A <see cref="T:Gdk.Image"/> containing the contents of this Drawable object.</returns>
<remarks>
<p>
</p><p>
<paramref name="x"/>, <paramref name="y"/>,
<paramref name="width"/>, and <paramref name="height"/> define
the region of the drawable to obtain as an image.
</p><p>
You would usually copy image data to the client side if you intend
to examine the values of individual pixels, for example to darken
an image or add a red tint. It would be prohibitively slow to
make a round-trip request to the windowing system for each pixel,
so instead you get all of them at once, modify them, then copy
them all back at once.
</p><p>
If the X server or other windowing system backend is on the local
machine, this function may use shared memory to avoid copying
the image data.
</p><p>
If the source drawable is a #GdkWindow and partially offscreen
or obscured, then the obscured portions of the returned image
will contain undefined data.
</p>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DrawDrawable"> <Member MemberName="DrawDrawable">
@ -236,16 +302,33 @@
<Parameter Name="height" Type="System.Int32" /> <Parameter Name="height" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<param name="gc">To be added: an object of type 'Gdk.GC'</param> Copies the <paramref name="width"/>x<paramref name="height"/> region of <paramref name="src"/> at coordinates (<paramref name="xsrc"/>,
<param name="src">To be added: an object of type 'Gdk.Drawable'</param> <paramref name="ysrc"/>) to coordinates (<paramref name="xdest"/>, <paramref name="ydest"/>) in <paramref name="drawable"/>.
<param name="xsrc">To be added: an object of type 'int'</param> <paramref name="width"/> and/or <paramref name="height"/> may be given as -1, in which case the entire
<param name="ysrc">To be added: an object of type 'int'</param> <paramref name="src"/> drawable will be copied.
<param name="xdest">To be added: an object of type 'int'</param> Most fields in <paramref name="gc"/> are not used for this operation, but notably the
<param name="ydest">To be added: an object of type 'int'</param> clip mask or clip region will be honored.
<param name="width">To be added: an object of type 'int'</param> </summary>
<param name="height">To be added: an object of type 'int'</param> <param name="gc">A <see cref="T:Gdk.GC"/></param>
<remarks>To be added</remarks> <param name="src">A <see cref="T:Gdk.Drawable"/>, the source Drawable. </param>
<param name="xsrc">A <see cref="T:System.Int32"/></param>
<param name="ysrc">A <see cref="T:System.Int32"/></param>
<param name="xdest">A <see cref="T:System.Int32"/></param>
<param name="ydest">A <see cref="T:System.Int32"/></param>
<param name="width">A <see cref="T:System.Int32"/></param>
<param name="height">A <see cref="T:System.Int32"/></param>
<remarks>
The source and destination drawables must have the same visual and
colormap, or errors will result. (On X11, failure to match
visual/colormap results in a BadMatch error from the X server.)
A common cause of this problem is an attempt to draw a bitmap to
a color drawable. The way to draw a bitmap is to set the
bitmap as a clip mask on your #GdkGC, then use gdk_draw_rectangle()
to draw a rectangle clipped to the bitmap.
<p>TODO: This API needs to be adjusted; <paramref name="src"/> should
probably not exist.</p>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DrawImage"> <Member MemberName="DrawImage">
@ -266,14 +349,14 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Draws a <see cref="T:Gdk.Image" /> onto a drawable.</summary> <summary>Draws a <see cref="T:Gdk.Image" /> onto a drawable.</summary>
<param name="gc">To be added: an object of type 'Gdk.GC'</param> <param name="gc">A <see cref="T:Gdk.GC"/></param>
<param name="image">To be added: an object of type 'Gdk.Image'</param> <param name="image">A <see cref="T:Gdk.Image"/></param>
<param name="xsrc">To be added: an object of type 'int'</param> <param name="xsrc">A <see cref="T:System.Int32"/></param>
<param name="ysrc">To be added: an object of type 'int'</param> <param name="ysrc">A <see cref="T:System.Int32"/></param>
<param name="xdest">To be added: an object of type 'int'</param> <param name="xdest">A <see cref="T:System.Int32"/></param>
<param name="ydest">To be added: an object of type 'int'</param> <param name="ydest">A <see cref="T:System.Int32"/></param>
<param name="width">To be added: an object of type 'int'</param> <param name="width">A <see cref="T:System.Int32"/></param>
<param name="height">To be added: an object of type 'int'</param> <param name="height">A <see cref="T:System.Int32"/></param>
<remarks>The depth of the <see cref="T:Gdk.Image" /> must match the depth of the <see cref="T:Gdk.Drawable" />.</remarks> <remarks>The depth of the <see cref="T:Gdk.Image" /> must match the depth of the <see cref="T:Gdk.Drawable" />.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -289,11 +372,11 @@
<Parameter Name="y" Type="System.Int32" /> <Parameter Name="y" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Draws a point at (<paramref name="x"/>,<paramref name="y"/>).</summary>
<param name="gc">To be added: an object of type 'Gdk.GC'</param> <param name="gc">A <see cref="T:Gdk.GC"/></param>
<param name="x">To be added: an object of type 'int'</param> <param name="x">A <see cref="T:System.Int32"/></param>
<param name="y">To be added: an object of type 'int'</param> <param name="y">A <see cref="T:System.Int32"/></param>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Finalize"> <Member MemberName="Finalize">
@ -333,10 +416,17 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>The color map for this Drawable. You only need to set
<param name="value">To be added: an object of type 'Gdk.Colormap'</param> the color map if the drawable-creating function did not have a
<returns>To be added: an object of type 'Gdk.Colormap'</returns> way to determine the colormap, and you then use drawable operations
<remarks>To be added</remarks> that require a colormap. The colormap for all drawables and
graphics contexts you intend to use together should match. i.e.
when using a #GdkGC to draw to a drawable, or copying one drawable
to another, the colormaps should match.
</summary>
<param name="value">A <see cref="T:Gdk.Colormap"/></param>
<returns>A <see cref="T:Gdk.Colormap"/></returns>
<remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="VisibleRegion"> <Member MemberName="VisibleRegion">
@ -347,8 +437,8 @@
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.Region'</returns> <returns>A <see cref="T:Gdk.Region"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ClipRegion"> <Member MemberName="ClipRegion">
@ -359,8 +449,8 @@
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.Region'</returns> <returns>A <see cref="T:Gdk.Region"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Visual"> <Member MemberName="Visual">
@ -371,8 +461,8 @@
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.Visual'</returns> <returns>A <see cref="T:Gdk.Visual"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Depth"> <Member MemberName="Depth">
@ -383,8 +473,8 @@
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<returns>To be added: an object of type 'int'</returns> <returns>A <see cref="T:System.Int32"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Screen"> <Member MemberName="Screen">
@ -396,7 +486,7 @@
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<returns>a <see cref="T:Gdk.Screen" /></returns> <returns>a <see cref="T:Gdk.Screen" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Display"> <Member MemberName="Display">
@ -408,7 +498,7 @@
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<returns>a <see cref="T:Gdk.Display" /></returns> <returns>a <see cref="T:Gdk.Display" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DrawLines"> <Member MemberName="DrawLines">
@ -425,7 +515,7 @@
<summary>To be added</summary> <summary>To be added</summary>
<param name="gc">a <see cref="T:Gdk.GC" /></param> <param name="gc">a <see cref="T:Gdk.GC" /></param>
<param name="points">a <see cref="T:Gdk.Point[]" /></param> <param name="points">a <see cref="T:Gdk.Point[]" /></param>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DrawPolygon"> <Member MemberName="DrawPolygon">
@ -486,7 +576,7 @@
<param name="y1_">a <see cref="T:System.Int32" /></param> <param name="y1_">a <see cref="T:System.Int32" /></param>
<param name="x2_">a <see cref="T:System.Int32" /></param> <param name="x2_">a <see cref="T:System.Int32" /></param>
<param name="y2_">a <see cref="T:System.Int32" /></param> <param name="y2_">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DrawArc"> <Member MemberName="DrawArc">
@ -515,7 +605,7 @@
<param name="height">a <see cref="T:System.Int32" /></param> <param name="height">a <see cref="T:System.Int32" /></param>
<param name="angle1">a <see cref="T:System.Int32" /></param> <param name="angle1">a <see cref="T:System.Int32" /></param>
<param name="angle2">a <see cref="T:System.Int32" /></param> <param name="angle2">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DrawPixbuf"> <Member MemberName="DrawPixbuf">
@ -550,7 +640,7 @@
<param name="dither">a <see cref="T:Gdk.RgbDither" /></param> <param name="dither">a <see cref="T:Gdk.RgbDither" /></param>
<param name="x_dither">a <see cref="T:System.Int32" /></param> <param name="x_dither">a <see cref="T:System.Int32" /></param>
<param name="y_dither">a <see cref="T:System.Int32" /></param> <param name="y_dither">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DrawRectangle"> <Member MemberName="DrawRectangle">
@ -613,7 +703,7 @@
<Docs> <Docs>
<summary>This is a constructor used by derivative types of Drawable. This is not typically used by C# code.</summary> <summary>This is a constructor used by derivative types of Drawable. This is not typically used by C# code.</summary>
<returns>a <see cref="T:Gdk.Drawable" /></returns> <returns>a <see cref="T:Gdk.Drawable" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DrawRgbImage"> <Member MemberName="DrawRgbImage">
@ -642,7 +732,7 @@
<param name="dith">a <see cref="T:System.Int32" /></param> <param name="dith">a <see cref="T:System.Int32" /></param>
<param name="rgb_buf">a <see cref="T:System.Byte" /></param> <param name="rgb_buf">a <see cref="T:System.Byte" /></param>
<param name="rowstride">a <see cref="T:System.Int32" /></param> <param name="rowstride">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DrawRgb32ImageDithalign"> <Member MemberName="DrawRgb32ImageDithalign">
@ -675,7 +765,7 @@
<param name="rowstride">a <see cref="T:System.Int32" /></param> <param name="rowstride">a <see cref="T:System.Int32" /></param>
<param name="xdith">a <see cref="T:System.Int32" /></param> <param name="xdith">a <see cref="T:System.Int32" /></param>
<param name="ydith">a <see cref="T:System.Int32" /></param> <param name="ydith">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DrawIndexedImage"> <Member MemberName="DrawIndexedImage">
@ -706,7 +796,7 @@
<param name="buf">a <see cref="T:System.Byte" /></param> <param name="buf">a <see cref="T:System.Byte" /></param>
<param name="rowstride">a <see cref="T:System.Int32" /></param> <param name="rowstride">a <see cref="T:System.Int32" /></param>
<param name="cmap">a <see cref="T:Gdk.RgbCmap" /></param> <param name="cmap">a <see cref="T:Gdk.RgbCmap" /></param>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DrawRgb32Image"> <Member MemberName="DrawRgb32Image">
@ -735,7 +825,7 @@
<param name="dith">a <see cref="T:System.Int32" /></param> <param name="dith">a <see cref="T:System.Int32" /></param>
<param name="buf">a <see cref="T:System.Byte" /></param> <param name="buf">a <see cref="T:System.Byte" /></param>
<param name="rowstride">a <see cref="T:System.Int32" /></param> <param name="rowstride">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DrawGrayImage"> <Member MemberName="DrawGrayImage">
@ -764,7 +854,7 @@
<param name="dith">a <see cref="T:System.Int32" /></param> <param name="dith">a <see cref="T:System.Int32" /></param>
<param name="buf">a <see cref="T:System.Byte" /></param> <param name="buf">a <see cref="T:System.Byte" /></param>
<param name="rowstride">a <see cref="T:System.Int32" /></param> <param name="rowstride">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DrawRgbImageDithalign"> <Member MemberName="DrawRgbImageDithalign">
@ -797,7 +887,7 @@
<param name="rowstride">a <see cref="T:System.Int32" /></param> <param name="rowstride">a <see cref="T:System.Int32" /></param>
<param name="xdith">a <see cref="T:System.Int32" /></param> <param name="xdith">a <see cref="T:System.Int32" /></param>
<param name="ydith">a <see cref="T:System.Int32" /></param> <param name="ydith">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DrawPolygon"> <Member MemberName="DrawPolygon">
@ -821,4 +911,4 @@
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

165
doc/en/Gdk/Pixbuf.xml
View file

@ -817,20 +817,26 @@
<Parameter Name="y_dither" Type="System.Int32" /> <Parameter Name="y_dither" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Obsolete; do not use. Use <see cref="M:Gdk.Drawable.DrawPixbuf"/> instead.</summary>
<param name="drawable">To be added: an object of type 'Gdk.Drawable'</param> <param name="drawable">A <see cref="T:Gdk.Drawable"/></param>
<param name="src_x">To be added: an object of type 'int'</param> <param name="src_x">A <see cref="T:System.Int32"/></param>
<param name="src_y">To be added: an object of type 'int'</param> <param name="src_y">A <see cref="T:System.Int32"/></param>
<param name="dest_x">To be added: an object of type 'int'</param> <param name="dest_x">A <see cref="T:System.Int32"/></param>
<param name="dest_y">To be added: an object of type 'int'</param> <param name="dest_y">A <see cref="T:System.Int32"/></param>
<param name="width">To be added: an object of type 'int'</param> <param name="width">A <see cref="T:System.Int32"/></param>
<param name="height">To be added: an object of type 'int'</param> <param name="height">A <see cref="T:System.Int32"/></param>
<param name="alpha_mode">To be added: an object of type 'Gdk.PixbufAlphaMode'</param> <param name="alpha_mode">A <see cref="T:Gdk.PixbufAlphaMode"/></param>
<param name="alpha_threshold">To be added: an object of type 'int'</param> <param name="alpha_threshold">A <see cref="T:System.Int32"/></param>
<param name="dither">To be added: an object of type 'Gdk.RgbDither'</param> <param name="dither">A <see cref="T:Gdk.RgbDither"/></param>
<param name="x_dither">To be added: an object of type 'int'</param> <param name="x_dither">A <see cref="T:System.Int32"/></param>
<param name="y_dither">To be added: an object of type 'int'</param> <param name="y_dither">A <see cref="T:System.Int32"/></param>
<remarks>To be added</remarks> <remarks>Renders a rectangular portion of a pixbuf to a drawable. The destination
drawable must have a colormap. All windows have a colormap, however, pixmaps
only have colormap by default if they were created with a non-NULL window argument.
Otherwise a colormap must be set on them with <see cref="P:Gdk.Drawable.Colormap"/>.
On older X servers, rendering pixbufs with an alpha channel involves round trips
to the X server, and may be somewhat slow.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Finalize"> <Member MemberName="Finalize">
@ -1076,17 +1082,17 @@
<Parameter Name="height" Type="System.Int32" /> <Parameter Name="height" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Generates a new Pixbuf object from a <see cref="T:Gdk.Drawable"/>.</summary>
<param name="src">To be added: an object of type 'Gdk.Drawable'</param> <param name="src">A <see cref="T:Gdk.Drawable"/></param>
<param name="cmap">To be added: an object of type 'Gdk.Colormap'</param> <param name="cmap">A <see cref="T:Gdk.Colormap"/></param>
<param name="src_x">To be added: an object of type 'int'</param> <param name="src_x">A <see cref="T:System.Int32"/></param>
<param name="src_y">To be added: an object of type 'int'</param> <param name="src_y">A <see cref="T:System.Int32"/></param>
<param name="dest_x">To be added: an object of type 'int'</param> <param name="dest_x">A <see cref="T:System.Int32"/></param>
<param name="dest_y">To be added: an object of type 'int'</param> <param name="dest_y">A <see cref="T:System.Int32"/></param>
<param name="width">To be added: an object of type 'int'</param> <param name="width">A <see cref="T:System.Int32"/></param>
<param name="height">To be added: an object of type 'int'</param> <param name="height">A <see cref="T:System.Int32"/></param>
<returns>To be added: an object of type 'Gdk.Pixbuf'</returns> <returns>A <see cref="T:Gdk.Pixbuf"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -1103,16 +1109,16 @@
<Parameter Name="destroy_fn" Type="Gdk.PixbufDestroyNotify" /> <Parameter Name="destroy_fn" Type="Gdk.PixbufDestroyNotify" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Public constructor.</summary>
<param name="data">To be added: an object of type 'byte []'</param> <param name="data">A <see cref="T:byte []"/>, the raw data</param>
<param name="has_alpha">To be added: an object of type 'bool'</param> <param name="has_alpha">A <see cref="T:System.Boolean"/>, true if this pixbuf has an alpha layer.</param>
<param name="bits_per_sample">To be added: an object of type 'int'</param> <param name="bits_per_sample">A <see cref="T:System.Int32"/></param>
<param name="width">To be added: an object of type 'int'</param> <param name="width">A <see cref="T:System.Int32"/>, image width</param>
<param name="height">To be added: an object of type 'int'</param> <param name="height">A <see cref="T:System.Int32"/>, image height</param>
<param name="rowstride">To be added: an object of type 'int'</param> <param name="rowstride">A <see cref="T:System.Int32"/></param>
<param name="destroy_fn">To be added: an object of type 'Gdk.PixbufDestroyNotify'</param> <param name="destroy_fn">A <see cref="T:Gdk.PixbufDestroyNotify"/></param>
<returns>To be added: an object of type 'Gdk.Pixbuf'</returns> <returns>A <see cref="T:Gdk.Pixbuf"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -1125,10 +1131,10 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="data">To be added: an object of type 'byte []'</param> <param name="data">A <see cref="T:System.Byte []"/></param>
<param name="copy_pixels">To be added: an object of type 'bool'</param> <param name="copy_pixels">A <see cref="T:System.Boolean"/></param>
<returns>To be added: an object of type 'Gdk.Pixbuf'</returns> <returns>A <see cref="T:Gdk.Pixbuf"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -1159,7 +1165,7 @@
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<returns>a <see cref="T:System.Int32" /></returns> <returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -1175,7 +1181,7 @@
<param name="assembly">a <see cref="T:System.Reflection.Assembly" /></param> <param name="assembly">a <see cref="T:System.Reflection.Assembly" /></param>
<param name="resource">a <see cref="T:System.String" /></param> <param name="resource">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gdk.Pixbuf" /></returns> <returns>a <see cref="T:Gdk.Pixbuf" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="LoadFromResource"> <Member MemberName="LoadFromResource">
@ -1191,7 +1197,7 @@
<summary>To be added</summary> <summary>To be added</summary>
<param name="resource">a <see cref="T:System.String" /></param> <param name="resource">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gdk.Pixbuf" /></returns> <returns>a <see cref="T:Gdk.Pixbuf" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -1202,10 +1208,10 @@
<Parameter Name="stream" Type="System.IO.Stream" /> <Parameter Name="stream" Type="System.IO.Stream" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Makes a new Pixbuf object from a <see cref="T:System.IO.Stream"/>.</summary>
<param name="stream">a <see cref="T:System.IO.Stream" /></param> <param name="stream">a <see cref="T:System.IO.Stream" /></param>
<returns>a <see cref="T:Gdk.Pixbuf" /></returns> <returns>a <see cref="T:Gdk.Pixbuf" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -1223,7 +1229,10 @@
<Parameter Name="destroy_fn" Type="Gdk.PixbufDestroyNotify" /> <Parameter Name="destroy_fn" Type="Gdk.PixbufDestroyNotify" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Public constructor; creates a new <see cref="T:Gdk.Pixbuf"/>
and allocates a buffer for it. Note that the buffer is not cleared;
you will have to fill it completely yourself.
</summary>
<param name="data">a <see cref="T:System.Byte[]" /></param> <param name="data">a <see cref="T:System.Byte[]" /></param>
<param name="colorspace">a <see cref="T:Gdk.Colorspace" /></param> <param name="colorspace">a <see cref="T:Gdk.Colorspace" /></param>
<param name="has_alpha">a <see cref="T:System.Boolean" /></param> <param name="has_alpha">a <see cref="T:System.Boolean" /></param>
@ -1232,8 +1241,10 @@
<param name="height">a <see cref="T:System.Int32" /></param> <param name="height">a <see cref="T:System.Int32" /></param>
<param name="rowstride">a <see cref="T:System.Int32" /></param> <param name="rowstride">a <see cref="T:System.Int32" /></param>
<param name="destroy_fn">a <see cref="T:Gdk.PixbufDestroyNotify" /></param> <param name="destroy_fn">a <see cref="T:Gdk.PixbufDestroyNotify" /></param>
<returns>a <see cref="T:Gdk.Pixbuf" /></returns> <returns>a <see cref="T:Gdk.Pixbuf" /> with a reference count of 1, or
<remarks>To be added</remarks> null if not enough memory could be allocated for the image buffer.
</returns>
<remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -1262,10 +1273,10 @@
<Parameter Name="data" Type="System.String[]" /> <Parameter Name="data" Type="System.String[]" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Public constructor.</summary>
<param name="data">a <see cref="T:System.String[]" /></param> <param name="data">a <see cref="T:System.String[]" /></param>
<returns>a <see cref="T:Gdk.Pixbuf" /></returns> <returns>a <see cref="T:Gdk.Pixbuf" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -1305,7 +1316,7 @@
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<returns>a <see cref="T:Gdk.PixbufFormat[]" /></returns> <returns>a <see cref="T:Gdk.PixbufFormat[]" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Pixels"> <Member MemberName="Pixels">
@ -1318,7 +1329,7 @@
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<returns>a <see cref="T:System.IntPtr" /></returns> <returns>a <see cref="T:System.IntPtr" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Savev"> <Member MemberName="Savev">
@ -1339,8 +1350,8 @@
<param name="type">The file type to save (one of "ani", "bmp", "gif", "ico", "jpeg", "pcx", "png", "pnm", "ras", "tga", "tiff" "wbmp", "xpm" or "xbm")</param> <param name="type">The file type to save (one of "ani", "bmp", "gif", "ico", "jpeg", "pcx", "png", "pnm", "ras", "tga", "tiff" "wbmp", "xpm" or "xbm")</param>
<param name="option_keys">Options that are passed to the save module.</param> <param name="option_keys">Options that are passed to the save module.</param>
<param name="option_values">Values for each key</param> <param name="option_values">Values for each key</param>
<returns>To be added: an object of type 'bool'</returns> <returns>A <see cref="T:System.Boolean"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Save"> <Member MemberName="Save">
@ -1358,7 +1369,7 @@
<param name="filename">a <see cref="T:System.String" /></param> <param name="filename">a <see cref="T:System.String" /></param>
<param name="type">a <see cref="T:System.String" /></param> <param name="type">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="RenderThresholdAlpha"> <Member MemberName="RenderThresholdAlpha">
@ -1377,7 +1388,7 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Render pixbuf alpha channel as a bi-level clip mask to a <see cref="T:Gdk.Bitmap" /></summary> <summary>Render pixbuf alpha channel as a bi-level clip mask to a <see cref="T:Gdk.Bitmap" /></summary>
<param name="bitmap">The destination object of type 'Gdk.Bitmap'</param> <param name="bitmap">The destination object of type "Gdk.Bitmap"/></param>
<param name="src_x">Source X coordinate.</param> <param name="src_x">Source X coordinate.</param>
<param name="src_y">Source Y coordinate.</param> <param name="src_y">Source Y coordinate.</param>
<param name="dest_x">Destination X coordinate. <param name="dest_x">Destination X coordinate.
@ -1385,7 +1396,7 @@
<param name="dest_y">Destination Y coordinate.</param> <param name="dest_y">Destination Y coordinate.</param>
<param name="alpha_threshold">Value below this will be painted as zero; all other values will be painted as one.</param> <param name="alpha_threshold">Value below this will be painted as zero; all other values will be painted as one.</param>
<remarks>This function is designed to threshold and render the alpha values from this <see cref="T:Gdk.Pixbuf" /> into the destination <see cref="T:Gdk.Bitmask" /> which can then be used as a clipping mask for a <see cref="T:Gdk.Drawable" />.</remarks> <remarks>This function is designed to threshold and render the alpha values from this <see cref="T:Gdk.Pixbuf" /> into the destination <see cref="T:Gdk.Bitmask" /> which can then be used as a clipping mask for a <see cref="T:Gdk.Drawable" />.</remarks>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="RenderPixmapAndMask"> <Member MemberName="RenderPixmapAndMask">
@ -1400,11 +1411,27 @@
<Parameter Name="alpha_threshold" Type="System.Int32" /> <Parameter Name="alpha_threshold" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
Creates a pixmap and a mask bitmap which are returned in the
<paramref name="pixmap_return"/> and <paramref name="mask_return"/>
arguments, respectively, and renders a pixbuf and its
corresponding thresholded alpha mask to them. This is merely a convenience
function; applications that need to render pixbufs with dither offsets or to
given drawables should use <see cref="M:Gdk.Pixbuf.RenderToDrawableAlpha"/>
or <see cref="M:Gdk.Pixbuf.RenderToDrawable"/> and
<see cref="M:Gdk.Pixbuf.RenderThresholdAlpha"/>.
</summary>
<param name="pixmap_return">a <see cref="T:Gdk.Pixmap" /></param> <param name="pixmap_return">a <see cref="T:Gdk.Pixmap" /></param>
<param name="mask_return">a <see cref="T:Gdk.Bitmap" /></param> <param name="mask_return">a <see cref="T:Gdk.Bitmap" /></param>
<param name="alpha_threshold">a <see cref="T:System.Int32" /></param> <param name="alpha_threshold">a <see cref="T:System.Int32" />, threshold value for opacity.</param>
<remarks>To be added</remarks> <remarks>
The pixmap that is created is created for the colormap returned
by <see cref="M:Gdk.Rgb.GetColormap"/>. You normally will want to instead use
the actual colormap for a widget, and use
<see cref="M:Gdk.Pixbuf.RenderPixmapAndMaskForColormap"/>,
If the pixbuf does not have an alpha channel, then *<paramref name="mask_return"/> will be set
to <see langword="null"/>.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="RenderPixmapAndMaskForColormap"> <Member MemberName="RenderPixmapAndMaskForColormap">
@ -1420,12 +1447,28 @@
<Parameter Name="alpha_threshold" Type="System.Int32" /> <Parameter Name="alpha_threshold" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
Creates a pixmap and a mask bitmap which are returned in the
<paramref name="pixmap_return"/> and <paramref name="mask_return"/>
arguments, respectively, and renders a pixbuf and its
corresponding thresholded alpha mask to them.
This is merely a convenience
function; applications that need to render pixbufs with dither offsets or to
given drawables should use <see cref="M:Gdk.Pixbuf.RenderToDrawableAlpha"/>
or <see cref="M:Gdk.Pixbuf.RenderToDrawable"/> and
<see cref="M:Gdk.Pixbuf.RenderThresholdAlpha"/>.
</summary>
<param name="colormap">a <see cref="T:Gdk.Colormap" /></param> <param name="colormap">a <see cref="T:Gdk.Colormap" /></param>
<param name="pixmap_return">a <see cref="T:Gdk.Pixmap" /></param> <param name="pixmap_return">a <see cref="T:Gdk.Pixmap" /></param>
<param name="mask_return">a <see cref="T:Gdk.Bitmap" /></param> <param name="mask_return">a <see cref="T:Gdk.Bitmap" /></param>
<param name="alpha_threshold">a <see cref="T:System.Int32" /></param> <param name="alpha_threshold">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks> <remarks>
The pixmap that is created uses the <see cref="T:Gdk.Colormap"/> specified by <paramref name="colormap"/>.
This colormap must match the colormap of the window where the pixmap
will eventually be used or an error will result.
If the pixbuf does not have an alpha channel, then *<paramref name="mask_return"/> will be set
to <see langword="null"/>.
</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

6
doc/en/Gdk/PixbufAlphaMode.xml
View file

@ -10,8 +10,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Do not use.</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Enum</BaseTypeName> <BaseTypeName>System.Enum</BaseTypeName>
@ -69,4 +69,4 @@
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

18
doc/en/Gdk/PixbufAniAnim.xml
View file

@ -10,8 +10,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Represents an ANI format animation internally. Do not use.</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>Gdk.PixbufAnimation</BaseTypeName> <BaseTypeName>Gdk.PixbufAnimation</BaseTypeName>
@ -35,7 +35,7 @@
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -46,10 +46,10 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Constructor for use by internal code. Do not use.</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param> <param name="raw">a <see cref="T:System.IntPtr" />, pointer to underlying C data</param>
<returns>a <see cref="T:Gdk.PixbufAniAnim" /></returns> <returns>a <see cref="T:Gdk.PixbufAniAnim" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -85,10 +85,10 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Protected constructor.</summary>
<returns>a <see cref="T:Gdk.PixbufAniAnim" /></returns> <returns>a <see cref="T:Gdk.PixbufAniAnim" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

18
doc/en/Gdk/PixbufAniAnimIter.xml
View file

@ -10,8 +10,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Iterator for pointing to a particular frame of an ANI animation. Mostly internal; not for general developer use.</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>Gdk.PixbufAnimationIter</BaseTypeName> <BaseTypeName>Gdk.PixbufAnimationIter</BaseTypeName>
@ -35,7 +35,7 @@
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -46,10 +46,10 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Constructor for internal use.</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param> <param name="raw">a <see cref="T:System.IntPtr" />, pointer to the underlying C object</param>
<returns>a <see cref="T:Gdk.PixbufAniAnimIter" /></returns> <returns>a <see cref="T:Gdk.PixbufAniAnimIter" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -85,10 +85,10 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Protected constructor.</summary>
<returns>a <see cref="T:Gdk.PixbufAniAnimIter" /></returns> <returns>a <see cref="T:Gdk.PixbufAniAnimIter" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

102
doc/en/Gdk/PixbufAnimation.xml
View file

@ -10,8 +10,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>A base class for animations that are rendered using <see cref="T:Gdk.Pixbuf"/></summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>GLib.Object</BaseTypeName> <BaseTypeName>GLib.Object</BaseTypeName>
@ -36,10 +36,51 @@
<Parameter Name="start_time" Type="System.IntPtr" /> <Parameter Name="start_time" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<param name="start_time">To be added: an object of type 'IntPtr'</param> Get an iterator for displaying an animation. The iterator provides
<returns>To be added: an object of type 'Gdk.PixbufAnimationIter'</returns> the frames that should be displayed at a given time.
<remarks>To be added</remarks> It should be freed after use with g_object_unref().
</summary>
<param name="start_time">A <see cref="T:IntPtr"/></param>
<returns>A <see cref="T:Gdk.PixbufAnimationIter"/> to move over the animation</returns>
<remarks>
<p>
<paramref name="start_time"/> would normally come from
g_get_current_time() (FIXME: this function isn't bound into C#;
this needs a look), and
marks the beginning of animation playback. After creating an
iterator, you should immediately display the pixbuf returned by
<see cref="P:Gdk.PixbufAnimationIter.Pixbuf"/>. Then, you should install a
timeout (with g_timeout_add() (FIXME)) or by some other mechanism ensure
that you'll update the image after
<see cref="P:Gdk.PixbufAnimation.DelayTime"/> milliseconds. Each time
the image is updated, you should reinstall the timeout with the new,
possibly-changed delay time.
</p><p>
As a shortcut, if <paramref name="start_time"/> is <see langword="null"/>, the result of
g_get_current_time() will be used automatically.
</p><p>
To update the image (i.e. possibly change the result of
gdk_pixbuf_animation_iter_get_pixbuf() to a new frame of the animation),
call gdk_pixbuf_animation_iter_advance().
</p><p>
If you're using <see cref="T:Gdk.PixbufLoader"/>, in addition
to updating the image
after the delay time, you should also update it whenever you
receive the area_updated signal and
<see cref="M:Gdk.PixbufAnimationIter.OnCurrentlyLoadingFrame"/> returns
true. In this case, the frame currently being fed into the loader
has received new data, so needs to be refreshed. The delay time for
a frame may also be modified after an
<see cref="E:Gdk.PixbufLoader.AreaUpdated"/> signal, for
example if the delay time for a frame is encoded in the data after
the frame itself. So your timeout should be reinstalled after any
<see cref="E:Gdk.PixbufLoader.AreaUpdated"/> signal.
</p><p>
A delay time of -1 is possible, indicating "infinite."
</p>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Finalize"> <Member MemberName="Finalize">
@ -78,11 +119,19 @@
<Parameter Name="filename" Type="System.String" /> <Parameter Name="filename" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Public constructor; creates a new animation by
<param name="filename">To be added: an object of type 'string'</param> loading it from a file. The file format is
<returns>To be added: an object of type 'Gdk.PixbufAnimation'</returns> detected automatically. If the file's format does not support
<remarks>To be added</remarks> multi-frame images, then an animation with a single frame will
</Docs> be created. Possible errors are in the
<see cref="T:Gdk.PixbufError"/> and <see cref="T:Gdk.Error"/> domains.
</summary>
<param name="filename">A <see cref="T:System.String"/>, the filename to load into this object.</param>
<returns>A <see cref="T:Gdk.PixbufAnimation"/> with a reference count
of 1, or <see langword="null"/> if an error occurred.
</returns>
<remarks/>
</Docs>
</Member> </Member>
<Member MemberName="Width"> <Member MemberName="Width">
<MemberSignature Language="C#" Value="public int Width { get; };" /> <MemberSignature Language="C#" Value="public int Width { get; };" />
@ -91,9 +140,9 @@
<ReturnType>System.Int32</ReturnType> <ReturnType>System.Int32</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>The width of the animation.</summary>
<returns>To be added: an object of type 'int'</returns> <returns>A <see cref="T:System.Int32"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="StaticImage"> <Member MemberName="StaticImage">
@ -103,9 +152,10 @@
<ReturnType>Gdk.Pixbuf</ReturnType> <ReturnType>Gdk.Pixbuf</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>Gets the image if this animation is actually a static,
<returns>To be added: an object of type 'Gdk.Pixbuf'</returns> unanimaged file.</summary>
<remarks>To be added</remarks> <returns>A <see cref="T:Gdk.Pixbuf"/></returns>
<remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Height"> <Member MemberName="Height">
@ -115,9 +165,9 @@
<ReturnType>System.Int32</ReturnType> <ReturnType>System.Int32</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>The height of the animation.</summary>
<returns>To be added: an object of type 'int'</returns> <returns>A <see cref="T:System.Int32"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="IsStaticImage"> <Member MemberName="IsStaticImage">
@ -128,9 +178,15 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>
If you load a file with <see cref="M:Gdk.PixbufAnimation.ctor"/>
and it turns out to be a plain, unanimated image, then this
function will return
TRUE. Use <see cref="P:Gdk.PixbufAnimation.StaticImage"/> to
retrieve the image.
</summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -161,4 +217,4 @@
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

88
doc/en/Gdk/PixbufAnimationIter.xml
View file

@ -10,8 +10,10 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>
<remarks>To be added</remarks> An iterator used by <see cref="T:Gdk.PixbufAnimation"/> for displaying animations by stepping through frames.
</summary>
<remarks/>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>GLib.Object</BaseTypeName> <BaseTypeName>GLib.Object</BaseTypeName>
@ -36,10 +38,34 @@
<Parameter Name="current_time" Type="System.IntPtr" /> <Parameter Name="current_time" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<param name="current_time">To be added: an object of type 'IntPtr'</param> Possibly advances an animation to a new frame. Chooses the frame based
<returns>To be added: an object of type 'bool'</returns> on the start time passed to
<remarks>To be added</remarks> <see cref="M:Gdk.PixbufAnimation.GetIter"/>.
</summary>
<param name="current_time">A <see cref="T:IntPtr"/>, pointer to a C time object</param>
<returns>A <see cref="T:System.Boolean"/>, true if the image may need updating.</returns>
<remarks>
<p>
<paramref name="current_time"/> would normally come from g_get_current_time(), and
must be greater than or equal to the time passed to
<see cref="M:Gdk.PixbufAnimation.GetIter"/>, and must increase or remain
unchanged each time this method is
called. That is, you can't go backward in time; animations only
play forward.
</p><p>
As a shortcut, pass <see langword="null"/> for the current time and g_get_current_time()
will be invoked on your behalf. So you only need to explicitly pass
<paramref name="current_time"/> if you're doing something odd like playing the animation
at double speed.
</p><p>
If this method returns false, there's no need to update the animation
display, assuming the display had been rendered prior to advancing;
if true, you need to call
<see cref="P:Gdk.PixbufAnimationIter.Pixbuf"/> and update the
display with the new pixbuf.
</p>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="OnCurrentlyLoadingFrame"> <Member MemberName="OnCurrentlyLoadingFrame">
@ -50,9 +76,17 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>
<returns>To be added: an object of type 'bool'</returns> Used to determine how to respond to the
<remarks>To be added</remarks> <see cref="E:Gdk.PixbufLoader.AreaUpdated"/> signal
when loading an animation.
<see cref="E:Gdk.PixbufLoader.AreaUpdated"/> is emitted
for an area of the frame currently streaming into the loader. So if
you're on the currently loading frame, you need to redraw the
screen for the updated area.
</summary>
<returns>A <see cref="T:System.Boolean"/>, true if the frame we're on is partially loaded, or the last frame</returns>
<remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Finalize"> <Member MemberName="Finalize">
@ -90,9 +124,16 @@
<ReturnType>System.Int32</ReturnType> <ReturnType>System.Int32</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<returns>To be added: an object of type 'int'</returns> Gets the number of milliseconds the current pixbuf should be displayed,
<remarks>To be added</remarks> or -1 if the current pixbuf should be displayed forever.
</summary>
<returns>A <see cref="T:System.Int32"/>, delay time in milliseconds (thousandths of a second)</returns>
<remarks>
g_timeout_add() (FIXME: this doesn't seem to be bound)
conveniently takes a timeout in milliseconds, so you can use a timeout
to schedule the next update.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Pixbuf"> <Member MemberName="Pixbuf">
@ -102,9 +143,20 @@
<ReturnType>Gdk.Pixbuf</ReturnType> <ReturnType>Gdk.Pixbuf</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<returns>To be added: an object of type 'Gdk.Pixbuf'</returns> Gets the current pixbuf which should be displayed; the pixbuf will
<remarks>To be added</remarks> be the same size as the animation itself
(<see cref="M:Gdk.PixbufAnimation.GetWidth"/>, <see cref="M:Gdk.PixbufAnimation.GetHeight"/>). This pixbuf should be displayed
for <see cref="P:Gdk.PixbufAnimation.DelayTime"/> milliseconds. The caller
of this function does not own a reference to the returned pixbuf;
the returned pixbuf will become invalid when the iterator advances
to the next frame, which may happen anytime you call
<see cref="M:Gdk.PixbufAnimationIter.Advance"/>. Copy the pixbuf to keep it
(don't just add a reference), as it may get recycled as you advance
the iterator.
</summary>
<returns>A <see cref="T:Gdk.Pixbuf"/></returns>
<remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -140,10 +192,10 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Protected constructor.</summary>
<returns>a <see cref="T:Gdk.PixbufAnimationIter" /></returns> <returns>a <see cref="T:Gdk.PixbufAnimationIter" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>