diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 9bc1eb5c2b..8c1f0285bd 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,21 @@ +2005-05-08 Matthias Clasen + + * gdk/Makefile.am (IGNORE_HFILES): Add keyname-table.h + + * gdk/gdk-sections.txt: Add gdk_cairo_set_source_color, + gdk_drawable_create_cairo_context and + gdk_pixbuf_set_as_cairo_source, remove + gdk_draw_rectangle_alpha_libgtk_only + + * gdk/tmpl/pixbufs.sgml: + * gdk/tmpl/cursors.sgml: Add long descriptions. + + * gdk/tmpl/events.sgml: + * gdk/tmpl/dnd.sgml: + * gdk/tmpl/windows.sgml: + * gdk/tmpl/pixmaps.sgml: + * gdk/tmpl/x_interaction.sgml: Small additions. + 2005-05-07 Matthias Clasen * gdk/tmpl/pango_interaction.sgml: Fix a reference. diff --git a/docs/reference/gdk/Makefile.am b/docs/reference/gdk/Makefile.am index 92b2cfd277..7600c9820c 100644 --- a/docs/reference/gdk/Makefile.am +++ b/docs/reference/gdk/Makefile.am @@ -28,6 +28,7 @@ IGNORE_HFILES= \ gdkprivate.h \ gdkpoly-generic.h \ gdkregion-generic.h \ + keyname-table.h \ linux-fb \ nanox \ win32 \ diff --git a/docs/reference/gdk/gdk-sections.txt b/docs/reference/gdk/gdk-sections.txt index cbba5c3b23..10f911d383 100644 --- a/docs/reference/gdk/gdk-sections.txt +++ b/docs/reference/gdk/gdk-sections.txt @@ -343,6 +343,7 @@ gdk_pixbuf_render_pixmap_and_mask gdk_pixbuf_render_pixmap_and_mask_for_colormap gdk_pixbuf_get_from_drawable gdk_pixbuf_get_from_image +gdk_pixbuf_set_as_cairo_source
@@ -374,6 +375,7 @@ gdk_color_alloc gdk_color_change gdk_color_equal gdk_color_hash +gdk_cairo_set_source_color GDK_COLORMAP @@ -453,6 +455,7 @@ gdk_drawable_get_depth gdk_drawable_get_size gdk_drawable_get_clip_region gdk_drawable_get_visible_region +gdk_drawable_create_cairo_context gdk_draw_point @@ -496,7 +499,6 @@ GDK_IS_DRAWABLE_CLASS GdkDrawableClass gdk_draw_bitmap -gdk_draw_rectangle_alpha_libgtk_only
diff --git a/docs/reference/gdk/tmpl/cursors.sgml b/docs/reference/gdk/tmpl/cursors.sgml index eb4442a109..7f12bd92ba 100644 --- a/docs/reference/gdk/tmpl/cursors.sgml +++ b/docs/reference/gdk/tmpl/cursors.sgml @@ -6,7 +6,21 @@ Standard and pixmap cursors - +These functions are used to create and destroy cursors. +There is a number of standard cursors, but it is also +possible to construct new cursors from pixmaps and +pixbufs. There may be limitations as to what kinds of +cursors can be constructed on a given display, see +gdk_display_supports_cursor_alpha(), +gdk_display_supports_cursor_color(), +gdk_display_get_default_cursor_size() and +gdk_display_get_maximal_cursor_size(). + + +Cursors by themselves are not very interesting, they must be be +bound to a window for users to see them. This is done with +gdk_window_set_cursor() or by setting the cursor member of the +#GdkWindowAttr struct passed to gdk_window_new(). @@ -14,13 +28,15 @@ Standard and pixmap cursors + + + A GdkCursor structure represents a cursor. -@type: -@ref_count: +@type: the #GdkCursorType of the cursor @@ -104,9 +120,9 @@ The standard cursors available. @GDK_UR_ANGLE: @GDK_WATCH: @GDK_XTERM: -@GDK_LAST_CURSOR: +@GDK_LAST_CURSOR: last cursor type @GDK_CURSOR_IS_PIXMAP: type of cursors constructed with - gdk_cursor_new_from_pixmap(). +gdk_cursor_new_from_pixmap() or gdk_cursor_new_from_pixbuf() diff --git a/docs/reference/gdk/tmpl/dnd.sgml b/docs/reference/gdk/tmpl/dnd.sgml index 4dfdcc0513..9ab6a702c8 100644 --- a/docs/reference/gdk/tmpl/dnd.sgml +++ b/docs/reference/gdk/tmpl/dnd.sgml @@ -22,6 +22,9 @@ the GTK+ documentation for more information. + + + @@ -194,7 +197,7 @@ Used in #GdkDragContext to indicate what the destination should do with the dropped data. -@GDK_ACTION_DEFAULT: +@GDK_ACTION_DEFAULT: Means nothing, and should not be used. @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. diff --git a/docs/reference/gdk/tmpl/events.sgml b/docs/reference/gdk/tmpl/events.sgml index 941c4e5cea..2922f73499 100644 --- a/docs/reference/gdk/tmpl/events.sgml +++ b/docs/reference/gdk/tmpl/events.sgml @@ -27,6 +27,9 @@ The structs used for each type of event. + + + Specifies the type of the event. @@ -81,9 +84,10 @@ has changed. @GDK_VISIBILITY_NOTIFY: the window visibility status has changed. @GDK_NO_EXPOSE: indicates that the source region was completely available when parts of a drawable were copied. This is not very useful. -@GDK_SCROLL: -@GDK_WINDOW_STATE: -@GDK_SETTING: +@GDK_SCROLL: the scroll wheel was turned +@GDK_WINDOW_STATE: the state of a window has changed. See #GdkWindowState +for the possible window states +@GDK_SETTING: a setting has been modified. @GDK_OWNER_CHANGE: the owner of a selection has changed. This event type was added in 2.6 diff --git a/docs/reference/gdk/tmpl/pixbufs.sgml b/docs/reference/gdk/tmpl/pixbufs.sgml index e1b5547dd1..0098118e3e 100644 --- a/docs/reference/gdk/tmpl/pixbufs.sgml +++ b/docs/reference/gdk/tmpl/pixbufs.sgml @@ -6,7 +6,9 @@ Functions for rendering pixbufs on drawables - +These functions allow to render pixbufs on drawables. Pixbufs are +client-side images. For details on how to create and manipulate +pixbufs, see the #GdkPixbuf API documentation. @@ -14,6 +16,9 @@ Functions for rendering pixbufs on drawables + + + @@ -126,3 +131,14 @@ Functions for rendering pixbufs on drawables @Returns: + + + + + +@pixbuf: +@cr: +@pixbuf_x: +@pixbuf_y: + + diff --git a/docs/reference/gdk/tmpl/pixmaps.sgml b/docs/reference/gdk/tmpl/pixmaps.sgml index 18463f6503..5ea7f8aac8 100644 --- a/docs/reference/gdk/tmpl/pixmaps.sgml +++ b/docs/reference/gdk/tmpl/pixmaps.sgml @@ -18,6 +18,9 @@ pixel can be either on or off). + + + An opaque structure representing an offscreen drawable. diff --git a/docs/reference/gdk/tmpl/windows.sgml b/docs/reference/gdk/tmpl/windows.sgml index e3d1de59a3..0850dd8208 100644 --- a/docs/reference/gdk/tmpl/windows.sgml +++ b/docs/reference/gdk/tmpl/windows.sgml @@ -18,6 +18,9 @@ For example, each #GtkButton has a #GdkWindow associated with it. + + + An opaque structure representing an onscreen drawable. @@ -273,7 +276,7 @@ corresponding flag in #GdkWindowAttributesType. Deprecated equivalent of g_object_ref() -@Returns: +@Returns: the window @@ -1075,7 +1078,7 @@ Deprecated equivalent of gdk_drawable_get_size(). Deprecated equivalent of gdk_drawable_get_visual(). -@Returns: +@Returns: the #GdkVisual of the window diff --git a/docs/reference/gdk/tmpl/x_interaction.sgml b/docs/reference/gdk/tmpl/x_interaction.sgml index 82ab674858..a04ac0e8cc 100644 --- a/docs/reference/gdk/tmpl/x_interaction.sgml +++ b/docs/reference/gdk/tmpl/x_interaction.sgml @@ -14,6 +14,9 @@ X backend-specific functions + + + Obtains the Xlib window id of the root window of the current screen. @@ -59,10 +62,8 @@ Returns the X window belonging to a #GdkWindow. Returns the display of a #GdkPixmap. -@pix: +@pix: a #GdkPixmap. @Returns: an Xlib Display*. - -@win: a #GdkPixmap. @@ -70,10 +71,8 @@ Returns the display of a #GdkPixmap. Returns the X pixmap belonging to a #GdkPixmap. -@pix: +@pix: a #GdkPixmap. @Returns: the Xlib XPixmap of @win. - -@win: a #GdkPixmap.