summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMatthias Clasen <matthiasc@src.gnome.org>2005-06-30 03:21:25 +0000
committerMatthias Clasen <matthiasc@src.gnome.org>2005-06-30 03:21:25 +0000
commit546e045ccf7438cdf931482a2e27b97bb24002fe (patch)
treec48421a1de68254eedd174e9172d9077c2e2df09 /docs
parent15fd38a033d792dffc5b64c5507058ddbb0d7a0d (diff)
downloadgdk-pixbuf-546e045ccf7438cdf931482a2e27b97bb24002fe.tar.gz
Updates
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/ChangeLog14
-rw-r--r--docs/reference/gdk/tmpl/cairo_interaction.sgml12
-rw-r--r--docs/reference/gdk/tmpl/dnd.sgml2
-rw-r--r--docs/reference/gdk/tmpl/event_structs.sgml8
-rw-r--r--docs/reference/gdk/tmpl/events.sgml53
-rw-r--r--docs/reference/gdk/tmpl/images.sgml6
-rw-r--r--docs/reference/gdk/tmpl/input_devices.sgml2
-rw-r--r--docs/reference/gdk/tmpl/visuals.sgml6
-rw-r--r--docs/reference/gdk/tmpl/windows.sgml35
-rw-r--r--docs/reference/gtk/Makefile.am1
-rw-r--r--docs/reference/gtk/gtk-sections.txt4
-rw-r--r--docs/reference/gtk/tmpl/gtkstock.sgml32
12 files changed, 125 insertions, 50 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 14b0d60c6..c294850de 100644
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,17 @@
+2005-06-29 Matthias Clasen <mclasen@redhat.com>
+
+ * gdk/tmpl/images.sgml:
+ * gdk/tmpl/dnd.sgml:
+ * gdk/tmpl/events.sgml:
+ * gdk/tmpl/windows.sgml:
+ * gdk/tmpl/visuals.sgml:
+ * gdk/tmpl/cairo_interaction.sgml:
+ * gdk/tmpl/event_structs.sgml:
+ * gdk/tmpl/input_devices.sgml:
+ * gtk/gtk-sections.txt:
+ * gtk/Makefile.am (IGNORE_HFILES):
+ * gtk/tmpl/gtkstock.sgml: Updates.
+
2005-06-28 Ross Burton <ross@burtonini.com>
* gtk/tmpl/gtkcomboboxentry.sgml: Clarify.
diff --git a/docs/reference/gdk/tmpl/cairo_interaction.sgml b/docs/reference/gdk/tmpl/cairo_interaction.sgml
index 624b5e71b..1d6b3bfdc 100644
--- a/docs/reference/gdk/tmpl/cairo_interaction.sgml
+++ b/docs/reference/gdk/tmpl/cairo_interaction.sgml
@@ -2,11 +2,21 @@
Cairo Interaction
<!-- ##### SECTION Short_Description ##### -->
-
+Functions to support using Cairo
<!-- ##### SECTION Long_Description ##### -->
<para>
+<link href="http://cairographics.org">Cairo</link> is a graphics
+library that supports vector graphics and image compositing that
+can be used with GDK. Since 2.8, GTK+ does most of its drawing
+using Cairo.
+</para>
+<para>
+GDK does not wrap the Cairo API, instead it allows to create Cairo
+contexts which can be used to draw on GDK drawables. Additional
+functions allow to convert GDK's rectangles and regions into
+Cairo paths and to use pixbufs as sources for drawing operations.
</para>
<!-- ##### SECTION See_Also ##### -->
diff --git a/docs/reference/gdk/tmpl/dnd.sgml b/docs/reference/gdk/tmpl/dnd.sgml
index 9ab6a702c..b3c360d6e 100644
--- a/docs/reference/gdk/tmpl/dnd.sgml
+++ b/docs/reference/gdk/tmpl/dnd.sgml
@@ -179,7 +179,7 @@ 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: the 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.
diff --git a/docs/reference/gdk/tmpl/event_structs.sgml b/docs/reference/gdk/tmpl/event_structs.sgml
index ed81d237d..91f0c8f7e 100644
--- a/docs/reference/gdk/tmpl/event_structs.sgml
+++ b/docs/reference/gdk/tmpl/event_structs.sgml
@@ -429,15 +429,17 @@ only available if the X server supports the XFIXES extension.
Generated when a pointer or keyboard grab is broken. On X11, this happens
when the grab window becomes unviewable (i.e. it or one of its ancestors
is unmapped), or if the same application grabs the pointer or keyboard
-again.
+again. Note that implicit grabs (which are initiated by button presses)
+can also cause #GdkEventGrabBroken events.
</para>
-@type: the type of the event (%GDK_GRAB_BROKEN)
+@type: the type of the event (%GDK_GRAB_BROKEN)
@window: the window which received the event, i.e. the window
that previously owned the grab
@send_event: %TRUE if the event was sent explicitly (e.g. using <function>XSendEvent</function>).
@keyboard: %TRUE if a keyboard grab was broken, %FALSE if a pointer
grab was broken
+@implicit: %TRUE if the broken grab was implicit
@grab_window: If this event is caused by another grab in the same
application, @grab_window contains the new grab window. Otherwise
@grab_window id %NULL.
@@ -492,7 +494,7 @@ full details of crossing event generation.
which are not ancestors of each other and the window is part of
the ancestor chain between one of these windows and their least
common ancestor.
-@GDK_NOTIFY_UNKNOWN:
+@GDK_NOTIFY_UNKNOWN: an unknown type of enter/leave event occurred.
<!-- ##### ENUM GdkPropertyState ##### -->
<para>
diff --git a/docs/reference/gdk/tmpl/events.sgml b/docs/reference/gdk/tmpl/events.sgml
index b1eb7bcf4..fea13493e 100644
--- a/docs/reference/gdk/tmpl/events.sgml
+++ b/docs/reference/gdk/tmpl/events.sgml
@@ -105,32 +105,33 @@ number of %GDK_MOTION_NOTIFY events received. Normally a %GDK_MOTION_NOTIFY
event is received each time the mouse moves. However, if the application
spends a lot of time processing the event (updating the display, for example),
it can easily lag behind the position of the mouse. When using the
-%GDK_POINTER_MOTION_HINT_MASK the server will only send a single %GDK_MOTION_NOTIFY
-event (which is marked as a hint) until the application asks for more, by calling
-gdk_window_get_pointer().
-</para>
-
-@GDK_EXPOSURE_MASK:
-@GDK_POINTER_MOTION_MASK:
-@GDK_POINTER_MOTION_HINT_MASK:
-@GDK_BUTTON_MOTION_MASK:
-@GDK_BUTTON1_MOTION_MASK:
-@GDK_BUTTON2_MOTION_MASK:
-@GDK_BUTTON3_MOTION_MASK:
-@GDK_BUTTON_PRESS_MASK:
-@GDK_BUTTON_RELEASE_MASK:
-@GDK_KEY_PRESS_MASK:
-@GDK_KEY_RELEASE_MASK:
-@GDK_ENTER_NOTIFY_MASK:
-@GDK_LEAVE_NOTIFY_MASK:
-@GDK_FOCUS_CHANGE_MASK:
-@GDK_STRUCTURE_MASK:
-@GDK_PROPERTY_CHANGE_MASK:
-@GDK_VISIBILITY_NOTIFY_MASK:
-@GDK_PROXIMITY_IN_MASK:
-@GDK_PROXIMITY_OUT_MASK:
-@GDK_SUBSTRUCTURE_MASK:
-@GDK_SCROLL_MASK:
+%GDK_POINTER_MOTION_HINT_MASK the server will only send a single
+%GDK_MOTION_NOTIFY event (which is marked as a hint) until the application
+asks for more, by calling gdk_window_get_pointer().
+</para>
+
+@GDK_EXPOSURE_MASK: receive expose events
+@GDK_POINTER_MOTION_MASK: receive all pointer motion events
+@GDK_POINTER_MOTION_HINT_MASK: see the explanation above
+@GDK_BUTTON_MOTION_MASK: receive pointer motion events while any button is pressed
+@GDK_BUTTON1_MOTION_MASK: receive pointer motion events while 1 button is pressed
+@GDK_BUTTON2_MOTION_MASK: receive pointer motion events while 2 button is pressed
+@GDK_BUTTON3_MOTION_MASK: receive pointer motion events while 3 button is pressed
+@GDK_BUTTON_PRESS_MASK: receive button press events
+@GDK_BUTTON_RELEASE_MASK: receive button release events
+@GDK_KEY_PRESS_MASK: receive key press events
+@GDK_KEY_RELEASE_MASK: receive key release events
+@GDK_ENTER_NOTIFY_MASK: receive window enter events
+@GDK_LEAVE_NOTIFY_MASK: receive window leave events
+@GDK_FOCUS_CHANGE_MASK: receive focus change events
+@GDK_STRUCTURE_MASK: receive events about window configuration change
+@GDK_PROPERTY_CHANGE_MASK: receive property change events
+@GDK_VISIBILITY_NOTIFY_MASK: receive visibility change events
+@GDK_PROXIMITY_IN_MASK: receive proximity in events
+@GDK_PROXIMITY_OUT_MASK: receive proximity out events
+@GDK_SUBSTRUCTURE_MASK: receive events about window configuration changes of
+ child windows
+@GDK_SCROLL_MASK: receive scroll events
@GDK_ALL_EVENTS_MASK: the combination of all the above event masks.
<!-- ##### MACRO GDK_CURRENT_TIME ##### -->
diff --git a/docs/reference/gdk/tmpl/images.sgml b/docs/reference/gdk/tmpl/images.sgml
index 045510a1d..5ac5b0f3b 100644
--- a/docs/reference/gdk/tmpl/images.sgml
+++ b/docs/reference/gdk/tmpl/images.sgml
@@ -63,7 +63,7 @@ displays.
The #GdkImage struct contains information on the image and the pixel data.
</para>
-@parent_instance:
+@parent_instance: the parent instance
@type: the type of the image.
@visual: the visual.
@byte_order: the byte order.
@@ -72,9 +72,9 @@ The #GdkImage struct contains information on the image and the pixel data.
@depth: the depth of the image, i.e. the number of bits per pixel.
@bpp: the number of bytes per pixel.
@bpl: the number of bytes per line of the image.
-@bits_per_pixel:
+@bits_per_pixel: the number of bits per pixel.
@mem: the pixel data.
-@colormap:
+@colormap: the #GdkColormap associated with the image
<!-- ##### FUNCTION gdk_image_new ##### -->
<para>
diff --git a/docs/reference/gdk/tmpl/input_devices.sgml b/docs/reference/gdk/tmpl/input_devices.sgml
index da462324f..21a2fa137 100644
--- a/docs/reference/gdk/tmpl/input_devices.sgml
+++ b/docs/reference/gdk/tmpl/input_devices.sgml
@@ -101,7 +101,7 @@ gdk_device_set_mode(), gdk_device_set_key() and gdk_device_set_axis_use()
to configure various aspects of the device.
</para>
-@parent_instance:
+@parent_instance: the parent instance
@name: the name of this device.
@source: the type of this device.
@mode: the mode of this device
diff --git a/docs/reference/gdk/tmpl/visuals.sgml b/docs/reference/gdk/tmpl/visuals.sgml
index a40e4733c..cd740e95d 100644
--- a/docs/reference/gdk/tmpl/visuals.sgml
+++ b/docs/reference/gdk/tmpl/visuals.sgml
@@ -239,8 +239,8 @@ in memory as 0x00, 0xcc, 0xee, 0xff.
Deprecated equivalent of g_object_ref().
</para>
-@v:
-@Returns:
+@v: a #GdkVisual
+@Returns: the same visual
<!-- ##### MACRO gdk_visual_unref ##### -->
@@ -248,7 +248,7 @@ Deprecated equivalent of g_object_ref().
Deprecated equivalent of g_object_unref().
</para>
-@v:
+@v: a #GdkVisual
<!-- ##### FUNCTION gdk_visual_get_screen ##### -->
diff --git a/docs/reference/gdk/tmpl/windows.sgml b/docs/reference/gdk/tmpl/windows.sgml
index a82b658d8..b2f981041 100644
--- a/docs/reference/gdk/tmpl/windows.sgml
+++ b/docs/reference/gdk/tmpl/windows.sgml
@@ -142,7 +142,6 @@ ratio.
@min_width: minimum width of window (or -1 to use requisition, with #GtkWindow only)
@min_height minimum height of window (or -1 to use requisition, with #GtkWindow only)
-@min_height:
@max_width: maximum width of window (or -1 to use requisition, with #GtkWindow only)
@max_height: maximum height of window (or -1 to use requisition, with #GtkWindow only)
@base_width: allowed window widths are @base_width + @width_inc * N where N is any integer (-1 allowed with #GtkWindow)
@@ -488,6 +487,17 @@ Deprecated equivalent of g_object_unref()
@dy:
+<!-- ##### FUNCTION gdk_window_move_region ##### -->
+<para>
+
+</para>
+
+@window:
+@region:
+@dx:
+@dy:
+
+
<!-- ##### FUNCTION gdk_window_reparent ##### -->
<para>
@@ -536,15 +546,18 @@ Deprecated equivalent of g_object_unref()
Deprecated equivalent to gdk_draw_drawable(), see that function for docs
</para>
-@drawable:
-@gc:
-@x:
-@y:
-@source_drawable:
-@source_x:
-@source_y:
-@width:
-@height:
+@drawable: a #GdkDrawable
+@gc: a #GdkGC sharing the drawable's visual and colormap
+@drawable: a #GdkDrawable
+@x: X position in @drawable where the rectangle should be drawn
+@y: Y position in @drawable where the rectangle should be drawn
+@source_drawable: the source #GdkDrawable, which may be the same as @drawable
+@source_x: X position in @src of rectangle to draw
+@source_y: Y position in @src of rectangle to draw
+@xdest: X position in @drawable where the rectangle should be drawn
+@ydest: Y position in @drawable where the rectangle should be drawn
+@width: width of rectangle to draw, or -1 for entire @src width
+@height: height of rectangle to draw, or -1 for entire @src height
<!-- ##### FUNCTION gdk_window_raise ##### -->
@@ -1172,7 +1185,7 @@ Like the X Window System, GDK supports 8 modifier keys and 5 mouse buttons.
@GDK_BUTTON5_MASK: the fifth mouse button.
@GDK_RELEASE_MASK: not used in GDK itself. GTK+ uses it to differentiate
between (keyval, modifiers) pairs from key press and release events.
-@GDK_MODIFIER_MASK:
+@GDK_MODIFIER_MASK: a mask covering all modifier types.
<!-- ##### FUNCTION gdk_window_get_parent ##### -->
<para>
diff --git a/docs/reference/gtk/Makefile.am b/docs/reference/gtk/Makefile.am
index fb5a4d7ed..9b7274c03 100644
--- a/docs/reference/gtk/Makefile.am
+++ b/docs/reference/gtk/Makefile.am
@@ -45,6 +45,7 @@ IGNORE_HFILES= \
gtkintl.h \
gtkkeyhash.h \
gtkmarshal.h \
+ gtkmnemonichash.h \
gtkpathbar.h \
gtkprivate.h \
gtkrbtree.h \
diff --git a/docs/reference/gtk/gtk-sections.txt b/docs/reference/gtk/gtk-sections.txt
index 7ebb8d8ce..2779236b9 100644
--- a/docs/reference/gtk/gtk-sections.txt
+++ b/docs/reference/gtk/gtk-sections.txt
@@ -448,6 +448,7 @@ GTK_CALENDAR_CLASS
GTK_IS_CALENDAR_CLASS
GTK_CALENDAR_GET_CLASS
<SUBSECTION Private>
+GtkCalendarPrivate
gtk_calendar_get_type
</SECTION>
@@ -1633,7 +1634,6 @@ gtk_hseparator_get_type
<FILE>gtkiconview</FILE>
<TITLE>GtkIconView</TITLE>
GtkIconView
-GtkIconViewPrivate
GtkIconViewForeachFunc
gtk_icon_view_new
gtk_icon_view_new_with_model
@@ -1676,6 +1676,7 @@ gtk_icon_view_item_activated
gtk_icon_view_scroll_to_path
gtk_icon_view_get_visible_range
<SUBSECTION Dnd>
+GtkIconViewDropPosition
gtk_icon_view_enable_model_drag_source
gtk_icon_view_enable_model_drag_dest
gtk_icon_view_unset_model_drag_source
@@ -1696,6 +1697,7 @@ GTK_TYPE_ICON_VIEW
GTK_ICON_VIEW
<SUBSECTION Private>
gtk_icon_view_get_type
+GtkIconViewPrivate
</SECTION>
<SECTION>
diff --git a/docs/reference/gtk/tmpl/gtkstock.sgml b/docs/reference/gtk/tmpl/gtkstock.sgml
index f10b856fe..998d5f930 100644
--- a/docs/reference/gtk/tmpl/gtkstock.sgml
+++ b/docs/reference/gtk/tmpl/gtkstock.sgml
@@ -466,6 +466,15 @@ The "Index" item.
+<!-- ##### MACRO GTK_STOCK_INFO ##### -->
+<para>
+The "Info" item.
+<inlinegraphic fileref="stock_info_24.png" format="PNG"></inlinegraphic>
+</para>
+
+@Since: 2.8
+
+
<!-- ##### MACRO GTK_STOCK_ITALIC ##### -->
<para>
The "Italic" item.
@@ -880,3 +889,26 @@ The "Zoom Out" item.
+<!-- ##### MACRO GTK_STOCK_FULLSCREEN ##### -->
+<para>
+The "Fullscreen" item.
+<inlinegraphic fileref="stock_fullscreen_24.png" format="PNG"></inlinegraphic>
+</para>
+
+@Since: 2.8
+
+
+
+<!-- ##### MACRO GTK_STOCK_LEAVE_FULLSCREEN ##### -->
+<para>
+The "Leave Fullscreen" item.
+<inlinegraphic fileref="stock_leave_fullscreen_24.png" format="PNG"></inlinegraphic>
+</para>
+
+@Since: 2.8
+
+
+
+
+
+