Make 3.0 parallel-installable to 2.x

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

diff --git a/docs/reference/gdk/tmpl/drawing.sgml b/docs/reference/gdk/tmpl/drawing.sgml
index 55adf506c7be3d6a34911d68b79b5b268e131e8d..9cd73f81f3015292b2901bdb43d2e90e1ed55274 100644 (file)
--- a/docs/reference/gdk/tmpl/drawing.sgml
+++ b/docs/reference/gdk/tmpl/drawing.sgml
@@ -2,11 +2,28 @@
 Drawing Primitives
 
 <!-- ##### SECTION Short_Description ##### -->
-
+Functions for drawing points, lines, arcs, and text
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-
+These functions provide support for drawing points, lines, arcs and text
+onto what are called 'drawables'. Drawables, as the name suggests, are things
+which support drawing onto them, and are either #GdkWindow or #GdkPixmap
+objects.
+</para>
+<para>
+Many of the drawing operations take a #GdkGC argument, which represents a
+graphics context. This #GdkGC contains a number of drawing attributes such
+as foreground color, background color and line width, and is used to reduce
+the number of arguments needed for each drawing operation. See the
+<link linkend="gdk-Graphics-Contexts">Graphics Contexts</link> section for
+more information.
+</para>
+<para id="pango-data-structures">
+Some of the drawing operations take Pango data structures like #PangoContext,
+#PangoLayout or #PangoLayoutLine as arguments. If you're using GTK+, the ususal 
+way to obtain these structures is via gtk_widget_create_pango_context() or
+gtk_widget_create_pango_layout().
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
@@ -14,16 +31,17 @@ Drawing Primitives
 
 </para>
 
-<!-- ##### STRUCT GdkDrawable ##### -->
-<para>
+<!-- ##### SECTION Stability_Level ##### -->
 
-</para>
 
-@user_data: 
+<!-- ##### SECTION Image ##### -->
 
-<!-- ##### STRUCT GdkDrawableClass ##### -->
-<para>
 
+<!-- ##### STRUCT GdkDrawable ##### -->
+<para>
+An opaque structure representing an object that can be
+drawn onto. This can be a #GdkPixmap, a #GdkBitmap,
+or a #GdkWindow.
 </para>
 
 
@@ -65,6 +83,24 @@ Drawing Primitives
 @Returns: 
 
 
+<!-- ##### FUNCTION gdk_drawable_get_display ##### -->
+<para>
+
+</para>
+
+@drawable: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gdk_drawable_get_screen ##### -->
+<para>
+
+</para>
+
+@drawable: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gdk_drawable_get_visual ##### -->
 <para>
 
@@ -111,11 +147,28 @@ Drawing Primitives
 @height: 
 
 
-<!-- ##### FUNCTION gdk_draw_point ##### -->
+<!-- ##### FUNCTION gdk_drawable_get_clip_region ##### -->
 <para>
 
 </para>
 
+@drawable: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gdk_drawable_get_visible_region ##### -->
+<para>
+
+</para>
+
+@drawable: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gdk_draw_point ##### -->
+<para>
+</para>
+
 @drawable: 
 @gc: 
 @x: 
@@ -124,64 +177,84 @@ Drawing Primitives
 
 <!-- ##### FUNCTION gdk_draw_points ##### -->
 <para>
-
 </para>
 
 @drawable: 
 @gc: 
 @points: 
-@npoints: 
+@n_points: 
 
 
 <!-- ##### FUNCTION gdk_draw_line ##### -->
 <para>
-
 </para>
 
 @drawable: 
 @gc: 
-@x1: 
-@y1: 
-@x2: 
-@y2: 
+@x1_: 
+@y1_: 
+@x2_: 
+@y2_: 
 
 
 <!-- ##### FUNCTION gdk_draw_lines ##### -->
 <para>
-
 </para>
 
 @drawable: 
 @gc: 
 @points: 
-@npoints: 
+lines.
+@n_points: 
 
 
-<!-- ##### FUNCTION gdk_draw_segments ##### -->
+<!-- ##### FUNCTION gdk_draw_pixbuf ##### -->
 <para>
 
 </para>
 
+@drawable: 
+@gc: 
+@pixbuf: 
+@src_x: 
+@src_y: 
+@dest_x: 
+@dest_y: 
+@width: 
+@height: 
+@dither: 
+@x_dither: 
+@y_dither: 
+
+
+<!-- ##### FUNCTION gdk_draw_segments ##### -->
+<para>
+</para>
+
 @drawable: 
 @gc: 
 @segs: 
-@nsegs: 
+@n_segs: 
 
 
 <!-- ##### STRUCT GdkSegment ##### -->
 <para>
-
+Specifies the start and end point of a line for use by the gdk_draw_segments()
+function.
 </para>
 
-@x1: 
-@y1: 
-@x2: 
-@y2: 
+@x1: the x coordinate of the start point.
+@y1: the y coordinate of the start point.
+@x2: the x coordinate of the end point.
+@y2: the y coordinate of the end point.
 
 <!-- ##### FUNCTION gdk_draw_rectangle ##### -->
 <para>
-
 </para>
+<note>
+<para>
+</para>
+</note>
 
 @drawable: 
 @gc: 
@@ -194,7 +267,6 @@ Drawing Primitives
 
 <!-- ##### FUNCTION gdk_draw_arc ##### -->
 <para>
-
 </para>
 
 @drawable: 
@@ -210,15 +282,39 @@ Drawing Primitives
 
 <!-- ##### FUNCTION gdk_draw_polygon ##### -->
 <para>
-
 </para>
 
 @drawable: 
 @gc: 
 @filled: 
 @points: 
-@npoints: 
+@n_points: 
+
+
+<!-- ##### FUNCTION gdk_draw_trapezoids ##### -->
+<para>
+
+</para>
+
+@drawable: 
+@gc: 
+@trapezoids: 
+@n_trapezoids: 
+
+
+<!-- ##### STRUCT GdkTrapezoid ##### -->
+<para>
+Specifies a trapezpoid for use by the gdk_draw_trapezoids().
+The trapezoids used here have parallel, horizontal top and 
+bottom edges. 
+</para>
 
+@y1: the y coordinate of the start point.
+@x11: the x coordinate of the top left corner
+@x21: the x coordinate of the top right corner
+@y2: the y coordinate of the end point.
+@x12: the x coordinate of the bottom left corner
+@x22: the x coordinate of the bottom right corner
 
 <!-- ##### FUNCTION gdk_draw_glyphs ##### -->
 <para>
@@ -233,6 +329,20 @@ Drawing Primitives
 @glyphs: 
 
 
+<!-- ##### FUNCTION gdk_draw_glyphs_transformed ##### -->
+<para>
+
+</para>
+
+@drawable: 
+@gc: 
+@matrix: 
+@font: 
+@x: 
+@y: 
+@glyphs: 
+
+
 <!-- ##### FUNCTION gdk_draw_layout_line ##### -->
 <para>
 
@@ -245,6 +355,20 @@ Drawing Primitives
 @line: 
 
 
+<!-- ##### FUNCTION gdk_draw_layout_line_with_colors ##### -->
+<para>
+
+</para>
+
+@drawable: 
+@gc: 
+@x: 
+@y: 
+@line: 
+@foreground: 
+@background: 
+
+
 <!-- ##### FUNCTION gdk_draw_layout ##### -->
 <para>
 
@@ -257,11 +381,24 @@ Drawing Primitives
 @layout: 
 
 
-<!-- ##### FUNCTION gdk_draw_string ##### -->
+<!-- ##### FUNCTION gdk_draw_layout_with_colors ##### -->
 <para>
 
 </para>
 
+@drawable: 
+@gc: 
+@x: 
+@y: 
+@layout: 
+@foreground: 
+@background: 
+
+
+<!-- ##### FUNCTION gdk_draw_string ##### -->
+<para>
+</para>
+
 @drawable: 
 @font: 
 @gc: 
@@ -272,7 +409,6 @@ Drawing Primitives
 
 <!-- ##### FUNCTION gdk_draw_text ##### -->
 <para>
-
 </para>
 
 @drawable: 
@@ -286,7 +422,6 @@ Drawing Primitives
 
 <!-- ##### FUNCTION gdk_draw_text_wc ##### -->
 <para>
-
 </para>
 
 @drawable: 
@@ -300,9 +435,10 @@ Drawing Primitives
 
 <!-- ##### MACRO gdk_draw_pixmap ##### -->
 <para>
-
+Draws a pixmap, or a part of a pixmap, onto another drawable.
 </para>
 
+@Deprecated: Use gdk_draw_drawable() instead.
 
 
 <!-- ##### FUNCTION gdk_draw_drawable ##### -->
@@ -323,7 +459,6 @@ Drawing Primitives
 
 <!-- ##### FUNCTION gdk_draw_image ##### -->
 <para>
-
 </para>
 
 @drawable: 
@@ -350,3 +485,19 @@ Drawing Primitives
 @Returns: 
 
 
+<!-- ##### FUNCTION gdk_drawable_copy_to_image ##### -->
+<para>
+
+</para>
+
+@drawable: 
+@image: 
+@src_x: 
+@src_y: 
+@dest_x: 
+@dest_y: 
+@width: 
+@height: 
+@Returns: 
+
+