diff --git a/doc/ChangeLog b/doc/ChangeLog index c2673d200..4fd515b10 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,7 @@ +2003-02-19 Jeffrey Stedfast + + * en/Gdk/GC.xml: Documented. + 2003-02-17 Duncan Mak * AtkSharp/*.xml: diff --git a/doc/en/Gdk/GC.xml b/doc/en/Gdk/GC.xml index f9cc3c75b..0a93d2b93 100644 --- a/doc/en/Gdk/GC.xml +++ b/doc/en/Gdk/GC.xml @@ -7,8 +7,13 @@ To be added - To be added - To be added + Represents a graphics context + + The Gdk.GC class is used to represent a graphics + context. It is an opaque structure with no user-visible + elements. + + GLib.Object @@ -33,9 +38,11 @@ - To be added - To be added: an object of type 'Gdk.GC' - To be added + Copy the set of values from one graphics context onto another graphics context. + An object of type 'Gdk.GC' + + Copy the set of values from one graphics context onto another graphics context. + @@ -49,10 +56,15 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + Set the origin when using tiles or stipples with the GC. + the x-coordinate of the origin. + the y-coordinate of the origin. + + Set the origin when using tiles or stipples with the + GC. The tile or stipple will be aligned such that the upper + left corner of the tile or stipple will coincide with this + point. + @@ -66,10 +78,14 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + Sets the origin of the clip mask. + the x-coordinate of the origin. + the y-coordinate of the origin. + + Sets the origin of the clip mask. The coordinates are + interpreted relative to the upper-left corner of the + destination drawable of the current operation. + @@ -83,10 +99,15 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + Set the x and y offsets on the Gdk.GC + amount by which to offset the GC in the X direction + amount by which to offset the GC in the Y direction + + Offset attributes such as the clip and tile-stipple + origins of the GC so that drawing at x - x_offset, y - + y_offset with the offset GC has the same effect as drawing + at x, y with the original GC. + @@ -101,11 +122,18 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'byte[]' - To be added: an object of type 'int' - To be added + Sets the way dashed-lines are drawn. + the dash offset. + an array of dash lengths. + the number of elemenst in dash_list. + + Sets the way dashed-lines are drawn. Lines will be + drawn with alternating on and off segments of the lengths + specified in dash_list. The manner in which the on and off + segments are drawn is determined by the line_style value of + the GC. (This can be changed with + Gdk.GC.SetLineAttributes()) + @@ -119,10 +147,16 @@ - To be added - To be added: an object of type 'Gdk.GCValues' - To be added: an object of type 'Gdk.GCValuesMask' - To be added + Sets attributes of a graphics context in bulk. + struct containing the new values + mask indicating which struct fields are to be used + + Sets attributes of a graphics context in bulk. For + each flag set in values_mask, the corresponding field will + be read from values and set as the new value for gc. If + you're only setting a few values on gc, calling individual + "setter" functions is likely more convenient. + @@ -138,12 +172,16 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'Gdk.LineStyle' - To be added: an object of type 'Gdk.CapStyle' - To be added: an object of type 'Gdk.JoinStyle' - To be added + Sets various attributes of how lines are drawn. + the width of lines. + the dash-style for lines. + the manner in which the ends of lines are drawn. + the way in which lines are joined together. + + Sets various attributes of how lines are drawn. See + the corresponding members of Gdk.GC.Values for full + explanations of the arguments. + @@ -156,9 +194,11 @@ - To be added - To be added: an object of type 'Gdk.GCValues' - To be added + Retrieves the current values from a graphics context. + the GdkGCValues structure in which to store the results. + + Retrieves the current values from a graphics context. + @@ -266,10 +306,19 @@ - To be added - To be added: an object of type 'Gdk.Color' - To be added: an object of type 'Gdk.Color' - To be added + Set the foreground color of a GC using an unallocated color. + + an object of type 'Gdk.Color' + + Set the foreground color of a GC using an unallocated + color. The pixel value for the color will be determined + using GdkRGB. If the colormap for the GC has not previously + been initialized for GdkRGB, then for pseudo-color colormaps + (colormaps with a small modifiable number of colors), a + colorcube will be allocated in the colormap. + Calling this function for a GC without a colormap is + an error. + @@ -282,10 +331,14 @@ - To be added - To be added: an object of type 'Gdk.Rectangle' - To be added: an object of type 'Gdk.Rectangle' - To be added + Sets the clip mask for a graphics context from a rectangle. + the rectangle to clip to. + an object of type 'Gdk.Rectangle' + + Sets the clip mask for a graphics context from a + rectangle. The clip mask is interpreted relative to the clip + origin. (See Gdk.GC.SetClipOrigin()). + @@ -298,10 +351,13 @@ - To be added - To be added: an object of type 'Gdk.Pixmap' - To be added: an object of type 'Gdk.Pixmap' - To be added + Set a tile pixmap for a graphics context. + the new tile pixmap. + an object of type 'Gdk.Pixmap' + + Set a tile pixmap for a graphics context. This will + only be used if the fill mode is GDK_TILED. + @@ -314,10 +370,14 @@ - To be added - To be added: an object of type 'Gdk.Bitmap' - To be added: an object of type 'Gdk.Bitmap' - To be added + Sets the clip mask for a graphics context from a bitmap. + a bitmap. + a bitmap. + + Sets the clip mask for a graphics context from a + bitmap. The clip mask is interpreted relative to the clip + origin. (See Gdk.GC.SetClipOrigin()). + @@ -330,10 +390,12 @@ - To be added - To be added: an object of type 'Gdk.Fill' - To be added: an object of type 'Gdk.Fill' - To be added + Set the fill mode for a graphics context. + the new fill mode. + the new fill mode. + + Set the fill mode for a graphics context. + @@ -346,10 +408,14 @@ - To be added - To be added: an object of type 'Gdk.Colormap' - To be added: an object of type 'Gdk.Colormap' - To be added + Sets the colormap for the GC to the given colormap. + a Gdk.Colormap + a Gdk.Colormap + + Sets the colormap for the GC to the given + colormap. The depth of the colormap's visual must match the + depth of the drawable for which the GC was created. + @@ -362,10 +428,19 @@ - To be added - To be added: an object of type 'Gdk.Color' - To be added: an object of type 'Gdk.Color' - To be added + Set the background color of a GC using an unallocated color. + a Gdk.Color + a Gdk.Color + + Set the background color of a GC using an unallocated + color. The pixel value for the color will be determined + using GdkRGB. If the colormap for the GC has not previously + been initialized for GdkRGB, then for pseudo-color colormaps + (colormaps with a small modifiable number of colors), a + colorcube will be allocated in the colormap. + Calling this function for a GC without a colormap is + an error. + @@ -378,10 +453,12 @@ - To be added - To be added: an object of type 'Gdk.Color' - To be added: an object of type 'Gdk.Color' - To be added + Sets the foreground color for a graphics context. + the new foreground color. + the new foreground color. + + Sets the foreground color for a graphics context. + @@ -394,10 +471,14 @@ - To be added - To be added: an object of type 'Gdk.Region' - To be added: an object of type 'Gdk.Region' - To be added + Sets the clip mask for a graphics context from a region structure. + the Gdk.Region + the Gdk.Region + + Sets the clip mask for a graphics context from a + region structure. The clip mask is interpreted relative to + the clip origin. (See Gdk.GC.SetClipOrigin()). + @@ -410,10 +491,13 @@ - To be added - To be added: an object of type 'Gdk.SubwindowMode' - To be added: an object of type 'Gdk.SubwindowMode' - To be added + Sets how drawing with this GC on a window will affect child windows of that window. + the subwindow mode. + the subwindow mode. + + Sets how drawing with this GC on a window will affect + child windows of that window. + @@ -426,10 +510,14 @@ - To be added - To be added: an object of type 'Gdk.Pixmap' - To be added: an object of type 'Gdk.Pixmap' - To be added + Set the stipple bitmap for a graphics context. + the new stipple bitmap. + the new stipple bitmap. + + Set the stipple bitmap for a graphics context. The + stipple will only be used if the fill mode is GDK_STIPPLED + or GDK_OPAQUE_STIPPLED. + @@ -442,10 +530,14 @@ - To be added - To be added: an object of type 'Gdk.Function' - To be added: an object of type 'Gdk.Function' - To be added + Determines how the current pixel values and the pixel values being drawn are combined to produce the final pixel values. + a function. + a function. + + Determines how the current pixel values and the pixel + values being drawn are combined to produce the final pixel + values. + @@ -458,10 +550,13 @@ - To be added - To be added: an object of type 'Gdk.Color' - To be added: an object of type 'Gdk.Color' - To be added + Sets the background color for a graphics context. + the new background color. + the new background color. + + Sets the background color for a graphics + context. + @@ -474,10 +569,15 @@ - To be added + Sets whether or not this GC should geenrate exposure events. To be added: an object of type 'bool' To be added: an object of type 'bool' - To be added + + Sets whether copying non-visible portions of a + drawable using this graphics context generate exposure + events for the corresponding regions of the destination + drawable. (See Gdk.Drawable). +