summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthias Clasen <matthiasc@src.gnome.org>2002-11-01 00:45:32 +0000
committerMatthias Clasen <matthiasc@src.gnome.org>2002-11-01 00:45:32 +0000
commitca00536f34bfbb895b8b5e01b1faf9c1c60545bf (patch)
treea052fdbb241c7da85e8da57ae67080cec336f6f0
parent1489222cabc46db5b54d9e23415b17d44e63d4a0 (diff)
downloadgdk-pixbuf-ca00536f34bfbb895b8b5e01b1faf9c1c60545bf.tar.gz
More doc comments moved inline.
-rw-r--r--ChangeLog7
-rw-r--r--ChangeLog.pre-2-107
-rw-r--r--ChangeLog.pre-2-27
-rw-r--r--ChangeLog.pre-2-47
-rw-r--r--ChangeLog.pre-2-67
-rw-r--r--ChangeLog.pre-2-87
-rw-r--r--docs/reference/ChangeLog3
-rw-r--r--docs/reference/gdk/tmpl/drawing.sgml196
-rw-r--r--docs/reference/gdk/tmpl/fonts.sgml224
-rw-r--r--gdk/gdkdraw.c163
-rw-r--r--gdk/gdkfont.c148
-rw-r--r--gdk/x11/gdkfont-x11.c79
-rw-r--r--gdk/x11/gdkim-x11.c40
13 files changed, 611 insertions, 284 deletions
diff --git a/ChangeLog b/ChangeLog
index 510dddd74..2425cc91e 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2002-11-01 Matthias Clasen <maclas@gmx.de>
+
+ * gdk/x11/gdkim-x11.c:
+ * gdk/gdkfont.c:
+ * gdk/x11/gdkfont-x11.c:
+ * gdk/gdkdraw.c: Some docs moved inline.
+
Thu Oct 31 17:41:12 2002 Owen Taylor <otaylor@redhat.com>
* gtk/gtktooltips.c (gtk_tooltips_update_screen): Fix
diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10
index 510dddd74..2425cc91e 100644
--- a/ChangeLog.pre-2-10
+++ b/ChangeLog.pre-2-10
@@ -1,3 +1,10 @@
+2002-11-01 Matthias Clasen <maclas@gmx.de>
+
+ * gdk/x11/gdkim-x11.c:
+ * gdk/gdkfont.c:
+ * gdk/x11/gdkfont-x11.c:
+ * gdk/gdkdraw.c: Some docs moved inline.
+
Thu Oct 31 17:41:12 2002 Owen Taylor <otaylor@redhat.com>
* gtk/gtktooltips.c (gtk_tooltips_update_screen): Fix
diff --git a/ChangeLog.pre-2-2 b/ChangeLog.pre-2-2
index 510dddd74..2425cc91e 100644
--- a/ChangeLog.pre-2-2
+++ b/ChangeLog.pre-2-2
@@ -1,3 +1,10 @@
+2002-11-01 Matthias Clasen <maclas@gmx.de>
+
+ * gdk/x11/gdkim-x11.c:
+ * gdk/gdkfont.c:
+ * gdk/x11/gdkfont-x11.c:
+ * gdk/gdkdraw.c: Some docs moved inline.
+
Thu Oct 31 17:41:12 2002 Owen Taylor <otaylor@redhat.com>
* gtk/gtktooltips.c (gtk_tooltips_update_screen): Fix
diff --git a/ChangeLog.pre-2-4 b/ChangeLog.pre-2-4
index 510dddd74..2425cc91e 100644
--- a/ChangeLog.pre-2-4
+++ b/ChangeLog.pre-2-4
@@ -1,3 +1,10 @@
+2002-11-01 Matthias Clasen <maclas@gmx.de>
+
+ * gdk/x11/gdkim-x11.c:
+ * gdk/gdkfont.c:
+ * gdk/x11/gdkfont-x11.c:
+ * gdk/gdkdraw.c: Some docs moved inline.
+
Thu Oct 31 17:41:12 2002 Owen Taylor <otaylor@redhat.com>
* gtk/gtktooltips.c (gtk_tooltips_update_screen): Fix
diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6
index 510dddd74..2425cc91e 100644
--- a/ChangeLog.pre-2-6
+++ b/ChangeLog.pre-2-6
@@ -1,3 +1,10 @@
+2002-11-01 Matthias Clasen <maclas@gmx.de>
+
+ * gdk/x11/gdkim-x11.c:
+ * gdk/gdkfont.c:
+ * gdk/x11/gdkfont-x11.c:
+ * gdk/gdkdraw.c: Some docs moved inline.
+
Thu Oct 31 17:41:12 2002 Owen Taylor <otaylor@redhat.com>
* gtk/gtktooltips.c (gtk_tooltips_update_screen): Fix
diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8
index 510dddd74..2425cc91e 100644
--- a/ChangeLog.pre-2-8
+++ b/ChangeLog.pre-2-8
@@ -1,3 +1,10 @@
+2002-11-01 Matthias Clasen <maclas@gmx.de>
+
+ * gdk/x11/gdkim-x11.c:
+ * gdk/gdkfont.c:
+ * gdk/x11/gdkfont-x11.c:
+ * gdk/gdkdraw.c: Some docs moved inline.
+
Thu Oct 31 17:41:12 2002 Owen Taylor <otaylor@redhat.com>
* gtk/gtktooltips.c (gtk_tooltips_update_screen): Fix
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index d43400086..14144b9b1 100644
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,5 +1,8 @@
2002-11-01 Matthias Clasen <maclas@gmx.de>
+ * gdk/tmpl/fonts.sgml:
+ * gdk/tmpl/drawing.sgml: More docs moved inline.
+
* gtk/tmpl/gtkfilesel.sgml: The label is "Folders" now, not
"Directories". (#97224, Vitaly Tishkov)
diff --git a/docs/reference/gdk/tmpl/drawing.sgml b/docs/reference/gdk/tmpl/drawing.sgml
index 0238676f7..35ea028c4 100644
--- a/docs/reference/gdk/tmpl/drawing.sgml
+++ b/docs/reference/gdk/tmpl/drawing.sgml
@@ -155,53 +155,45 @@ or a #GdkWindow.
<!-- ##### FUNCTION gdk_draw_point ##### -->
<para>
-Draws a point, using the foreground color and other attributes of the #GdkGC.
</para>
-@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
-@gc: a #GdkGC.
-@x: the x coordinate of the point.
-@y: the y coordinate of the point.
+@drawable:
+@gc:
+@x:
+@y:
<!-- ##### FUNCTION gdk_draw_points ##### -->
<para>
-Draws a number of points, using the foreground color and other attributes of
-the #GdkGC.
</para>
-@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
-@gc: a #GdkGC.
-@points: an array of #GdkPoint structures.
-@npoints: the number of points to be drawn.
+@drawable:
+@gc:
+@points:
+@npoints:
<!-- ##### FUNCTION gdk_draw_line ##### -->
<para>
-Draws a line, using the foreground color and other attributes of the #GdkGC.
</para>
-@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
-@gc: a #GdkGC.
-@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.
+@drawable:
+@gc:
+@x1:
+@y1:
+@x2:
+@y2:
<!-- ##### FUNCTION gdk_draw_lines ##### -->
<para>
-Draws a series of lines connecting the given points.
-The way in which joins between lines are draw is determined by the
-#GdkCapStyle value in the #GdkGC. This can be set with
-gdk_gc_set_line_attributes().
</para>
-@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
-@gc: a #GdkGC.
-@points: an array of #GdkPoint structures specifying the endpoints of the
+@drawable:
+@gc:
+@points:
lines.
-@npoints: the size of the @points array.
+@npoints:
<!-- ##### FUNCTION gdk_draw_pixbuf ##### -->
@@ -225,14 +217,12 @@ lines.
<!-- ##### FUNCTION gdk_draw_segments ##### -->
<para>
-Draws a number of unconnected lines.
</para>
-@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
-@gc: a #GdkGC.
-@segs: an array of #GdkSegment structures specifying the start and end points
-of the lines to be drawn,
-@nsegs: the number of line segments to draw, i.e. the size of the @segs array.
+@drawable:
+@gc:
+@segs:
+@nsegs:
<!-- ##### STRUCT GdkSegment ##### -->
@@ -248,60 +238,45 @@ function.
<!-- ##### FUNCTION gdk_draw_rectangle ##### -->
<para>
-Draws a rectangular outline or filled rectangle, using the foreground color
-and other attributes of the #GdkGC.
</para>
<note>
<para>
-A rectangle drawn filled is 1 pixel smaller in both dimensions than a rectangle
-outlined. Calling <literal>gdk_draw_rectangle (window, gc, TRUE, 0, 0, 20, 20)</literal> results
-in a filled rectangle 20 pixels wide and 20 pixels high. Calling
-<literal>gdk_draw_rectangle (window, gc, FALSE, 0, 0, 20, 20)</literal> results in an outlined
-rectangle with corners at (0, 0), (0, 20), (20, 20), and (20, 0), which
-makes it 21 pixels wide and 21 pixels high.
</para>
</note>
-@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
-@gc: a #GdkGC.
-@filled: %TRUE if the rectangle should be filled.
-@x: the x coordinate of the left edge of the rectangle.
-@y: the y coordinate of the top edge of the rectangle.
-@width: the width of the rectangle.
-@height: the height of the rectangle.
+@drawable:
+@gc:
+@filled:
+@x:
+@y:
+@width:
+@height:
<!-- ##### FUNCTION gdk_draw_arc ##### -->
<para>
-Draws an arc or a filled 'pie slice'. The arc is defined by the bounding
-rectangle of the entire ellipse, and the start and end angles of the part of
-the ellipse to be drawn.
</para>
-@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
-@gc: a #GdkGC.
-@filled: %TRUE if the arc should be filled, producing a 'pie slice'.
-@x: the x coordinate of the left edge of the bounding rectangle.
-@y: the y coordinate of the top edge of the bounding rectangle.
-@width: the width of the bounding rectangle.
-@height: the height of the bounding rectangle.
-@angle1: the start angle of the arc, relative to the 3 o'clock position,
-counter-clockwise, in 1/64ths of a degree.
-@angle2: the end angle of the arc, relative to @angle1, in 1/64ths of a degree.
+@drawable:
+@gc:
+@filled:
+@x:
+@y:
+@width:
+@height:
+@angle1:
+@angle2:
<!-- ##### FUNCTION gdk_draw_polygon ##### -->
<para>
-Draws an outlined or filled polygon.
</para>
-@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
-@gc: a #GdkGC.
-@filled: %TRUE if the polygon should be filled. The polygon is closed
-automatically, connecting the last point to the first point if necessary.
-@points: an array of #GdkPoint structures specifying the points making up the
-polygon.
-@npoints: the number of points.
+@drawable:
+@gc:
+@filled:
+@points:
+@npoints:
<!-- ##### FUNCTION gdk_draw_glyphs ##### -->
@@ -371,45 +346,40 @@ polygon.
<!-- ##### FUNCTION gdk_draw_string ##### -->
<para>
-Draws a string of characters in the given font or fontset.
</para>
-@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
-@font: a #GdkFont.
-@gc: a #GdkGC.
-@x: the x coordinate of the left edge of the text.
-@y: the y coordinate of the baseline of the text.
-@string: the string of characters to draw.
+@drawable:
+@font:
+@gc:
+@x:
+@y:
+@string:
<!-- ##### FUNCTION gdk_draw_text ##### -->
<para>
-Draws a number of characters in the given font or fontset.
</para>
-@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
-@font: a #GdkFont.
-@gc: a #GdkGC.
-@x: the x coordinate of the left edge of the text.
-@y: the y coordinate of the baseline of the text.
-@text: the characters to draw.
-@text_length: the number of characters of @text to draw.
+@drawable:
+@font:
+@gc:
+@x:
+@y:
+@text:
+@text_length:
<!-- ##### FUNCTION gdk_draw_text_wc ##### -->
<para>
-Draws a number of wide characters using the given font of fontset.
-If the font is a 1-byte font, the string is converted into 1-byte characters
-(discarding the high bytes) before output.
</para>
-@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
-@font: a #GdkFont.
-@gc: a #GdkGC.
-@x: the x coordinate of the left edge of the text.
-@y: the y coordinate of the baseline of the text.
-@text: the wide characters to draw.
-@text_length: the number of characters to draw.
+@drawable:
+@font:
+@gc:
+@x:
+@y:
+@text:
+@text_length:
<!-- ##### MACRO gdk_draw_pixmap ##### -->
@@ -417,20 +387,6 @@ If the font is a 1-byte font, the string is converted into 1-byte characters
Draws a pixmap, or a part of a pixmap, onto another drawable.
</para>
-<!-- # Unused Parameters # -->
-@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
-@gc: a #GdkGC.
-@src: the source #GdkPixmap to draw.
-@xsrc: the left edge of the source rectangle within @src.
-@ysrc: the top of the source rectangle within @src.
-@xdest: the x coordinate of the destination within @drawable.
-@ydest: the y coordinate of the destination within @drawable.
-@width: the width of the area to be copied, or -1 to make the area extend to
-the right edge of the source pixmap.
-@height: the height of the area to be copied, or -1 to make the area extend
-to the bottom edge of the source pixmap.
-
-
<!-- ##### FUNCTION gdk_draw_drawable ##### -->
<para>
@@ -449,21 +405,17 @@ to the bottom edge of the source pixmap.
<!-- ##### FUNCTION gdk_draw_image ##### -->
<para>
-Draws a #GdkImage onto a drawable.
-The depth of the #GdkImage must match the depth of the #GdkDrawable.
-</para>
-
-@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
-@gc: a #GdkGC.
-@image: the #GdkImage to draw.
-@xsrc: the left edge of the source rectangle within @image.
-@ysrc: the top of the source rectangle within @image.
-@xdest: the x coordinate of the destination within @drawable.
-@ydest: the y coordinate of the destination within @drawable.
-@width: the width of the area to be copied, or -1 to make the area extend to
-the right edge of @image.
-@height: the height of the area to be copied, or -1 to make the area extend
-to the bottom edge of @image.
+</para>
+
+@drawable:
+@gc:
+@image:
+@xsrc:
+@ysrc:
+@xdest:
+@ydest:
+@width:
+@height:
<!-- ##### FUNCTION gdk_drawable_get_image ##### -->
diff --git a/docs/reference/gdk/tmpl/fonts.sgml b/docs/reference/gdk/tmpl/fonts.sgml
index eba6864a1..63fac5c85 100644
--- a/docs/reference/gdk/tmpl/fonts.sgml
+++ b/docs/reference/gdk/tmpl/fonts.sgml
@@ -287,16 +287,10 @@ are currently:
<!-- ##### FUNCTION gdk_font_load ##### -->
<para>
-Loads a font.
</para>
-<para>
-The font may be newly loaded or looked up the font in a cache.
-You should make no assumptions about the initial reference count.
-</para>
-
-@font_name: a XLFD describing the font to load.
-@Returns: a #GdkFont, or %NULL if the font could not be loaded.
+@font_name:
+@Returns:
<!-- ##### FUNCTION gdk_font_load_for_display ##### -->
@@ -311,16 +305,10 @@ You should make no assumptions about the initial reference count.
<!-- ##### FUNCTION gdk_fontset_load ##### -->
<para>
-Loads a fontset.
-</para>
-<para>
-The fontset may be newly loaded or looked up in a cache.
-You should make no assumptions about the initial reference count.
</para>
-@fontset_name: a comma-separated list of XLFDs describing
- the component fonts of the fontset to load.
-@Returns: a #GdkFont, or %NULL if the fontset could not be loaded.
+@fontset_name:
+@Returns:
<!-- ##### FUNCTION gdk_fontset_load_for_display ##### -->
@@ -363,225 +351,178 @@ You should make no assumptions about the initial reference count.
<!-- ##### FUNCTION gdk_font_ref ##### -->
<para>
-Increases the reference count of a font by one.
</para>
-@font: a #GdkFont
-@Returns: @font
+@font:
+@Returns:
<!-- ##### FUNCTION gdk_font_unref ##### -->
<para>
-Decreases the reference count of a font by one.
-If the result is zero, destroys the font.
</para>
-@font: a #GdkFont
+@font:
<!-- ##### FUNCTION gdk_font_id ##### -->
<para>
-Returns the X Font ID for the given font.
</para>
-@font: a #GdkFont.
-@Returns: the numeric X Font ID
+@font:
+@Returns:
<!-- ##### FUNCTION gdk_font_equal ##### -->
<para>
-Compares two fonts for equality. Single fonts compare equal
-if they have the same X font ID. This operation does
-not currently work correctly for fontsets.
</para>
-@fonta: a #GdkFont.
-@fontb: another #GdkFont.
-@Returns: %TRUE if the fonts are equal.
+@fonta:
+@fontb:
+@Returns:
<!-- ##### FUNCTION gdk_string_extents ##### -->
<para>
-Returns the metrics of a nul-terminated string.
</para>
-@font: a #GdkFont.
-@string: the nul-terminated string to measure.
-@lbearing: the left bearing of the string.
-@rbearing: the right bearing of the string.
-@width: the width of the string.
-@ascent: the ascent of the string.
-@descent: the descent of the string.
+@font:
+@string:
+@lbearing:
+@rbearing:
+@width:
+@ascent:
+@descent:
<!-- ##### FUNCTION gdk_text_extents ##### -->
<para>
-Returns the metrics of a string.
</para>
-@font: a #GdkFont
-@text: the text to measure
-@text_length: the length of the text in bytes. (If the
- font is a 16-bit font, this is twice the length
- of the text in characters.)
-@lbearing: the left bearing of the string.
-@rbearing: the right bearing of the string.
-@width: the width of the string.
-@ascent: the ascent of the string.
-@descent: the descent of the string.
+@font:
+@text:
+@text_length:
+@lbearing:
+@rbearing:
+@width:
+@ascent:
+@descent:
<!-- ##### FUNCTION gdk_text_extents_wc ##### -->
<para>
-Returns the metrics of a string of wide characters.
</para>
-@font: a #GdkFont
-@text: the text to measure.
-@text_length: the length of the text in character.
-@lbearing: the left bearing of the string.
-@rbearing: the right bearing of the string.
-@width: the width of the string.
-@ascent: the ascent of the string.
-@descent: the descent of the string.
+@font:
+@text:
+@text_length:
+@lbearing:
+@rbearing:
+@width:
+@ascent:
+@descent:
<!-- ##### FUNCTION gdk_string_width ##### -->
<para>
-Determines the width of a nul-terminated string.
-(The distance from the origin of the string to the
-point where the next string in a sequence of strings
-should be drawn)
</para>
-@font: a #GdkFont
-@string: the nul-terminated string to measure
-@Returns: the width of the string in pixels.
+@font:
+@string:
+@Returns:
<!-- ##### FUNCTION gdk_text_width ##### -->
<para>
-Determines the width of a given string.
</para>
-@font: a #GdkFont
-@text: the text to measure.
-@text_length: the length of the text in bytes.
-@Returns: the width of the string in pixels.
+@font:
+@text:
+@text_length:
+@Returns:
<!-- ##### FUNCTION gdk_text_width_wc ##### -->
<para>
-Determines the width of a given wide-character string.
</para>
-@font: a #GdkFont
-@text: the text to measure.
-@text_length: the length of the text in characters.
-@Returns: the width of the string in pixels.
+@font:
+@text:
+@text_length:
+@Returns:
<!-- ##### FUNCTION gdk_char_width ##### -->
<para>
-Determines the width of a given character.
</para>
-@font: a #GdkFont
-@character: the character to measure.
-@Returns: the width of the character in pixels.
+@font:
+@character:
+@Returns:
<!-- ##### FUNCTION gdk_char_width_wc ##### -->
<para>
-Determines the width of a given wide character. (Encoded
-in the wide-character encoding of the current locale).
</para>
-@font: a #GdkFont
-@character: the character to measure.
-@Returns: the width of the character in pixels.
+@font:
+@character:
+@Returns:
<!-- ##### FUNCTION gdk_string_measure ##### -->
<para>
-Determines the distance from the origin to the rightmost
-portion of a nul-terminated string when drawn. This is not the
-correct value for determining the origin of the next
-portion when drawing text in multiple pieces.
-See gdk_string_width().
</para>
-@font: a #GdkFont
-@string: the nul-terminated string to measure.
-@Returns: the right bearing of the string in pixels.
+@font:
+@string:
+@Returns:
<!-- ##### FUNCTION gdk_text_measure ##### -->
<para>
-Determines the distance from the origin to the rightmost
-portion of a string when drawn. This is not the
-correct value for determining the origin of the next
-portion when drawing text in multiple pieces.
-See gdk_text_width().
</para>
-@font: a #GdkFont
-@text: the text to measure.
-@text_length: the length of the text in bytes.
-@Returns: the right bearing of the string in pixels.
+@font:
+@text:
+@text_length:
+@Returns:
<!-- ##### FUNCTION gdk_char_measure ##### -->
<para>
-Determines the distance from the origin to the rightmost
-portion of a character when drawn. This is not the
-correct value for determining the origin of the next
-portion when drawing text in multiple pieces.
</para>
-@font: a #GdkFont
-@character: the character to measure.
-@Returns: the right bearing of the character in pixels.
+@font:
+@character:
+@Returns:
<!-- ##### FUNCTION gdk_string_height ##### -->
<para>
-Determines the total height of a given nul-terminated
-string. This value is not generally useful, because you
-cannot determine how this total height will be drawn in
-relation to the baseline. See gdk_string_extents().
</para>
-@font: a #GdkFont
-@string: the nul-terminated string to measure.
-@Returns: the height of the string in pixels.
+@font:
+@string:
+@Returns:
<!-- ##### FUNCTION gdk_text_height ##### -->
<para>
-Determines the total height of a given string.
-This value is not generally useful, because you cannot
-determine how this total height will be drawn in
-relation to the baseline. See gdk_text_extents().
</para>
-@font: a #GdkFont
-@text: the text to measure.
-@text_length: the length of the text in bytes.
-@Returns: the height of the string in pixels.
+@font:
+@text:
+@text_length:
+@Returns:
<!-- ##### FUNCTION gdk_char_height ##### -->
<para>
-Determines the total height of a given character.
-This value is not generally useful, because you cannot
-determine how this total height will be drawn in
-relation to the baseline. See gdk_text_extents().
</para>
-@font: a #GdkFont
-@character: the character to measure.
-@Returns: the height of the character in pixels.
+@font:
+@character:
+@Returns:
<!-- ##### TYPEDEF GdkWChar ##### -->
@@ -621,28 +562,19 @@ for more detailed information on wide and multi-byte characters.
<!-- ##### FUNCTION gdk_wcstombs ##### -->
<para>
-Converts a wide character string to a multi-byte string.
-(The function name comes from an acronym of 'Wide Character String TO
-Multi-Byte String').
</para>
-@src: a wide character string.
-@Returns: the multi-byte string corresponding to @src, or %NULL if the
-conversion failed. The returned string should be freed with g_free() when no
-longer needed.
+@src:
+@Returns:
<!-- ##### FUNCTION gdk_mbstowcs ##### -->
<para>
-Converts a multi-byte string to a wide character string.
-(The function name comes from an acronym of 'Multi-Byte String TO Wide
-Character String').
</para>
-@dest: the space to place the converted wide character string into.
-@src: the multi-byte string to convert, which must be nul-terminated.
-@dest_max: the maximum number of wide characters to place in @dest.
-@Returns: the number of wide characters written into @dest, or -1 if the
-conversion failed.
+@dest:
+@src:
+@dest_max:
+@Returns:
diff --git a/gdk/gdkdraw.c b/gdk/gdkdraw.c
index 5b44e4923..8e024fa76 100644
--- a/gdk/gdkdraw.c
+++ b/gdk/gdkdraw.c
@@ -311,6 +311,17 @@ gdk_drawable_unref (GdkDrawable *drawable)
/* Drawing
*/
+
+/**
+ * gdk_draw_point:
+ * @drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
+ * @gc: a #GdkGC.
+ * @x: the x coordinate of the point.
+ * @y: the y coordinate of the point.
+ *
+ * Draws a point, using the foreground color and other attributes of
+ * the #GdkGC.
+ **/
void
gdk_draw_point (GdkDrawable *drawable,
GdkGC *gc,
@@ -328,6 +339,18 @@ gdk_draw_point (GdkDrawable *drawable,
GDK_DRAWABLE_GET_CLASS (drawable)->draw_points (drawable, gc, &point, 1);
}
+/**
+ * gdk_draw_line:
+ * @drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
+ * @gc: a #GdkGC.
+ * @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.
+ *
+ * Draws a line, using the foreground color and other attributes of
+ * the #GdkGC.
+ **/
void
gdk_draw_line (GdkDrawable *drawable,
GdkGC *gc,
@@ -350,6 +373,27 @@ gdk_draw_line (GdkDrawable *drawable,
GDK_DRAWABLE_GET_CLASS (drawable)->draw_segments (drawable, gc, &segment, 1);
}
+/**
+ * gdk_draw_rectangle:
+ * @drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
+ * @gc: a #GdkGC.
+ * @filled: %TRUE if the rectangle should be filled.
+ * @x: the x coordinate of the left edge of the rectangle.
+ * @y: the y coordinate of the top edge of the rectangle.
+ * @width: the width of the rectangle.
+ * @height: the height of the rectangle.
+ *
+ * Draws a rectangular outline or filled rectangle, using the foreground color
+ * and other attributes of the #GdkGC.
+ *
+ * A rectangle drawn filled is 1 pixel smaller in both dimensions than a
+ * rectangle outlined. Calling
+ * <literal>gdk_draw_rectangle (window, gc, TRUE, 0, 0, 20, 20)</literal>
+ * results in a filled rectangle 20 pixels wide and 20 pixels high. Calling
+ * <literal>gdk_draw_rectangle (window, gc, FALSE, 0, 0, 20, 20)</literal>
+ * results in an outlined rectangle with corners at (0, 0), (0, 20), (20, 20),
+ * and (20, 0), which makes it 21 pixels wide and 21 pixels high.
+ **/
void
gdk_draw_rectangle (GdkDrawable *drawable,
GdkGC *gc,
@@ -379,6 +423,24 @@ gdk_draw_rectangle (GdkDrawable *drawable,
width, height);
}
+/**
+ * gdk_draw_arc:
+ * @drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
+ * @gc: a #GdkGC.
+ * @filled: %TRUE if the arc should be filled, producing a 'pie slice'.
+ * @x: the x coordinate of the left edge of the bounding rectangle.
+ * @y: the y coordinate of the top edge of the bounding rectangle.
+ * @width: the width of the bounding rectangle.
+ * @height: the height of the bounding rectangle.
+ * @angle1: the start angle of the arc, relative to the 3 o'clock position,
+ * counter-clockwise, in 1/64ths of a degree.
+ * @angle2: the end angle of the arc, relative to @angle1, in 1/64ths
+ * of a degree.
+ *
+ * Draws an arc or a filled 'pie slice'. The arc is defined by the bounding
+ * rectangle of the entire ellipse, and the start and end angles of the part
+ * of the ellipse to be drawn.
+ **/
void
gdk_draw_arc (GdkDrawable *drawable,
GdkGC *gc,
@@ -410,6 +472,19 @@ gdk_draw_arc (GdkDrawable *drawable,
x, y, width, height, angle1, angle2);
}
+/**
+ * gdk_draw_polygon:
+ * @drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
+ * @gc: a #GdkGC.
+ * @filled: %TRUE if the polygon should be filled. The polygon is closed
+ * automatically, connecting the last point to the first point if
+ * necessary.
+ * @points: an array of #GdkPoint structures specifying the points making
+ * up the polygon.
+ * @npoints: the number of points.
+ *
+ * Draws an outlined or filled polygon.
+ **/
void
gdk_draw_polygon (GdkDrawable *drawable,
GdkGC *gc,
@@ -430,6 +505,17 @@ gdk_draw_polygon (GdkDrawable *drawable,
*
* Interface changed: add "GdkFont *font" to specify font or fontset explicitely
*/
+/**
+ * gdk_draw_string:
+ * @drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
+ * @font: a #GdkFont.
+ * @gc: a #GdkGC.
+ * @x: the x coordinate of the left edge of the text.
+ * @y: the y coordinate of the baseline of the text.
+ * @string: the string of characters to draw.
+ *
+ * Draws a string of characters in the given font or fontset.
+ **/
void
gdk_draw_string (GdkDrawable *drawable,
GdkFont *font,
@@ -447,6 +533,18 @@ gdk_draw_string (GdkDrawable *drawable,
*
* Interface changed: add "GdkFont *font" to specify font or fontset explicitely
*/
+/**
+ * gdk_draw_text:
+ * @drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
+ * @font: a #GdkFont.
+ * @gc: a #GdkGC.
+ * @x: the x coordinate of the left edge of the text.
+ * @y: the y coordinate of the baseline of the text.
+ * @text: the characters to draw.
+ * @text_length: the number of characters of @text to draw.
+ *
+ * Draws a number of characters in the given font or fontset.
+ **/
void
gdk_draw_text (GdkDrawable *drawable,
GdkFont *font,
@@ -464,6 +562,20 @@ gdk_draw_text (GdkDrawable *drawable,
GDK_DRAWABLE_GET_CLASS (drawable)->draw_text (drawable, font, gc, x, y, text, text_length);
}
+/**
+ * gdk_draw_text_wc:
+ * @drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
+ * @font: a #GdkFont.
+ * @gc: a #GdkGC.
+ * @x: the x coordinate of the left edge of the text.
+ * @y: the y coordinate of the baseline of the text.
+ * @text: the wide characters to draw.
+ * @text_length: the number of characters to draw.
+ *
+ * Draws a number of wide characters using the given font of fontset.
+ * If the font is a 1-byte font, the string is converted into 1-byte
+ * characters (discarding the high bytes) before output.
+ **/
void
gdk_draw_text_wc (GdkDrawable *drawable,
GdkFont *font,
@@ -559,6 +671,23 @@ gdk_draw_drawable (GdkDrawable *drawable,
g_object_unref (composite);
}
+/**
+ * gdk_draw_image:
+ * @drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
+ * @gc: a #GdkGC.
+ * @image: the #GdkImage to draw.
+ * @xsrc: the left edge of the source rectangle within @image.
+ * @ysrc: the top of the source rectangle within @image.
+ * @xdest: the x coordinate of the destination within @drawable.
+ * @ydest: the y coordinate of the destination within @drawable.
+ * @width: the width of the area to be copied, or -1 to make the area
+ * extend to the right edge of @image.
+ * @height: the height of the area to be copied, or -1 to make the area
+ * extend to the bottom edge of @image.
+ *
+ * Draws a #GdkImage onto a drawable.
+ * The depth of the #GdkImage must match the depth of the #GdkDrawable.
+ **/
void
gdk_draw_image (GdkDrawable *drawable,
GdkGC *gc,
@@ -634,6 +763,16 @@ gdk_draw_pixbuf (GdkDrawable *drawable,
dither, x_dither, y_dither);
}
+/**
+ * gdk_draw_points:
+ * @drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
+ * @gc: a #GdkGC.
+ * @points: an array of #GdkPoint structures.
+ * @npoints: the number of points to be drawn.
+ *
+ * Draws a number of points, using the foreground color and other
+ * attributes of the #GdkGC.
+ **/
void
gdk_draw_points (GdkDrawable *drawable,
GdkGC *gc,
@@ -651,6 +790,17 @@ gdk_draw_points (GdkDrawable *drawable,
GDK_DRAWABLE_GET_CLASS (drawable)->draw_points (drawable, gc, points, npoints);
}
+/**
+ * gdk_draw_segments:
+ * @drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
+ * @gc: a #GdkGC.
+ * @segs: an array of #GdkSegment structures specifying the start and
+ * end points of the lines to be drawn.
+ * @nsegs: the number of line segments to draw, i.e. the size of the
+ * @segs array.
+ *
+ * Draws a number of unconnected lines.
+ **/
void
gdk_draw_segments (GdkDrawable *drawable,
GdkGC *gc,
@@ -669,13 +819,24 @@ gdk_draw_segments (GdkDrawable *drawable,
GDK_DRAWABLE_GET_CLASS (drawable)->draw_segments (drawable, gc, segs, nsegs);
}
+/**
+ * gdk_draw_lines:
+ * @drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
+ * @gc: a #GdkGC.
+ * @points: an array of #GdkPoint structures specifying the endpoints of the
+ * @npoints: the size of the @points array.
+ *
+ * Draws a series of lines connecting the given points.
+ * The way in which joins between lines are draw is determined by the
+ * #GdkCapStyle value in the #GdkGC. This can be set with
+ * gdk_gc_set_line_attributes().
+ **/
void
gdk_draw_lines (GdkDrawable *drawable,
GdkGC *gc,
GdkPoint *points,
gint npoints)
{
-
g_return_if_fail (GDK_IS_DRAWABLE (drawable));
g_return_if_fail (points != NULL);
g_return_if_fail (GDK_IS_GC (gc));
diff --git a/gdk/gdkfont.c b/gdk/gdkfont.c
index adbffd3fe..262eb657c 100644
--- a/gdk/gdkfont.c
+++ b/gdk/gdkfont.c
@@ -40,6 +40,14 @@ gdk_font_get_type (void)
return our_type;
}
+/**
+ * gdk_font_ref:
+ * @font: a #GdkFont
+ *
+ * Increases the reference count of a font by one.
+ *
+ * Return value: @font
+ **/
GdkFont*
gdk_font_ref (GdkFont *font)
{
@@ -52,6 +60,13 @@ gdk_font_ref (GdkFont *font)
return font;
}
+/**
+ * gdk_font_unref:
+ * @font: a #GdkFont
+ *
+ * Decreases the reference count of a font by one.
+ * If the result is zero, destroys the font.
+ **/
void
gdk_font_unref (GdkFont *font)
{
@@ -66,6 +81,18 @@ gdk_font_unref (GdkFont *font)
_gdk_font_destroy (font);
}
+/**
+ * gdk_string_width:
+ * @font: a #GdkFont
+ * @string: the nul-terminated string to measure
+ *
+ * Determines the width of a nul-terminated string.
+ * (The distance from the origin of the string to the
+ * point where the next string in a sequence of strings
+ * should be drawn)
+ *
+ * Return value: the width of the string in pixels.
+ **/
gint
gdk_string_width (GdkFont *font,
const gchar *string)
@@ -76,6 +103,15 @@ gdk_string_width (GdkFont *font,
return gdk_text_width (font, string, _gdk_font_strlen (font, string));
}
+/**
+ * gdk_char_width:
+ * @font: a #GdkFont
+ * @character: the character to measure.
+ *
+ * Determines the width of a given character.
+ *
+ * Return value: the width of the character in pixels.
+ **/
gint
gdk_char_width (GdkFont *font,
gchar character)
@@ -85,6 +121,16 @@ gdk_char_width (GdkFont *font,
return gdk_text_width (font, &character, 1);
}
+/**
+ * gdk_char_width_wc:
+ * @font: a #GdkFont
+ * @character: the character to measure.
+ *
+ * Determines the width of a given wide character. (Encoded
+ * in the wide-character encoding of the current locale).
+ *
+ * Return value: the width of the character in pixels.
+ **/
gint
gdk_char_width_wc (GdkFont *font,
GdkWChar character)
@@ -94,6 +140,19 @@ gdk_char_width_wc (GdkFont *font,
return gdk_text_width_wc (font, &character, 1);
}
+/**
+ * gdk_string_measure:
+ * @font: a #GdkFont
+ * @string: the nul-terminated string to measure.
+ *
+ * Determines the distance from the origin to the rightmost
+ * portion of a nul-terminated string when drawn. This is not the
+ * correct value for determining the origin of the next
+ * portion when drawing text in multiple pieces.
+ * See gdk_string_width().
+ *
+ * Return value: the right bearing of the string in pixels.
+ **/
gint
gdk_string_measure (GdkFont *font,
const gchar *string)
@@ -104,6 +163,18 @@ gdk_string_measure (GdkFont *font,
return gdk_text_measure (font, string, _gdk_font_strlen (font, string));
}
+/**
+ * gdk_string_extents:
+ * @font: a #GdkFont.
+ * @string: the nul-terminated string to measure.
+ * @lbearing: the left bearing of the string.
+ * @rbearing: the right bearing of the string.
+ * @width: the width of the string.
+ * @ascent: the ascent of the string.
+ * @descent: the descent of the string.
+ *
+ * Returns the metrics of a nul-terminated string.
+ **/
void
gdk_string_extents (GdkFont *font,
const gchar *string,
@@ -121,6 +192,20 @@ gdk_string_extents (GdkFont *font,
}
+/**
+ * gdk_text_measure:
+ * @font: a #GdkFont
+ * @text: the text to measure.
+ * @text_length: the length of the text in bytes.
+ *
+ * Determines the distance from the origin to the rightmost
+ * portion of a string when drawn. This is not the
+ * correct value for determining the origin of the next
+ * portion when drawing text in multiple pieces.
+ * See gdk_text_width().
+ *
+ * Return value: the right bearing of the string in pixels.
+ **/
gint
gdk_text_measure (GdkFont *font,
const gchar *text,
@@ -134,6 +219,19 @@ gdk_text_measure (GdkFont *font,
gdk_text_extents (font, text, text_length, NULL, &rbearing, NULL, NULL, NULL);
return rbearing;
}
+
+/**
+ * gdk_char_measure:
+ * @font: a #GdkFont
+ * @character: the character to measure.
+ *
+ * Determines the distance from the origin to the rightmost
+ * portion of a character when drawn. This is not the
+ * correct value for determining the origin of the next
+ * portion when drawing text in multiple pieces.
+ *
+ * Return value: the right bearing of the character in pixels.
+ **/
gint
gdk_char_measure (GdkFont *font,
gchar character)
@@ -143,6 +241,18 @@ gdk_char_measure (GdkFont *font,
return gdk_text_measure (font, &character, 1);
}
+/**
+ * gdk_string_height:
+ * @font: a #GdkFont
+ * @string: the nul-terminated string to measure.
+ *
+ * Determines the total height of a given nul-terminated
+ * string. This value is not generally useful, because you
+ * cannot determine how this total height will be drawn in
+ * relation to the baseline. See gdk_string_extents().
+ *
+ * Return value: the height of the string in pixels.
+ **/
gint
gdk_string_height (GdkFont *font,
const gchar *string)
@@ -153,6 +263,19 @@ gdk_string_height (GdkFont *font,
return gdk_text_height (font, string, _gdk_font_strlen (font, string));
}
+/**
+ * gdk_text_height:
+ * @font: a #GdkFont
+ * @text: the text to measure.
+ * @text_length: the length of the text in bytes.
+ *
+ * Determines the total height of a given string.
+ * This value is not generally useful, because you cannot
+ * determine how this total height will be drawn in
+ * relation to the baseline. See gdk_text_extents().
+ *
+ * Return value: the height of the string in pixels.
+ **/
gint
gdk_text_height (GdkFont *font,
const gchar *text,
@@ -167,6 +290,18 @@ gdk_text_height (GdkFont *font,
return ascent + descent;
}
+/**
+ * gdk_char_height:
+ * @font: a #GdkFont
+ * @character: the character to measure.
+ *
+ * Determines the total height of a given character.
+ * This value is not generally useful, because you cannot
+ * determine how this total height will be drawn in
+ * relation to the baseline. See gdk_text_extents().
+ *
+ * Return value: the height of the character in pixels.
+ **/
gint
gdk_char_height (GdkFont *font,
gchar character)
@@ -195,8 +330,21 @@ gdk_font_from_description (PangoFontDescription *font_desc)
return gdk_font_from_description_for_display (gdk_display_get_default (),font_desc);
}
+/**
+ * gdk_font_load:
+ * @font_name: a XLFD describing the font to load.
+ *
+ * Loads a font.
+ *
+ * The font may be newly loaded or looked up the font in a cache.
+ * You should make no assumptions about the initial reference count.
+ *
+ * Return value: a #GdkFont, or %NULL if the font could not be loaded.
+ **/
GdkFont*
gdk_font_load (const gchar *font_name)
{
return gdk_font_load_for_display (gdk_display_get_default(), font_name);
}
+
+
diff --git a/gdk/x11/gdkfont-x11.c b/gdk/x11/gdkfont-x11.c
index b42a83187..adcc2ee0c 100644
--- a/gdk/x11/gdkfont-x11.c
+++ b/gdk/x11/gdkfont-x11.c
@@ -396,6 +396,18 @@ gdk_fontset_load_for_display (GdkDisplay *display,
}
}
+/**
+ * gdk_fontset_load:
+ * @fontset_name: a comma-separated list of XLFDs describing
+ * the component fonts of the fontset to load.
+ *
+ * Loads a fontset.
+ *
+ * The fontset may be newly loaded or looked up in a cache.
+ * You should make no assumptions about the initial reference count.
+ *
+ * Return value: a #GdkFont, or %NULL if the fontset could not be loaded.
+ **/
GdkFont*
gdk_fontset_load (const gchar *fontset_name)
{
@@ -464,6 +476,14 @@ _gdk_font_strlen (GdkFont *font,
return length;
}
+/**
+ * gdk_font_id:
+ * @font: a #GdkFont.
+ *
+ * Returns the X Font ID for the given font.
+ *
+ * Return value: the numeric X Font ID
+ **/
gint
gdk_font_id (const GdkFont *font)
{
@@ -483,6 +503,17 @@ gdk_font_id (const GdkFont *font)
}
}
+/**
+ * gdk_font_equal:
+ * @fonta: a #GdkFont.
+ * @fontb: another #GdkFont.
+ *
+ * Compares two fonts for equality. Single fonts compare equal
+ * if they have the same X font ID. This operation does
+ * not currently work correctly for fontsets.
+ *
+ * Return value: %TRUE if the fonts are equal.
+ **/
gboolean
gdk_font_equal (const GdkFont *fonta,
const GdkFont *fontb)
@@ -515,6 +546,16 @@ gdk_font_equal (const GdkFont *fonta,
return 0;
}
+/**
+ * gdk_text_width:
+ * @font: a #GdkFont
+ * @text: the text to measure.
+ * @text_length: the length of the text in bytes.
+ *
+ * Determines the width of a given string.
+ *
+ * Return value: the width of the string in pixels.
+ **/
gint
gdk_text_width (GdkFont *font,
const gchar *text,
@@ -553,6 +594,16 @@ gdk_text_width (GdkFont *font,
return width;
}
+/**
+ * gdk_text_width_wc:
+ * @font: a #GdkFont
+ * @text: the text to measure.
+ * @text_length: the length of the text in characters.
+ *
+ * Determines the width of a given wide-character string.
+ *
+ * Return value: the width of the string in pixels.
+ **/
gint
gdk_text_width_wc (GdkFont *font,
const GdkWChar *text,
@@ -609,6 +660,21 @@ gdk_text_width_wc (GdkFont *font,
return width;
}
+/**
+ * gdk_text_extents:
+ * @font: a #GdkFont
+ * @text: the text to measure
+ * @text_length: the length of the text in bytes. (If the
+ * font is a 16-bit font, this is twice the length
+ * of the text in characters.)
+ * @lbearing: the left bearing of the string.
+ * @rbearing: the right bearing of the string.
+ * @width: the width of the string.
+ * @ascent: the ascent of the string.
+ * @descent: the descent of the string.
+ *
+ * Returns the metrics of a string.
+ **/
void
gdk_text_extents (GdkFont *font,
const gchar *text,
@@ -678,6 +744,19 @@ gdk_text_extents (GdkFont *font,
}
+/**
+ * gdk_text_extents_wc:
+ * @font: a #GdkFont
+ * @text: the text to measure.
+ * @text_length: the length of the text in character.
+ * @lbearing: the left bearing of the string.
+ * @rbearing: the right bearing of the string.
+ * @width: the width of the string.
+ * @ascent: the ascent of the string.
+ * @descent: the descent of the string.
+ *
+ * Returns the metrics of a string of wide characters.
+ **/
void
gdk_text_extents_wc (GdkFont *font,
const GdkWChar *text,
diff --git a/gdk/x11/gdkim-x11.c b/gdk/x11/gdkim-x11.c
index 4d4624405..263b149f1 100644
--- a/gdk/x11/gdkim-x11.c
+++ b/gdk/x11/gdkim-x11.c
@@ -122,14 +122,18 @@ find_a_display ()
return display;
}
-/*
- * gdk_wcstombs
- *
- * Returns a multi-byte string converted from the specified array
- * of wide characters. The string is newly allocated. The array of
- * wide characters must be null-terminated. If the conversion is
- * failed, it returns NULL.
- */
+/**
+ * gdk_wcstombs:
+ * @src: a wide character string.
+ *
+ * Converts a wide character string to a multi-byte string.
+ * (The function name comes from an acronym of 'Wide Character String TO
+ * Multi-Byte String').
+ *
+ * Return value: the multi-byte string corresponding to @src, or %NULL if the
+ * conversion failed. The returned string should be freed with g_free() when no
+ * longer needed.
+ **/
gchar *
gdk_wcstombs (const GdkWChar *src)
{
@@ -188,14 +192,20 @@ gdk_wcstombs (const GdkWChar *src)
return mbstr;
}
+/**
+ * gdk_mbstowcs:
+ * @dest: the space to place the converted wide character string into.
+ * @src: the multi-byte string to convert, which must be nul-terminated.
+ * @dest_max: the maximum number of wide characters to place in @dest.
+ *
+ * Converts a multi-byte string to a wide character string.
+ * (The function name comes from an acronym of 'Multi-Byte String TO Wide
+ * Character String').
+ *
+ * Return value: the number of wide characters written into @dest, or -1 if
+ * the conversion failed.
+ **/
-/*
- * gdk_mbstowcs
- *
- * Converts the specified string into wide characters, and, returns the
- * number of wide characters written. The string 'src' must be
- * null-terminated. If the conversion is failed, it returns -1.
- */
gint
gdk_mbstowcs (GdkWChar *dest, const gchar *src, gint dest_max)
{