diff --git a/ChangeLog b/ChangeLog index 73ee8c23f7..4f5070bfdc 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2001-12-28 Matthias Clasen + + * gdk/x11/gdkproperty-x11.c, gdk/x11/gdkselection-x11.c: + Minor documentation tweaks. + 2001-12-28 Tor Lillqvist * gdk/win32/gdkfont-win32.c: Use G_N_ELEMENTS(). diff --git a/ChangeLog.pre-2-0 b/ChangeLog.pre-2-0 index 73ee8c23f7..4f5070bfdc 100644 --- a/ChangeLog.pre-2-0 +++ b/ChangeLog.pre-2-0 @@ -1,3 +1,8 @@ +2001-12-28 Matthias Clasen + + * gdk/x11/gdkproperty-x11.c, gdk/x11/gdkselection-x11.c: + Minor documentation tweaks. + 2001-12-28 Tor Lillqvist * gdk/win32/gdkfont-win32.c: Use G_N_ELEMENTS(). diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10 index 73ee8c23f7..4f5070bfdc 100644 --- a/ChangeLog.pre-2-10 +++ b/ChangeLog.pre-2-10 @@ -1,3 +1,8 @@ +2001-12-28 Matthias Clasen + + * gdk/x11/gdkproperty-x11.c, gdk/x11/gdkselection-x11.c: + Minor documentation tweaks. + 2001-12-28 Tor Lillqvist * gdk/win32/gdkfont-win32.c: Use G_N_ELEMENTS(). diff --git a/ChangeLog.pre-2-2 b/ChangeLog.pre-2-2 index 73ee8c23f7..4f5070bfdc 100644 --- a/ChangeLog.pre-2-2 +++ b/ChangeLog.pre-2-2 @@ -1,3 +1,8 @@ +2001-12-28 Matthias Clasen + + * gdk/x11/gdkproperty-x11.c, gdk/x11/gdkselection-x11.c: + Minor documentation tweaks. + 2001-12-28 Tor Lillqvist * gdk/win32/gdkfont-win32.c: Use G_N_ELEMENTS(). diff --git a/ChangeLog.pre-2-4 b/ChangeLog.pre-2-4 index 73ee8c23f7..4f5070bfdc 100644 --- a/ChangeLog.pre-2-4 +++ b/ChangeLog.pre-2-4 @@ -1,3 +1,8 @@ +2001-12-28 Matthias Clasen + + * gdk/x11/gdkproperty-x11.c, gdk/x11/gdkselection-x11.c: + Minor documentation tweaks. + 2001-12-28 Tor Lillqvist * gdk/win32/gdkfont-win32.c: Use G_N_ELEMENTS(). diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6 index 73ee8c23f7..4f5070bfdc 100644 --- a/ChangeLog.pre-2-6 +++ b/ChangeLog.pre-2-6 @@ -1,3 +1,8 @@ +2001-12-28 Matthias Clasen + + * gdk/x11/gdkproperty-x11.c, gdk/x11/gdkselection-x11.c: + Minor documentation tweaks. + 2001-12-28 Tor Lillqvist * gdk/win32/gdkfont-win32.c: Use G_N_ELEMENTS(). diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8 index 73ee8c23f7..4f5070bfdc 100644 --- a/ChangeLog.pre-2-8 +++ b/ChangeLog.pre-2-8 @@ -1,3 +1,8 @@ +2001-12-28 Matthias Clasen + + * gdk/x11/gdkproperty-x11.c, gdk/x11/gdkselection-x11.c: + Minor documentation tweaks. + 2001-12-28 Tor Lillqvist * gdk/win32/gdkfont-win32.c: Use G_N_ELEMENTS(). diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 8bf85204e7..815deab4aa 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,4 +1,19 @@ +2001-12-28 Matthias Clasen + + * gdk/tmpl/properties.sgml, gdk/tmpl/selections.sgml: Additions. + +2001-12-23 Matthias Clasen + + * gdk-pixbuf/porting-from-imlib.sgml: GDK instead of Gdk. + + * gdk-pixbuf/tmpl/gdk-pixbuf-xlib-init.sgml: Replace references to + deprecated functions. + + * gdk/tmpl/event_structs.sgml, gdk/tmpl/gcs.sgml, + gdk/tmpl/images.sgml: Replace references to deprecated functions. + 2001-12-28 Vitaly Tishkov + * gtkwindow.sgml: additional fix for #59314 ('' is changed to '' in docs for gtk_window_set_policy ()) diff --git a/docs/reference/gdk-pixbuf/porting-from-imlib.sgml b/docs/reference/gdk-pixbuf/porting-from-imlib.sgml index a87c26a294..c390153335 100644 --- a/docs/reference/gdk-pixbuf/porting-from-imlib.sgml +++ b/docs/reference/gdk-pixbuf/porting-from-imlib.sgml @@ -139,7 +139,7 @@ The &gdk-pixbuf; library has the policy of always rendering - pixbufs to Gdk drawables you provide; it will not create + pixbufs to GDK drawables you provide; it will not create them for you. This is in general more flexible than &Imlib;'s policy of always creating a pixmap and making you use that instead. diff --git a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-xlib-init.sgml b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-xlib-init.sgml index 28f2e6a538..376afeaa37 100644 --- a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-xlib-init.sgml +++ b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-xlib-init.sgml @@ -12,9 +12,7 @@ Initializing the &gdk-pixbuf; Xlib library. functions in this section are used to initialize the &gdk-pixbuf; Xlib library. This library must be initialized near the beginning of the program or before calling any of the other &gdk-pixbuf; - Xlib functions; it cannot be initialized automatically since - Xlib-only applications do not call gdk_rgb_init() like GNOME - applications do. + Xlib functions. diff --git a/docs/reference/gdk/tmpl/event_structs.sgml b/docs/reference/gdk/tmpl/event_structs.sgml index c9f18cb713..09b24f6605 100644 --- a/docs/reference/gdk/tmpl/event_structs.sgml +++ b/docs/reference/gdk/tmpl/event_structs.sgml @@ -364,7 +364,7 @@ union, 16-bit data uses the s array, and 32-bit data uses the l array. -Generated when the area of a #GdkDrawable being copied, with gdk_draw_pixmap() +Generated when the area of a #GdkDrawable being copied, with gdk_draw_drawable() or gdk_window_copy_area(), was completely available. diff --git a/docs/reference/gdk/tmpl/gcs.sgml b/docs/reference/gdk/tmpl/gcs.sgml index aca26cda0c..4d8c8780a2 100644 --- a/docs/reference/gdk/tmpl/gcs.sgml +++ b/docs/reference/gdk/tmpl/gcs.sgml @@ -379,7 +379,7 @@ windows of that window. 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_draw_pixmap()). +drawable. (See gdk_draw_drawable()). @gc: a #GdkGC. diff --git a/docs/reference/gdk/tmpl/images.sgml b/docs/reference/gdk/tmpl/images.sgml index 6f0cacff4e..bf71e94cd8 100644 --- a/docs/reference/gdk/tmpl/images.sgml +++ b/docs/reference/gdk/tmpl/images.sgml @@ -13,7 +13,7 @@ It has now been superceded to a large extent by the much more flexible To create an empty #GdkImage use gdk_image_new(). To create a #GdkImage from bitmap data use gdk_image_new_bitmap(). -To create an image from part of a #GdkWindow use gdk_image_get(). +To create an image from part of a #GdkWindow use gdk_drawable_get_image(). The image can be manipulated with gdk_image_get_pixel() and diff --git a/docs/reference/gdk/tmpl/properties.sgml b/docs/reference/gdk/tmpl/properties.sgml index fdefc57df2..292ae857e7 100644 --- a/docs/reference/gdk/tmpl/properties.sgml +++ b/docs/reference/gdk/tmpl/properties.sgml @@ -20,7 +20,7 @@ using an atom. A property has an associated format, an integer describing how many bits are in each unit of data inside the property. It must be 8, 16, or 32. -When data is transfered between the server and client, +When data is transferred between the server and client, if they are of different endianesses it will be byteswapped as necessary according to the format of the property. Note that on the client side, properties of format 32 @@ -44,25 +44,26 @@ data commonly stored in X window properties. -A numeric type representing a string as an index into a table +An opaque type representing a string as an index into a table of strings on the X server. - +Converts a #GdkAtom into a pointer type. -@atom: +@atom: a #GdkAtom. - +Extracts a #GdkAtom from a pointer. The #GdkAtom must have been +stored in the pointer with GDK_ATOM_TO_POINTER(). -@ptr: +@ptr: a pointer containing a #GdkAtom. @@ -75,10 +76,10 @@ in the Xlib API. -Convert a text string from the encoding as it is stored in +Converts a text string from the encoding as it is stored in a property into an array of strings in the encoding of the current local. (The elements of the array represent -the null-separated elements of the original text string.) +the nul-separated elements of the original text string.) @encoding: an atom representing the encoding. The most common @@ -87,7 +88,7 @@ the null-separated elements of the original text string.) value used as the type for the property. @format: the format of the property. @text: the text data. -@length: the length of the property, in item.s +@length: the length of the property, in items. @list: location to store a terminated array of strings in the encoding of the current locale. This array should be freed using gdk_free_text_list(). @@ -97,7 +98,7 @@ the null-separated elements of the original text string.) -Free the array of strings created by +Frees the array of strings created by gdk_text_property_to_text_list(). @@ -120,11 +121,11 @@ gdk_text_property_to_text_list(). -Convert a string from the encoding of the current locale +Converts a string from the encoding of the current locale into a form suitable for storing in a window property. -@str: a null-terminated string. +@str: a nul-terminated string. @encoding: location to store the encoding atom (to be used as the type for the property). @format: location to store the format for the property. @ctext: location to store newly allocated data for the property. @@ -134,7 +135,7 @@ into a form suitable for storing in a window property. -Free the data returned from gdk_string_to_compound_text(). +Frees the data returned from gdk_string_to_compound_text(). @ctext: The pointer stored in @ctext from a call to gdk_string_to_compound_text(). @@ -164,24 +165,24 @@ Free the data returned from gdk_string_to_compound_text(). -Find or create an atom corresponding to a given string. +Finds or creates an atom corresponding to a given string. @atom_name: a string. @only_if_exists: if %TRUE, do not create a new atom, but just return the atom if it already exists. @Returns: the atom corresponding to @atom_name, or, if - @only_if_exists is TRUE, and an atom does not + @only_if_exists is %TRUE, and an atom does not already exists for the string, %GDK_NONE. -Determine the string corresponding to an atom. +Determines the string corresponding to an atom. @atom: a #GdkAtom. -@Returns: a newly allocated string containing the string +@Returns: a newly-allocated string containing the string corresponding to @atom. When you are done with the return value, you should free it using g_free(). @@ -190,10 +191,12 @@ Determine the string corresponding to an atom. Retrieves a portion of the contents of a property. If the -property does not exist, then the function returns FALSE, +property does not exist, then the function returns %FALSE, and %GDK_NONE will be stored in @actual_property_type. - -Note: the XGetWindowProperty() + + + +The XGetWindowProperty() function that gdk_property_get() uses has a very confusing and complicated set of semantics. Unfortunately, gdk_property_get() makes the situation @@ -204,6 +207,7 @@ should return a useful error to the program. You are advised to use directly until a replacement function for gdk_property_get() is provided. + @window: a #GdkWindow. @property: the property to retrieve. @@ -234,7 +238,7 @@ is provided. -Change the contents of a property on a window. +Changes the contents of a property on a window. @window: a #GdkWindow. @@ -268,7 +272,7 @@ using gdk_property_change(). -Delete a property from a window. +Deletes a property from a window. @window: a #GdkWindow. diff --git a/docs/reference/gdk/tmpl/selections.sgml b/docs/reference/gdk/tmpl/selections.sgml index abf7dee937..118fe8971f 100644 --- a/docs/reference/gdk/tmpl/selections.sgml +++ b/docs/reference/gdk/tmpl/selections.sgml @@ -79,122 +79,122 @@ compatibility with older programs. - +A #GdkAtom representing the PRIMARY selection. - +A #GdkAtom representing the SECONDARY selection. - +A #GdkAtom representing the CLIPBOARD selection. - +A #GdkAtom representing the BITMAP selection target. - +A #GdkAtom representing the COLORMAP selection target. - +A #GdkAtom representing the DRAWABLE selection target. - +A #GdkAtom representing the PIXMAP selection target. - +A #GdkAtom representing the STRING selection target. - +A #GdkAtom representing the ATOM selection type. - +A #GdkAtom representing the BITMAP selection type. - +A #GdkAtom representing the COLORMAP selection type. - +A #GdkAtom representing the DRAWABLE selection type. - +A #GdkAtom representing the INTEGER selection type. - +A #GdkAtom representing the PIXMAP selection type. - +A #GdkAtom representing the WINDOW selection type. - +A #GdkAtom representing the STRING selection type. -Set the owner of the given selection. +Sets the owner of the given selection. -@owner: a #GdkWindow or NULL to indicate that the +@owner: a #GdkWindow or %NULL to indicate that the the owner for the given should be unset. @selection: an atom identifying a selection. @time: timestamp to use when setting the selection. @@ -210,14 +210,14 @@ Set the owner of the given selection. -Determine the owner of the given selection. +Determines the owner of the given selection. @selection: an atom indentifying a selection. @Returns: if there is a selection owner for this window, and it is a window known to the current process, the #GdkWindow that owns the selection, otherwise - NULL. Note that the return value may be owned + %NULL. Note that the return value may be owned by a different process if a foreign window was previously created for that window, but a new foreign window will never be created by @@ -226,7 +226,7 @@ Determine the owner of the given selection. -Retrieve the contents of a selection in a given +Retrieves the contents of a selection in a given form. @@ -242,18 +242,18 @@ form. -Retrieve selection data that was stored by the selection -data in response to a call to gdk_selection_convert() +Retrieves selection data that was stored by the selection +data in response to a call to gdk_selection_convert(). @requestor: the window on which the data is stored @data: location to store a pointer to the retrieved data. - If the retrieval failed, NULL we be stored here, otherwise, it - will be non-NULL and the returned data should be freed with g_free() + If the retrieval failed, %NULL we be stored here, otherwise, it + will be non-%NULL and the returned data should be freed with g_free() when you are finished using it. The length of the allocated memory is one more than the the length of the returned data, and the final byte will always - be zero, to ensure null-termination of strings. + be zero, to ensure nul-termination of strings. @prop_type: location to store the type of the property. @prop_format: location to store the format of the property. @Returns: the length of the retrieved data. @@ -261,7 +261,7 @@ data in response to a call to gdk_selection_convert() -Send a response to SelectionRequest event. +Sends a response to SelectionRequest event. @requestor: window to which to deliver response. diff --git a/gdk/x11/gdkproperty-x11.c b/gdk/x11/gdkproperty-x11.c index 9a0f8e7c5c..f7e315b707 100644 --- a/gdk/x11/gdkproperty-x11.c +++ b/gdk/x11/gdkproperty-x11.c @@ -139,8 +139,8 @@ insert_atom_pair (GdkAtom virtual_atom, * gdk_x11_atom_to_xatom: * @atom: A #GdkAtom * - * Convert from a #GdkAtom to the X atom for the default GDK display - * with the same string value.x + * Converts from a #GdkAtom to the X atom for the default GDK display + * with the same string value. * * Return value: the X atom corresponding to @atom. **/ @@ -174,10 +174,10 @@ gdk_x11_atom_to_xatom (GdkAtom atom) * gdk_x11_xatom_to_atom: * @xatom: an X atom for the default GDK display * - * Convert from an X atom for the default display to the corresponding + * Converts from an X atom for the default display to the corresponding * #GdkAtom. * - * Return value: the corresponding G#dkAtom. + * Return value: the corresponding #GdkAtom. **/ GdkAtom gdk_x11_xatom_to_atom (Atom xatom) @@ -280,7 +280,8 @@ gdk_atom_name (GdkAtom atom) * * Returns the X atom for GDK's default display corresponding to @atom_name. * This function caches the result, so if called repeatedly it is much - * faster than XInternAtom, which is a round trip to the server each time. + * faster than XInternAtom(), which is a round trip to + * the server each time. * * Return value: a X atom for GDK's default display. **/ @@ -296,9 +297,9 @@ gdk_x11_get_xatom_by_name (const gchar *atom_name) * * Returns the name of an X atom for GDK's default display. This * function is meant mainly for debugging, so for convenience, unlike - * XAtomName() and gdk_atom_name(), the result doesn't need to - * be freed. Also, this function will never return %NULL, even - * if @xatom is invalid. + * XAtomName() and gdk_atom_name(), the result + * doesn't need to be freed. Also, this function will never return %NULL, + * even if @xatom is invalid. * * Return value: name of the X atom; this string is owned by GTK+, * so it shouldn't be modifed or freed. diff --git a/gdk/x11/gdkselection-x11.c b/gdk/x11/gdkselection-x11.c index e48d1f36a2..4cadfb63cf 100644 --- a/gdk/x11/gdkselection-x11.c +++ b/gdk/x11/gdkselection-x11.c @@ -408,7 +408,7 @@ make_list (const gchar *text, * @list: location to store the list of strings or %NULL. The * list should be freed with g_strfreev(). * - * Convert a text property in the giving encoding to + * Converts a text property in the giving encoding to * a list of UTF-8 strings. * * Return value: the number of strings in the resulting @@ -570,12 +570,12 @@ sanitize_utf8 (const gchar *src) * gdk_utf8_to_string_target: * @str: a UTF-8 string * - * Convert an UTF-8 string into the best possible representation + * Converts an UTF-8 string into the best possible representation * as a STRING. The representation of characters not in STRING * is not specified; it may be as pseudo-escape sequences * \x{ABCD}, or it may be in some other form of approximation. * - * Return value: the newly allocated string, or %NULL if the + * Return value: the newly-allocated string, or %NULL if the * conversion failed. (It should not fail for * any properly formed UTF-8 string.) **/ @@ -608,10 +608,10 @@ gdk_utf8_to_string_target (const gchar *str) * @length: location to store the length of the data * stored in @ctext * - * Convert from UTF-8 to compound text. + * Converts from UTF-8 to compound text. * * Return value: %TRUE if the conversion succeeded, otherwise - * false. + * %FALSE. **/ gboolean gdk_utf8_to_compound_text (const gchar *str,