diff --git a/doc/ChangeLog b/doc/ChangeLog index 7b62814a3..ee6224be4 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,14 @@ +2004-09-25 Shane Landrum + + * 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 * en/Gtk/Widget.xml : docs for new OnSetScrollAdjustments VM. diff --git a/doc/en/Gdk/Drawable.xml b/doc/en/Gdk/Drawable.xml index dc325dda6..a4682a24a 100644 --- a/doc/en/Gdk/Drawable.xml +++ b/doc/en/Gdk/Drawable.xml @@ -39,11 +39,11 @@ - To be added - To be added: an object of type 'Gdk.GC' - To be added: an object of type 'Gdk.Point' - To be added: an object of type 'int' - To be added + Draws a number of points using the given graphics context. + A + An array of objects. + A + NOTE: Drawable.custom needs to be fixed to implement this properly. @@ -61,14 +61,18 @@ - To be added - To be added: an object of type 'Gdk.GC' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'Pango.Layout' - To be added: an object of type 'Gdk.Color' - To be added: an object of type 'Gdk.Color' - To be added + Render a onto the Drawable + object, overriding the layout's normal colors with + and/or . + and + need not be allocated. + A , the graphics context to use + A , the X position of the left of the layout (in pixels) + A , the Y position of the top of the layout (in pixels) + A , the layout to render + A , the foreground color + A , the background color + @@ -84,12 +88,13 @@ - To be added - To be added: an object of type 'Gdk.GC' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'Pango.LayoutLine' - To be added + Render a onto the Drawable + object. + A , the graphics context to use + A , the X position of the start of string (in pixels) + A , the Y position of the baseline (in pixels) + A + @@ -107,14 +112,18 @@ - To be added - To be added: an object of type 'Gdk.GC' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'Pango.LayoutLine' - To be added: an object of type 'Gdk.Color' - To be added: an object of type 'Gdk.Color' - To be added + Render a onto the Drawable + object, overriding the layout's normal colors with + and/or . + and + need not be allocated. + A , the graphics context to use + A , the X position of the start of string (in pixels) + A , the Y position of the baseline (in pixels) + A , a line of text to render + A , the foreground color + A , the background color + @@ -131,10 +140,10 @@ Render a onto a - To be added: an object of type 'Gdk.GC' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'Pango.Layout' + A + A + A + A If you are using Gtk, the usual way to obtain a is . @@ -149,10 +158,18 @@ - To be added - To be added: an object of type 'int&' - To be added: an object of type 'int&' - To be added + Fills and + with the size of the Drawable. or + can be if you + only want the other one. + + A + A + + On the X11 platform, if this Drawable object is also a , the returned + size is the size reported in the most-recently-processed configure + event, rather than the current size on the X server. + @@ -167,11 +184,11 @@ - To be added - To be added: an object of type 'Gdk.GC' - To be added: an object of type 'Gdk.Segment' - To be added: an object of type 'int' - To be added + Draws a number of unconnected lines. + A + A , a list of segments to draw. + A , the number of segments. + TODO: Drawable.custom needs to be edited to make segs an array of Gdk.Segment objects. @@ -188,13 +205,21 @@ - To be added - To be added: an object of type 'Gdk.GC' - To be added: an object of type 'Pango.Font' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'Pango.GlyphString' - To be added + +

This is a low-level function; 99% of text rendering should be done + using instead.

+

A glyph is a character in a font. This function draws a sequence of + glyphs. To obtain a sequence of glyphs you have to understand a + lot about internationalized text handling, which you don't want to + understand; thus, use instead of this function, + handles the details.

+
+ A + A + A + A + A +
@@ -210,13 +235,54 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'Gdk.Image' - To be added + +

+ A stores client-side image data (pixels). In contrast, + and are server-side + objects. This method obtains the pixels from a + server-side drawable as a client-side . +

+ The format of a depends on + the of the current display, which + makes manipulating extremely difficult; + therefore, in + most cases you should use + instead of + this lower-level function. A 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. +

+
+ A , X coordinate of the upper left corner of the region to get as a drawable + A , Y coordinate of the upper left corner of the region to get as a drawable. + A , width of the rectangle + A , height of the rectangle. + A containing the contents of this Drawable object. + +

+

+ , , + , and define + the region of the drawable to obtain as an image. +

+ 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. +

+ 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. +

+ If the source drawable is a #GdkWindow and partially offscreen + or obscured, then the obscured portions of the returned image + will contain undefined data. +

+
@@ -236,16 +302,33 @@ - To be added - To be added: an object of type 'Gdk.GC' - To be added: an object of type 'Gdk.Drawable' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + + Copies the x region of at coordinates (, + ) to coordinates (, ) in . + and/or may be given as -1, in which case the entire + drawable will be copied. + Most fields in are not used for this operation, but notably the + clip mask or clip region will be honored. + + A + A , the source Drawable. + A + A + A + A + A + A + + 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. +

TODO: This API needs to be adjusted; should + probably not exist.

+
@@ -266,14 +349,14 @@ Draws a onto a drawable. - To be added: an object of type 'Gdk.GC' - To be added: an object of type 'Gdk.Image' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'int' + A + A + A + A + A + A + A + A The depth of the must match the depth of the . @@ -289,11 +372,11 @@ - To be added - To be added: an object of type 'Gdk.GC' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + Draws a point at (,). + A + A + A + @@ -333,10 +416,17 @@ - To be added - To be added: an object of type 'Gdk.Colormap' - To be added: an object of type 'Gdk.Colormap' - To be added + The color map for this Drawable. You only need to set + the color map if the drawable-creating function did not have a + way to determine the colormap, and you then use drawable operations + 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. + + A + A + @@ -347,8 +437,8 @@ To be added - To be added: an object of type 'Gdk.Region' - To be added + A + @@ -359,8 +449,8 @@ To be added - To be added: an object of type 'Gdk.Region' - To be added + A + @@ -371,8 +461,8 @@ To be added - To be added: an object of type 'Gdk.Visual' - To be added + A + @@ -383,8 +473,8 @@ To be added - To be added: an object of type 'int' - To be added + A + @@ -396,7 +486,7 @@ To be added a - To be added + @@ -408,7 +498,7 @@ To be added a - To be added + @@ -425,7 +515,7 @@ To be added a a - To be added + @@ -486,7 +576,7 @@ a a a - To be added + @@ -515,7 +605,7 @@ a a a - To be added + @@ -550,7 +640,7 @@ a a a - To be added + @@ -613,7 +703,7 @@ This is a constructor used by derivative types of Drawable. This is not typically used by C# code. a - To be added + @@ -642,7 +732,7 @@ a a a - To be added + @@ -675,7 +765,7 @@ a a a - To be added + @@ -706,7 +796,7 @@ a a a - To be added + @@ -735,7 +825,7 @@ a a a - To be added + @@ -764,7 +854,7 @@ a a a - To be added + @@ -797,7 +887,7 @@ a a a - To be added + @@ -821,4 +911,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gdk/Pixbuf.xml b/doc/en/Gdk/Pixbuf.xml index 5a091a5e4..c85016216 100644 --- a/doc/en/Gdk/Pixbuf.xml +++ b/doc/en/Gdk/Pixbuf.xml @@ -817,20 +817,26 @@ - To be added - To be added: an object of type 'Gdk.Drawable' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'Gdk.PixbufAlphaMode' - To be added: an object of type 'int' - To be added: an object of type 'Gdk.RgbDither' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + Obsolete; do not use. Use instead. + A + A + A + A + A + A + A + A + A + A + A + A + 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 . + On older X servers, rendering pixbufs with an alpha channel involves round trips + to the X server, and may be somewhat slow. + @@ -1076,17 +1082,17 @@ - To be added - To be added: an object of type 'Gdk.Drawable' - To be added: an object of type 'Gdk.Colormap' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'Gdk.Pixbuf' - To be added + Generates a new Pixbuf object from a . + A + A + A + A + A + A + A + A + A + @@ -1103,16 +1109,16 @@ - To be added - To be added: an object of type 'byte []' - To be added: an object of type 'bool' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'Gdk.PixbufDestroyNotify' - To be added: an object of type 'Gdk.Pixbuf' - To be added + Public constructor. + A , the raw data + A , true if this pixbuf has an alpha layer. + A + A , image width + A , image height + A + A + A + @@ -1125,10 +1131,10 @@ To be added - To be added: an object of type 'byte []' - To be added: an object of type 'bool' - To be added: an object of type 'Gdk.Pixbuf' - To be added + A + A + A + @@ -1159,7 +1165,7 @@ To be added a - To be added + @@ -1175,7 +1181,7 @@ a a a - To be added + @@ -1191,7 +1197,7 @@ To be added a a - To be added + @@ -1202,10 +1208,10 @@ - To be added + Makes a new Pixbuf object from a . a a - To be added + @@ -1223,7 +1229,10 @@ - To be added + Public constructor; creates a new + and allocates a buffer for it. Note that the buffer is not cleared; + you will have to fill it completely yourself. + a a a @@ -1232,8 +1241,10 @@ a a a - a - To be added + a with a reference count of 1, or + null if not enough memory could be allocated for the image buffer. + + @@ -1262,10 +1273,10 @@ - To be added + Public constructor. a a - To be added + @@ -1305,7 +1316,7 @@ To be added a - To be added + @@ -1318,7 +1329,7 @@ To be added a - To be added + @@ -1339,8 +1350,8 @@ The file type to save (one of "ani", "bmp", "gif", "ico", "jpeg", "pcx", "png", "pnm", "ras", "tga", "tiff" "wbmp", "xpm" or "xbm") Options that are passed to the save module. Values for each key - To be added: an object of type 'bool' - To be added + A + @@ -1358,7 +1369,7 @@ a a a - To be added + @@ -1377,7 +1388,7 @@ Render pixbuf alpha channel as a bi-level clip mask to a - The destination object of type 'Gdk.Bitmap' + The destination object of type "Gdk.Bitmap"/> Source X coordinate. Source Y coordinate. Destination X coordinate. @@ -1385,7 +1396,7 @@ Destination Y coordinate. Value below this will be painted as zero; all other values will be painted as one. This function is designed to threshold and render the alpha values from this into the destination which can then be used as a clipping mask for a . - To be added + @@ -1400,11 +1411,27 @@ - To be added + + Creates a pixmap and a mask bitmap which are returned in the + and + 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 + or and + . + a a - a - To be added + a , threshold value for opacity. + + The pixmap that is created is created for the colormap returned + by . You normally will want to instead use + the actual colormap for a widget, and use + , + If the pixbuf does not have an alpha channel, then * will be set + to . + @@ -1420,12 +1447,28 @@ - To be added + + Creates a pixmap and a mask bitmap which are returned in the + and + 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 + or and + . + a a a a - To be added + + The pixmap that is created uses the specified by . + 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 * will be set + to . + diff --git a/doc/en/Gdk/PixbufAlphaMode.xml b/doc/en/Gdk/PixbufAlphaMode.xml index 91995c8d5..9dd5597d1 100644 --- a/doc/en/Gdk/PixbufAlphaMode.xml +++ b/doc/en/Gdk/PixbufAlphaMode.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Do not use. + System.Enum @@ -69,4 +69,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gdk/PixbufAniAnim.xml b/doc/en/Gdk/PixbufAniAnim.xml index 2870b962a..21a0461be 100644 --- a/doc/en/Gdk/PixbufAniAnim.xml +++ b/doc/en/Gdk/PixbufAniAnim.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Represents an ANI format animation internally. Do not use. + Gdk.PixbufAnimation @@ -35,7 +35,7 @@ To be added - To be added + @@ -46,10 +46,10 @@ - To be added - a + Constructor for use by internal code. Do not use. + a , pointer to underlying C data a - To be added + @@ -85,10 +85,10 @@ - To be added + Protected constructor. a - To be added + - \ No newline at end of file + diff --git a/doc/en/Gdk/PixbufAniAnimIter.xml b/doc/en/Gdk/PixbufAniAnimIter.xml index 24da2d486..8f2dd18ad 100644 --- a/doc/en/Gdk/PixbufAniAnimIter.xml +++ b/doc/en/Gdk/PixbufAniAnimIter.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Iterator for pointing to a particular frame of an ANI animation. Mostly internal; not for general developer use. + Gdk.PixbufAnimationIter @@ -35,7 +35,7 @@ To be added - To be added + @@ -46,10 +46,10 @@ - To be added - a + Constructor for internal use. + a , pointer to the underlying C object a - To be added + @@ -85,10 +85,10 @@ - To be added + Protected constructor. a - To be added + - \ No newline at end of file + diff --git a/doc/en/Gdk/PixbufAnimation.xml b/doc/en/Gdk/PixbufAnimation.xml index 705818a67..a0ee5e9b9 100644 --- a/doc/en/Gdk/PixbufAnimation.xml +++ b/doc/en/Gdk/PixbufAnimation.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A base class for animations that are rendered using + GLib.Object @@ -36,10 +36,51 @@ - To be added - To be added: an object of type 'IntPtr' - To be added: an object of type 'Gdk.PixbufAnimationIter' - To be added + + Get an iterator for displaying an animation. The iterator provides + the frames that should be displayed at a given time. + It should be freed after use with g_object_unref(). + + A + A to move over the animation + +

+ 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 + . Then, you should install a + timeout (with g_timeout_add() (FIXME)) or by some other mechanism ensure + that you'll update the image after + milliseconds. Each time + the image is updated, you should reinstall the timeout with the new, + possibly-changed delay time. +

+ As a shortcut, if is , the result of + g_get_current_time() will be used automatically. +

+ 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(). +

+ + If you're using , in addition + to updating the image + after the delay time, you should also update it whenever you + receive the area_updated signal and + 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 + 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 + signal. +

+ A delay time of -1 is possible, indicating "infinite." +

+
@@ -78,11 +119,19 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'Gdk.PixbufAnimation' - To be added - + Public constructor; creates a new animation by + loading it from a file. The file format is + detected automatically. If the file's format does not support + multi-frame images, then an animation with a single frame will + be created. Possible errors are in the + and domains. + + A , the filename to load into this object. + A with a reference count + of 1, or if an error occurred. + + + @@ -91,9 +140,9 @@ System.Int32 - To be added - To be added: an object of type 'int' - To be added + The width of the animation. + A + @@ -103,9 +152,10 @@ Gdk.Pixbuf - To be added - To be added: an object of type 'Gdk.Pixbuf' - To be added + Gets the image if this animation is actually a static, + unanimaged file. + A + @@ -115,9 +165,9 @@ System.Int32 - To be added - To be added: an object of type 'int' - To be added + The height of the animation. + A + @@ -128,9 +178,15 @@ - To be added + + If you load a file with + and it turns out to be a plain, unanimated image, then this + function will return + TRUE. Use to + retrieve the image. + a - To be added + @@ -161,4 +217,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gdk/PixbufAnimationIter.xml b/doc/en/Gdk/PixbufAnimationIter.xml index d65f11f77..2b1f89f19 100644 --- a/doc/en/Gdk/PixbufAnimationIter.xml +++ b/doc/en/Gdk/PixbufAnimationIter.xml @@ -10,8 +10,10 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + + An iterator used by for displaying animations by stepping through frames. + + GLib.Object @@ -36,10 +38,34 @@ - To be added - To be added: an object of type 'IntPtr' - To be added: an object of type 'bool' - To be added + + Possibly advances an animation to a new frame. Chooses the frame based + on the start time passed to + . + + A , pointer to a C time object + A , true if the image may need updating. + +

+ would normally come from g_get_current_time(), and + must be greater than or equal to the time passed to + , 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. +

+ As a shortcut, pass for the current time and g_get_current_time() + will be invoked on your behalf. So you only need to explicitly pass + if you're doing something odd like playing the animation + at double speed. +

+ 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 + and update the + display with the new pixbuf. +

+
@@ -50,9 +76,17 @@ - To be added - To be added: an object of type 'bool' - To be added + + Used to determine how to respond to the + signal + when loading an animation. + 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. + + A , true if the frame we're on is partially loaded, or the last frame + @@ -90,9 +124,16 @@ System.Int32 - To be added - To be added: an object of type 'int' - To be added + + Gets the number of milliseconds the current pixbuf should be displayed, + or -1 if the current pixbuf should be displayed forever. + + A , delay time in milliseconds (thousandths of a second) + + 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. + @@ -102,9 +143,20 @@ Gdk.Pixbuf - To be added - To be added: an object of type 'Gdk.Pixbuf' - To be added + + Gets the current pixbuf which should be displayed; the pixbuf will + be the same size as the animation itself + (, ). This pixbuf should be displayed + for 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 + . Copy the pixbuf to keep it + (don't just add a reference), as it may get recycled as you advance + the iterator. + + A + @@ -140,10 +192,10 @@ - To be added + Protected constructor. a - To be added + - \ No newline at end of file +