Commit 856a93cb authored by Owen Taylor's avatar Owen Taylor Committed by Owen Taylor

Add gtktextutil.h

Sat Dec 22 18:18:07 2001  Owen Taylor  <otaylor@redhat.com>

        * gtk/Makefile.am (IGNORE_HFILES): Add gtktextutil.h

        * gtk/text_widget.sgml (linkend): SGML fixes.

        * gtk/gtk-sections.txt: Update

        * gdk/gdk-sections.txt: Update.

        * gdk/tmpl/cursors.sgml: SGML fix.

        * gdk/gdk-docs.sgml: Add PNG handling magic.
parent afc1c7c9
Sat Dec 22 18:18:07 2001 Owen Taylor <otaylor@redhat.com>
* gtk/Makefile.am (IGNORE_HFILES): Add gtktextutil.h
* gtk/text_widget.sgml (linkend): SGML fixes.
* gtk/gtk-sections.txt: Update
* gdk/gdk-sections.txt: Update.
* gdk/tmpl/cursors.sgml: SGML fix.
* gdk/gdk-docs.sgml: Add PNG handling magic.
2001-12-21 Matthias Clasen <matthiasc@poet.de>
* gtk/text_widget.sgml: More precise wording. (#63388)
......
......@@ -3,7 +3,7 @@ Reference Counting and Memory Mangement
<!-- ##### SECTION Short_Description ##### -->
Functions for reference counting and memory management on pixbufs.
Functions for reference counting and memory management on pixbufs.
<!-- ##### SECTION Long_Description ##### -->
<para>
......
<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!notation PNG system "PNG">
<!entity % local.notation.class "| PNG">
<!entity gdk-General SYSTEM "sgml/general.sgml">
<!entity gdk-Bitmaps-and-Pixmaps SYSTEM "sgml/pixmaps.sgml">
<!entity gdk-Images SYSTEM "sgml/images.sgml">
......
......@@ -483,6 +483,7 @@ GdkWindowEdge
GdkWindowTypeHint
GdkWindowAttr
GdkWindowAttributesType
GdkScreen
gdk_window_new
gdk_window_destroy
gdk_window_ref
......@@ -527,6 +528,7 @@ gdk_window_end_paint
<SUBSECTION>
gdk_window_invalidate_rect
gdk_window_invalidate_region
gdk_window_invalidate_maybe_recurse
gdk_window_get_update_area
gdk_window_freeze_updates
gdk_window_thaw_updates
......@@ -629,16 +631,35 @@ GdkWindowObjectClass
GdkSelection
GdkSelectionType
GdkTarget
GDK_SELECTION_PRIMARY
GDK_SELECTION_SECONDARY
GDK_SELECTION_CLIPBOARD
GDK_TARGET_BITMAP
GDK_TARGET_COLORMAP
GDK_TARGET_DRAWABLE
GDK_TARGET_PIXMAP
GDK_TARGET_STRING
GDK_SELECTION_TYPE_ATOM
GDK_SELECTION_TYPE_BITMAP
GDK_SELECTION_TYPE_COLORMAP
GDK_SELECTION_TYPE_DRAWABLE
GDK_SELECTION_TYPE_INTEGER
GDK_SELECTION_TYPE_PIXMAP
GDK_SELECTION_TYPE_WINDOW
GDK_SELECTION_TYPE_STRING
gdk_selection_owner_set
gdk_selection_owner_get
gdk_selection_convert
gdk_selection_property_get
gdk_selection_send_notify
</SECTION>
<SECTION>
<TITLE>Properties and Atoms</TITLE>
<FILE>properties</FILE>
GdkAtom
GDK_ATOM_TO_POINTER
GDK_POINTER_TO_ATOM
GDK_NONE
gdk_text_property_to_text_list
gdk_free_text_list
......@@ -726,6 +747,7 @@ gdk_rectangle_get_type
<FILE>threads</FILE>
GDK_THREADS_ENTER
GDK_THREADS_LEAVE
gdk_threads_init
gdk_threads_enter
gdk_threads_leave
gdk_threads_mutex
......@@ -736,7 +758,6 @@ gdk_threads_mutex
<FILE>keys</FILE>
GdkKeymap
GdkKeymapKey
GdkKeyInfo
gdk_keymap_get_default
gdk_keymap_lookup_key
gdk_keymap_translate_keyboard_state
......@@ -1033,6 +1054,10 @@ gdk_x11_image_get_xdisplay
gdk_x11_image_get_ximage
gdk_x11_ungrab_server
gdk_x11_visual_get_xvisual
gdk_x11_atom_to_xatom
gdk_x11_xatom_to_atom
gdk_x11_get_xatom_by_name
gdk_x11_get_xatom_name
<SUBSECTION Private>
gdk_display
......
......@@ -57,7 +57,6 @@ allocated or unallocated color.
@green: The blue component of the color.
@blue: The green component of the color.
<!-- ##### STRUCT GdkColormap ##### -->
<para>
The colormap structure contains the following public fields.
......@@ -71,7 +70,6 @@ The colormap structure contains the following public fields.
back to RGB values. This is only meaningful for
pseudo-color colormaps.
<!-- ##### FUNCTION gdk_colormap_new ##### -->
<para>
Creates a new colormap for the given visual.
......@@ -90,7 +88,7 @@ Creates a new colormap for the given visual.
</para>
@cmap:
@Returns:
@Returns:
<!-- ##### FUNCTION gdk_colormap_unref ##### -->
......
......@@ -76,7 +76,7 @@ The standard cursors available.
@GDK_QUESTION_ARROW: <inlinegraphic format="png" fileref="question_arrow.png"></inlinegraphic>
@GDK_RIGHT_PTR: <inlinegraphic format="png" fileref="right_ptr.png"></inlinegraphic>
@GDK_RIGHT_SIDE: <inlinegraphic format="png" fileref="right_side.png"></inlinegraphic>
@GDK_RIGHT_TEE: <inlinegraphic format="png" fileref="right_tee.png"></inlinegraphic></inlinegraphic>
@GDK_RIGHT_TEE: <inlinegraphic format="png" fileref="right_tee.png"></inlinegraphic>
@GDK_RIGHTBUTTON: <inlinegraphic format="png" fileref="rightbutton.png"></inlinegraphic>
@GDK_RTL_LOGO: <inlinegraphic format="png" fileref="rtl_logo.png"></inlinegraphic>
@GDK_SAILBOAT: <inlinegraphic format="png" fileref="sailboat.png"></inlinegraphic>
......
......@@ -128,7 +128,7 @@ This function is called by the drag source.
@context: a #GdkDragContext.
@dest_window: the new destination window, obtained by gdk_drag_find_window().
@protocol: the DND protocol in use, obtained by gdk_drag_find_window().
@protocol: the DND protocol in use, obtained by gdk_drag_find_window().
@x_root: the x position of the pointer in root coordinates.
@y_root: the y position of the pointer in root coordinates.
@suggested_action: the suggested action.
......@@ -172,9 +172,9 @@ which DND is done.
@GDK_DRAG_PROTO_XDND: The Xdnd protocol.
@GDK_DRAG_PROTO_ROOTWIN: An extension to the Xdnd protocol for
unclaimed root window drops.
@GDK_DRAG_PROTO_NONE: no protocol.
@GDK_DRAG_PROTO_NONE: no protocol.
@GDK_DRAG_PROTO_WIN32_DROPFILES: The simple WM_DROPFILES protocol.
@GDK_DRAG_PROTO_OLE2: The complex OLE2 DND protocol (not implemented).
@GDK_DRAG_PROTO_OLE2: The complex OLE2 DND protocol (not implemented).
@GDK_DRAG_PROTO_LOCAL: Intra-application DND.
<!-- ##### FUNCTION gdk_drag_context_unref ##### -->
......@@ -191,11 +191,11 @@ A <structname>GdkDragContext</structname> holds information about a
drag in progress. It is used on both source and destination sides.
</para>
@parent_instance:
@parent_instance:
@protocol: the DND protocol which governs this drag.
@is_source: %TRUE if the context is used on the source side.
@source_window: the source of this drag.
@dest_window: the destination window of this drag.
@dest_window: the destination window of this drag.
@targets: a list of targets offered by the source.
@actions: a bitmask of actions proposed by the source when
@suggested_action is %GDK_ACTION_ASK.
......@@ -203,7 +203,6 @@ drag in progress. It is used on both source and destination sides.
@action: the action chosen by the destination.
@start_time: a timestamp recording the start time of this drag.
<!-- ##### ENUM GdkDragAction ##### -->
<para>
Used in #GdkDragContext to indicate what the destination
......@@ -211,14 +210,14 @@ should do with the dropped data.
</para>
@GDK_ACTION_DEFAULT:
@GDK_ACTION_COPY: Copy the data.
@GDK_ACTION_COPY: Copy the data.
@GDK_ACTION_MOVE: Move the data, i.e. first copy it, then delete
it from the source using the DELETE target of the X selection protocol.
@GDK_ACTION_LINK: Add a link to the data. Note that this is only
useful if source and destination agree on what it means.
@GDK_ACTION_PRIVATE: Special action which tells the source that the
destination will do something that the source doesn't understand.
@GDK_ACTION_ASK: Ask the user what to do with the data.
@GDK_ACTION_ASK: Ask the user what to do with the data.
<!-- ##### FUNCTION gdk_drag_status ##### -->
<para>
......@@ -233,3 +232,5 @@ gdk_drag_motion() called by the drag source.
@action: the selected action which will be taken when a drop happens,
or 0 to indicate that a drop will not be accepted.
@time: the timestamp for this operation.
......@@ -34,12 +34,6 @@ or a #GdkWindow.
@user_data:
<!-- ##### STRUCT GdkDrawableClass ##### -->
<para>
</para>
<!-- ##### FUNCTION gdk_drawable_ref ##### -->
<para>
......
......@@ -276,7 +276,6 @@ and is reference counted with gdk_font_ref() and gdk_font_unref()
@descent: the maximum distance that the font, when drawn,
descends below the baseline.
<!-- ##### ENUM GdkFontType ##### -->
<para>
Indicates the type of a font. The possible values
......@@ -286,7 +285,6 @@ are currently:
@GDK_FONT_FONT: the font is a single font.
@GDK_FONT_FONTSET: the font is a fontset.
<!-- ##### FUNCTION gdk_font_load ##### -->
<para>
Loads a font.
......
......@@ -44,19 +44,13 @@ elements.
@ts_y_origin:
@colormap:
<!-- ##### STRUCT GdkGCClass ##### -->
<para>
</para>
<!-- ##### STRUCT GdkGCValues ##### -->
<para>
The #GdkGCValues structure holds a set of values used
to create or modify a graphics context.
</para>
@foreground: the foreground color.
@foreground: the foreground color.
@background: the background color.
@font: the default font.
@function: the bitwise operation used when drawing.
......@@ -81,7 +75,7 @@ A set of bit flags used to indicate which fields
#GdkGCValues structure are set.
</para>
@GDK_GC_FOREGROUND: the @foreground is set.
@GDK_GC_FOREGROUND: the @foreground is set.
@GDK_GC_BACKGROUND: the @background is set.
@GDK_GC_FONT: the @font is set.
@GDK_GC_FUNCTION: the @function is set.
......@@ -155,8 +149,8 @@ Create a new GC with the given initial values.
</para>
@gc:
@Returns:
@gc:
@Returns:
<!-- ##### FUNCTION gdk_gc_unref ##### -->
......@@ -164,7 +158,7 @@ Create a new GC with the given initial values.
</para>
@gc:
@gc:
<!-- ##### MACRO gdk_gc_destroy ##### -->
......@@ -173,6 +167,7 @@ Identical to gdk_gc_unref(). This function is obsolete
and should not be used.
</para>
<!-- # Unused Parameters # -->
@gc: a #GdkGC.
......@@ -268,16 +263,16 @@ Set the fill mode for a graphics context.
Determines how primitives are drawn.
</para>
@GDK_SOLID: draw with the foreground color.
@GDK_SOLID: draw with the foreground color.
@GDK_TILED: draw with a tiled pixmap.
@GDK_STIPPLED: draw using the stipple bitmap. Pixels corresponding
to bits in the stipple bitmap that are set will be drawn in the
foreground color; pixels corresponding to bits that are
not set will be left untouched.
not set will be left untouched.
@GDK_OPAQUE_STIPPLED: draw using the stipple bitmap. Pixels corresponding
to bits in the stipple bitmap that are set will be drawn in the
foreground color; pixels corresponding to bits that are
not set will be drawn with the background color.
not set will be drawn with the background color.
<!-- ##### FUNCTION gdk_gc_set_tile ##### -->
<para>
......@@ -410,37 +405,35 @@ explanations of the arguments.
Determines how lines are drawn.
</para>
@GDK_LINE_SOLID: lines are drawn solid.
@GDK_LINE_ON_OFF_DASH: even segments are drawn; odd segments are not drawn.
@GDK_LINE_SOLID: lines are drawn solid.
@GDK_LINE_ON_OFF_DASH: even segments are drawn; odd segments are not drawn.
@GDK_LINE_DOUBLE_DASH: even segments are normally. Odd segments are drawn
in the background color if the fill style is %GDK_SOLID, or in the background
color masked by the stipple if the fill style is %GDK_STIPPLED.
<!-- ##### ENUM GdkCapStyle ##### -->
<para>
Determines how the end of lines are drawn.
</para>
@GDK_CAP_BUTT: the ends of the lines are drawn squared off and extending
to the coordinates of the end point.
@GDK_CAP_NOT_LAST: the same as %GDK_CAP_BUTT for lines of non-zero width.
for zero width lines, the final point on the line will not be drawn.
for zero width lines, the final point on the line will not be drawn.
@GDK_CAP_BUTT: the ends of the lines are drawn squared off and extending
to the coordinates of the end point.
@GDK_CAP_ROUND: the ends of the lines are drawn as semicircles with the
diameter equal to the line width and centered at the end point.
diameter equal to the line width and centered at the end point.
@GDK_CAP_PROJECTING: the ends of the lines are drawn squared off and extending
half the width of the line beyond the end point.
half the width of the line beyond the end point.
<!-- ##### ENUM GdkJoinStyle ##### -->
<para>
Determines how the joins between segments of a polygon are drawn.
</para>
@GDK_JOIN_MITER: the sides of each line are extended to meet at an angle.
@GDK_JOIN_ROUND: the sides of the two lines are joined by a circular arc.
@GDK_JOIN_MITER: the sides of each line are extended to meet at an angle.
@GDK_JOIN_ROUND: the sides of the two lines are joined by a circular arc.
@GDK_JOIN_BEVEL: the sides of the two lines are joined by a straight line which
makes an equal angle with each line.
makes an equal angle with each line.
<!-- ##### FUNCTION gdk_gc_set_dashes ##### -->
<para>
......@@ -453,7 +446,7 @@ be changed with gdk_gc_set_line_attributes())
</para>
@gc: a #GdkGC.
@dash_offset: the
@dash_offset: the
@dash_list: an array of dash lengths.
@n: the number of elements in @dash_list.
......
......@@ -138,59 +138,6 @@ support for internationalized text input.
Input Methods
<!-- ##### SECTION ./tmpl/selections.sgml:Long_Description ##### -->
<para>
The X selection mechanism provides a way to transfer
arbitrary chunks of data between programs.
A <firstterm>selection</firstterm> is a essentially
a named clipboard, identified by a string interned
as a #GdkAtom. By claiming ownership of a selection,
an application indicates that it will be responsible
for supplying its contents. The most common
selections are <literal>PRIMARY</literal> and
<literal>CLIPBOARD</literal>.
</para>
<para>
The contents of a selection can be represented in
a number of formats, called <firstterm>targets</firstterm>.
Each target is identified by an atom. A list of
all possible targets supported by the selection owner
can be retrieved by requesting the special target
<literal>TARGETS</literal>. When a selection is
retrieved, the data is accompanied by a type
(an atom), and a format (an integer, representing
the number of bits per item).
See <link linkend="gdk-Properties-and-Atoms">Properties and Atoms</link>
for more information.
</para>
<para>
The functions in this section only contain the lowlevel
parts of the selection protocol. A considerably more
complicated implementation is needed on top of this.
GTK+ contains such an implementation in the functions
in <literal>gtkselection.h</literal> and programmers
should use those functions instead of the ones presented
here. If you plan to implement selection handling
directly on top of the functions here, you should refer
to the X Inter-client Communication Conventions Manual
(ICCCM).
</para>
<!-- ##### SECTION ./tmpl/selections.sgml:See_Also ##### -->
<para>
</para>
<!-- ##### SECTION ./tmpl/selections.sgml:Short_Description ##### -->
functions for transfering data via the X selection mechanism.
<!-- ##### SECTION ./tmpl/selections.sgml:Title ##### -->
Selections
<!-- ##### MACRO GDK_CORE_POINTER ##### -->
<para>
This macro contains an integer value representing
......@@ -260,6 +207,12 @@ the device ID for the core pointer device.
@GDK_CC_MODE_MY_GRAY:
@GDK_CC_MODE_PALETTE:
<!-- ##### STRUCT GdkDeviceClass ##### -->
<para>
</para>
<!-- ##### STRUCT GdkDeviceInfo ##### -->
<para>
The #GdkDeviceInfo structure contains information about a
......@@ -284,6 +237,18 @@ device. It has the following fields:
which describe what key press events are generated
for each macro button.
<!-- ##### STRUCT GdkDrawableClass ##### -->
<para>
</para>
<!-- ##### STRUCT GdkGCClass ##### -->
<para>
</para>
<!-- ##### STRUCT GdkIC ##### -->
<para>
The #GdkIC struct is an opaque structure representing an input context
......@@ -465,6 +430,21 @@ status information, so the application does not need to do anything.
@GDK_IM_STATUS_NONE: The input method does not display status information.
@GDK_IM_STATUS_MASK: A bit-mask containing all the status flags.
<!-- ##### STRUCT GdkKeyInfo ##### -->
<para>
</para>
@keycode:
@group:
@level:
<!-- ##### STRUCT GdkKeymapClass ##### -->
<para>
</para>
<!-- ##### ENUM GdkPixbufAlphaMode ##### -->
<para>
......
......@@ -237,10 +237,10 @@ Returned by gdk_pointer_grab() and gdk_keyboard_grab() to indicate
success or the reason for the failure of the grab attempt.
</para>
@GDK_GRAB_SUCCESS: the resource was successfully grabbed.
@GDK_GRAB_SUCCESS: the resource was successfully grabbed.
@GDK_GRAB_ALREADY_GRABBED: the resource is actively grabbed by another client.
@GDK_GRAB_INVALID_TIME: the resource was grabbed more recently than the
specified time.
specified time.
@GDK_GRAB_NOT_VIEWABLE: the grab window or the @confine_to window are not
viewable.
@GDK_GRAB_FROZEN: the resource is frozen by an active grab of another client.
......
......@@ -99,7 +99,7 @@ to configure various aspects of the device.
</para>
@parent_instance:
@name: the name of this device.
@name: the name of this device.
@source: the type of this device.
@mode: the mode of this device
@has_cursor: %TRUE if the pointer follows device motion.
......@@ -109,12 +109,6 @@ to configure various aspects of the device.
@keys: an array of #GdkDeviceKey, describing the mapped macro buttons
of this device.
<!-- ##### STRUCT GdkDeviceClass ##### -->
<para>
</para>
<!-- ##### ENUM GdkInputSource ##### -->
<para>
An enumeration describing the type of an input device
......@@ -159,7 +153,7 @@ about the range and mapping of a device axis.
</para>
@use: specifies how the axis is used.
@min: the minimal value that will be reported by this axis.
@min: the minimal value that will be reported by this axis.
@max: the maximal value that will be reported by this axis.
<!-- ##### ENUM GdkAxisUse ##### -->
......@@ -257,9 +251,9 @@ Obtains the motion history for a device.
</para>
@device: a #GdkDevice.
@window: the window wrt. which the event coordinates will be translated.
@start: only return events newer than this timestamp.
@stop: only return events older than this timestamp.
@window: the window wrt. which the event coordinates will be translated.
@start: only return events newer than this timestamp.
@stop: only return events older than this timestamp.
@events: location to return a newly-allocated array of #GdkTimeCoord.
@n_events: location to return the length of @events.
@Returns: %TRUE if the @events were successfully filled.
......
......@@ -91,12 +91,6 @@ in the keymap and see what keyval it corresponds to.
@parent_instance:
<!-- ##### STRUCT GdkKeymapClass ##### -->
<para>
</para>
<!-- ##### STRUCT GdkKeymapKey ##### -->
<para>
A <structname>GdkKeymapKey</structname> is a hardware key that can
......@@ -113,16 +107,7 @@ be mapped to a keyval.
exclamation point ("!") character on it. The level indicates whether to use
the "1" or the "!" symbol. The letter keys are considered to have a lowercase
letter at level 0, and an uppercase letter at level 1, though only the
uppercase letter is printed.
<!-- ##### STRUCT GdkKeyInfo ##### -->
<para>
</para>
@keycode:
@group:
@level:
uppercase letter is printed.
<!-- ##### FUNCTION gdk_keymap_get_default ##### -->
<para>
......
......@@ -40,7 +40,6 @@ rendering the text.
@attr: the #PangoAttribute.
@embossed: the embossed bitmap.
<!-- ##### STRUCT GdkPangoAttrStipple ##### -->
<para>
A Pango text attribute containing a stipple bitmap to be used when
......
......@@ -152,8 +152,9 @@ in which case a default color will be used.
Deprecated equivalent of g_object_ref().
</para>
@pixmap: a #GdkPixmap
@Returns: @pixmap
<!-- # Unused Parameters # -->
@pixmap: a #GdkPixmap
<!-- ##### MACRO gdk_pixmap_unref ##### -->
......@@ -161,6 +162,7 @@ Deprecated equivalent of g_object_ref().
Deprecated equivalent of g_object_unref().
</para>
<!-- # Unused Parameters # -->
@pixmap: a #GdkPixmap
......@@ -180,6 +182,7 @@ Deprecated equivalent of g_object_ref().
</para>
@Returns: @pixmap
<!-- # Unused Parameters # -->
@pixmap: a #GdkBitmap
......@@ -188,6 +191,7 @@ Deprecated equivalent of g_object_ref().
Deprecated equivalent of g_object_unref().
</para>
<!-- # Unused Parameters # -->
@pixmap: a #GdkBitmap
......@@ -49,6 +49,22 @@ of strings on the X server.
</para>
<!-- ##### MACRO GDK_ATOM_TO_POINTER ##### -->
<para>
</para>
@atom:
<!-- ##### MACRO GDK_POINTER_TO_ATOM ##### -->
<para>
</para>
@ptr:
<!-- ##### MACRO GDK_NONE ##### -->
<para>
A null value for #GdkAtom, used in a similar way as <literal>None</literal>
......
......@@ -77,6 +77,118 @@ compatibility with older programs.
</para>
<!-- ##### MACRO GDK_SELECTION_PRIMARY ##### -->
<para>
</para>
<!-- ##### MACRO GDK_SELECTION_SECONDARY ##### -->
<para>
</para>
<!-- ##### MACRO GDK_SELECTION_CLIPBOARD ##### -->
<para>
</para>
<!-- ##### MACRO GDK_TARGET_BITMAP ##### -->
<para>
</para>
<!-- ##### MACRO GDK_TARGET_COLORMAP ##### -->
<para>
</para>
<!-- ##### MACRO GDK_TARGET_DRAWABLE ##### -->
<para>
</para>
<!-- ##### MACRO GDK_TARGET_PIXMAP ##### -->
<para>
</para>
<!-- ##### MACRO GDK_TARGET_STRING ##### -->
<para>
</para>
<!-- ##### MACRO GDK_SELECTION_TYPE_ATOM ##### -->
<para>
</para>
<!-- ##### MACRO GDK_SELECTION_TYPE_BITMAP ##### -->
<para>
</para>
<!-- ##### MACRO GDK_SELECTION_TYPE_COLORMAP ##### -->
<para>
</para>
<!-- ##### MACRO GDK_SELECTION_TYPE_DRAWABLE ##### -->
<para>
</para>
<!-- ##### MACRO GDK_SELECTION_TYPE_INTEGER ##### -->
<para>
</para>
<!-- ##### MACRO GDK_SELECTION_TYPE_PIXMAP ##### -->
<para>
</para>
<!-- ##### MACRO GDK_SELECTION_TYPE_WINDOW ##### -->
<para>
</para>
<!-- ##### MACRO GDK_SELECTION_TYPE_STRING ##### -->
<para>
</para>
<!-- ##### FUNCTION gdk_selection_owner_set ##### -->
<para>
Set the owner of the given selection.
......
......@@ -54,6 +54,13 @@ begun with #GDK_THREADS_ENTER.
<!-- ##### FUNCTION gdk_threads_init ##### -->
<para>