Commit 50ab749f authored by Damon Chaplin's avatar Damon Chaplin Committed by Damon Chaplin
Browse files

ran make templates.

2000-02-02  Damon Chaplin  <damon@karuna.freeserve.co.uk>

        * gdk/tmpl/*.sgml: ran make templates.

        * gdk/gdk-docs.sgml: rearranged sections.

        * gdk/tmpl/events.sgml: documented.

        * gdk/tmpl/general.sgml: documented.

        * gdk/tmpl/rgb.sgml: fixed a few '@' -> '#'.

        * gdk/gdk-sections.txt: rearranged a few bits, including moving
        GdkWChar and related functions from the input method section to the
        font section, and GdkCapStyle etc. from Drawing Primitives to GCs.

        * gdk/tmpl/images.sgml: documented.

        * gdk/tmpl/drawing.sgml: updated.

        * gdk/tmpl/regions.sgml: updated.

        * gdk/tmpl/input_contexts.sgml: documented.

        * gdk/tmpl/input_methods.sgml: documented.

        * gdk/tmpl/selections.sgml: changed xref to a link since Jade says
        a xref to a RefEntry is not supported.
parent d2014471
2000-02-02 Damon Chaplin <damon@karuna.freeserve.co.uk>
* gdk/tmpl/*.sgml: ran make templates.
* gdk/gdk-docs.sgml: rearranged sections.
* gdk/tmpl/events.sgml: documented.
* gdk/tmpl/general.sgml: documented.
* gdk/tmpl/rgb.sgml: fixed a few '@' -> '#'.
* gdk/gdk-sections.txt: rearranged a few bits, including moving
GdkWChar and related functions from the input method section to the
font section, and GdkCapStyle etc. from Drawing Primitives to GCs.
* gdk/tmpl/images.sgml: documented.
* gdk/tmpl/drawing.sgml: updated.
* gdk/tmpl/regions.sgml: updated.
* gdk/tmpl/input_contexts.sgml: documented.
* gdk/tmpl/input_methods.sgml: documented.
* gdk/tmpl/selections.sgml: changed xref to a link since Jade says
a xref to a RefEntry is not supported.
2000-01-19 Damon Chaplin <damon@karuna.freeserve.co.uk>
* gtk/tmpl/gtkscrollbar.sgml: Started.
......
......@@ -870,17 +870,17 @@ GdkImage *image
<FUNCTION>
<NAME>gdk_colormap_new</NAME>
<RETURNS>GdkColormap *</RETURNS>
GdkVisual *visual,gint allocate
GdkVisual *visual,gint allocate
</FUNCTION>
<FUNCTION>
<NAME>gdk_colormap_ref</NAME>
<RETURNS>GdkColormap *</RETURNS>
GdkColormap *cmap
GdkColormap *cmap
</FUNCTION>
<FUNCTION>
<NAME>gdk_colormap_unref</NAME>
<RETURNS>void </RETURNS>
GdkColormap *cmap
GdkColormap *cmap
</FUNCTION>
<FUNCTION>
<NAME>gdk_colormap_get_system</NAME>
......@@ -895,42 +895,42 @@ void
<FUNCTION>
<NAME>gdk_colormap_change</NAME>
<RETURNS>void </RETURNS>
GdkColormap *colormap,gint ncolors
GdkColormap *colormap,gint ncolors
</FUNCTION>
<FUNCTION>
<NAME>gdk_colormap_alloc_colors</NAME>
<RETURNS>gint </RETURNS>
GdkColormap *colormap,GdkColor *colors,gint ncolors,gboolean writeable,gboolean best_match,gboolean *success
GdkColormap *colormap,GdkColor *colors,gint ncolors,gboolean writeable,gboolean best_match,gboolean *success
</FUNCTION>
<FUNCTION>
<NAME>gdk_colormap_alloc_color</NAME>
<RETURNS>gboolean </RETURNS>
GdkColormap *colormap,GdkColor *color,gboolean writeable,gboolean best_match
GdkColormap *colormap,GdkColor *color,gboolean writeable,gboolean best_match
</FUNCTION>
<FUNCTION>
<NAME>gdk_colormap_free_colors</NAME>
<RETURNS>void </RETURNS>
GdkColormap *colormap,GdkColor *colors,gint ncolors
GdkColormap *colormap,GdkColor *colors,gint ncolors
</FUNCTION>
<FUNCTION>
<NAME>gdk_colormap_get_visual</NAME>
<RETURNS>GdkVisual *</RETURNS>
GdkColormap *colormap
<RETURNS>GdkVisual *</RETURNS>
GdkColormap *colormap
</FUNCTION>
<FUNCTION>
<NAME>gdk_color_copy</NAME>
<RETURNS>GdkColor *</RETURNS>
GdkColor *color
<RETURNS>GdkColor *</RETURNS>
GdkColor *color
</FUNCTION>
<FUNCTION>
<NAME>gdk_color_free</NAME>
<RETURNS>void </RETURNS>
GdkColor *color
GdkColor *color
</FUNCTION>
<FUNCTION>
<NAME>gdk_color_parse</NAME>
<RETURNS>gint </RETURNS>
const gchar *spec,GdkColor *color
<RETURNS>gboolean </RETURNS>
const gchar *spec,GdkColor *color
</FUNCTION>
<FUNCTION>
<NAME>gdk_color_hash</NAME>
......@@ -949,7 +949,7 @@ GdkColormap *colormap,GdkColor *colors,gint ncolors
</FUNCTION>
<FUNCTION>
<NAME>gdk_colors_alloc</NAME>
<RETURNS>gint </RETURNS>
<RETURNS>gboolean </RETURNS>
GdkColormap *colormap,gint contiguous,gulong *planes,gint nplanes,gulong *pixels,gint npixels
</FUNCTION>
<FUNCTION>
......@@ -959,22 +959,22 @@ GdkColormap *colormap,gulong *pixels,gint npixels,gulong planes
</FUNCTION>
<FUNCTION>
<NAME>gdk_color_white</NAME>
<RETURNS>gint </RETURNS>
<RETURNS>gboolean </RETURNS>
GdkColormap *colormap,GdkColor *color
</FUNCTION>
<FUNCTION>
<NAME>gdk_color_black</NAME>
<RETURNS>gint </RETURNS>
<RETURNS>gboolean </RETURNS>
GdkColormap *colormap,GdkColor *color
</FUNCTION>
<FUNCTION>
<NAME>gdk_color_alloc</NAME>
<RETURNS>gint </RETURNS>
<RETURNS>gboolean </RETURNS>
GdkColormap *colormap,GdkColor *color
</FUNCTION>
<FUNCTION>
<NAME>gdk_color_change</NAME>
<RETURNS>gint </RETURNS>
<RETURNS>gboolean </RETURNS>
GdkColormap *colormap,GdkColor *color
</FUNCTION>
<FUNCTION>
......
......@@ -32,28 +32,41 @@
<chapter id="gdk">
<title>GDK</title>
&gdk-General;
&gdk-Points-Rectangles-and-Regions;
&gdk-Graphics-Contexts;
&gdk-Drawing-Primitives;
&gdk-Bitmaps-and-Pixmaps;
&gdk-Images;
&gdk-GdkRGB;
&gdk-Images;
&gdk-Colormaps-and-Colors;
&gdk-Fonts;
&gdk-Drawing-Primitives;
&gdk-Graphics-Contexts;
&gdk-Color-Contexts;
&gdk-Visuals;
&gdk-Fonts;
&gdk-Cursors;
&gdk-Windows;
&gdk-Events;
&gdk-Event-Structures;
&gdk-Selections;
&gdk-Drag-and-Drop;
&gdk-Properties-and-Atoms;
&gdk-Input-Methods;
&gdk-Input-Contexts;
&gdk-Color-Contexts;
&gdk-Points-Rectangles-and-Regions;
&gdk-Threads;
&gdk-Key-Values;
&gdk-Input-Devices;
&gdk-Events;
&gdk-Event-Structures;
&gdk-Cursors;
&gdk-Input;
&gdk-Drag-and-Drop;
&gdk-Input-Devices;
&gdk-Key-Values;
&gdk-Input-Methods;
&gdk-Input-Contexts;
</chapter>
</book>
......@@ -7,35 +7,47 @@
gdk_init
gdk_init_check
gdk_exit
GdkStatus
GDK_NONE
GDK_CURRENT_TIME
GDK_PRIORITY_EVENTS
gdk_set_locale
gdk_get_show_events
gdk_set_show_events
gdk_add_client_message_filter
gdk_set_sm_client_id
gdk_get_use_xshm
gdk_set_use_xshm
<SUBSECTION>
gdk_get_display
<SUBSECTION>
gdk_flush
<SUBSECTION>
gdk_screen_width
gdk_screen_height
gdk_screen_width_mm
gdk_screen_height_mm
<SUBSECTION>
gdk_pointer_grab
gdk_pointer_ungrab
gdk_pointer_is_grabbed
<SUBSECTION>
gdk_keyboard_grab
gdk_keyboard_ungrab
gdk_pointer_is_grabbed
gdk_flush
gdk_beep
<SUBSECTION>
gdk_key_repeat_disable
gdk_key_repeat_restore
<SUBSECTION>
gdk_beep
<SUBSECTION>
gdk_get_use_xshm
gdk_set_use_xshm
<SUBSECTION>
gdk_error_trap_push
gdk_error_trap_pop
<SUBSECTION Private>
GdkStatus
gdk_time_get
gdk_timer_get
gdk_timer_set
......@@ -65,13 +77,14 @@ gdk_bitmap_unref
<TITLE>Images</TITLE>
<FILE>images</FILE>
GdkImage
gdk_image_new
GdkImageType
gdk_image_new_bitmap
gdk_image_new
gdk_image_get
gdk_image_destroy
<SUBSECTION>
gdk_image_put_pixel
gdk_image_get_pixel
gdk_image_destroy
</SECTION>
<SECTION>
......@@ -162,16 +175,16 @@ gdk_char_measure
gdk_string_height
gdk_text_height
gdk_char_height
<SUBSECTION>
GdkWChar
gdk_wcstombs
gdk_mbstowcs
</SECTION>
<SECTION>
<TITLE>Drawing Primitives</TITLE>
<FILE>drawing</FILE>
GdkFill
GdkLineStyle
GdkCapStyle
GdkJoinStyle
gdk_draw_point
gdk_draw_points
gdk_draw_line
......@@ -189,8 +202,10 @@ gdk_draw_text_wc
<SUBSECTION>
gdk_draw_pixmap
gdk_draw_bitmap
gdk_draw_image
<SUBSECTION Private>
gdk_draw_bitmap
</SECTION>
<SECTION>
......@@ -213,6 +228,7 @@ gdk_gc_set_background
gdk_gc_set_font
gdk_gc_set_function
gdk_gc_set_fill
GdkFill
gdk_gc_set_tile
gdk_gc_set_stipple
gdk_gc_set_ts_origin
......@@ -224,6 +240,9 @@ gdk_gc_set_subwindow
GdkSubwindowMode
gdk_gc_set_exposures
gdk_gc_set_line_attributes
GdkLineStyle
GdkCapStyle
GdkJoinStyle
gdk_gc_set_dashes
gdk_gc_copy
</SECTION>
......@@ -347,6 +366,7 @@ gdk_selection_send_notify
<TITLE>Properties and Atoms</TITLE>
<FILE>properties</FILE>
GdkAtom
GDK_NONE
gdk_text_property_to_text_list
gdk_free_text_list
gdk_string_to_compound_text
......@@ -363,29 +383,29 @@ gdk_property_delete
<TITLE>Input Methods</TITLE>
<FILE>input_methods</FILE>
GdkIMStyle
GdkWChar
gdk_im_ready
gdk_im_begin
gdk_im_end
gdk_im_decide_style
gdk_im_set_best_style
gdk_wcstombs
gdk_mbstowcs
<SUBSECTION>
gdk_im_begin
gdk_im_end
</SECTION>
<SECTION>
<TITLE>Input Contexts</TITLE>
<FILE>input_contexts</FILE>
GdkIC
GdkICAttr
GdkICAttributesType
gdk_ic_new
gdk_ic_destroy
gdk_ic_get_events
gdk_ic_get_style
gdk_ic_set_attr
gdk_ic_get_attr
gdk_ic_get_events
gdk_ic_set_attr
<SUBSECTION>
GdkICAttr
GdkICAttributesType
gdk_ic_attr_new
gdk_ic_attr_destroy
</SECTION>
......@@ -502,7 +522,10 @@ gdk_input_exit
<FILE>events</FILE>
GdkEventType
GdkEventMask
GDK_CURRENT_TIME
GDK_PRIORITY_EVENTS
<SUBSECTION>
gdk_events_pending
gdk_event_peek
gdk_event_get
......@@ -511,12 +534,19 @@ gdk_event_put
gdk_event_copy
gdk_event_free
gdk_event_get_time
gdk_event_handler_set
gdk_event_send_client_message
<SUBSECTION>
gdk_event_handler_set
GdkEventFunc
<SUBSECTION>
gdk_event_send_client_message
gdk_event_send_clientmessage_toall
gdk_add_client_message_filter
<SUBSECTION>
gdk_get_show_events
gdk_set_show_events
</SECTION>
<SECTION>
......
......@@ -25,100 +25,80 @@ more information.
</para>
<!-- ##### ENUM GdkFill ##### -->
<!-- ##### FUNCTION gdk_draw_point ##### -->
<para>
Used to specify the way in which drawing operations are performed.
See gdk_gc_set_fill().
Draws a point, using the foreground color and other attributes of the #GdkGC.
</para>
@GDK_SOLID: graphics are drawn in a solid color, usually the foreground color
of the #GdkGC.
@GDK_TILED: graphics are drawn using a tile pixmap. See gdk_gc_set_tile().
@GDK_STIPPLED: graphics are drawn with a stipple (a pixmap with a depth of 1).
Bits set in the stipple are drawn in the foreground color. Bits not set in the
stipple are left as they are. See gdk_gc_set_stipple().
@GDK_OPAQUE_STIPPLED: graphics are drawn with a stipple, as in @GDK_STIPPLED,
except that the bits not set in the stipple are drawn in the background color
instead of being left as they are. See gdk_gc_set_stipple().
<!-- ##### ENUM GdkFillRule ##### -->
@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.
<!-- ##### FUNCTION gdk_draw_points ##### -->
<para>
The method for determining which pixels are included in a region, when
creating a #GdkRegion from a polygon.
The fill rule is only relevant for polygons which overlap themselves.
Draws a number of points, using the foreground color and other attributes of
the #GdkGC.
</para>
@GDK_EVEN_ODD_RULE: areas which are overlapped an odd number of times are
included in the region, while areas overlapped an even number of times are not.
@GDK_WINDING_RULE: overlapping areas are always included.
@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.
<!-- ##### ENUM GdkLineStyle ##### -->
<!-- ##### FUNCTION gdk_draw_line ##### -->
<para>
Used to specify how lines are drawn. See gdk_gc_set_line_attributes().
Draws a line, using the foreground color and other attributes of the #GdkGC.
</para>
@GDK_LINE_SOLID: lines are drawn in a solid color, the foreground color.
@GDK_LINE_ON_OFF_DASH: dashed lines are drawn, with the pixels between the
dashes left as they are. The #GdkCapStyle is applied to each end of the dashes.
@GDK_LINE_DOUBLE_DASH: dashed lines are drawn, alternating between the
foreground and background colors. The %GDK_CAP_BUTT style is used where
dashes and gaps meet.
@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.
<!-- ##### ENUM GdkCapStyle ##### -->
<para>
Used to specify how the ends of lines and dashes are drawn.
See gdk_gc_set_line_attributes().
</para>
@GDK_CAP_NOT_LAST: this is equivalent to %GDK_CAP_BUTT, except that for a line
width of 0 the final endpoint is not drawn.
@GDK_CAP_BUTT: the ends of the line are square with no projection beyond the
endpoint.
@GDK_CAP_ROUND: the ends of the line are rounded using a circular arc centered
on the endpoint. This is equivalent to %GDK_CAP_BUTT when the line width is 0.
@GDK_CAP_PROJECTING: the ends of the line are square, but project beyond the
endpoint to a distance of half the line width.
This is equivalent to %GDK_CAP_BUTT when the line width is 0.
<!-- ##### ENUM GdkJoinStyle ##### -->
<!-- ##### FUNCTION gdk_draw_lines ##### -->
<para>
Used to specify how the the joins between lines are drawn.
See gdk_gc_set_line_attributes().
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>
@GDK_JOIN_MITER: the ends of the lines are extended to meet at a point.
If the angle between the lines is less than 11 degrees, %GDK_JOIN_BEVEL is
used instead.
@GDK_JOIN_ROUND: the ends of the lines are rounded with a circular arc
centered on the joinpoint, with a diameter equal to the line width.
@GDK_JOIN_BEVEL: the lines have %GDK_CAP_BUTT cap styles, with the triangular
notch filled.
@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
@gc: a #GdkGC.
@points: an array of #GdkPoint structures specifying the endpoints of the
lines.
@npoints: the size of the @points array.
<!-- ##### FUNCTION gdk_draw_point ##### -->
<!-- ##### FUNCTION gdk_draw_segments ##### -->
<para>
Draws a point, using the foreground color and other attributes of the #GdkGC.
Draws a number of unconnected lines.
</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.
@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.
<!-- ##### FUNCTION gdk_draw_line ##### -->
<!-- ##### STRUCT GdkSegment ##### -->
<para>
Draws a line, using the foreground color and other attributes of the #GdkGC.
Specifies the start and end point of a line for use by the gdk_draw_segments()
function.
</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.
<!-- ##### FUNCTION gdk_draw_rectangle ##### -->
<para>
Draws a rectangular outline or filled rectangle, using the foreground color
......@@ -238,83 +218,22 @@ the right edge of the source pixmap.
to the bottom edge of the source pixmap.
<!-- ##### FUNCTION gdk_draw_bitmap ##### -->
<para>
</para>
@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
@gc:
@src:
@xsrc:
@ysrc:
@xdest:
@ydest:
@width:
@height:
<!-- ##### FUNCTION gdk_draw_image ##### -->
<para>
</para>
@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
@gc:
@image:
@xsrc:
@ysrc:
@xdest:
@ydest:
@width:
@height:
<!-- ##### 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.
<!-- ##### FUNCTION gdk_draw_segments ##### -->
<para>
</para>
@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
@gc:
@segs:
@nsegs:
<!-- ##### STRUCT GdkSegment ##### -->
<para>
</para>
@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().
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.
@points: an array of #GdkPoint structures specifying the endpoints of the
lines.
@npoints: the number of endpoints.
@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.
......@@ -232,6 +232,14 @@ as graphics tablets. It defaults to 0.5.
@time: