Commit eacd03ae authored by Havoc Pennington's avatar Havoc Pennington Committed by Havoc Pennington

Throughout: assorted docs

2001-10-02  Havoc Pennington  <hp@redhat.com>

        Throughout: assorted docs

	* gdk/gdkwindow.h: deprecate gdk_window_set_hints(), it's broken,
	gdk_window_set_geometry_hints() should be used instead.

	* gdk/gdkimage.h: deprecate gdk_image_ref, gdk_image_unref, and
	document them

	* gdk/x11/gdkx.h: remove gdk_get_client_window() since it doesn't
	seem to exist in any .c files

	* gdk/x11/gdkcolor-x11.c (gdk_colormap_query_color): docs,
	g_return_if_fail (pixel < colormap->size).
parent a8d54496
2001-10-02 Havoc Pennington <hp@redhat.com>
Throughout: assorted docs
* gdk/gdkwindow.h: deprecate gdk_window_set_hints(), it's broken,
gdk_window_set_geometry_hints() should be used instead.
* gdk/gdkimage.h: deprecate gdk_image_ref, gdk_image_unref, and
document them
* gdk/x11/gdkx.h: remove gdk_get_client_window() since it doesn't
seem to exist in any .c files
* gdk/x11/gdkcolor-x11.c (gdk_colormap_query_color): docs,
g_return_if_fail (pixel < colormap->size).
Wed Oct 3 10:42:54 2001 Owen Taylor <otaylor@redhat.com>
* gtk/gtkdnd.c (gtk_drag_dest_find_target): Allow
NUOL for @target_list to mean, use
NULL for @target_list to mean, use
gtk_drag_dest_get_target_list (widget).
* gtk/gtkdnd.c (gtk_drag_finish): Fix problem where
......
2001-10-02 Havoc Pennington <hp@redhat.com>
Throughout: assorted docs
* gdk/gdkwindow.h: deprecate gdk_window_set_hints(), it's broken,
gdk_window_set_geometry_hints() should be used instead.
* gdk/gdkimage.h: deprecate gdk_image_ref, gdk_image_unref, and
document them
* gdk/x11/gdkx.h: remove gdk_get_client_window() since it doesn't
seem to exist in any .c files
* gdk/x11/gdkcolor-x11.c (gdk_colormap_query_color): docs,
g_return_if_fail (pixel < colormap->size).
Wed Oct 3 10:42:54 2001 Owen Taylor <otaylor@redhat.com>
* gtk/gtkdnd.c (gtk_drag_dest_find_target): Allow
NUOL for @target_list to mean, use
NULL for @target_list to mean, use
gtk_drag_dest_get_target_list (widget).
* gtk/gtkdnd.c (gtk_drag_finish): Fix problem where
......
2001-10-02 Havoc Pennington <hp@redhat.com>
Throughout: assorted docs
* gdk/gdkwindow.h: deprecate gdk_window_set_hints(), it's broken,
gdk_window_set_geometry_hints() should be used instead.
* gdk/gdkimage.h: deprecate gdk_image_ref, gdk_image_unref, and
document them
* gdk/x11/gdkx.h: remove gdk_get_client_window() since it doesn't
seem to exist in any .c files
* gdk/x11/gdkcolor-x11.c (gdk_colormap_query_color): docs,
g_return_if_fail (pixel < colormap->size).
Wed Oct 3 10:42:54 2001 Owen Taylor <otaylor@redhat.com>
* gtk/gtkdnd.c (gtk_drag_dest_find_target): Allow
NUOL for @target_list to mean, use
NULL for @target_list to mean, use
gtk_drag_dest_get_target_list (widget).
* gtk/gtkdnd.c (gtk_drag_finish): Fix problem where
......
2001-10-02 Havoc Pennington <hp@redhat.com>
Throughout: assorted docs
* gdk/gdkwindow.h: deprecate gdk_window_set_hints(), it's broken,
gdk_window_set_geometry_hints() should be used instead.
* gdk/gdkimage.h: deprecate gdk_image_ref, gdk_image_unref, and
document them
* gdk/x11/gdkx.h: remove gdk_get_client_window() since it doesn't
seem to exist in any .c files
* gdk/x11/gdkcolor-x11.c (gdk_colormap_query_color): docs,
g_return_if_fail (pixel < colormap->size).
Wed Oct 3 10:42:54 2001 Owen Taylor <otaylor@redhat.com>
* gtk/gtkdnd.c (gtk_drag_dest_find_target): Allow
NUOL for @target_list to mean, use
NULL for @target_list to mean, use
gtk_drag_dest_get_target_list (widget).
* gtk/gtkdnd.c (gtk_drag_finish): Fix problem where
......
2001-10-02 Havoc Pennington <hp@redhat.com>
Throughout: assorted docs
* gdk/gdkwindow.h: deprecate gdk_window_set_hints(), it's broken,
gdk_window_set_geometry_hints() should be used instead.
* gdk/gdkimage.h: deprecate gdk_image_ref, gdk_image_unref, and
document them
* gdk/x11/gdkx.h: remove gdk_get_client_window() since it doesn't
seem to exist in any .c files
* gdk/x11/gdkcolor-x11.c (gdk_colormap_query_color): docs,
g_return_if_fail (pixel < colormap->size).
Wed Oct 3 10:42:54 2001 Owen Taylor <otaylor@redhat.com>
* gtk/gtkdnd.c (gtk_drag_dest_find_target): Allow
NUOL for @target_list to mean, use
NULL for @target_list to mean, use
gtk_drag_dest_get_target_list (widget).
* gtk/gtkdnd.c (gtk_drag_finish): Fix problem where
......
2001-10-02 Havoc Pennington <hp@redhat.com>
Throughout: assorted docs
* gdk/gdkwindow.h: deprecate gdk_window_set_hints(), it's broken,
gdk_window_set_geometry_hints() should be used instead.
* gdk/gdkimage.h: deprecate gdk_image_ref, gdk_image_unref, and
document them
* gdk/x11/gdkx.h: remove gdk_get_client_window() since it doesn't
seem to exist in any .c files
* gdk/x11/gdkcolor-x11.c (gdk_colormap_query_color): docs,
g_return_if_fail (pixel < colormap->size).
Wed Oct 3 10:42:54 2001 Owen Taylor <otaylor@redhat.com>
* gtk/gtkdnd.c (gtk_drag_dest_find_target): Allow
NUOL for @target_list to mean, use
NULL for @target_list to mean, use
gtk_drag_dest_get_target_list (widget).
* gtk/gtkdnd.c (gtk_drag_finish): Fix problem where
......
2001-10-02 Havoc Pennington <hp@redhat.com>
Throughout: assorted docs
* gdk/gdkwindow.h: deprecate gdk_window_set_hints(), it's broken,
gdk_window_set_geometry_hints() should be used instead.
* gdk/gdkimage.h: deprecate gdk_image_ref, gdk_image_unref, and
document them
* gdk/x11/gdkx.h: remove gdk_get_client_window() since it doesn't
seem to exist in any .c files
* gdk/x11/gdkcolor-x11.c (gdk_colormap_query_color): docs,
g_return_if_fail (pixel < colormap->size).
Wed Oct 3 10:42:54 2001 Owen Taylor <otaylor@redhat.com>
* gtk/gtkdnd.c (gtk_drag_dest_find_target): Allow
NUOL for @target_list to mean, use
NULL for @target_list to mean, use
gtk_drag_dest_get_target_list (widget).
* gtk/gtkdnd.c (gtk_drag_finish): Fix problem where
......
......@@ -10,6 +10,11 @@ gdk_set_locale
gdk_set_sm_client_id
gdk_exit
<SUBSECTION>
gdk_get_program_class
gdk_set_program_class
<SUBSECTION>
gdk_get_display
......@@ -152,6 +157,8 @@ gdk_image_get
gdk_image_ref
gdk_image_unref
gdk_image_destroy
gdk_image_get_colormap
gdk_image_set_colormap
<SUBSECTION>
gdk_image_put_pixel
gdk_image_get_pixel
......@@ -215,7 +222,9 @@ gdk_pixbuf_render_threshold_alpha
gdk_pixbuf_render_to_drawable
gdk_pixbuf_render_to_drawable_alpha
gdk_pixbuf_render_pixmap_and_mask
gdk_pixbuf_render_pixmap_and_mask_for_colormap
gdk_pixbuf_get_from_drawable
gdk_pixbuf_get_from_image
</SECTION>
<SECTION>
......@@ -407,6 +416,8 @@ gdk_gc_copy
gdk_gc_set_colormap
gdk_gc_get_colormap
gdk_gc_offset
<SUBSECTION Standard>
GDK_GC
GDK_TYPE_GC
......@@ -429,6 +440,7 @@ GDK_TYPE_SUBWINDOW_MODE
<TITLE>Visuals</TITLE>
<FILE>visuals</FILE>
GdkVisual
GdkVisualClass
GdkVisualType
GdkByteOrder
gdk_query_depths
......@@ -449,6 +461,11 @@ gdk_visual_unref
GDK_TYPE_BYTE_ORDER
GDK_TYPE_VISUAL_TYPE
GDK_TYPE_VISUAL
GDK_IS_VISUAL
GDK_IS_VISUAL_CLASS
GDK_VISUAL
GDK_VISUAL_CLASS
GDK_VISUAL_GET_CLASS
<SUBSECTION Private>
gdk_visual_get_type
......@@ -457,16 +474,16 @@ gdk_visual_get_type
<SECTION>
<TITLE>Windows</TITLE>
<FILE>windows</FILE>
GdkWindowAttr
GdkWindow
GdkWindowType
GdkWindowClass
GdkWindowAttributesType
GdkWindowHints
GdkGeometry
GdkGravity
GdkWindowEdge
GdkWindowTypeHint
GdkWindowAttr
GdkWindowAttributesType
gdk_window_new
gdk_window_destroy
gdk_window_ref
......@@ -474,6 +491,7 @@ gdk_window_unref
gdk_window_get_window_type
gdk_window_at_pointer
gdk_window_show
gdk_window_show_unraised
gdk_window_hide
gdk_window_is_visible
gdk_window_is_viewable
......@@ -516,6 +534,7 @@ gdk_window_thaw_updates
gdk_window_process_all_updates
gdk_window_process_updates
gdk_window_set_debug_updates
gdk_window_get_internal_paint_info
<SUBSECTION>
gdk_window_set_user_data
......@@ -571,6 +590,12 @@ GdkWMDecoration
gdk_window_set_functions
GdkWMFunction
gdk_window_get_toplevels
gdk_get_default_root_window
<SUBSECTION>
GdkPointerHooks
gdk_set_pointer_hooks
<SUBSECTION Standard>
GDK_WINDOW
......@@ -697,6 +722,8 @@ gdk_region_spans_intersect_foreach
<SUBSECTION Standard>
GDK_TYPE_OVERLAP_TYPE
GDK_TYPE_RECTANGLE
gdk_rectangle_get_type
</SECTION>
<SECTION>
......@@ -721,6 +748,7 @@ gdk_keymap_lookup_key
gdk_keymap_translate_keyboard_state
gdk_keymap_get_entries_for_keyval
gdk_keymap_get_entries_for_keycode
gdk_keymap_get_direction
<SUBSECTION>
gdk_keyval_name
......@@ -750,6 +778,7 @@ GDK_KEYMAP_GET_CLASS
<TITLE>Input Devices</TITLE>
<FILE>input_devices</FILE>
GdkDevice
GdkDeviceClass
GdkInputSource
GdkInputMode
GdkDeviceKey
......@@ -761,6 +790,7 @@ gdk_device_set_source
gdk_device_set_mode
gdk_device_set_key
gdk_device_set_axis_use
gdk_device_get_core_pointer
<SUBSECTION>
gdk_device_get_state
......@@ -778,6 +808,13 @@ GDK_TYPE_AXIS_USE
GDK_TYPE_EXTENSION_MODE
GDK_TYPE_INPUT_MODE
GDK_TYPE_INPUT_SOURCE
GDK_DEVICE
GDK_DEVICE_CLASS
GDK_DEVICE_GET_CLASS
GDK_IS_DEVICE
GDK_IS_DEVICE_CLASS
GDK_TYPE_DEVICE
gdk_device_get_type
<SUBSECTION Private>
GDK_MAX_TIMECOORD_AXES
......@@ -804,6 +841,8 @@ gdk_event_free
gdk_event_get_time
gdk_event_get_state
gdk_event_get_axis
gdk_event_get_coords
gdk_event_get_root_coords
<SUBSECTION>
gdk_event_handler_set
......@@ -888,6 +927,8 @@ gdk_cursor_destroy
<SUBSECTION Standard>
GDK_TYPE_CURSOR_TYPE
GDK_TYPE_CURSOR
gdk_cursor_get_type
</SECTION>
<SECTION>
......@@ -961,6 +1002,8 @@ GDK_COLORMAP_XCOLORMAP
GDK_VISUAL_XVISUAL
GDK_FONT_XDISPLAY
GDK_FONT_XFONT
GDK_CURSOR_XCURSOR
GDK_CURSOR_XDISPLAY
GDK_GC_XGC
GDK_GC_GET_XGC
GDK_WINDOW_XWINDOW
......@@ -980,6 +1023,25 @@ gdk_pixmap_lookup
gdk_font_lookup
gdk_x11_get_server_time
gdk_net_wm_supports
gdk_x11_colormap_get_xcolormap
gdk_x11_colormap_get_xdisplay
gdk_x11_cursor_get_xcursor
gdk_x11_cursor_get_xdisplay
gdk_x11_drawable_get_xdisplay
gdk_x11_drawable_get_xid
gdk_x11_font_get_name
gdk_x11_font_get_xdisplay
gdk_x11_font_get_xfont
gdk_x11_gc_get_xdisplay
gdk_x11_gc_get_xgc
gdk_x11_get_default_root_xwindow
gdk_x11_get_default_screen
gdk_x11_get_default_xdisplay
gdk_x11_grab_server
gdk_x11_image_get_xdisplay
gdk_x11_image_get_ximage
gdk_x11_ungrab_server
gdk_x11_visual_get_xvisual
<SUBSECTION Private>
GDK_TYPE_GC_X11
......
......@@ -30,11 +30,11 @@ The standard cursors available.
<!-- ##### FUNCTION gdk_cursor_new ##### -->
<para>
Creates a new standard cursor.
</para>
@cursor_type: the type of the cursor.
@Returns: a new #GdkCursor.
@cursor_type:
@Returns:
<!-- ##### FUNCTION gdk_cursor_new_from_pixmap ##### -->
......
......@@ -249,6 +249,28 @@ no timestamp.
@Returns:
<!-- ##### FUNCTION gdk_event_get_coords ##### -->
<para>
</para>
@event:
@x_win:
@y_win:
@Returns:
<!-- ##### FUNCTION gdk_event_get_root_coords ##### -->
<para>
</para>
@event:
@x_root:
@y_root:
@Returns:
<!-- ##### FUNCTION gdk_event_handler_set ##### -->
<para>
Sets the function to call to handle all events from GDK.
......
......@@ -700,3 +700,13 @@ onto another graphics context.
@Returns:
<!-- ##### FUNCTION gdk_gc_offset ##### -->
<para>
</para>
@gc:
@x_offset:
@y_offset:
......@@ -557,6 +557,15 @@ status information, so the application does not need to do anything.
</para>
<!-- ##### FUNCTION gdk_get_client_window ##### -->
<para>
</para>
@dpy:
@win:
@Returns:
<!-- ##### FUNCTION gdk_ic_attr_destroy ##### -->
<para>
Destroys the given #GdkICAttr struct, freeing the allocated memory.
......
......@@ -113,6 +113,22 @@ of g_atexit()).
@error_code: the error code to pass to the exit() call.
<!-- ##### FUNCTION gdk_get_program_class ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gdk_set_program_class ##### -->
<para>
</para>
@program_class:
<!-- ##### FUNCTION gdk_get_display ##### -->
<para>
Gets the name of the display, which usually comes from the DISPLAY
......
......@@ -159,6 +159,24 @@ Destroys a #GdkImage, freeing any resources allocated for it.
@image: a #GdkImage.
<!-- ##### FUNCTION gdk_image_get_colormap ##### -->
<para>
</para>
@image:
@Returns:
<!-- ##### FUNCTION gdk_image_set_colormap ##### -->
<para>
</para>
@image:
@colormap:
<!-- ##### FUNCTION gdk_image_put_pixel ##### -->
<para>
Sets a pixel in a #GdkImage to a given pixel value.
......
......@@ -106,6 +106,12 @@ sets of additional valuators than the pressure xtilt and ytilt.
@num_keys:
@keys:
<!-- ##### STRUCT GdkDeviceClass ##### -->
<para>
</para>
<!-- ##### ENUM GdkInputSource ##### -->
<para>
An enumeration describing the type of an input device
......@@ -216,6 +222,14 @@ types that GTK+ understands.
@use:
<!-- ##### FUNCTION gdk_device_get_core_pointer ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gdk_device_get_state ##### -->
<para>
......
......@@ -169,6 +169,15 @@ gdk_keymap_translate_keyboard_state() just to get the keyval.
@Returns:
<!-- ##### FUNCTION gdk_keymap_get_direction ##### -->
<para>
</para>
@keymap:
@Returns:
<!-- ##### FUNCTION gdk_keyval_name ##### -->
<para>
Converts a key value into a symbolic name.
......
......@@ -80,6 +80,18 @@ Pixbufs
@alpha_threshold:
<!-- ##### FUNCTION gdk_pixbuf_render_pixmap_and_mask_for_colormap ##### -->
<para>
</para>
@pixbuf:
@colormap:
@pixmap_return:
@mask_return:
@alpha_threshold:
<!-- ##### FUNCTION gdk_pixbuf_get_from_drawable ##### -->
<para>
......@@ -97,3 +109,20 @@ Pixbufs
@Returns:
<!-- ##### FUNCTION gdk_pixbuf_get_from_image ##### -->
<para>
</para>
@dest:
@src:
@cmap:
@src_x:
@src_y:
@dest_x:
@dest_y:
@width:
@height:
@Returns:
......@@ -58,7 +58,7 @@ main (int argc, char *argv[])
window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
darea = gtk_drawing_area_new ();
gtk_widget_set_usize (darea, IMAGE_WIDTH, IMAGE_HEIGHT);
gtk_widget_set_size_request (darea, IMAGE_WIDTH, IMAGE_HEIGHT);
gtk_container_add (GTK_CONTAINER (window), darea);
gtk_signal_connect (GTK_OBJECT (darea), "expose-event",
GTK_SIGNAL_FUNC (on_darea_expose), NULL);
......
......@@ -3,23 +3,37 @@ Visuals
<!-- ##### SECTION Short_Description ##### -->
Low-level display hardware information
<!-- ##### SECTION Long_Description ##### -->
<para>
A #GdkVisual describes a particular video hardware display format. For example,
a piece of display hardware might support 24-bit color, 16-bit color, or 8-bit
color; meaning 24/16/8-bit pixel sizes. For a given pixel size, pixels can be in
different formats; for example the "red" element of an RGB pixel may be in the
top 8 bits of the pixel, or may be in the lower 4 bits.
</para>
<para>
Usually you can avoid thinking about visuals in GTK+. Visuals are useful to
interpret the contents of a #GdkImage, but you should avoid #GdkImage precisely
because its contents depend on the display hardware; use #GdkPixbuf instead, for
all but the most low-level purposes. Also, anytime you provide a #GdkColormap,
the visual is implied as part of the colormap (gdk_colormap_get_visual()), so
you won't have to provide a visual in addition.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GdkImage, #GdkColormap
</para>
<!-- ##### STRUCT GdkVisual ##### -->
<para>
Description of an image data format
</para>
@parent_instance:
@parent_instance: inherited portion from #GObject
@type:
@depth:
@byte_order:
......@@ -35,6 +49,12 @@ Visuals
@blue_shift:
@blue_prec:
<!-- ##### STRUCT GdkVisualClass ##### -->
<para>
</para>
<!-- ##### ENUM GdkVisualType ##### -->
<para>
......@@ -143,22 +163,18 @@ Visuals
<!-- ##### MACRO gdk_visual_ref ##### -->
<para>
Deprecated equivalent of g_object_ref().
</para>
@v:
@Returns:
<!-- # Unused Parameters # -->
@visual:
<!-- ##### MACRO gdk_visual_unref ##### -->
<para>
Deprecated equivalent of g_object_unref().
</para>
@v:
<!-- # Unused Parameters # -->
@visual:
......@@ -3,10 +3,15 @@ Windows
<!-- ##### SECTION Short_Description ##### -->
onscreen display areas in the target window system
<!-- ##### SECTION Long_Description ##### -->
<para>
A #GdkWindow is a rectangular region on the screen. It's a low-level object,
used to implement high-level objects such as #GtkWidget and #GtkWindow on the
GTK+ level. A #GtkWindow is a toplevel window, the thing a user might think of
as a "window" with a titlebar and so on; a #GtkWindow may contain many #GdkWindow.
For example, each #GtkButton has a #GdkWindow associated with it.
</para>
<!-- ##### SECTION See_Also ##### -->
......@@ -14,66 +19,34 @@ Windows
</para>
<!-- ##### STRUCT GdkWindowAttr ##### -->
<para>
</para>
@title:
@event_mask:
@x:
@y:
@width:
@height:
@wclass:
@visual:
@colormap:
@window_type:
@cursor:
@wmclass_name:
@wmclass_class:
@override_redirect:
<!-- ##### STRUCT GdkWindow ##### -->
<para>
</para>