Make 3.0 parallel-installable to 2.x

[~andy/gtk] / docs / reference / gdk / tmpl / pixmaps.sgml

diff --git a/docs/reference/gdk/tmpl/pixmaps.sgml b/docs/reference/gdk/tmpl/pixmaps.sgml
index 8c9d798646e9fbd85e0b9195718b131e5545151d..333a2b348c575643e94d1bc6792ac247d800c62f 100644 (file)
--- a/docs/reference/gdk/tmpl/pixmaps.sgml
+++ b/docs/reference/gdk/tmpl/pixmaps.sgml
@@ -2,7 +2,7 @@
 Bitmaps and Pixmaps
 
 <!-- ##### SECTION Short_Description ##### -->
-Offscreen drawables.
+Offscreen drawables
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
@@ -18,6 +18,12 @@ pixel can be either on or off).
 <para>
 </para>
 
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### SECTION Image ##### -->
+
+
 <!-- ##### STRUCT GdkPixmap ##### -->
 <para>
 An opaque structure representing an offscreen drawable.
@@ -27,21 +33,20 @@ The type #GdkDrawable refers generically to any of
 these types.
 </para>
 
-@user_data: 
 
 <!-- ##### FUNCTION gdk_pixmap_new ##### -->
 <para>
 Create a new pixmap with a given size and depth.
 </para>
 
-@window: a #GdkWindow, used to determine default values for the
-  new pixmap. Can be %NULL if @depth is specified,
+@drawable: A #GdkDrawable, used to determine default values
+for the new pixmap. Can be %NULL if @depth is specified,
 @width: The width of the new pixmap in pixels.
 @height: The height of the new pixmap in pixels.
 @depth: The depth (number of bits per pixel) of the new pixmap. 
-  If -1, and @window is not %NULL, the depth of the new
-  pixmap will be equal to that of @window.
-@Returns: the #GdkBitmap
+  If -1, and @drawable is not %NULL, the depth of the new
+  pixmap will be equal to that of @drawable.
+@Returns: the #GdkPixmap
 
 
 <!-- ##### FUNCTION gdk_bitmap_create_from_data ##### -->
@@ -49,9 +54,9 @@ Create a new pixmap with a given size and depth.
 Creates a new bitmap from data in XBM format.
 </para>
 
-@window: a #GdkWindow, used to determine default values for the
-  new pixmap. Can be %NULL, in which case the root window is
-  used.
+@drawable: a #GdkDrawable, used to determine default values
+for the new pixmap. Can be %NULL, in which case the root
+window is used.
 @data: a pointer to the XBM data.
 @width: the width of the new pixmap in pixels.
 @height: the height of the new pixmap in pixels.
@@ -63,8 +68,8 @@ Creates a new bitmap from data in XBM format.
 Create a two-color pixmap from data in XBM data.
 </para>
 
-@window: a #GdkWindow, used to determine default values for the
-  new pixmap. Can be %NULL, if the depth is given.
+@drawable: a #GdkDrawable, used to determine default values
+for the new pixmap. Can be %NULL, if the depth is given.
 @data: a pointer to the data.
 @width: the width of the new pixmap in pixels.
 @height: the height of the new pixmap in pixels.
@@ -75,126 +80,53 @@ Create a two-color pixmap from data in XBM data.
 
 
 <!-- ##### FUNCTION gdk_pixmap_create_from_xpm ##### -->
-<para>
-Create a pixmap from a XPM file.
-</para>
 
-@window: a #GdkWindow, used to determine default values for the
-  new pixmap.
-@mask: a pointer to a place to store a bitmap representing
-the transparency mask of the XPM file. Can be %NULL,
-in which case transparency will be ignored.
-@transparent_color: the color to be used for the pixels
-that are transparent in the input file. Can be %NULL,
-in which case a default color will be used.
-@filename: the filename of a file containing XPM data.
-@Returns: the #GdkPixmap
+
+@drawable: 
+@mask: 
+@transparent_color: 
+@filename: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gdk_pixmap_colormap_create_from_xpm ##### -->
-<para>
-Create a pixmap from a XPM file using a particular colormap.
-</para>
 
-@window: a #GdkWindow, used to determine default values for the
-  new pixmap. Can be %NULL if @colormap is given.
-@colormap: the #GdkColormap that the new pixmap will be use.
-  If omitted, the colormap for @window will be used.
-@mask: a pointer to a place to store a bitmap representing
-the transparency mask of the XPM file. Can be %NULL,
-in which case transparency will be ignored.
-@transparent_color: the color to be used for the pixels
-that are transparent in the input file. Can be %NULL,
-in which case a default color will be used.
-@filename: the filename of a file containing XPM data.
-@Returns: the #GdkPixmap.
 
+@drawable: 
+@colormap: 
+@mask: 
+@transparent_color: 
+@filename: 
+@Returns: 
 
-<!-- ##### FUNCTION gdk_pixmap_create_from_xpm_d ##### -->
-<para>
-Create a pixmap from data in XPM format.
-</para>
 
-@window: a #GdkWindow, used to determine default values for the
-  new pixmap.
-@mask: Pointer to a place to store a bitmap representing
-the transparency mask of the XPM file. Can be %NULL,
-in which case transparency will be ignored.
-@transparent_color: This color will be used for the pixels
-that are transparent in the input file. Can be %NULL
-in which case a default color will be used.
-@data: Pointer to a string containing the XPM data.
-@Returns: the #GdkPixmap
+<!-- ##### FUNCTION gdk_pixmap_create_from_xpm_d ##### -->
 
 
-<!-- ##### FUNCTION gdk_pixmap_colormap_create_from_xpm_d ##### -->
-<para>
-Create a pixmap from data in XPM format using a particular
-colormap.
-</para>
-
-@window: a #GdkWindow, used to determine default values for the
-  new pixmap. Can be %NULL if @colormap is given.
-@colormap: the #GdkColormap that the new pixmap will be use.
-  If omitted, the colormap for @window will be used.
-@mask: a pointer to a place to store a bitmap representing
-the transparency mask of the XPM file. Can be %NULL,
-in which case transparency will be ignored.
-@transparent_color: the color to be used for the pixels
-that are transparent in the input file. Can be %NULL,
-in which case a default color will be used.
-@data: Pointer to a string containing the XPM data.
-@Returns: the #GdkPixmap.
-
-
-<!-- ##### MACRO gdk_pixmap_ref ##### -->
-<para>
-Increase the reference count of a pixmap.
-</para>
+@drawable: 
+@mask: 
+@transparent_color: 
+@data: 
+@Returns: 
 
-@Returns: @pixmap
-<!-- # Unused Parameters # -->
-@pixmap: a #GdkPixmap
 
+<!-- ##### FUNCTION gdk_pixmap_colormap_create_from_xpm_d ##### -->
 
-<!-- ##### MACRO gdk_pixmap_unref ##### -->
-<para>
-Decrease the reference count of a pixmap. If the resulting
-reference count is zero, destroy the pixmap.
-</para>
 
-<!-- # Unused Parameters # -->
-@pixmap: a #GdkPixmap
+@drawable: 
+@colormap: 
+@mask: 
+@transparent_color: 
+@data: 
+@Returns: 
 
 
-<!-- ##### STRUCT GdkBitmap ##### -->
+<!-- ##### TYPEDEF GdkBitmap ##### -->
 <para>
 An opaque structure representing an offscreen drawable of depth
-1. Pointers to structures of type GdkPixmap, #GdkBitmap, and
+1. Pointers to structures of type #GdkPixmap, #GdkBitmap, and
 #GdkWindow, can often be used interchangeably.  The type #GdkDrawable
 refers generically to any of these types.
 </para>
 
-@user_data: 
-
-<!-- ##### MACRO gdk_bitmap_ref ##### -->
-<para>
-Increase the reference count of a bitmap. An alias
-for gdk_pixmap_ref().
-</para>
-
-@Returns: 
-<!-- # Unused Parameters # -->
-@pixmap: 
-
-
-<!-- ##### MACRO gdk_bitmap_unref ##### -->
-<para>
-Decrease the reference count of a bitmap. An alias
-for gdk_pixmap_unref().
-</para>
-
-<!-- # Unused Parameters # -->
-@pixmap: 
-