From 764b8ac5d827f13abe0d76262cbf7c4f63233338 Mon Sep 17 00:00:00 2001 From: Dan Winship Date: Thu, 28 Oct 2004 19:26:15 +0000 Subject: [PATCH] * en/Gdk/Pixbuf.xml * en/Gdk/Pixmap.xml * en/Gdk/Window.xml * en/Gtk/Style.xml * en/Gtk/TargetList.xml: Update to match API fixes svn path=/trunk/gtk-sharp/; revision=35410 --- doc/ChangeLog | 8 + doc/en/Gdk/Pixbuf.xml | 142 ++++----- doc/en/Gdk/Pixmap.xml | 68 ++-- doc/en/Gdk/Window.xml | 645 ++++++++++++++++++++------------------ doc/en/Gtk/Style.xml | 336 +++++++++++++------- doc/en/Gtk/TargetList.xml | 183 ++++++----- 6 files changed, 789 insertions(+), 593 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index 90d30d403..7615654ff 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,11 @@ +2004-10-28 Dan Winship + + * en/Gdk/Pixbuf.xml + * en/Gdk/Pixmap.xml + * en/Gdk/Window.xml + * en/Gtk/Style.xml + * en/Gtk/TargetList.xml: Update to match API fixes + 2004-10-11 Shane Landrum * en/Gdk/AreaUpdatedArgs.xml diff --git a/doc/en/Gdk/Pixbuf.xml b/doc/en/Gdk/Pixbuf.xml index 59b3cca51..6b4014754 100644 --- a/doc/en/Gdk/Pixbuf.xml +++ b/doc/en/Gdk/Pixbuf.xml @@ -817,23 +817,23 @@ - Obsolete; do not use. Use instead. - A - A - A - A - A - A - A - A - A - A - A - A + 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 . + 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. @@ -1082,17 +1082,17 @@ - Generates a new Pixbuf object from a . - A - A - A - A - A - A - A - A - A - + Generates a new Pixbuf object from a . + A + A + A + A + A + A + A + A + A + @@ -1110,15 +1110,15 @@ 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 - + A , the raw data + A , true if this pixbuf has an alpha layer. + A + A , image width + A , image height + A + A + A + @@ -1131,10 +1131,10 @@ Constructor. - A - A , whether to copy raw pixel data; run-length encoded pixel data is always copied. - A - + A + A , whether to copy raw pixel data; run-length encoded pixel data is always copied. + A + @@ -1165,7 +1165,7 @@ To be added a - + @@ -1181,7 +1181,7 @@ a a a - + @@ -1208,10 +1208,10 @@ - Makes a new Pixbuf object from a . + Makes a new Pixbuf object from a . a a - + @@ -1229,7 +1229,7 @@ - Public constructor; creates a new + 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. @@ -1244,7 +1244,7 @@ a with a reference count of 1, or null if not enough memory could be allocated for the image buffer. - + @@ -1276,7 +1276,7 @@ Public constructor. a a - + @@ -1316,7 +1316,7 @@ To be added a - + @@ -1329,7 +1329,7 @@ The pixels contained by this Pixbuf object. a , pointer to the underlying C data - + @@ -1350,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 - A - + A + @@ -1392,7 +1392,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. @@ -1400,46 +1400,46 @@ 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 . - + - + Method System.Void - + Creates a pixmap and a mask bitmap which are returned in the - and + 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 - . + given drawables should use + or and + . a a a , threshold value for opacity. The pixmap that is created is created for the colormap returned - by . You normally will want to instead use + 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 . + , + If the pixbuf does not have an alpha channel, then * will be set + to . - + Method System.Void @@ -1447,33 +1447,33 @@ - + Creates a pixmap and a mask bitmap which are returned in the - and + 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 - . + given drawables should use + or and + . a a a a - The pixmap that is created uses the specified by . + 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 . + If the pixbuf does not have an alpha channel, then * will be set + to . - + \ No newline at end of file diff --git a/doc/en/Gdk/Pixmap.xml b/doc/en/Gdk/Pixmap.xml index 00e105cf6..e826cf20a 100644 --- a/doc/en/Gdk/Pixmap.xml +++ b/doc/en/Gdk/Pixmap.xml @@ -229,29 +229,29 @@ For example in the X backend, a native pixmap handle is an Xlib XID. - + Method Gdk.Pixmap - + - + Create a pixmap from XPM data. a - a + a a - a + an array of , defining an XPM image a To be added - + Method Gdk.Pixmap @@ -259,7 +259,7 @@ For example in the X backend, a native pixmap handle is an Xlib XID. - + @@ -267,7 +267,7 @@ For example in the X backend, a native pixmap handle is an Xlib XID. Create a pixmap from an XPM file using a specific colormap. a a - a + a a a a @@ -275,21 +275,21 @@ For example in the X backend, a native pixmap handle is an Xlib XID. - + Method Gdk.Pixmap - + Create a pixmap from an XPM file. a - a + a a a a @@ -297,7 +297,7 @@ For example in the X backend, a native pixmap handle is an Xlib XID. - + Method Gdk.Pixmap @@ -305,17 +305,17 @@ For example in the X backend, a native pixmap handle is an Xlib XID. - + - + Create a pixmap from XPM data using a colormap. a a - a + a a - a + an array of , defining an image in XPM format a To be added @@ -340,6 +340,24 @@ For example in the X backend, a native pixmap handle is an Xlib XID. To be added + + + Method + + Gdk.Pixmap + + + + + + + To be added + a + a + a + To be added + + Method @@ -360,24 +378,6 @@ For example in the X backend, a native pixmap handle is an Xlib XID. To be added - - - Method - - Gdk.Pixmap - - - - - - - To be added - a - a - a - To be added - - Method diff --git a/doc/en/Gdk/Window.xml b/doc/en/Gdk/Window.xml index 0ebe26a0e..702651472 100644 --- a/doc/en/Gdk/Window.xml +++ b/doc/en/Gdk/Window.xml @@ -21,7 +21,7 @@ Gdk.Drawable - + GLib.IWrapper @@ -39,8 +39,8 @@ - Calls for all windows in the application. - + Calls for all windows in the application. + @@ -54,9 +54,9 @@ For internal use only. Looks up the Window that wraps the given native window handle. - A , a native window ID. - A - + A , a native window ID. + A + @@ -70,11 +70,11 @@ For internal use only. - Wraps a native window for the default display in a . + Wraps a native window for the default display in a . This may fail if the window has been destroyed. - A - A - + A + A + @@ -87,10 +87,10 @@ Sets the shape mask of this window to the union of shape masks for all children of the window, ignoring the shape mask of the window - itself. Contrast with + itself. Contrast with which includes the shape mask of the window in the masks to be merged. - + @@ -105,31 +105,29 @@ - Adds to the update area for the window. + Adds to the update area for the window. The update area is the region that needs to be redrawn, or "dirty region." - A - A + A + A -

The call sends one or +

The call sends one or more expose events to the window, which together cover the entire update area. An application would normally redraw the contents of - in response to those expose events.

- -

GDK will call on your behalf + in response to those expose events.

+

GDK will call on your behalf whenever your program returns to the main loop and becomes idle, so normally there's no need to do that manually, you just need to invalidate regions that you know should be redrawn.

- -

The parameter controls +

The parameter controls whether the region of - each child window that intersects will + each child window that intersects will also be invalidated. - If , then the update area for child windows will remain - unaffected. See if you need + If , then the update area for child windows will remain + unaffected. See if you need fine grained control over which children are invalidated.

- + @@ -145,12 +143,12 @@ Reparents this window into the given - . The window being + . The window being reparented will be unmapped as a side effect. - A , new parent to move this window into - A , X location inside the new parent - A , Y location inside the new parent - + A , new parent to move this window into + A , X location inside the new parent + A , Y location inside the new parent + @@ -175,9 +173,9 @@ other cases, a multi-step process is used to scroll the window which may produce temporary visual artifacts and unnecessary invalidations.) - A , amount to scroll in the X direction - A , amount to scroll in the Y direction - + A , amount to scroll in the X direction + A , amount to scroll in the Y direction + @@ -196,9 +194,9 @@ implementing scary features that involve deep knowledge of the windowing system. Don't worry about it unless you have to. - A - A , true if the server supports static gravity - + A + A , true if the server supports static gravity + @@ -210,19 +208,21 @@ -

Lowers this window to the bottom of the Z-order (stacking order), so that +

Lowers this window to the bottom of the Z-order (stacking order), so that other windows with the same parent window appear above this window. This is true whether or not the other windows are visible. -

- If this window is a toplevel, the window manager may choose to deny the - request to move the window in the Z-order, only - requests the restack, but does not guarantee it. -

- Note that raises the window again, so don't call this - function before . (Try .)

- - +

+ If this window is a toplevel, the window manager may choose to deny the + request to move the window in the Z-order, only + requests the restack, but does not guarantee it. +

+

+ Note that raises the window again, so don't call this + function before . (Try .) +

+ + @@ -239,17 +239,17 @@ - Equivalent to calling and - in succession, + Equivalent to calling and + in succession, except that both operations are performed at once, avoiding strange visual effects. (i.e. the user may be able to see the window first move, then resize, if you don't use this method.) - A , new X position relative to window's parent - A , new Y position relative to window's parent - A , new width - A , new height - + A , new X position relative to window's parent + A , new Y position relative to window's parent + A , new width + A , new height + @@ -286,34 +286,36 @@ - Sets the geometry hints for this window. Hints flagged in - are set, hints not flagged in are unset. - To unset all hints, use a of 0 and a of . + Sets the geometry hints for this window. Hints flagged in + are set, hints not flagged in are unset. + To unset all hints, use a of 0 and a of . - A - A + A + A -

+

This function provides hints to the windowing system about acceptable sizes for a toplevel window. The purpose of this is to constrain user resizing, but the windowing system will typically (but is not required to) also constrain the current size of the window to the provided values and - constrain programatic resizing via or - . -

+ constrain programatic resizing via or + . +

+

Note that on X11, this effect has no effect on windows of type GDK_WINDOW_TEMP or windows where override_redirect - has been turned on via + has been turned on via since these windows are not resizable by the user. -

+

+

Since you can't count on the windowing system doing the constraints for programmatic resizes, you should generally - call + call yourself to determine appropriate sizes.

- + @@ -327,8 +329,8 @@ Asks to iconify (minimize) the window. The window manager may choose to ignore the request, but normally will honor it. Using - is preferred, if you have a - widget. + is preferred, if you have a + widget. This function only makes sense when this window is a toplevel window. @@ -349,11 +351,11 @@ Adds an event filter to this window, allowing you to intercept events before they reach GDK. This is a low-level operation and makes it easy to break GDK and/or GTK+, so you have to know what you're - doing. Pass for this window to get all events + doing. Pass for this window to get all events for all windows, instead of events for a specific window. - A - + A + @@ -367,37 +369,33 @@ - Adds to the update area for the + Adds to the update area for the window. The update area is the region that needs to be redrawn, or "dirty region." - A - A + A + A -

function to use to decide if to recurse to a child, +

function to use to decide if to recurse to a child, %NULL means never recurse.

-

The call +

The call sends one or more expose events to the window, which together cover the entire update area. An application would normally redraw the contents of the whole window in response to those expose events.

- -

GDK will call on +

GDK will call on your behalf whenever your program returns to the main loop and becomes idle, so normally there's no need to do that manually, you just need to invalidate regions that you know should be redrawn.

- -

(TODO: See bugzilla.ximian.com bug # 66241, to which the following +

(TODO: See bugzilla.ximian.com bug # 66241, to which the following text pertains.) - The parameter controls whether the region of - each child window that intersects will also be invalidated. - Only children for which returns TRUE will have the area - invalidated. -

- - + The parameter controls whether the region of + each child window that intersects will also be invalidated. + Only children for which returns TRUE will have the area + invalidated.

+ @@ -420,11 +418,11 @@ http://www.freedesktop.org), but has a fallback implementation for other window managers. - A , the button being used to drag - A , root window X coordinate of mouse click that began the drag - A m root window Y coordinate of mouse click that began the drag - A , timestamp of mouse click that began the drag - + A , the button being used to drag + A , root window X coordinate of mouse click that began the drag + A m root window Y coordinate of mouse click that began the drag + A , timestamp of mouse click that began the drag + @@ -440,48 +438,51 @@ Indicates that you are beginning the process of redrawing @region. - A + A -

- A backing store (offscreen buffer) large enough to contain +

+ A backing store (offscreen buffer) large enough to contain will be created. The backing store will be initialized with the background color or background pixmap for this window. Then, all drawing operations performed on this window will be diverted to the - backing store. When you call , the backing + backing store. When you call , the backing store will be copied to this window, making it visible onscreen. Only - the part of this window contained in will be modified; that is, - drawing operations are clipped to . -

+ the part of this window contained in will be modified; that is, + drawing operations are clipped to . +

+

The net result of all this is to remove flicker, because the user sees the finished product appear all at once when you call - . If you draw to the window directly without - calling , the user may see flicker + . If you draw to the window directly without + calling , the user may see flicker as individual drawing operations are performed in sequence. The clipping and background-initializing features of - are conveniences for the + are conveniences for the programmer, so you can avoid doing that work yourself. -

+

+

When using GTK+, the widget system automatically places calls to - and around + and around emissions of the expose_event signal. That is, if you're writing an expose event handler, you can assume that the exposed area in #GdkEventExpose has already been cleared to the window background, is already set as the clip region, and already has a backing store. Therefore in most cases, application code need not call - . (You can disable the automatic + . (You can disable the automatic calls around expose events on a widget-by-widget basis by calling gtk_widget_set_double_buffered().) -

+

+

If you call this function multiple times before calling the - matching , the backing stores are pushed onto - a stack. copies the topmost backing store + matching , the backing stores are pushed onto + a stack. copies the topmost backing store onscreen, subtracts the topmost region from all other regions in the stack, and pops the stack. All drawing operations affect only the topmost backing store in the stack. One matching call to - is required for each call to - . + is required for each call to + .

- + @@ -498,13 +499,13 @@ - Like , but also generates an + Like , but also generates an expose event for the cleared area. - A , x coordinate of rectangle to clear - A , y coordinate of rectangle to clear - A , width of rectangle to clear - A , height of rectangle to clear + A , x coordinate of rectangle to clear + A , y coordinate of rectangle to clear + A , width of rectangle to clear + A , height of rectangle to clear This function has a stupid name because it dates back to the mists time, pre-GDK-1.0. @@ -519,8 +520,8 @@ - Reverse operation for . - + Reverse operation for . + @@ -535,9 +536,9 @@ To be added - A - A - + A + A + @@ -553,11 +554,11 @@ To be added - A - A - A - A - + A + A + A + A + @@ -573,10 +574,10 @@ To be added - A - A - A - + A + A + A + @@ -588,7 +589,7 @@ To be added - + @@ -600,7 +601,7 @@ To be added - + @@ -612,7 +613,7 @@ To be added - + @@ -626,8 +627,8 @@ "Pins" a window such that it's on all workspaces and does not scroll with viewports, for window managers that have scrollable viewports. - (When using , - may be more useful.) + (When using , + may be more useful.) On the X11 platform, this function depends on window manager @@ -671,13 +672,13 @@ A convenience wrapper around - which + which invalidates a rectangular region. See - for details. + for details. - A - A , whether to invalidate child windows - + A + A , whether to invalidate child windows + @@ -693,17 +694,17 @@ this function does nothing. -

On X11, asks the window manager to maximize the window, if the window +

On X11, asks the window manager to maximize the window, if the window manager supports this operation. Not all window managers support this, and some deliberately ignore it or don't have a concept of "maximized"; so you can't rely on the maximization actually happening. But it will happen with most standard window managers, and GDK makes a best effort to get it to happen. -

+

+

On Windows, reliably maximizes the window.

- - + @@ -719,27 +720,28 @@ Sets the background pixmap of this window. May also be used to set a background of - "None" on this window, by setting a background pixmap of . + "None" on this window, by setting a background pixmap of . A background pixmap will be tiled, positioning the first tile at the origin of - this window, or if is true, the tiling will be done based on the + this window, or if is true, the tiling will be done based on the origin of the parent window (useful to align tiles in a parent with tiles in a child). - A - A + A + A -

- A background pixmap of means that the window will have no +

+ A background pixmap of means that the window will have no background. A window with no background will never have its background filled by the windowing system, instead the window will contain whatever pixels were already in the corresponding area of the display. -

+

+

The windowing system will normally fill a window with its background when the window is obscured then exposed, or when you call - . + .

- + @@ -756,11 +758,11 @@ in a child). Clears an area of this window to the background color or background pixmap. - A , x coordinate of rectangle to clear - A , y coordinate of rectangle to clear - A , width of rectangle to clear - A , height of rectangle to clear - + A , x coordinate of rectangle to clear + A , y coordinate of rectangle to clear + A , width of rectangle to clear + A , height of rectangle to clear + @@ -774,12 +776,12 @@ in a child). Attempt to deiconify (unminimize) this window. On X11 the window manager may choose to ignore the request to deiconify. When using GTK+, - use instead of the variant. Or better yet, - you probably want to use , + use instead of the variant. Or better yet, + you probably want to use , which raises the window, focuses it, unminimizes it, and puts it on the current desktop. - + @@ -797,14 +799,14 @@ in a child). Sets the icon of this window as a pixmap or window. - A - A - A + A + A + A If using GTK+, investigate - first, and then - and . If those don't meet your needs, look at - . Only if all those are too high-level do you + first, and then + and . If those don't meet your needs, look at + . Only if all those are too high-level do you want to fall back to this method. @@ -821,8 +823,8 @@ in a child). For toplevel windows, withdraws them, so they will no longer be known to the window manager; for all windows, unmaps them, so they won't be displayed. Normally done automatically as - part of . - + part of . + @@ -837,7 +839,7 @@ in a child). Withdraws a window (unmaps it and asks the window manager to forget about it). - This function is not really useful as automatically + This function is not really useful as automatically withdraws toplevel windows before hiding them. @@ -854,26 +856,27 @@ in a child). "Decorations" are the features the window manager adds to a toplevel - . + . This function sets the traditional Motif window manager hints that tell the window manager which decorations you would like your window to have. - Usually you should use on a - instead of + Usually you should use on a + instead of using the GDK function directly. - A + A -

- The argument is the logical OR of the fields in - the enumeration. If is included in the +

+ The argument is the logical OR of the fields in + the enumeration. If is included in the mask, the other bits indicate which decorations should be turned off. - If is not included, then the other bits indicate + If is not included, then the other bits indicate which decorations should be turned on. -

+

+

Most window managers honor a decorations hint of 0 to disable all decorations, but very few honor all possible combinations of bits.

- + @@ -886,12 +889,12 @@ in a child). - Sends one or more expose events to the window. - A , whether to process updates for child windows + Sends one or more expose events to the window. + A , whether to process updates for child windows The areas in each expose event will cover the entire update area for the window (see - for details). - Normally GDK calls + for details). + Normally GDK calls on your behalf, so there's no need to call this function unless you want to force expose events to be delivered immediately and synchronously (vs. the usual @@ -909,17 +912,18 @@ in a child). -

Merges the shape masks for any child windows into the +

Merges the shape masks for any child windows into the shape mask for this window. i.e. the union of all masks for this window and its children will become the new mask - for this window. See . -

- This function is distinct from + for this window. See . +

+

+ This function is distinct from because it includes this window's shape mask in the set of shapes to be merged.

- - + + @@ -939,17 +943,17 @@ in a child). Begins a window resize operation (for a toplevel window). You might use this function to implement a "window resize grip," for - example; in fact uses it. The function works best + example; in fact uses it. The function works best with window managers that support the Extended Window Manager Hints spec (see http://www.freedesktop.org), but has a fallback implementation for other window managers. - A - A - A - A - A - + A + A + A + A + A + @@ -962,14 +966,14 @@ in a child). Indicates that the backing store created by the most recent call to - () should be copied onscreen and + () should be copied onscreen and deleted, leaving the next-most-recent backing store or no backing store at all as the active paint region. See - () for full details. + () for full details. It is an error to call this function without a matching - () first. + () first. @@ -984,12 +988,12 @@ in a child). - A convenience wrapper around () which + A convenience wrapper around () which creates a rectangular region for you. See - () for details. + () for details. - A - + A + @@ -1001,8 +1005,8 @@ in a child). - Shows a onscreen, but does not modify its stacking - order. In contrast, will raise the window + Shows a onscreen, but does not modify its stacking + order. In contrast, will raise the window to the top of the window stack. @@ -1023,9 +1027,9 @@ in a child). - Remove a filter previously added with . - A - + Remove a filter previously added with . + A + @@ -1037,7 +1041,7 @@ in a child). Clears the entire window to the background color or background pixmap. - + @@ -1051,11 +1055,11 @@ in a child). Sets keyboard focus to this window. If the window is not onscreen this - will not work. In most cases, + will not work. In most cases, should be used on - a , rather than calling this function. - A , timestamp of the event calling this method - + a , rather than calling this function. + A , timestamp of the event calling this method + @@ -1069,11 +1073,11 @@ in a child). Temporarily freezes a window such that it won't receive expose events. The window will begin receiving expose events again when - is called. If - has been called more than once, must be called + is called. If + has been called more than once, must be called an equal number of times to begin processing exposes. - + @@ -1085,7 +1089,7 @@ in a child). To be added - + @@ -1101,30 +1105,31 @@ in a child). -

Applies a shape mask to this window. +

Applies a shape mask to this window. Pixels in this window corresponding to - set bits in the will be visible; pixels in this window - corresponding to unset bits in the will be transparent. This + set bits in the will be visible; pixels in this window + corresponding to unset bits in the will be transparent. This gives a non-rectangular window.

-

If is , the shape +

If is , the shape mask will be unset, and the - / parameters are not + / parameters are not used.

- - A , a shape mask - A , X position of shape mask with respect to this window - A , Y position of shape mask with respect to this window + + A , a shape mask + A , X position of shape mask with respect to this window + A , Y position of shape mask with respect to this window -

+

On the X11 platform, this uses an X server extension which is widely available on most common platforms, but not available on very old X servers, and occasionally the implementation will be buggy. On servers without the shape extension, this function will do nothing. -

+

+

This function works on both toplevel and child windows.

- + @@ -1141,17 +1146,17 @@ in a child). Repositions a window relative to its parent window. - A - A + A + A -

For toplevel windows, window managers may ignore or modify the move; - you should probably use on a widget +

For toplevel windows, window managers may ignore or modify the move; + you should probably use on a widget anyway, instead of using GDK functions. For child windows, the move will reliably succeed.

-

If you're also planning to resize the window, use +

If you're also planning to resize the window, use to both move and resize simultaneously, for a nicer visual effect.

- + @@ -1168,10 +1173,10 @@ in a child). Obtains the bounding box of the window, including window manager titlebar/borders if any. The frame position is given in root window coordinates. To get the position of the window itself (rather than - the frame) in root window coordinates, use . + the frame) in root window coordinates, use . - A - + A + @@ -1213,11 +1218,29 @@ in a child). Basic constructor - A - A - A - A - + A + A + A + A + The type of the parameter in this auto-generated constructor is incorrect. You would normally want to use the overloaded constructor that takes a . + + + + + Constructor + + + + + + + + Basic constructor + a + a + a + a + @@ -1230,9 +1253,9 @@ in a child). For debugging use only. - A - A - + A + A + @@ -1245,9 +1268,9 @@ in a child). To be added - A - A - + A + A + @@ -1260,9 +1283,9 @@ in a child). To be added - A - A - + A + A + @@ -1275,9 +1298,9 @@ in a child). To be added - A - A - + A + A + @@ -1290,9 +1313,9 @@ in a child). To be added - A - A - + A + A + @@ -1303,8 +1326,8 @@ in a child). To be added - A - + A + @@ -1336,9 +1359,9 @@ in a child). To be added - A - A - + A + A + @@ -1351,9 +1374,9 @@ in a child). To be added - A - A - + A + A + @@ -1364,8 +1387,8 @@ in a child). To be added - A - + A + @@ -1376,8 +1399,8 @@ in a child). To be added - A - + A + @@ -1390,9 +1413,9 @@ in a child). To be added - A - A - + A + A + @@ -1405,9 +1428,9 @@ in a child). To be added - A - A - + A + A + @@ -1420,9 +1443,9 @@ in a child). To be added - A - A - + A + A + @@ -1433,8 +1456,8 @@ in a child). To be added - A - + A + @@ -1447,9 +1470,9 @@ in a child). To be added - A - A - + A + A + @@ -1463,7 +1486,7 @@ in a child). Sets the background color for the window. The color - A + A Sets the background color of window. (However, when using GTK+, set the background of a widget with - if you're an application - or - if you're implementing a custom widget. The color must be allocated; @@ -1478,8 +1501,8 @@ The color must be allocated; To be added - A - + A + @@ -1494,7 +1517,7 @@ The color must be allocated; To be added a a - + @@ -1509,7 +1532,7 @@ The color must be allocated; To be added a a - + @@ -1527,7 +1550,7 @@ The color must be allocated; a a a - + @@ -1545,7 +1568,7 @@ The color must be allocated; a a a - + @@ -1557,7 +1580,7 @@ The color must be allocated; To be added - + @@ -1569,7 +1592,7 @@ The color must be allocated; To be added - + @@ -1587,7 +1610,7 @@ The color must be allocated; a a a - + @@ -1606,7 +1629,7 @@ The color must be allocated; a a a - + @@ -1624,7 +1647,7 @@ The color must be allocated; a a a - + @@ -1649,7 +1672,7 @@ The color must be allocated; a a a - + @@ -1672,7 +1695,7 @@ The color must be allocated; a a a - + @@ -1689,7 +1712,7 @@ The color must be allocated; To be added a a - + @@ -1703,11 +1726,11 @@ The color must be allocated; - Returns the decorations set on the window with . + Returns the decorations set on the window with . a to put the decorations in a , true if the window has decorations set, false otherwise. - + @@ -1724,7 +1747,7 @@ The color must be allocated; To be added a a - + @@ -1737,7 +1760,7 @@ The color must be allocated; To be added a - + @@ -1750,7 +1773,7 @@ The color must be allocated; To be added a - + @@ -1777,7 +1800,7 @@ The color must be allocated; To be added a - + @@ -1802,7 +1825,7 @@ The color must be allocated; To be added a - + @@ -1817,7 +1840,7 @@ The color must be allocated; To be added a - + @@ -1834,7 +1857,7 @@ The color must be allocated; To be added a a - + @@ -1847,8 +1870,8 @@ The color must be allocated; To be added a - + - + \ No newline at end of file diff --git a/doc/en/Gtk/Style.xml b/doc/en/Gtk/Style.xml index 1722b8921..8185c5b53 100644 --- a/doc/en/Gtk/Style.xml +++ b/doc/en/Gtk/Style.xml @@ -1,13 +1,7 @@ : - gtk-sharp - - - 0.0.0.0 - neutral - - + gtk-sharp0.0.0.0neutral Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. Methods for drawing widget parts. @@ -38,9 +32,9 @@ Gets the foreground color for a particular state - A , the state being considered - A - + A , the state being considered + A + @@ -54,7 +48,7 @@ Sets the background of to the background color or pixmap specified by style for the state. - A , the state being considered + A , the state being considered A color to be used for the background. @@ -70,10 +64,10 @@ - Gets the graphics context for the background of . - a - a , the graphics context - + Gets the graphics context for the background of . + a + a , the graphics context + @@ -86,10 +80,10 @@ - Gets the graphics context for the foreground of . - a - a , the graphics context - + Gets the graphics context for the foreground of . + a + a , the graphics context + @@ -110,14 +104,14 @@ Sets the default background. - A - A (TODO: explain) - A - A - A , X coordinate of the upper left corner - A , Y coordinate of the upper left corner - A , width of the area - A , height of the area + A + A (TODO: explain) + A + A + A , X coordinate of the upper left corner + A , Y coordinate of the upper left corner + A , width of the area + A , height of the area TODO: explain this, as the underlying GTK+ isn't very well-commented either @@ -132,11 +126,11 @@ - Set the background of to the -color or pixmap specified by this style for . - A - A - + Set the background of to the +color or pixmap specified by this style for . + A + A + @@ -148,7 +142,7 @@ color or pixmap specified by this style for . Detaches this style from the window it's attached to. - + @@ -166,14 +160,14 @@ color or pixmap specified by this style for . - Renders the icon specified by at the given according to the given parameters and returns the result in a pixbuf. - A - A - A - A - A - A - A + Renders the icon specified by at the given according to the given parameters and returns the result in a pixbuf. + A + A + A + A + A + A + A TODO: needs an example. @@ -200,10 +194,10 @@ color or pixmap specified by this style for . - Gets the icon set for the given . - A - A - + Gets the icon set for the given . + A + A + @@ -284,9 +278,9 @@ color or pixmap specified by this style for . The Y thickness, which is used for vertical padding. - A - A - + A + A + @@ -312,8 +306,8 @@ color or pixmap specified by this style for . The foreground colors - A - + A + @@ -324,8 +318,8 @@ color or pixmap specified by this style for . The background colors. - A - + A + @@ -336,8 +330,8 @@ color or pixmap specified by this style for . Black. - A - + A + @@ -348,8 +342,8 @@ color or pixmap specified by this style for . White. - A - + A + @@ -360,8 +354,8 @@ color or pixmap specified by this style for . Gets the graphics context objects for the background. - A - + A + @@ -372,8 +366,8 @@ color or pixmap specified by this style for . Gets the graphics context objects for the foreground. - A - + A + @@ -384,8 +378,8 @@ color or pixmap specified by this style for . Gets a white graphics context. - A - + A + @@ -396,8 +390,8 @@ color or pixmap specified by this style for . Gets a black graphics context. - A - + A + @@ -414,7 +408,7 @@ color or pixmap specified by this style for . Sets the graphics context for the foreground. a , the state of the widget to set the style for a - + @@ -431,7 +425,7 @@ color or pixmap specified by this style for . Sets the graphics context for the background. a , the state of the widget to set the style for a - + @@ -445,9 +439,9 @@ color or pixmap specified by this style for . Returns the base graphics context for the widget. - a , the state of the widget to get the style for + a , the state of the widget to get the GC for a - + @@ -462,9 +456,9 @@ color or pixmap specified by this style for . Sets the graphics context for the background. - a , the state of the widget to set the style for + a , the state of the widget to set the GC for a - + @@ -478,9 +472,9 @@ color or pixmap specified by this style for . Returns the graphics context for the widget's text. - a , the state of the widget to get the style for + a , the state of the widget to get the GC for a - + @@ -495,9 +489,9 @@ color or pixmap specified by this style for . Sets the graphics context for text. - a , the state of the widget to set the style for + a , the state of the widget to set the GC for a - + @@ -532,7 +526,7 @@ color or pixmap specified by this style for . a a a - + @@ -555,7 +549,7 @@ color or pixmap specified by this style for . - Draws a check button indicator in the given rectangle on with the given parameters. + Draws a check button indicator in the given rectangle on with the given parameters. a a a @@ -567,7 +561,7 @@ color or pixmap specified by this style for . a a a - + @@ -602,7 +596,7 @@ color or pixmap specified by this style for . a a a - + @@ -635,7 +629,7 @@ color or pixmap specified by this style for . a a a - + @@ -671,7 +665,7 @@ color or pixmap specified by this style for . a a a - + @@ -708,7 +702,7 @@ color or pixmap specified by this style for . a a a - + @@ -731,7 +725,7 @@ color or pixmap specified by this style for . - Draws a diamond in the given rectangle on using the given parameters. + Draws a diamond in the given rectangle on using the given parameters. a a a @@ -743,7 +737,7 @@ color or pixmap specified by this style for . a a a - + @@ -766,7 +760,7 @@ color or pixmap specified by this style for . - Draws a shadow around the given rectangle in using the given style and state and shadow type. + Draws a shadow around the given rectangle in using the given style and state and shadow type. a a a @@ -778,7 +772,7 @@ color or pixmap specified by this style for . a a a - + @@ -799,7 +793,7 @@ color or pixmap specified by this style for . - Draws a vertical line from (, ) to (, ) in using the given style and state. + Draws a vertical line from (, ) to (, ) in using the given style and state. a a a @@ -809,7 +803,7 @@ color or pixmap specified by this style for . a a a - + @@ -845,7 +839,7 @@ color or pixmap specified by this style for . a a a - + @@ -867,7 +861,7 @@ color or pixmap specified by this style for . - Draws a focus indicator around the given rectangle on using the given style. + Draws a focus indicator around the given rectangle on using the given style. a a a @@ -878,7 +872,7 @@ color or pixmap specified by this style for . a a a - + @@ -919,7 +913,7 @@ color or pixmap specified by this style for . a a a - + @@ -956,7 +950,7 @@ color or pixmap specified by this style for . a a a - + @@ -979,7 +973,7 @@ color or pixmap specified by this style for . - Draws a flat box on with the given parameters. + Draws a flat box on with the given parameters. a a a @@ -991,7 +985,7 @@ color or pixmap specified by this style for . a a a - + @@ -1028,7 +1022,7 @@ color or pixmap specified by this style for . a a a - + @@ -1053,7 +1047,7 @@ color or pixmap specified by this style for . - Draw an arrow at (, ) using the given parameters. + Draw an arrow at (, ) using the given parameters. a a a @@ -1067,7 +1061,7 @@ color or pixmap specified by this style for . a a a - + @@ -1088,7 +1082,7 @@ color or pixmap specified by this style for . - Draws a horizontal line from (, ) to (, ) in using the given style and state. + Draws a horizontal line from (, ) to (, ) in using the given style and state. a a a @@ -1098,7 +1092,7 @@ color or pixmap specified by this style for . a a a - + @@ -1139,7 +1133,7 @@ color or pixmap specified by this style for . a a a - + @@ -1179,7 +1173,7 @@ color or pixmap specified by this style for . The colors to use for text. a - + @@ -1192,7 +1186,7 @@ color or pixmap specified by this style for . The base color set. a - + @@ -1208,7 +1202,7 @@ color or pixmap specified by this style for . Returns the color for text in the given state. a a - + @@ -1224,7 +1218,7 @@ color or pixmap specified by this style for . Returns the base color for the given state. a a - + @@ -1291,5 +1285,137 @@ color or pixmap specified by this style for . + + + Method + + Gdk.GC + + + + + + Returns the graphics context for anti-aliased text. + a , the state of the widget to get the GC for + a + + + + + + Method + + System.Void + + + + + + + Set the graphics context for anti-aliased text. + a , the state of the widget to set the GC for + a + + + + + + Method + + Gdk.GC + + + + + + Returns a graphics context for light-colored drawing + a , the state of the widget to get the GC for + a + + + + + + Method + + System.Void + + + + + + + Set the graphics context for light-colored drawing + a , the state of the widget to set the GC for + a + + + + + + Method + + Gdk.GC + + + + + + Returns a graphics context for dark-colored drawing + a , the state of the widget to get the GC for + a + + + + + + Method + + System.Void + + + + + + + Set the graphics context for dark-colored drawing + a , the state of the widget to set the GC for + a + + + + + + Method + + Gdk.GC + + + + + + Returns a graphics context for medium-colored drawing + a , the state of the widget to get the GC for + a + + + + + + Method + + System.Void + + + + + + + Set the graphics context for medium-colored drawing + a , the state of the widget to set the GC for + a + + + - + \ No newline at end of file diff --git a/doc/en/Gtk/TargetList.xml b/doc/en/Gtk/TargetList.xml index a227c7abb..2d807e1fb 100644 --- a/doc/en/Gtk/TargetList.xml +++ b/doc/en/Gtk/TargetList.xml @@ -1,5 +1,5 @@ - + gtk-sharp @@ -10,71 +10,66 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - A list of potential targets for a drag-and-drop operation. - + A list of potential targets for a paste or drag-and-drop operation. + - System.ValueType + Glib.Opaque - - - Field - - Gtk.TargetList - + + + Constructor + - To be added - + Basic constructor + an empty + - - - Method - - Gtk.TargetList - + + + Constructor + - - + - To be added - To be added: an object of type 'Gtk.TargetEntry' - To be added: an object of type 'uint' - To be added: an object of type 'Gtk.TargetList' - + Constructor + an array of + a initialized from + - - - Method - - Gtk.TargetList - + + + Constructor + - To be added - To be added: an object of type 'IntPtr' - To be added: an object of type 'Gtk.TargetList' - + Internal constructor + a + a wrapping + + This is an internal constructor, and should not be used by user code. + - - + + Method System.Void - To be added - + Disposes the resources associated with the object. + @@ -89,26 +84,33 @@ - To be added - To be added: an object of type 'Gdk.Atom' - To be added: an object of type 'uint' - To be added: an object of type 'uint' - + Add a target type to the target list + the target type, as a + target flags (for a drag-and-drop target, this is a value) + application-defined ID for this target type + - - + + Method System.Void - + + + + + - To be added - + Add a target type to the target list + the target type, as a string + target flags (for a drag-and-drop target, this is a value) + application-defined ID for this target type + - + Method @@ -119,25 +121,25 @@ - To be added - To be added: an object of type 'Gtk.TargetEntry' - To be added: an object of type 'uint' - + Add an entry to the target list + a + the "length" of . Must be 1. + This auto-generated method is incorrect, and exists only for backward-compatibility. Use the overloaded version instead. - - + + Method System.Void - + - To be added - To be added: an object of type 'Gdk.Atom' - + Add entries to the target list + an array of + @@ -151,25 +153,62 @@ - To be added - a - a - a - + Find a given target type + the target type to find, as a + on output, will contain the target's application-defined ID + + if the target was found + - - - Field + + + Method - System.UInt32 + System.Boolean + + - To be added - + Find a given target type + the target type to find, as a string + on output, will contain the target's application-defined ID + + if the target was found + + + + + + Method + + System.Void + + + + + + Remove an entry from the target list + the target to remove, as a + + + + + + Method + + System.Void + + + + + + Remove an entry from the target list + the target to remove, as a string + - + \ No newline at end of file