AuroraMiddleware/gtk
1
0
Fork 1
mirror of https://gitlab.gnome.org/GNOME/gtk.git synced 2024-11-05 16:20:10 +00:00
Code Issues Projects Releases Wiki Activity

Updates to new gtk-doc, gsignal, causing quite a bit of diffs but little

Browse Source 
Sun Oct 29 02:59:50 2000  Owen Taylor  <otaylor@redhat.com>

	* **: Updates to new gtk-doc, gsignal, causing quite
	a bit of diffs but little real changes.
This commit is contained in:
Owen Taylor 2000-10-29 08:03:34 +00:00 committed by Owen Taylor
parent 77556b694f
commit 9b1682bddc
48 changed files with 2510 additions and 2790 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/reference/ChangeLog
View File

@ -1,3 +1,8 @@
Sun Oct 29 02:59:50 2000 Owen Taylor <otaylor@redhat.com>
* **: Updates to new gtk-doc, gsignal, causing quite
a bit of diffs but little real changes.
2000-10-24 Havoc Pennington <hp@redhat.com>
* gtk/text_widget.sgml: add note about UTF-8

3
docs/reference/Makefile.am
View File

@ -1,3 +1,4 @@
## Process this file with automake to produce Makefile.in
#SUBDIRS = gdk-pixbuf gdk gtk
SUBDIRS = gdk-pixbuf gdk gtk

144
docs/reference/gdk-pixbuf/tmpl/animation.sgml
View File

@ -18,3 +18,147 @@ Animations as multi-frame structures.
#GdkPixbufLoader
</para>
<!-- ##### ENUM GdkPixbufFrameAction ##### -->
<para>
Each animation frame can have several things happen to it when the
next frame is displayed. The #GdkPixbufFrameAction determines
this. These are essentially the overlay modes supported by GIF
animations.
</para>
@GDK_PIXBUF_FRAME_RETAIN: The previous image should remain displayed,
and will potentially be occluded by the new frame.
@GDK_PIXBUF_FRAME_DISPOSE: The animation will be reverted to the state
before the frame was shown.
@GDK_PIXBUF_FRAME_REVERT: The animation will be reverted to the first
frame.
<!-- ##### STRUCT GdkPixbufFrame ##### -->
<para>
This structure describes a frame in a #GdkPixbufAnimation. Each
frame consists of a #GdkPixbuf, an offset of the frame within the
animation's bounding box, a duration, and an overlay mode or
action.
</para>
<!-- ##### STRUCT GdkPixbufAnimation ##### -->
<para>
This structure describes an animation, which is represented as a
list of #GdkPixbufFrame structures.
</para>
<!-- ##### FUNCTION gdk_pixbuf_animation_new_from_file ##### -->
<para>
</para>
@filename:
@error:
@Returns:
<!-- ##### FUNCTION gdk_pixbuf_animation_ref ##### -->
<para>
</para>
@animation:
@Returns:
<!-- ##### FUNCTION gdk_pixbuf_animation_unref ##### -->
<para>
</para>
@animation:
<!-- ##### FUNCTION gdk_pixbuf_animation_get_frames ##### -->
<para>
</para>
@animation:
@Returns:
<!-- ##### FUNCTION gdk_pixbuf_animation_get_width ##### -->
<para>
</para>
@animation:
@Returns:
<!-- ##### FUNCTION gdk_pixbuf_animation_get_num_frames ##### -->
<para>
</para>
@animation:
@Returns:
<!-- ##### FUNCTION gdk_pixbuf_animation_get_height ##### -->
<para>
</para>
@animation:
@Returns:
<!-- ##### FUNCTION gdk_pixbuf_frame_get_pixbuf ##### -->
<para>
</para>
@frame:
@Returns:
<!-- ##### FUNCTION gdk_pixbuf_frame_get_action ##### -->
<para>
</para>
@frame:
@Returns:
<!-- ##### FUNCTION gdk_pixbuf_frame_get_y_offset ##### -->
<para>
</para>
@frame:
@Returns:
<!-- ##### FUNCTION gdk_pixbuf_frame_get_delay_time ##### -->
<para>
</para>
@frame:
@Returns:
<!-- ##### FUNCTION gdk_pixbuf_frame_get_x_offset ##### -->
<para>
</para>
@frame:
@Returns: <!--
Local variables:
mode: sgml
sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
End:
-->

65
docs/reference/gdk-pixbuf/tmpl/creating.sgml
View File

@ -43,3 +43,68 @@ Creating a pixbuf from image data that is already in memory.
gdk_pixbuf_finalize().
</para>
<!-- ##### FUNCTION gdk_pixbuf_new ##### -->
<para>
</para>
@colorspace:
@has_alpha:
@bits_per_sample:
@width:
@height:
@Returns:
<!-- ##### FUNCTION gdk_pixbuf_new_from_data ##### -->
<para>
</para>
@data:
@colorspace:
@has_alpha:
@bits_per_sample:
@width:
@height:
@rowstride:
@destroy_fn:
@destroy_fn_data:
@Returns:
<!-- ##### FUNCTION gdk_pixbuf_new_from_xpm_data ##### -->
<para>
</para>
@data:
@Returns:
<!-- ##### FUNCTION gdk_pixbuf_new_from_inline ##### -->
<para>
</para>
@inline_pixbuf:
@copy_pixels:
@length:
@error:
@Returns:
<!-- ##### FUNCTION gdk_pixbuf_copy ##### -->
<para>
</para>
@pixbuf:
@Returns: <!--
Local variables:
mode: sgml
sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
End:
-->

15
docs/reference/gdk-pixbuf/tmpl/file-loading.sgml
View File

@ -25,3 +25,18 @@ Loading a pixbuf from a file.
#GdkPixbufLoader.
</para>
<!-- ##### FUNCTION gdk_pixbuf_new_from_file ##### -->
<para>
</para>
@filename:
@error:
@Returns: <!--
Local variables:
mode: sgml
sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
End:
-->

1474
docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-unused.sgml
View File

File diff suppressed because it is too large Load Diff

132
docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf.sgml
View File

@ -15,3 +15,135 @@ Information that describes an image.
<para>
</para>
<!-- ##### ENUM GdkPixbufError ##### -->
<para>
</para>
@GDK_PIXBUF_ERROR_CORRUPT_IMAGE:
@GDK_PIXBUF_ERROR_INSUFFICIENT_MEMORY:
@GDK_PIXBUF_ERROR_BAD_OPTION_VALUE:
@GDK_PIXBUF_ERROR_UNKNOWN_TYPE:
@GDK_PIXBUF_ERROR_UNSUPPORTED_OPERATION:
@GDK_PIXBUF_ERROR_FAILED:
<!-- ##### MACRO GDK_PIXBUF_ERROR ##### -->
<para>
</para>
<!-- ##### ENUM GdkColorspace ##### -->
<para>
This enumeration defines the color spaces that are supported by
the &gdk-pixbuf; library. Currently only RGB is supported.
</para>
@GDK_COLORSPACE_RGB: Indicates a red/green/blue additive color space.
<!-- ##### ENUM GdkPixbufAlphaMode ##### -->
<para>
These values can be passed to
gdk_pixbuf_render_to_drawable_alpha() to control how the alpha
chanel of an image should be handled. This function can create a
bilevel clipping mask (black and white) and use it while painting
the image. In the future, when the X Window System gets an alpha
channel extension, it will be possible to do full alpha
compositing onto arbitrary drawables. For now both cases fall
back to a bilevel clipping mask.
</para>
@GDK_PIXBUF_ALPHA_BILEVEL: A bilevel clipping mask (black and white)
will be created and used to draw the image. Pixels below 0.5 opacity
will be considered fully transparent, and all others will be
considered fully opaque.
@GDK_PIXBUF_ALPHA_FULL: For now falls back to #GDK_PIXBUF_ALPHA_BILEVEL.
In the future it will do full alpha compositing.
<!-- ##### STRUCT GdkPixbuf ##### -->
<para>
This is the main structure in the &gdk-pixbuf; library. It is
used to represent images. It contains information about the
image's pixel data, its color space, bits per sample, width and
height, and the rowstride or number of bytes between rows.
</para>
<!-- ##### FUNCTION gdk_pixbuf_get_colorspace ##### -->
<para>
</para>
@pixbuf:
@Returns:
<!-- ##### FUNCTION gdk_pixbuf_get_n_channels ##### -->
<para>
</para>
@pixbuf:
@Returns:
<!-- ##### FUNCTION gdk_pixbuf_get_has_alpha ##### -->
<para>
</para>
@pixbuf:
@Returns:
<!-- ##### FUNCTION gdk_pixbuf_get_bits_per_sample ##### -->
<para>
</para>
@pixbuf:
@Returns:
<!-- ##### FUNCTION gdk_pixbuf_get_pixels ##### -->
<para>
</para>
@pixbuf:
@Returns:
<!-- ##### FUNCTION gdk_pixbuf_get_width ##### -->
<para>
</para>
@pixbuf:
@Returns:
<!-- ##### FUNCTION gdk_pixbuf_get_height ##### -->
<para>
</para>
@pixbuf:
@Returns:
<!-- ##### FUNCTION gdk_pixbuf_get_rowstride ##### -->
<para>
</para>
@pixbuf:
@Returns: <!--
Local variables:
mode: sgml
sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
End:
-->

59
docs/reference/gdk-pixbuf/tmpl/initialization_versions.sgml
View File

@ -14,3 +14,62 @@ Initialization and Versions
</para>
<!-- ##### FUNCTION gdk_pixbuf_init ##### -->
<para>
</para>
<!-- ##### FUNCTION gdk_pixbuf_preinit ##### -->
<para>
</para>
@app:
@modinfo:
<!-- ##### FUNCTION gdk_pixbuf_postinit ##### -->
<para>
</para>
@app:
@modinfo:
<!-- ##### VARIABLE gdk_pixbuf_version ##### -->
<para>
</para>
<!-- ##### MACRO GDK_PIXBUF_VERSION ##### -->
<para>
</para>
<!-- ##### MACRO GDK_PIXBUF_MAJOR ##### -->
<para>
</para>
<!-- ##### MACRO GDK_PIXBUF_MINOR ##### -->
<para>
</para>
<!-- ##### MACRO GDK_PIXBUF_MICRO ##### -->
<para>
</para>

88
docs/reference/gdk-pixbuf/tmpl/module_interface.sgml
View File

@ -14,3 +14,91 @@ Module Interface
</para>
<!-- ##### USER_FUNCTION ModulePreparedNotifyFunc ##### -->
<para>
</para>
@pixbuf:
@user_data:
<!-- ##### USER_FUNCTION ModuleUpdatedNotifyFunc ##### -->
<para>
</para>
@pixbuf:
@x:
@y:
@width:
@height:
@user_data:
<!-- ##### USER_FUNCTION ModuleFrameDoneNotifyFunc ##### -->
<para>
</para>
@frame:
@user_data:
<!-- ##### USER_FUNCTION ModuleAnimationDoneNotifyFunc ##### -->
<para>
</para>
@pixbuf:
@user_data:
<!-- ##### STRUCT GdkPixbufModule ##### -->
<para>
</para>
@module_name:
@format_check:
@module:
@load:
@load_xpm_data:
@begin_load:
@stop_load:
@load_increment:
@load_animation:
@save:
<!-- ##### FUNCTION gdk_pixbuf_get_module ##### -->
<para>
</para>
@buffer:
@size:
@filename:
@error:
@Returns:
<!-- ##### FUNCTION gdk_pixbuf_get_named_module ##### -->
<para>
</para>
@name:
@error:
@Returns:
<!-- ##### FUNCTION gdk_pixbuf_load_module ##### -->
<para>
</para>
@image_module:
@error:
@Returns:

31
docs/reference/gdk-pixbuf/tmpl/refcounting.sgml
View File

@ -54,3 +54,34 @@ Functions to perform reference counting and memory management on a
#GdkPixbuf, gdk_pixbuf_new_from_data().
</para>
<!-- ##### USER_FUNCTION GdkPixbufDestroyNotify ##### -->
<para>
A function of this type is responsible for freeing the pixel array
of a pixbuf. The gdk_pixbuf_new_from_data() function lets you
pass in a pre-allocated pixel array so that a pixbuf can be
created from it; in this case you will need to pass in a function
of #GdkPixbufDestroyNotify so that the pixel data can be freed
when the pixbuf is finalized.
</para>
@pixels: The pixel array of the pixbuf that is being finalized.
@data: User closure data.
<!-- ##### FUNCTION gdk_pixbuf_ref ##### -->
<para>
</para>
@pixbuf:
@Returns:
<!-- ##### FUNCTION gdk_pixbuf_unref ##### -->
<para>
</para>
@pixbuf:

124
docs/reference/gdk-pixbuf/tmpl/scaling.sgml
View File

@ -68,3 +68,127 @@ expose_cb (GtkWidget *widget, GdkEventExpose *event, gpointer data)
GdkRGB
</para>
<!-- ##### ENUM GdkInterpType ##### -->
<para>
This enumeration describes the different interpolation modes that
can be used with the scaling functions.
<note>
<para>
Cubic filtering is missing from the list; hyperbolic
interpolation is just as fast and results in higher quality.
</para>
</note>
</para>
@GDK_INTERP_NEAREST: Nearest neighbor sampling; this is the fastest
and lowest quality mode.
@GDK_INTERP_TILES: This is an accurate simulation of the PostScript
image operator without any interpolation enabled. Each pixel is
rendered as a tiny parallelogram of solid color, the edges of which
are implemented with antialiasing. It resembles nearest neighbor for
enlargement, and bilinear for reduction.
@GDK_INTERP_BILINEAR: Bilinear interpolation. For enlargement, it is
equivalent to point-sampling the ideal bilinear-interpolated image.
For reduction, it is equivalent to laying down small tiles and
integrating over the coverage area.
@GDK_INTERP_HYPER: This is the slowest and highest quality
reconstruction function. It is derived from the hyperbolic filters in
Wolberg's "Digital Image Warping", and is formally defined as the
hyperbolic-filter sampling the ideal hyperbolic-filter interpolated
image (the filter is designed to be idempotent for 1:1 pixel mapping).
<!-- ##### FUNCTION gdk_pixbuf_scale ##### -->
<para>
</para>
@src:
@dest:
@dest_x:
@dest_y:
@dest_width:
@dest_height:
@offset_x:
@offset_y:
@scale_x:
@scale_y:
@interp_type:
<!-- ##### FUNCTION gdk_pixbuf_composite ##### -->
<para>
</para>
@src:
@dest:
@dest_x:
@dest_y:
@dest_width:
@dest_height:
@offset_x:
@offset_y:
@scale_x:
@scale_y:
@interp_type:
@overall_alpha:
<!-- ##### FUNCTION gdk_pixbuf_composite_color ##### -->
<para>
</para>
@src:
@dest:
@dest_x:
@dest_y:
@dest_width:
@dest_height:
@offset_x:
@offset_y:
@scale_x:
@scale_y:
@interp_type:
@overall_alpha:
@check_x:
@check_y:
@check_size:
@color1:
@color2:
<!-- ##### FUNCTION gdk_pixbuf_scale_simple ##### -->
<para>
</para>
@src:
@dest_width:
@dest_height:
@interp_type:
@Returns:
<!-- ##### FUNCTION gdk_pixbuf_composite_color_simple ##### -->
<para>
</para>
@src:
@dest_width:
@dest_height:
@interp_type:
@overall_alpha:
@check_size:
@color1:
@color2:
@Returns: <!--
Local variables:
mode: sgml
sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
End:
-->

44
docs/reference/gdk-pixbuf/tmpl/util.sgml
View File

@ -17,3 +17,47 @@ Utility and miscellaneous convenience functions.
#GdkPixbuf
</para>
<!-- ##### FUNCTION gdk_pixbuf_add_alpha ##### -->
<para>
</para>
@pixbuf:
@substitute_color:
@r:
@g:
@b:
@Returns:
<!-- ##### FUNCTION gdk_pixbuf_copy_area ##### -->
<para>
</para>
@src_pixbuf:
@src_x:
@src_y:
@width:
@height:
@dest_pixbuf:
@dest_x:
@dest_y: <!--
Local variables:
mode: sgml
sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
End:
-->
<!-- ##### FUNCTION gdk_pixbuf_saturate_and_pixelate ##### -->
<para>
</para>
@src:
@dest:
@saturation:
@pixelate:

222
docs/reference/gdk/tmpl/gdk-unused.sgml
View File

@ -1,34 +1,8 @@
<!-- ##### FUNCTION gdk_input_set_mode ##### -->
<!-- ##### SECTION ./tmpl/gdkregion.sgml:See_Also ##### -->
<para>
Enables or disables a device, and determines how the
device maps onto the screen.
</para>
@deviceid: the device to configure.
@mode: the new mode.
@Returns: %TRUE if the device supports the given mode, otherwise
%FALSE and the device's mode is unchanged.
<!-- ##### FUNCTION gdk_input_set_key ##### -->
<para>
Sets the key event generated when a macro button is pressed.
</para>
@deviceid: the device to configure.
@index: the index of the macro button.
@keyval: the key value for the #GdkKeypressEvent to generate.
(a value of 0 means no event will be generated.)
@modifiers: the modifier field for the generated
#GdkKeyPressEvent.
<!-- ##### FUNCTION gdk_regions_intersect ##### -->
<para>
Returns the intersection of two regions.
</para>
@source1: a #GdkRegion.
@source2: a #GdkRegion.
@Returns: the intersection of @source1 and @source2.
<!-- ##### FUNCTION gdk_regions_xor ##### -->
<para>
@ -42,32 +16,21 @@ but which are not in both.
@Returns: the difference between the union and the intersection of @source1
and @source2.
<!-- ##### FUNCTION gdk_regions_subtract ##### -->
<!-- ##### FUNCTION gdk_input_motion_events ##### -->
<para>
Subtracts one region from another.
The result is a region containing all the pixels which are in @source1, but
which are not in @source2.
Retrieves the motion history for a given device/window pair.
</para>
@source1: a #GdkRegion.
@source2: a #GdkRegion to subtract from @source1.
@Returns: @source1 - @source2.
@window: a #GdkWindow.
@deviceid: the device for which to retrieve motion history.
@start: the start time.
@stop: the stop time.
@nevents_return: location to store the number of events returned.
@Returns: a newly allocated array containing all the events
from @start to @stop. This array should be freed
with g_free() when you are finished using it.
<!-- ##### FUNCTION gdk_input_list_devices ##### -->
<para>
Lists all available input devices, along with their
configuration information.
</para>
@Returns: A #GList of #GdkDeviceInfo structures. This list
is internal data of GTK+ and should not be modified
or freed.
<!-- ##### SECTION ./tmpl/gdkregion.sgml:Short_Description ##### -->
<!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:See_Also ##### -->
<!-- ##### SECTION ./tmpl/gdkregion.sgml:Long_Description ##### -->
<para>
</para>
@ -77,29 +40,6 @@ configuration information.
<!-- ##### MACRO GDK_CORE_POINTER ##### -->
<para>
This macro contains an integer value representing
the device ID for the core pointer device.
</para>
<!-- ##### VARIABLE gdk_threads_mutex ##### -->
<para>
</para>
<!-- ##### FUNCTION gdk_input_set_axes ##### -->
<para>
Sets the mapping of the axes (valuators) of a device
onto the predefined valuator types that GTK+ understands.
</para>
@deviceid: the device to configure.
@axes: an array of GdkAxisUse. This length of this array
must match the number of axes for the device.
<!-- ##### STRUCT GdkDeviceInfo ##### -->
<para>
The #GdkDeviceInfo structure contains information about a
@ -124,11 +64,47 @@ device. It has the following fields:
which describe what key press events are generated
for each macro button.
<!-- ##### SECTION ./tmpl/gdkregion.sgml:Title ##### -->
Points, Rectangles and Regions
<!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:Title ##### -->
Pango Interaction
<!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:Long_Description ##### -->
<!-- ##### FUNCTION gdk_regions_union ##### -->
<para>
Returns the union of two regions.
This is all pixels in either of @source1 or @source2.
</para>
@source1: a #GdkRegion.
@source2: a #GdkRegion.
@Returns: the union of @source1 and @source2.
<!-- ##### SECTION ./tmpl/gdkregion.sgml:Short_Description ##### -->
<!-- ##### FUNCTION gdk_input_set_key ##### -->
<para>
Sets the key event generated when a macro button is pressed.
</para>
@deviceid: the device to configure.
@index: the index of the macro button.
@keyval: the key value for the #GdkKeypressEvent to generate.
(a value of 0 means no event will be generated.)
@modifiers: the modifier field for the generated
#GdkKeyPressEvent.
<!-- ##### FUNCTION gdk_input_list_devices ##### -->
<para>
Lists all available input devices, along with their
configuration information.
</para>
@Returns: A #GList of #GdkDeviceInfo structures. This list
is internal data of GTK+ and should not be modified
or freed.
<!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:See_Also ##### -->
<para>
</para>
@ -142,51 +118,16 @@ Points, Rectangles and Regions
@GDK_PIXBUF_ALPHA_BILEVEL:
@GDK_PIXBUF_ALPHA_FULL:
<!-- ##### FUNCTION gdk_input_motion_events ##### -->
<!-- ##### FUNCTION gdk_regions_subtract ##### -->
<para>
Retrieves the motion history for a given device/window pair.
</para>
@window: a #GdkWindow.
@deviceid: the device for which to retrieve motion history.
@start: the start time.
@stop: the stop time.
@nevents_return: location to store the number of events returned.
@Returns: a newly allocated array containing all the events
from @start to @stop. This array should be freed
with g_free() when you are finished using it.
<!-- ##### VARIABLE gdk_core_pointer ##### -->
<para>
</para>
<!-- ##### SECTION ./tmpl/gdkregion.sgml:See_Also ##### -->
<para>
</para>
<!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:Title ##### -->
Pango Interaction
<!-- ##### SECTION ./tmpl/gdkregion.sgml:Long_Description ##### -->
<para>
</para>
<!-- ##### FUNCTION gdk_regions_union ##### -->
<para>
Returns the union of two regions.
This is all pixels in either of @source1 or @source2.
Subtracts one region from another.
The result is a region containing all the pixels which are in @source1, but
which are not in @source2.
</para>
@source1: a #GdkRegion.
@source2: a #GdkRegion.
@Returns: the union of @source1 and @source2.
@source2: a #GdkRegion to subtract from @source1.
@Returns: @source1 - @source2.
<!-- ##### FUNCTION gdk_input_window_get_pointer ##### -->
<para>
@ -205,6 +146,23 @@ they will be ignored.
@ytilt: location to store current tilt in the y direction.
@mask: location to store the current modifier state.
<!-- ##### MACRO GDK_CORE_POINTER ##### -->
<para>
This macro contains an integer value representing
the device ID for the core pointer device.
</para>
<!-- ##### FUNCTION gdk_input_set_axes ##### -->
<para>
Sets the mapping of the axes (valuators) of a device
onto the predefined valuator types that GTK+ understands.
</para>
@deviceid: the device to configure.
@axes: an array of GdkAxisUse. This length of this array
must match the number of axes for the device.
<!-- ##### FUNCTION gdk_input_set_source ##### -->
<para>
Sets the source type for a device.
@ -213,3 +171,33 @@ Sets the source type for a device.
@deviceid: the device to configure
@source: the new source type.
<!-- ##### SECTION ./tmpl/gdkregion.sgml:Title ##### -->
Points, Rectangles and Regions
<!-- ##### FUNCTION gdk_regions_intersect ##### -->
<para>
Returns the intersection of two regions.
</para>
@source1: a #GdkRegion.
@source2: a #GdkRegion.
@Returns: the intersection of @source1 and @source2.
<!-- ##### FUNCTION gdk_input_set_mode ##### -->
<para>
Enables or disables a device, and determines how the
device maps onto the screen.
</para>
@deviceid: the device to configure.
@mode: the new mode.
@Returns: %TRUE if the device supports the given mode, otherwise
%FALSE and the device's mode is unchanged.
<!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:Long_Description ##### -->
<para>
</para>

6
docs/reference/gdk/tmpl/input_devices.sgml
View File

@ -175,6 +175,12 @@ types that GTK+ understands.
@Returns:
<!-- ##### VARIABLE gdk_core_pointer ##### -->
<para>
</para>
<!-- ##### FUNCTION gdk_device_set_source ##### -->
<para>

6
docs/reference/gdk/tmpl/threads.sgml
View File

@ -42,3 +42,9 @@ Threads
<!-- ##### VARIABLE gdk_threads_mutex ##### -->
<para>
</para>

1
docs/reference/gtk/Makefile.am
View File

@ -20,6 +20,7 @@ IGNORE_HFILES= \
gtkhsv.h \
gtkimcontextsimple.h \
gtkintl.h \
gtkmarshal.h \
gtkprivate.h \
gtktextbtree.h \
gtktextchild.h \

92
docs/reference/gtk/gtk-sections.txt
View File

@ -1988,12 +1988,7 @@ gtk_text_buffer_get_iter_at_mark
gtk_text_buffer_get_tags
gtk_text_buffer_modified
gtk_text_buffer_set_modified
gtk_text_buffer_set_clipboard_contents
gtk_text_buffer_get_clipboard_contents
gtk_text_buffer_paste_primary_selection
gtk_text_buffer_delete_selection
gtk_text_buffer_cut
gtk_text_buffer_copy
gtk_text_buffer_paste_clipboard
gtk_text_buffer_get_selection_bounds
<SUBSECTION Standard>
@ -2074,8 +2069,6 @@ gtk_text_iter_spew
GtkTextMark
gtk_text_mark_set_visible
gtk_text_mark_is_visible
gtk_text_mark_ref
gtk_text_mark_unref
gtk_text_mark_get_deleted
</SECTION>
@ -2084,7 +2077,6 @@ gtk_text_mark_get_deleted
GtkTextTag
GtkTextBTreeNode
GtkTextTagTable
GtkTextTabArray
GtkWrapMode
GtkTextAttributes
<TITLE>GtkTextTag</TITLE>
@ -2940,6 +2932,26 @@ gtk_selection_property_notify
gtk_selection_request
</SECTION>
<SECTION>
<FILE>gtkclipboard</FILE>
<TITLE>Clipboards</TITLE>
GtkClipboard
GtkClipboardReceivedFunc
GtkClipboardTextReceivedFunc
GtkClipboardGetFunc
GtkClipboardClearFunc
gtk_clipboard_get
gtk_clipboard_set_with_data
gtk_clipboard_set_with_owner
gtk_clipboard_get_owner
gtk_clipboard_clear
gtk_clipboard_set_text
gtk_clipboard_request_contents
gtk_clipboard_request_text
gtk_clipboard_wait_for_contents
gtk_clipboard_wait_for_text
</SECTION>
<SECTION>
<FILE>gtkdnd</FILE>
<TITLE>Drag and Drop</TITLE>
@ -2976,7 +2988,6 @@ GTK_SIGNAL_OFFSET
GtkSignalMarshal
GtkSignalDestroy
GtkEmissionHook
GtkSignalQuery
GtkSignalRunType
gtk_signal_init
gtk_signal_new
@ -2987,8 +2998,6 @@ gtk_signal_emit
gtk_signal_emit_by_name
gtk_signal_emitv
gtk_signal_emitv_by_name
gtk_signal_n_emissions
gtk_signal_n_emissions_by_name
gtk_signal_emit_stop
gtk_signal_emit_stop_by_name
gtk_signal_connect
@ -3012,72 +3021,11 @@ gtk_signal_handler_pending_by_func
gtk_signal_handler_pending_by_id
gtk_signal_handlers_destroy
gtk_signal_set_funcs
gtk_signal_query
gtk_signal_add_emission_hook
gtk_signal_add_emission_hook_full
gtk_signal_remove_emission_hook
</SECTION>
<SECTION>
<FILE>gtkmarshal</FILE>
<TITLE>Signal Marshallers</TITLE>
gtk_signal_default_marshaller
<SUBSECTION Private>
gtk_marshal_BOOL__POINTER_INT_INT_UINT
gtk_marshal_BOOL__POINTER_STRING_STRING_POINTER
gtk_marshal_ENUM__ENUM
gtk_marshal_NONE__BOXED
gtk_marshal_NONE__ENUM
gtk_marshal_NONE__ENUM_FLOAT
gtk_marshal_NONE__ENUM_FLOAT_BOOL
gtk_marshal_NONE__OBJECT
gtk_marshal_NONE__POINTER_STRING_STRING
gtk_marshal_NONE__POINTER_UINT
gtk_marshal_NONE__POINTER_UINT_ENUM
gtk_marshal_NONE__POINTER_POINTER_UINT_UINT
gtk_marshal_NONE__POINTER_INT_INT_POINTER_UINT_UINT
gtk_marshal_NONE__POINTER_UINT_UINT
gtk_marshal_NONE__STRING
gtk_marshal_NONE__STRING_INT_POINTER
gtk_marshal_NONE__UINT
gtk_marshal_NONE__UINT_POINTER_UINT_ENUM_ENUM_POINTER
gtk_marshal_NONE__UINT_POINTER_UINT_UINT_ENUM
gtk_marshal_NONE__UINT_STRING
gtk_marshal_BOOL__NONE
gtk_marshal_BOOL__POINTER
gtk_marshal_BOOL__POINTER_INT_INT
gtk_marshal_BOOL__POINTER_INT_INT_INT
gtk_marshal_BOOL__POINTER_POINTER_INT_INT
gtk_marshal_BOOL__POINTER_POINTER_POINTER_POINTER
gtk_marshal_INT__INT
gtk_marshal_INT__POINTER
gtk_marshal_INT__POINTER_CHAR_CHAR
gtk_marshal_NONE__BOOL
gtk_marshal_NONE__INT
gtk_marshal_NONE__INT_FLOAT
gtk_marshal_NONE__INT_FLOAT_BOOL
gtk_marshal_NONE__INT_INT
gtk_marshal_NONE__INT_INT_POINTER
gtk_marshal_NONE__INT_POINTER
gtk_marshal_NONE__INT_POINTER_INT_INT_INT
gtk_marshal_NONE__INT_POINTER_INT_INT_INT_POINTER
gtk_marshal_NONE__NONE
gtk_marshal_NONE__POINTER
gtk_marshal_NONE__POINTER_INT
gtk_marshal_NONE__POINTER_INT_INT
gtk_marshal_NONE__POINTER_INT_INT_POINTER_INT_INT
gtk_marshal_NONE__POINTER_INT_POINTER
gtk_marshal_NONE__POINTER_POINTER
gtk_marshal_NONE__POINTER_POINTER_INT_INT
gtk_marshal_NONE__POINTER_POINTER_POINTER
gtk_marshal_INT__OBJECT_BOXED_POINTER
gtk_marshal_INT__POINTER_POINTER_POINTER
gtk_marshal_NONE__POINTER_POINTER_INT
gtk_marshal_NONE__STRING_POINTER
gtk_marshal_NONE__INT_INT_INT
</SECTION>
<SECTION>
<FILE>gtkarg</FILE>
<TITLE>Object Properties</TITLE>

499
docs/reference/gtk/tmpl/gtk-unused.sgml
View File

@ -12,29 +12,71 @@ Debugging
</para>
<!-- ##### SECTION ./tmpl/gtkclipboard.sgml:See_Also ##### -->
<!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Long_Description ##### -->
<refsect2>
<title>What are Signal Marshallers?</title>
<para>
<variablelist>
<varlistentry>
<term>#GtkSelection</term>
<listitem><para>@GtkClipboard provides a high-level wrapper around the
lower level routines that deal with X selections. It is
also possibly to directly manipulate the X selections,
though it is seldom necessary to do so.</para></listitem>
</varlistentry>
</variablelist>
Marshals are functions which all have the same prototype:
they take a #GtkObject, a #GtkSignalFunc, a #gpointer,
and an array of argument values.
The functions are names gtk_marshall_RETURNTYPE__PARAMTYPE1_PARAMTYPE2....
</para>
<!-- ##### FUNCTION gtk_clipboard_get ##### -->
<para>
They then call a native function: the GtkObject is the first
parameter passed in. The arguments are passed in the native
calling convention: chars, shorts, ints, longs may be packed
on the stack, or tucked in registers: it doesn't matter
because the same calling convention will be generated
inside the gtkmarshal code as is expected where you define
your handlers.
</para>
<para>
So the function named:
<programlisting>
gtk_marshal_BOOL__POINTER_INT_INT_UINT(GtkObject*, GtkSignalFunc, gpointer, GtkArg*);
</programlisting>
will call the #GtkSignalFunc assuming it was a function with signature:
<programlisting>
gboolean sigfunc(gpointer,gint,gint,guint);
</programlisting>
</para>
</refsect2>
<refsect2>
<title>Writing Custom Marshals</title>
<para>
Marshals are primarily used as arguments to gtk_signal_new().
Sometimes, you may find that a marshaller you need isn't available
in the standard list. Then you have to write your own.
</para>
<para>
If you wish to define a signal with a new type of argument list.
Suppose you want 2 pointers and 2 integers.
You would write:
<programlisting>
typedef int (*GtkSignal_INT__POINTER_POINTER_INT_INT)(
gpointer, gpointer, gint, gint
);
void marshal_INT__POINTER_POINTER_INT_INT(GtkObject* object,
GtkSignalFunc func,
gpointer func_data,
GtkArg* args)
{
GtkSignal_NONE__POINTER_POINTER_INT_INT rfunc;
gint* return_val;
return_val = GTK_RETLOC_INT(args[4]);
rfunc = (GtkSignal_INT__POINTER_POINTER_INT_INT)func;
*return_val = (*rfunc)(object,
GTK_VALUE_POINTER(args[0]),
GTK_VALUE_POINTER(args[1]),
GTK_VALUE_INT(args[2]),
GTK_VALUE_INT(args[3]),
func_data);
}
</programlisting>
</para>
</refsect2>
@selection:
@Returns:
<!-- ##### SECTION ./tmpl/gtkmenufactory.sgml:Short_Description ##### -->
@ -133,6 +175,10 @@ will be shown, or NULL to show all charsets.
@container:
<!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Title ##### -->
Signal Marshallers
<!-- ##### SECTION ./tmpl/gtkenums.sgml.sgml:Long_Description ##### -->
<para>
@ -174,6 +220,39 @@ A structure used to return values from @gtk_type_query.
@func_data:
@args:
<!-- ##### USER_FUNCTION GtkSignalMarshal ##### -->
<para>
This is currently a hack left in for a scheme wrapper library.
It may be removed.
</para>
<para>
Don't use it.
</para>
@object: The object which emits the signal.
@data: The user data associated with the hook.
@nparams: The number of parameters to the function.
@args: The actual values of the arguments.
@arg_types: The types of the arguments.
@return_type: The type of the return value from the function
or #GTK_TYPE_NONE for no return value.
<!-- ##### FUNCTION gtk_signal_add_emission_hook_full ##### -->
<para>
Add an emission hook for a type of signal, for any object.
(with control of what happens when the hook is
destroyed).
</para>
@signal_id: the type of signal add the hook for.
@hook_func: the function to invoke to handle the hook.
@data: the user data passed in to hook_func.
@destroy: a function to invoke when the hook is destroyed,
to clean up any allocation done just for this
signal handler.
@Returns: the id (that you may pass as a parameter
to gtk_signal_remove_emission_hook()).
<!-- ##### FUNCTION gtk_text_buffer_paste_primary_selection ##### -->
<para>
@ -195,19 +274,6 @@ A structure used to return values from @gtk_type_query.
@func_data:
@args:
<!-- ##### FUNCTION gtk_clipboard_set_with_data ##### -->
<para>
</para>
@clipboard:
@targets:
@n_targets:
@get_func:
@clear_func:
@user_data:
@Returns:
<!-- ##### SIGNAL GtkTextView::copy-text ##### -->
<para>
@ -225,34 +291,6 @@ A structure used to return values from @gtk_type_query.
@x:
@y:
<!-- ##### USER_FUNCTION GtkClipboardReceivedFunc ##### -->
<para>
A function to be called when the results of gtk_clipboard_request_text()
are received, or when the request fails.
</para>
@clipboard: the #GtkClipboard
@selection_data: a #GtkSelectionData containing the data was received.
If retrieving the data failed, then then length field
of @selection_data will be negative.
@data: the @user_data supplied to gtk_clipboard_request_contents().
<!-- ##### FUNCTION gtk_clipboard_clear ##### -->
<para>
</para>
@clipboard:
<!-- ##### FUNCTION gtk_clipboard_wait_for_contents ##### -->
<para>
</para>
@clipboard:
@target:
@Returns:
<!-- ##### SECTION ./tmpl/gtkenums.sgml.sgml:Short_Description ##### -->
@ -408,17 +446,6 @@ Convert a gtk type into its sequence number
</para>
<!-- ##### USER_FUNCTION GtkClipboardClearFunc ##### -->
<para>
A function that will be called when the contents of the clipboard are changed
or cleared. Once this has called, the @user_data_or_owner argument
will not be used again.
</para>
@clipboard: the #GtkClipboard
@user_data_or_owner: the @user_data argument passed to gtk_clipboard_set_with_data(), or
the @owner argument passed to gtk_clipboard_set_owner()
<!-- ##### MACRO GTK_WIDGET_IS_OFFSCREEN ##### -->
<para>
@ -498,72 +525,6 @@ Deprecated.
@func_data:
@args:
<!-- ##### SECTION ./tmpl/gtkclipboard.sgml:Long_Description ##### -->
<para>
The #GtkClipboard object represents a clipboard of data shared
between different processes or between different widgets in
the same process. Each clipboard is identified by a name encoded as a
#GdkAtom. (Conversion to and from strings can be done with
gdk_atom_intern() and gdk_atom_name().) The default clipboard
corresponds to the CLIPBOARD atom; another commonly used clipboard
is the PRIMARY clipboard, which, in X, traditionally contains
the currently selected text.
</para>
<para>
To support having a number of different formats on the clipboard
at the same time, the clipboard mechanism allows providing
callbacks instead of the actual data. When you set the contents
of the clipboard, you can either supply the data directly (via
functions like gtk_clipboard_set_text()), or you can supply a
callback to be called at a later time when the data is needed (via
gtk_clipboard_set_with_data() or gtk_clipboard_set_with_owner().)
Providing a callback also avoids having to make copies of the data
when it is not needed.
</para>
<para>
gtk_clipboard_set_with_data() and gtk_clipboard_set_with_owner()
are quite similar; the choice between the two depends mostly on
which is more convenient in a particular situation.
The former is most useful when you want to have a blob of data
with callbacks to convert it into the various data types that you
advertise. When the @clear_func you provided is called, you
simply free the data blob. The latter is more useful when the
contents of clipboard reflect the internal state of a @GObject
(As an example, for the PRIMARY clipboard, when an entry widget
provides the clipboard's contents the contents are simply the
text within the selected region.) If the contents change, the
entry widget can call gtk_clipboard_set_with_owner() to update
the timestamp for clipboard ownership, without having to worry
about @clear_func being called.
</para>
<para>
Requesting the data from the clipboard is essentially
asynchronous. If the contents of the clipboard are provided within
the same process, then a direct function call will be made to
retrieve the data, but if they are provided by another process,
then the data needs to be retrieved from the other process, which
may take some time. To avoid blocking the user interface, the call
to request the selection, gtk_clipboard_request_contents() takes a
callback that will be called when the contents are received (or
when the request fails.) If you don't want to deal with providing
a separate callback, you can also use gtk_clipboard_wait_for_contents().
What this does is run the Glib main loop recursively waiting for
the contents. This can simplify the code flow, but you still have
to be aware that other callbacks in your program can be called
while this recursive mainloop is running.
</para>
<para>
Along with the functions to get the clipboard contents as an
arbitrary data chunk, there are also functions to retrieve
it as text, gtk_clipboard_request_text() and
gtk_clipboard_wait_for_text(). These functions take care of
determining which formats are advertised by the clipboard
provider, asking for the clipboard in the best available format
and converting the results into the UTF-8 encoding. (The standard
form for representing strings in GTK+.)
</para>
<!-- ##### SECTION ./tmpl/gtkdebug.sgml:See_Also ##### -->
<para>
@ -703,10 +664,6 @@ Get the number of signals defined by this object.
@subfactory:
@path:
<!-- ##### SECTION ./tmpl/gtkclipboard.sgml:Short_Description ##### -->
Storing data on Clipboards.
<!-- ##### FUNCTION gtk_type_children_types ##### -->
<para>
Return the pointer to the type's children's types.
@ -769,6 +726,22 @@ The first structured enumerated type value.
</para>
<!-- ##### STRUCT GtkSignalQuery ##### -->
<para>
This structure contains all the information about a particular
signal: its name, the type it affects, the signature of the handlers,
and its unique identifying integer.
</para>
@object_type:
@signal_id:
@signal_name:
@is_user_signal:
@signal_flags:
@return_val:
@nparams:
@params:
<!-- ##### FUNCTION gtk_type_describe_tree ##### -->
<para>
Given a @type, describe all of its children, and their children. Only
@ -778,16 +751,6 @@ show the size if @show_size is true.
@type: GtkType
@show_size: gboolean
<!-- ##### FUNCTION gtk_clipboard_request_contents ##### -->
<para>
</para>
@clipboard:
@target:
@callback:
@user_data:
<!-- ##### FUNCTION gtk_marshal_BOOL__POINTER_INT_INT_INT ##### -->
<para>
@ -798,14 +761,6 @@ show the size if @show_size is true.
@func_data:
@args:
<!-- ##### FUNCTION gtk_clipboard_get_owner ##### -->
<para>
</para>
@clipboard:
@Returns:
<!-- ##### SECTION ./tmpl/gtkdebug.sgml:Long_Description ##### -->
<para>
@ -871,10 +826,6 @@ will be shown, or NULL to show all spacings.
@charsets: a NULL-terminated array of strings containing charset names which
will be shown, or NULL to show all charsets.
<!-- ##### SECTION ./tmpl/gtkclipboard.sgml:Title ##### -->
Clipboards
<!-- ##### SIGNAL GtkTextView::delete-text ##### -->
<para>
@ -905,12 +856,23 @@ Combine a fundemantal type and a sequence number to create a gtk type.
@parent_t:
@seqno:
<!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Short_Description ##### -->
Functions to adapt C structures to native calling convention.
<!-- ##### MACRO GTK_TYPE_FLAT_LAST ##### -->
<para>
The last "flat" (no struct) enumerated type value.
</para>
<!-- ##### FUNCTION gtk_text_mark_unref ##### -->
<para>
</para>
@mark:
<!-- ##### FUNCTION gtk_marshal_NONE__POINTER ##### -->
<para>
@ -931,6 +893,17 @@ The last "flat" (no struct) enumerated type value.
@func_data:
@args:
<!-- ##### FUNCTION gtk_signal_handlers_destroy ##### -->
<para>
Destroy all the signal handlers connected to an object.
This is done automatically when the object is destroyed.
</para>
<para>
This function is labeled private.
</para>
@object: the object whose signal handlers should be destroyed.
<!-- ##### FUNCTION gtk_text_iter_in_region ##### -->
<para>
@ -949,19 +922,6 @@ Get the varargs type associated with @foreign_type
@foreign_type: GtkType
@Returns: GtkType
<!-- ##### FUNCTION gtk_clipboard_wait_for_text ##### -->
<para>
</para>
@clipboard:
@Returns: <!--
Local variables:
mode: sgml
sgml-parent-document: ("../gtk-docs.sgml" "book" "refsect2" "")
End:
-->
<!-- ##### STRUCT GtkMenuFactory ##### -->
<para>
@ -1020,19 +980,6 @@ Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_FOREIGN
@GTK_DEBUG_DND:
@GTK_DEBUG_PLUGSOCKET:
<!-- ##### FUNCTION gtk_clipboard_set_with_owner ##### -->
<para>
</para>
@clipboard:
@targets:
@n_targets:
@get_func:
@clear_func:
@owner:
@Returns:
<!-- ##### FUNCTION gtk_menu_factory_remove_paths ##### -->
<para>
@ -1078,6 +1025,18 @@ Hide the name of gtk_identifier_get_type
</para>
<!-- ##### FUNCTION gtk_signal_handler_pending_by_id ##### -->
<para>
Returns whether a connection id is valid (and optionally not blocked).
</para>
@object: the object to search for the desired handler.
@handler_id: the connection id.
@may_be_blocked: whether it is acceptable to return a blocked
handler.
@Returns: TRUE if the signal exists and wasn't blocked,
unless #may_be_blocked was specified. FALSE otherwise.
<!-- ##### MACRO GTK_PRIVATE_FLAGS ##### -->
<para>
@ -1204,6 +1163,20 @@ is enabled.
@func_data:
@args:
<!-- ##### SECTION ./tmpl/gtkmarshal.sgml:See_Also ##### -->
<para>
<variablelist>
<varlistentry>
<term>#GtkSignal</term>
<listitem><para>The signal handling functions (of which marshallers are
really an implementation detail).</para></listitem>
</varlistentry>
</variablelist>
</para>
<!-- ##### MACRO GTK_WIDGET_RESIZE_NEEDED ##### -->
<para>
@ -1261,6 +1234,12 @@ The first "flat" (no struct) enumerated type value.
@buffer:
<!-- ##### MACRO gtk_signal_default_marshaller ##### -->
<para>
A marshaller that returns void and takes no extra parameters.
</para>
<!-- ##### STRUCT GtkTextTabArray ##### -->
<para>
@ -1273,17 +1252,6 @@ The first "flat" (no struct) enumerated type value.
</para>
<!-- ##### USER_FUNCTION GtkClipboardTextReceivedFunc ##### -->
<para>
A function to be called when the results of gtk_clipboard_request_text()
are received, or when the request fails.
</para>
@clipboard: the #GtkClipboard
@text: the text received, as a UTF-8 encoded string, or %NULL
if retrieving the data failed.
@data: the @user_data supplied to gtk_clipboard_request_text().
<!-- ##### MACRO GTK_WIDGET_HAS_SHAPE_MASK ##### -->
<para>
@ -1299,6 +1267,14 @@ The first "flat" (no struct) enumerated type value.
@buffer:
@time:
<!-- ##### FUNCTION gtk_text_mark_ref ##### -->
<para>
</para>
@mark:
@Returns:
<!-- ##### FUNCTION gtk_marshal_NONE__POINTER_INT ##### -->
<para>
@ -1365,27 +1341,6 @@ make sure that it's okay to cast @type_object into a @cast_type.
@func_data:
@args:
<!-- ##### USER_FUNCTION GtkClipboardGetFunc ##### -->
<para>
A function that will be called to provide the contents of the selection.
If multiple types of data were advertised, the requested type can
be determined from the @info parameter or by checking the target field
of @selection_data. If the data could succesfully be converted into
then it should be stored into the @selection_data object by
calling gtk_selection_data_set() (or related functions such
as gtk_seletion_data_get().) If no data is set, the requestor
will be informed that the attempt to get the data failed.
</para>
@clipboard: the #GtkClipboard
@selection_data: a #GtkSelectionData argument in which the requested
data should be stored.
@info: the info field corresponding to the requested
target from the #GtkTargetEntry array passed to
gtk_clipboard_set_with_data() or gtk_clipboard_set_with_owner().
@user_data_or_owner: the @user_data argument passed to gtk_clipboard_set_with_data(), or
the @owner argument passed to gtk_clipboard_set_owner()
<!-- ##### MACRO gtk_marshal_NONE__OBJECT ##### -->
<para>
@ -1398,15 +1353,6 @@ will be informed that the attempt to get the data failed.
</para>
<!-- ##### FUNCTION gtk_clipboard_set_text ##### -->
<para>
</para>
@clipboard:
@text:
@len:
<!-- ##### FUNCTION gtk_type_set_varargs_type ##### -->
<para>
Set the varargs type for a fundamental type @foreign_type.
@ -1416,12 +1362,6 @@ Set the varargs type for a fundamental type @foreign_type.
fundamental type.
@varargs_type: Must be a GtkType which is either structured or flag, or NONE.
<!-- ##### STRUCT GtkClipboard ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_type_check_class_cast ##### -->
<para>
Given a GtkTypeClass pointer @klass, and a GtkType @cast_type, make
@ -1439,6 +1379,25 @@ sure that it's okay to cast something of that @klass into a @cast_type.
@factory:
<!-- ##### FUNCTION gtk_signal_n_emissions ##### -->
<para>
Find out the recursion depth of emissions for a particular type
of signal and object. (So it will
always return 0 or 1 if #GTK_RUN_NO_RECURSE is specified)
This is a way to avoid recursion: you can see if
you are currently running in that signal handler and emit it only
if you are.
</para>
<para>Another way to look at it is that this number increases
by one when #gtk_signal_emit(), et al, are called,
and decreases by one when #gtk_signal_emit() returns.
</para>
@object: the object with the signal handler.
@signal_id: the signal id.
@Returns: the recursion depth of emissions of this signal for this
object.
<!-- ##### FUNCTION gtk_text_buffer_insert_pixmap ##### -->
<para>
@ -1485,6 +1444,21 @@ Use to get the value of a GtkArg whose GtkType is GTK_TYPE_ARGS
@entries:
@nentries:
<!-- ##### FUNCTION gtk_signal_set_funcs ##### -->
<para>
These set default functions to call when the user didn't
supply a function when connecting. (These are rarely
used, and probably only for language bindings)
</para>
<para>
By default, there are no such functions.
</para>
@marshal_func: the function to invoke on every handlers for which there
isn't a function pointer. May be NULL.
@destroy_func: the function to invoke when each hook is destroyed.
May be NULL.
<!-- ##### FUNCTION gtk_im_context_simple_new ##### -->
<para>
@ -1527,6 +1501,24 @@ Return NULL if anything goes wrong.
@type: GtkType
@Returns: gpointer to the klass.
<!-- ##### USER_FUNCTION GtkSignalDestroy ##### -->
<para>
A function which you can use to clean up when the
signal handler is destroyed.
</para>
<para>
For example, if your handler requires a few variables
that you made into a struct and allocated (using g_new()
or something), then you will probably want to free
it as soon as the hook is destroyed. This will
allow you to do that. (For this in particular
it is convenient to pass g_free() as a #GtkSignalDestroy
function).
</para>
@data: The user data associated with the hook that is being
destroyed.
<!-- ##### FUNCTION gtk_window_set_default ##### -->
<para>
@ -1535,15 +1527,6 @@ Return NULL if anything goes wrong.
@window:
@defaultw:
<!-- ##### FUNCTION gtk_clipboard_request_text ##### -->
<para>
</para>
@clipboard:
@callback:
@user_data:
<!-- ##### FUNCTION gtk_marshal_NONE__INT ##### -->
<para>
@ -1636,6 +1619,28 @@ Internal function.
</para>
<!-- ##### FUNCTION gtk_signal_query ##### -->
<para>
Obtain information about a signal.
</para>
@signal_id: the signal type identifier.
@Returns: a pointer to a GtkSignalQuery structure
which contains all the information, or NULL.
The pointer is allocated just for you: you must g_free() it.
<!-- ##### FUNCTION gtk_signal_n_emissions_by_name ##### -->
<para>
Find out the recursion depth of emissions for a particular type
of signal and object. Just like gtk_signal_n_emissions()
except it will lookup the signal id for you.
</para>
@object: the object with the signal handler.
@name: the signal name.
@Returns: the recursion depth of emissions of this signal for this
object.
<!-- ##### SECTION ./tmpl/gtkenums.sgml.sgml:See_Also ##### -->
<para>
@ -1736,3 +1741,9 @@ Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_CALLBACK
@GTK_TEXT_SCROLL_PAGE_DOWN:
@GTK_TEXT_SCROLL_PAGE_UP:
<!-- ##### STRUCT GtkTextBTree ##### -->
<para>
</para>

30
docs/reference/gtk/tmpl/gtkbutton.sgml
View File

@ -107,21 +107,6 @@ Returns the current relief style of the given #GtkButton.
@Returns: The current #GtkReliefStyle
<!-- ##### SIGNAL GtkButton::pressed ##### -->
<para>
Emitted when the button is initially pressed.
</para>
@button: the object which received the signal.
<!-- ##### SIGNAL GtkButton::released ##### -->
<para>
Emitted when a button which is pressed is released, no matter where the
mouse cursor is.
</para>
@button: the object which received the signal.
<!-- ##### SIGNAL GtkButton::clicked ##### -->
<para>
Emitted when a button clicked on by the mouse and the cursor stays on the
@ -145,6 +130,21 @@ Emitted when the mouse cursor leaves the region of the button.
@button: the object which received the signal.
<!-- ##### SIGNAL GtkButton::pressed ##### -->
<para>
Emitted when the button is initially pressed.
</para>
@button: the object which received the signal.
<!-- ##### SIGNAL GtkButton::released ##### -->
<para>
Emitted when a button which is pressed is released, no matter where the
mouse cursor is.
</para>
@button: the object which received the signal.
<!-- ##### ARG GtkButton:label ##### -->
<para>
The text within the child #GtkLabel of the #GtkButton. Only useful if

34
docs/reference/gtk/tmpl/gtkcalendar.sgml
View File

@ -188,14 +188,6 @@ gtk_calendar_freeze() are displayed.
@calendar: a #GtkCalendar.
<!-- ##### SIGNAL GtkCalendar::month-changed ##### -->
<para>
Emitted when the user clicks a button to change the selected month on a
calendar.
</para>
@calendar: the object which received the signal.
<!-- ##### SIGNAL GtkCalendar::day-selected ##### -->
<para>
Emitted when the user selects a day.
@ -210,9 +202,10 @@ Emitted when the user selects a day.
@calendar: the object which received the signal.
<!-- ##### SIGNAL GtkCalendar::prev-month ##### -->
<!-- ##### SIGNAL GtkCalendar::month-changed ##### -->
<para>
Emitted when the user clicks a button to change the selected month on a
calendar.
</para>
@calendar: the object which received the signal.
@ -224,13 +217,6 @@ Emitted when the user selects a day.
@calendar: the object which received the signal.
<!-- ##### SIGNAL GtkCalendar::prev-year ##### -->
<para>
</para>
@calendar: the object which received the signal.
<!-- ##### SIGNAL GtkCalendar::next-year ##### -->
<para>
@ -238,3 +224,17 @@ Emitted when the user selects a day.
@calendar: the object which received the signal.
<!-- ##### SIGNAL GtkCalendar::prev-month ##### -->
<para>
</para>
@calendar: the object which received the signal.
<!-- ##### SIGNAL GtkCalendar::prev-year ##### -->
<para>
</para>
@calendar: the object which received the signal.

123
docs/reference/gtk/tmpl/gtkclipboard.sgml
View File

@ -68,7 +68,7 @@ Storing data on Clipboards.
and converting the results into the UTF-8 encoding. (The standard
form for representing strings in GTK+.)
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
<variablelist>
@ -90,6 +90,65 @@ Storing data on Clipboards.
</para>
<!-- ##### USER_FUNCTION GtkClipboardReceivedFunc ##### -->
<para>
A function to be called when the results of gtk_clipboard_request_text()
are received, or when the request fails.
</para>
@clipboard: the #GtkClipboard
@selection_data: a #GtkSelectionData containing the data was received.
If retrieving the data failed, then then length field
of @selection_data will be negative.
@data: the @user_data supplied to gtk_clipboard_request_contents().
<!-- ##### USER_FUNCTION GtkClipboardTextReceivedFunc ##### -->
<para>
A function to be called when the results of gtk_clipboard_request_text()
are received, or when the request fails.
</para>
@clipboard: the #GtkClipboard
@text: the text received, as a UTF-8 encoded string, or %NULL
if retrieving the data failed.
@data: the @user_data supplied to gtk_clipboard_request_text().
<!-- ##### USER_FUNCTION GtkClipboardGetFunc ##### -->
<para>
A function that will be called to provide the contents of the selection.
If multiple types of data were advertised, the requested type can
be determined from the @info parameter or by checking the target field
of @selection_data. If the data could succesfully be converted into
then it should be stored into the @selection_data object by
calling gtk_selection_data_set() (or related functions such
as gtk_seletion_data_get().) If no data is set, the requestor
will be informed that the attempt to get the data failed.
</para>
@clipboard: the #GtkClipboard
@selection_data: a #GtkSelectionData argument in which the requested
data should be stored.
@info: the info field corresponding to the requested
target from the #GtkTargetEntry array passed to
gtk_clipboard_set_with_data() or gtk_clipboard_set_with_owner().
@user_data_or_owner: the @user_data argument passed to gtk_clipboard_set_with_data(), or
the @owner argument passed to gtk_clipboard_set_owner()
<!-- ##### USER_FUNCTION GtkClipboardClearFunc ##### -->
<para>
A function that will be called when the contents of the clipboard are changed
or cleared. Once this has called, the @user_data_or_owner argument
will not be used again.
</para>
@clipboard: the #GtkClipboard
@user_data_or_owner: the @user_data argument passed to gtk_clipboard_set_with_data(), or
the @owner argument passed to gtk_clipboard_set_owner()
<!-- ##### FUNCTION gtk_clipboard_get ##### -->
<para>
@ -127,39 +186,6 @@ Storing data on Clipboards.
@Returns:
<!-- ##### USER_FUNCTION GtkClipboardGetFunc ##### -->
<para>
A function that will be called to provide the contents of the selection.
If multiple types of data were advertised, the requested type can
be determined from the @info parameter or by checking the target field
of @selection_data. If the data could succesfully be converted into
then it should be stored into the @selection_data object by
calling gtk_selection_data_set() (or related functions such
as gtk_seletion_data_get().) If no data is set, the requestor
will be informed that the attempt to get the data failed.
</para>
@clipboard: the #GtkClipboard
@selection_data: a #GtkSelectionData argument in which the requested
data should be stored.
@info: the info field corresponding to the requested
target from the #GtkTargetEntry array passed to
gtk_clipboard_set_with_data() or gtk_clipboard_set_with_owner().
@user_data_or_owner: the @user_data argument passed to gtk_clipboard_set_with_data(), or
the @owner argument passed to gtk_clipboard_set_owner()
<!-- ##### USER_FUNCTION GtkClipboardClearFunc ##### -->
<para>
A function that will be called when the contents of the clipboard are changed
or cleared. Once this has called, the @user_data_or_owner argument
will not be used again.
</para>
@clipboard: the #GtkClipboard
@user_data_or_owner: the @user_data argument passed to gtk_clipboard_set_with_data(), or
the @owner argument passed to gtk_clipboard_set_owner()
<!-- ##### FUNCTION gtk_clipboard_get_owner ##### -->
<para>
@ -198,19 +224,6 @@ will not be used again.
@user_data:
<!-- ##### USER_FUNCTION GtkClipboardReceivedFunc ##### -->
<para>
A function to be called when the results of gtk_clipboard_request_text()
are received, or when the request fails.
</para>
@clipboard: the #GtkClipboard
@selection_data: a #GtkSelectionData containing the data was received.
If retrieving the data failed, then then length field
of @selection_data will be negative.
@data: the @user_data supplied to gtk_clipboard_request_contents().
<!-- ##### FUNCTION gtk_clipboard_request_text ##### -->
<para>
@ -221,18 +234,6 @@ will not be used again.
@user_data:
<!-- ##### USER_FUNCTION GtkClipboardTextReceivedFunc ##### -->
<para>
A function to be called when the results of gtk_clipboard_request_text()
are received, or when the request fails.
</para>
@clipboard: the #GtkClipboard
@text: the text received, as a UTF-8 encoded string, or %NULL
if retrieving the data failed.
@data: the @user_data supplied to gtk_clipboard_request_text().
<!-- ##### FUNCTION gtk_clipboard_wait_for_contents ##### -->
<para>
@ -250,11 +251,11 @@ will not be used again.
@clipboard:
@Returns:
<!--
Local variables:
mode: sgml
sgml-parent-document: ("../gtk-docs.sgml" "book" "refsect2" "")
End:
-->

189
docs/reference/gtk/tmpl/gtkclist.sgml
View File

@ -1131,39 +1131,12 @@ aspect of the #GtkCList widget.
@adjustment: A pointer to a #GtkAdjustment widget, or NULL.
<!-- ##### SIGNAL GtkCList::select-row ##### -->
<!-- ##### SIGNAL GtkCList::abort-column-resize ##### -->
<para>
This signal is emitted when the user selects a row in the list.
It is emitted for every row that is selected in a multi-selection or
by calling gtk_clist_select_all().
This signal is emitted when a column resize is aborted.
</para>
@clist: The object which received the signal.
@row: The row selected.
@column: The column where the selection occured.
@event: A #GdkEvent structure for the selection.
<!-- ##### SIGNAL GtkCList::unselect-row ##### -->
<para>
This signal is emitted when the user unselects a row in the list.
It is emitted for every row that is unselected in a multi-selection or
by calling gtk_clist_unselect_all(). It is also emitted for the
previously selected row in a "single" or "browse" mode CList.
</para>
@clist: The object which received the signal.
@row: The selected row
@column: The column where the selection occured.
@event:
<!-- ##### SIGNAL GtkCList::row-move ##### -->
<para>
This signal is emitted when a row is moved.
</para>
@clist: The object which received the signal.
@arg1: The source position of the row.
@arg2: The destination position of the row.
@clist: the object which received the signal.
<!-- ##### SIGNAL GtkCList::click-column ##### -->
<para>
@ -1173,52 +1146,6 @@ This signal is emitted when a column title is clicked.
@clist: The object which received the signal.
@column: The number of the column.
<!-- ##### SIGNAL GtkCList::resize-column ##### -->
<para>
This signal is emitted when a column is resized.
</para>
@clist: The object which received the signal.
@column: The number of the column
@width: The new width of the column.
<!-- ##### SIGNAL GtkCList::toggle-focus-row ##### -->
<para>
</para>
@clist: The object which received the signal.
<!-- ##### SIGNAL GtkCList::select-all ##### -->
<para>
This signal is emitted when all the rows are selected in a CList.
</para>
@clist: the object which received the signal.
<!-- ##### SIGNAL GtkCList::unselect-all ##### -->
<para>
This signal is emitted when all rows are unselected in a CList.
</para>
@clist: the object which received the signal.
<!-- ##### SIGNAL GtkCList::undo-selection ##### -->
<para>
This signal is emitted when an undo selection occurs in the CList,
probably via calling gtk_clist_undo_selection().
</para>
@clist: the object which received the signal.
<!-- ##### SIGNAL GtkCList::start-selection ##### -->
<para>
This signal is emitted when a drag-selection is started in
a multiple-selection CList.
</para>
@clist: the object which received the signal.
<!-- ##### SIGNAL GtkCList::end-selection ##### -->
<para>
This signal is emitted when a selection ends in a
@ -1227,13 +1154,6 @@ multiple selection CList.
@clist: the object which received the signal.
<!-- ##### SIGNAL GtkCList::toggle-add-mode ##### -->
<para>
This signal is emitted when "add mode" is toggled.
</para>
@clist: the object which received the signal.
<!-- ##### SIGNAL GtkCList::extend-selection ##### -->
<para>
This signal is emitted when the selection is extended.
@ -1245,14 +1165,23 @@ occured during the selection.
@position: A value between 0.0 and 1.0.
@auto_start_selection: %TRUE or %FALSE.
<!-- ##### SIGNAL GtkCList::scroll-vertical ##### -->
<!-- ##### SIGNAL GtkCList::resize-column ##### -->
<para>
This signal is emitted when the CList is scrolled vertically.
This signal is emitted when a column is resized.
</para>
@clist: the object which received the signal.
@scroll_type: A #GtkScrollType value of how the scroll operation occured.
@position: A value between 0.0 and 1.0.
@clist: The object which received the signal.
@column: The number of the column
@width: The new width of the column.
<!-- ##### SIGNAL GtkCList::row-move ##### -->
<para>
This signal is emitted when a row is moved.
</para>
@clist: The object which received the signal.
@arg1: The source position of the row.
@arg2: The destination position of the row.
<!-- ##### SIGNAL GtkCList::scroll-horizontal ##### -->
<para>
@ -1263,12 +1192,92 @@ This signal is emitted when the CList is scrolled horizontally.
@scroll_type: A #GtkScrollType value of how the scroll operation occured.
@position: a value between 0.0 and 1.0.
<!-- ##### SIGNAL GtkCList::abort-column-resize ##### -->
<!-- ##### SIGNAL GtkCList::scroll-vertical ##### -->
<para>
This signal is emitted when a column resize is aborted.
This signal is emitted when the CList is scrolled vertically.
</para>
@clist: the object which received the signal.
@scroll_type: A #GtkScrollType value of how the scroll operation occured.
@position: A value between 0.0 and 1.0.
<!-- ##### SIGNAL GtkCList::select-all ##### -->
<para>
This signal is emitted when all the rows are selected in a CList.
</para>
@clist: the object which received the signal.
<!-- ##### SIGNAL GtkCList::select-row ##### -->
<para>
This signal is emitted when the user selects a row in the list.
It is emitted for every row that is selected in a multi-selection or
by calling gtk_clist_select_all().
</para>
@clist: The object which received the signal.
@row: The row selected.
@column: The column where the selection occured.
@event: A #GdkEvent structure for the selection.
<!-- ##### SIGNAL GtkCList::set-scroll-adjustments ##### -->
<para>
</para>
@clist: the object which received the signal.
@arg1:
@arg2:
<!-- ##### SIGNAL GtkCList::start-selection ##### -->
<para>
This signal is emitted when a drag-selection is started in
a multiple-selection CList.
</para>
@clist: the object which received the signal.
<!-- ##### SIGNAL GtkCList::toggle-add-mode ##### -->
<para>
This signal is emitted when "add mode" is toggled.
</para>
@clist: the object which received the signal.
<!-- ##### SIGNAL GtkCList::toggle-focus-row ##### -->
<para>
</para>
@clist: The object which received the signal.
<!-- ##### SIGNAL GtkCList::undo-selection ##### -->
<para>
This signal is emitted when an undo selection occurs in the CList,
probably via calling gtk_clist_undo_selection().
</para>
@clist: the object which received the signal.
<!-- ##### SIGNAL GtkCList::unselect-all ##### -->
<para>
This signal is emitted when all rows are unselected in a CList.
</para>
@clist: the object which received the signal.
<!-- ##### SIGNAL GtkCList::unselect-row ##### -->
<para>
This signal is emitted when the user unselects a row in the list.
It is emitted for every row that is unselected in a multi-selection or
by calling gtk_clist_unselect_all(). It is also emitted for the
previously selected row in a "single" or "browse" mode CList.
</para>
@clist: The object which received the signal.
@row: The selected row
@column: The column where the selection occured.
@event:
<!-- ##### ARG GtkCList:n_columns ##### -->
<para>

16
docs/reference/gtk/tmpl/gtkcontainer.sgml
View File

@ -348,14 +348,6 @@ GtkContainer
@container: the object which received the signal.
@widget:
<!-- ##### SIGNAL GtkContainer::remove ##### -->
<para>
</para>
@container: the object which received the signal.
@widget:
<!-- ##### SIGNAL GtkContainer::check-resize ##### -->
<para>
@ -372,6 +364,14 @@ GtkContainer
@direction:
@Returns:
<!-- ##### SIGNAL GtkContainer::remove ##### -->
<para>
</para>
@container: the object which received the signal.
@widget:
<!-- ##### SIGNAL GtkContainer::set-focus-child ##### -->
<para>

70
docs/reference/gtk/tmpl/gtkctree.sgml
View File

@ -1167,6 +1167,41 @@ criteria etc.
@show_stub:
<!-- ##### SIGNAL GtkCTree::change-focus-row-expansion ##### -->
<para>
The row which has the focus is either collapsed or expanded
or toggled.
</para>
@ctree: the object which received the signal.
@expansion: What is being done.
<!-- ##### SIGNAL GtkCTree::tree-collapse ##### -->
<para>
Emitted when a node is collapsed.
</para>
@ctree: the object which received the signal.
@node:
<!-- ##### SIGNAL GtkCTree::tree-expand ##### -->
<para>
Emitted when a node is expanded.
</para>
@ctree: the object which received the signal.
@node:
<!-- ##### SIGNAL GtkCTree::tree-move ##### -->
<para>
Emitted when a node is moved.
</para>
@ctree: the object which received the signal.
@node: The node that is moved.
@new_parent: The new parent of the node.
@new_sibling: The new sibling of the node.
<!-- ##### SIGNAL GtkCTree::tree-select-row ##### -->
<para>
Emitted when a row is selected.
@ -1185,41 +1220,6 @@ Emitted when a node is unselected.
@node: The node corresponding to the selected row.
@column:
<!-- ##### SIGNAL GtkCTree::tree-expand ##### -->
<para>
Emitted when a node is expanded.
</para>
@ctree: the object which received the signal.
@node:
<!-- ##### SIGNAL GtkCTree::tree-collapse ##### -->
<para>
Emitted when a node is collapsed.
</para>
@ctree: the object which received the signal.
@node:
<!-- ##### SIGNAL GtkCTree::tree-move ##### -->
<para>
Emitted when a node is moved.
</para>
@ctree: the object which received the signal.
@node: The node that is moved.
@new_parent: The new parent of the node.
@new_sibling: The new sibling of the node.
<!-- ##### SIGNAL GtkCTree::change-focus-row-expansion ##### -->
<para>
The row which has the focus is either collapsed or expanded
or toggled.
</para>
@ctree: the object which received the signal.
@expansion: What is being done.
<!-- ##### ARG GtkCTree:n_columns ##### -->
<para>
The number of columns in the tree.

232
docs/reference/gtk/tmpl/gtkeditable.sgml
View File

@ -264,6 +264,17 @@ widget or not.
in the widget.
<!-- ##### SIGNAL GtkEditable::activate ##### -->
<para>
Indicates that the user has activated the widget
in some fashion. Generally, this will be done
with a keystroke. (The default binding for this
action is Return for #GtkEntry and
Control-Return for #GtkText.)
</para>
@editable: the object which received the signal.
<!-- ##### SIGNAL GtkEditable::changed ##### -->
<para>
Indicates that the user has changed the contents
@ -272,6 +283,40 @@ of the widget.
@editable: the object which received the signal.
<!-- ##### SIGNAL GtkEditable::copy-clipboard ##### -->
<para>
An action signal. Causes the characters in the current selection to
be copied to the clipboard.
</para>
@editable: the object which received the signal.
<!-- ##### SIGNAL GtkEditable::cut-clipboard ##### -->
<para>
An action signal. Causes the characters in the current
selection to be copied to the clipboard and then deleted from
the widget.
</para>
@editable: the object which received the signal.
<!-- ##### SIGNAL GtkEditable::delete-text ##### -->
<para>
This signal is emitted when text is deleted from
the widget by the user. The default handler for
this signal will normally be responsible for inserting
the text, so by connecting to this signal and then
stopping the signal with gtk_signal_emit_stop(), it
is possible to modify the inserted text, or prevent
it from being inserted entirely. The @start_pos
and @end_pos parameters are interpreted as for
gtk_editable_delete_text()
</para>
@editable: the object which received the signal.
@start_pos: the starting position.
@end_pos: the end position.
<!-- ##### SIGNAL GtkEditable::insert-text ##### -->
<para>
This signal is emitted when text is inserted into
@ -291,30 +336,83 @@ it from being inserted entirely.
emission is finished, it should point after
the newly inserted text.
<!-- ##### SIGNAL GtkEditable::delete-text ##### -->
<!-- ##### SIGNAL GtkEditable::kill-char ##### -->
<para>
This signal is emitted when text is deleted from
the widget by the user. The default handler for
this signal will normally be responsible for inserting
the text, so by connecting to this signal and then
stopping the signal with gtk_signal_emit_stop(), it
is possible to modify the inserted text, or prevent
it from being inserted entirely. The @start_pos
and @end_pos parameters are interpreted as for
gtk_editable_delete_text()
An action signal. Delete a single character.
</para>
@editable: the object which received the signal.
@start_pos: the starting position.
@end_pos: the end position.
@direction: the direction in which to delete. Positive
indicates forward deletion, negative, backwards deletion.
<!-- ##### SIGNAL GtkEditable::activate ##### -->
<!-- ##### SIGNAL GtkEditable::kill-line ##### -->
<para>
Indicates that the user has activated the widget
in some fashion. Generally, this will be done
with a keystroke. (The default binding for this
action is Return for #GtkEntry and
Control-Return for #GtkText.)
An action signal. Delete a single line.
</para>
@editable: the object which received the signal.
@direction: the direction in which to delete. Positive
indicates forward deletion, negative, backwards deletion.
<!-- ##### SIGNAL GtkEditable::kill-word ##### -->
<para>
An action signal. Delete a single word.
</para>
@editable: the object which received the signal.
@direction: the direction in which to delete. Positive
indicates forward deletion, negative, backwards deletion.
<!-- ##### SIGNAL GtkEditable::move-cursor ##### -->
<para>
An action signal. Move the cursor position.
</para>
@editable: the object which received the signal.
@x: horizontal distance to move the cursor.
@y: vertical distance to move the cursor.
<!-- ##### SIGNAL GtkEditable::move-page ##### -->
<para>
An action signal. Move the cursor by pages.
</para>
@editable: the object which received the signal.
@x: Number of pages to move the cursor horizontally.
@y: Number of pages to move the cursor vertically.
<!-- ##### SIGNAL GtkEditable::move-to-column ##### -->
<para>
An action signal. Move the cursor to the given column.
</para>
@editable: the object which received the signal.
@column: the column to move to. (A negative value indicates
the last column)
<!-- ##### SIGNAL GtkEditable::move-to-row ##### -->
<para>
An action signal. Move the cursor to the given row.
</para>
@editable: the object which received the signal.
@row: the row to move to. (A negative value indicates
the last row)
<!-- ##### SIGNAL GtkEditable::move-word ##### -->
<para>
An action signal. Move the cursor by words.
</para>
@editable: the object which received the signal.
@num_words: The number of words to move the
cursor. (Can be negative).
<!-- ##### SIGNAL GtkEditable::paste-clipboard ##### -->
<para>
An action signal. Causes the contents of the clipboard to
be pasted into the editable widget at the current cursor
position.
</para>
@editable: the object which received the signal.
@ -331,104 +429,6 @@ applications.
@is_editable: %TRUE if the user is allowed to edit the text
in the widget.
<!-- ##### SIGNAL GtkEditable::move-cursor ##### -->
<para>
An action signal. Move the cursor position.
</para>
@editable: the object which received the signal.
@x: horizontal distance to move the cursor.
@y: vertical distance to move the cursor.
<!-- ##### SIGNAL GtkEditable::move-word ##### -->
<para>
An action signal. Move the cursor by words.
</para>
@editable: the object which received the signal.
@num_words: The number of words to move the
cursor. (Can be negative).
<!-- ##### SIGNAL GtkEditable::move-page ##### -->
<para>
An action signal. Move the cursor by pages.
</para>
@editable: the object which received the signal.
@x: Number of pages to move the cursor horizontally.
@y: Number of pages to move the cursor vertically.
<!-- ##### SIGNAL GtkEditable::move-to-row ##### -->
<para>
An action signal. Move the cursor to the given row.
</para>
@editable: the object which received the signal.
@row: the row to move to. (A negative value indicates
the last row)
<!-- ##### SIGNAL GtkEditable::move-to-column ##### -->
<para>
An action signal. Move the cursor to the given column.
</para>
@editable: the object which received the signal.
@column: the column to move to. (A negative value indicates
the last column)
<!-- ##### SIGNAL GtkEditable::kill-char ##### -->
<para>
An action signal. Delete a single character.
</para>
@editable: the object which received the signal.
@direction: the direction in which to delete. Positive
indicates forward deletion, negative, backwards deletion.
<!-- ##### SIGNAL GtkEditable::kill-word ##### -->
<para>
An action signal. Delete a single word.
</para>
@editable: the object which received the signal.
@direction: the direction in which to delete. Positive
indicates forward deletion, negative, backwards deletion.
<!-- ##### SIGNAL GtkEditable::kill-line ##### -->
<para>
An action signal. Delete a single line.
</para>
@editable: the object which received the signal.
@direction: the direction in which to delete. Positive
indicates forward deletion, negative, backwards deletion.
<!-- ##### SIGNAL GtkEditable::cut-clipboard ##### -->
<para>
An action signal. Causes the characters in the current
selection to be copied to the clipboard and then deleted from
the widget.
</para>
@editable: the object which received the signal.
<!-- ##### SIGNAL GtkEditable::copy-clipboard ##### -->
<para>
An action signal. Causes the characters in the current selection to
be copied to the clipboard.
</para>
@editable: the object which received the signal.
<!-- ##### SIGNAL GtkEditable::paste-clipboard ##### -->
<para>
An action signal. Causes the contents of the clipboard to
be pasted into the editable widget at the current cursor
position.
</para>
@editable: the object which received the signal.
<!-- ##### ARG GtkEditable:text_position ##### -->
<para>
The position of the cursor.

20
docs/reference/gtk/tmpl/gtkimcontext.sgml
View File

@ -65,7 +65,15 @@ GtkIMContext
@context:
<!-- ##### SIGNAL GtkIMContext::preedit-start ##### -->
<!-- ##### SIGNAL GtkIMContext::commit ##### -->
<para>
</para>
@imcontext: the object which received the signal.
@arg1:
<!-- ##### SIGNAL GtkIMContext::preedit-changed ##### -->
<para>
</para>
@ -79,18 +87,10 @@ GtkIMContext
@imcontext: the object which received the signal.
<!-- ##### SIGNAL GtkIMContext::preedit-changed ##### -->
<!-- ##### SIGNAL GtkIMContext::preedit-start ##### -->
<para>
</para>
@imcontext: the object which received the signal.
<!-- ##### SIGNAL GtkIMContext::commit ##### -->
<para>
</para>
@imcontext: the object which received the signal.
@arg1:

20
docs/reference/gtk/tmpl/gtkinputdialog.sgml
View File

@ -41,16 +41,6 @@ Creates a new #GtkInputDialog.
@Returns: the new #GtkInputDialog.
<!-- ##### SIGNAL GtkInputDialog::enable-device ##### -->
<para>
This signal is emitted when the user changes the
mode of a device from #GDK_MODE_DISABLED to a
#GDK_MODE_SCREEN or #GDK_MODE_WINDOW.
</para>
@inputdialog: the object which received the signal.
@deviceid: The ID of the newly enabled device.
<!-- ##### SIGNAL GtkInputDialog::disable-device ##### -->
<para>
This signal is emitted when the user changes the
@ -61,3 +51,13 @@ to #GDK_MODE_ENABLED.
@inputdialog: the object which received the signal.
@deviceid: The ID of the newly disabled device.
<!-- ##### SIGNAL GtkInputDialog::enable-device ##### -->
<para>
This signal is emitted when the user changes the
mode of a device from #GDK_MODE_DISABLED to a
#GDK_MODE_SCREEN or #GDK_MODE_WINDOW.
</para>
@inputdialog: the object which received the signal.
@deviceid: The ID of the newly enabled device.

8
docs/reference/gtk/tmpl/gtkitem.sgml
View File

@ -46,16 +46,16 @@ Emits the "toggle" signal on the given item.
@item: a #GtkItem.
<!-- ##### SIGNAL GtkItem::select ##### -->
<!-- ##### SIGNAL GtkItem::deselect ##### -->
<para>
Emitted when the item is selected.
Emitted when the item is deselected.
</para>
@item: the object which received the signal.
<!-- ##### SIGNAL GtkItem::deselect ##### -->
<!-- ##### SIGNAL GtkItem::select ##### -->
<para>
Emitted when the item is deselected.
Emitted when the item is selected.
</para>
@item: the object which received the signal.

9
docs/reference/gtk/tmpl/gtklayout.sgml
View File

@ -114,3 +114,12 @@ GtkLayout
@adjustment:
<!-- ##### SIGNAL GtkLayout::set-scroll-adjustments ##### -->
<para>
</para>
@layout: the object which received the signal.
@arg1:
@arg2:

14
docs/reference/gtk/tmpl/gtklist.sgml
View File

@ -332,13 +332,6 @@ effect if a drag selection is not active.
@list: the list widget.
<!-- ##### SIGNAL GtkList::selection-changed ##### -->
<para>
The selection of the widget has just changed.
</para>
@list: the object which received the signal.
<!-- ##### SIGNAL GtkList::select-child ##### -->
<para>
The child @widget has just been selected.
@ -347,6 +340,13 @@ The child @widget has just been selected.
@list: the object which received the signal.
@widget: the newly selected child.
<!-- ##### SIGNAL GtkList::selection-changed ##### -->
<para>
The selection of the widget has just changed.
</para>
@list: the object which received the signal.
<!-- ##### SIGNAL GtkList::unselect-child ##### -->
<para>
The child @widget has just been unselected.

102
docs/reference/gtk/tmpl/gtklistitem.sgml
View File

@ -66,41 +66,6 @@ Deselects the item, by emitting the item's "deselect" signal.
@list_item: a #GtkListItem.
<!-- ##### SIGNAL GtkListItem::toggle-focus-row ##### -->
<para>
</para>
@listitem: the object which received the signal.
<!-- ##### SIGNAL GtkListItem::select-all ##### -->
<para>
</para>
@listitem: the object which received the signal.
<!-- ##### SIGNAL GtkListItem::unselect-all ##### -->
<para>
</para>
@listitem: the object which received the signal.
<!-- ##### SIGNAL GtkListItem::undo-selection ##### -->
<para>
</para>
@listitem: the object which received the signal.
<!-- ##### SIGNAL GtkListItem::start-selection ##### -->
<para>
</para>
@listitem: the object which received the signal.
<!-- ##### SIGNAL GtkListItem::end-selection ##### -->
<para>
@ -108,13 +73,6 @@ Deselects the item, by emitting the item's "deselect" signal.
@listitem: the object which received the signal.
<!-- ##### SIGNAL GtkListItem::toggle-add-mode ##### -->
<para>
</para>
@listitem: the object which received the signal.
<!-- ##### SIGNAL GtkListItem::extend-selection ##### -->
<para>
@ -125,15 +83,6 @@ Deselects the item, by emitting the item's "deselect" signal.
@position:
@auto_start_selection:
<!-- ##### SIGNAL GtkListItem::scroll-vertical ##### -->
<para>
</para>
@listitem: the object which received the signal.
@scroll_type:
@position:
<!-- ##### SIGNAL GtkListItem::scroll-horizontal ##### -->
<para>
@ -143,3 +92,54 @@ Deselects the item, by emitting the item's "deselect" signal.
@scroll_type:
@position:
<!-- ##### SIGNAL GtkListItem::scroll-vertical ##### -->
<para>
</para>
@listitem: the object which received the signal.
@scroll_type:
@position:
<!-- ##### SIGNAL GtkListItem::select-all ##### -->
<para>
</para>
@listitem: the object which received the signal.
<!-- ##### SIGNAL GtkListItem::start-selection ##### -->
<para>
</para>
@listitem: the object which received the signal.
<!-- ##### SIGNAL GtkListItem::toggle-add-mode ##### -->
<para>
</para>
@listitem: the object which received the signal.
<!-- ##### SIGNAL GtkListItem::toggle-focus-row ##### -->
<para>
</para>
@listitem: the object which received the signal.
<!-- ##### SIGNAL GtkListItem::undo-selection ##### -->
<para>
</para>
@listitem: the object which received the signal.
<!-- ##### SIGNAL GtkListItem::unselect-all ##### -->
<para>
</para>
@listitem: the object which received the signal.

91
docs/reference/gtk/tmpl/gtkmarshal.sgml
View File

@ -1,91 +0,0 @@
<!-- ##### SECTION Title ##### -->
Signal Marshallers
<!-- ##### SECTION Short_Description ##### -->
Functions to adapt C structures to native calling convention.
<!-- ##### SECTION Long_Description ##### -->
<refsect2>
<title>What are Signal Marshallers?</title>
<para>
Marshals are functions which all have the same prototype:
they take a #GtkObject, a #GtkSignalFunc, a #gpointer,
and an array of argument values.
The functions are names gtk_marshall_RETURNTYPE__PARAMTYPE1_PARAMTYPE2....
</para>
<para>
They then call a native function: the GtkObject is the first
parameter passed in. The arguments are passed in the native
calling convention: chars, shorts, ints, longs may be packed
on the stack, or tucked in registers: it doesn't matter
because the same calling convention will be generated
inside the gtkmarshal code as is expected where you define
your handlers.
</para>
<para>
So the function named:
<programlisting>
gtk_marshal_BOOL__POINTER_INT_INT_UINT(GtkObject*, GtkSignalFunc, gpointer, GtkArg*);
</programlisting>
will call the #GtkSignalFunc assuming it was a function with signature:
<programlisting>
gboolean sigfunc(gpointer,gint,gint,guint);
</programlisting>
</para>
</refsect2>
<refsect2>
<title>Writing Custom Marshals</title>
<para>
Marshals are primarily used as arguments to gtk_signal_new().
Sometimes, you may find that a marshaller you need isn't available
in the standard list. Then you have to write your own.
</para>
<para>
If you wish to define a signal with a new type of argument list.
Suppose you want 2 pointers and 2 integers.
You would write:
<programlisting>
typedef int (*GtkSignal_INT__POINTER_POINTER_INT_INT)(
gpointer, gpointer, gint, gint
);
void marshal_INT__POINTER_POINTER_INT_INT(GtkObject* object,
GtkSignalFunc func,
gpointer func_data,
GtkArg* args)
{
GtkSignal_NONE__POINTER_POINTER_INT_INT rfunc;
gint* return_val;
return_val = GTK_RETLOC_INT(args[4]);
rfunc = (GtkSignal_INT__POINTER_POINTER_INT_INT)func;
*return_val = (*rfunc)(object,
GTK_VALUE_POINTER(args[0]),
GTK_VALUE_POINTER(args[1]),
GTK_VALUE_INT(args[2]),
GTK_VALUE_INT(args[3]),
func_data);
}
</programlisting>
</para>
</refsect2>
<!-- ##### SECTION See_Also ##### -->
<para>
<variablelist>
<varlistentry>
<term>#GtkSignal</term>
<listitem><para>The signal handling functions (of which marshallers are
really an implementation detail).</para></listitem>
</varlistentry>
</variablelist>
</para>
<!-- ##### MACRO gtk_signal_default_marshaller ##### -->
<para>
A marshaller that returns void and takes no extra parameters.
</para>

132
docs/reference/gtk/tmpl/gtkmenufactory.sgml
View File

@ -1,132 +0,0 @@
<!-- ##### SECTION Title ##### -->
Menu Factory
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### USER_FUNCTION GtkMenuCallback ##### -->
<para>
</para>
@widget:
@user_data:
<!-- ##### STRUCT GtkMenuEntry ##### -->
<para>
</para>
@path:
@accelerator:
@callback:
@callback_data:
@widget:
<!-- ##### STRUCT GtkMenuPath ##### -->
<para>
</para>
@path:
@widget:
<!-- ##### STRUCT GtkMenuFactory ##### -->
<para>
</para>
@path:
@type:
@accel_group:
@widget:
@subfactories:
<!-- ##### FUNCTION gtk_menu_factory_new ##### -->
<para>
</para>
@type:
@Returns:
<!-- ##### FUNCTION gtk_menu_factory_destroy ##### -->
<para>
</para>
@factory:
<!-- ##### FUNCTION gtk_menu_factory_add_entries ##### -->
<para>
</para>
@factory:
@entries:
@nentries:
<!-- ##### FUNCTION gtk_menu_factory_add_subfactory ##### -->
<para>
</para>
@factory:
@subfactory:
@path:
<!-- ##### FUNCTION gtk_menu_factory_remove_paths ##### -->
<para>
</para>
@factory:
@paths:
@npaths:
<!-- ##### FUNCTION gtk_menu_factory_remove_entries ##### -->
<para>
</para>
@factory:
@entries:
@nentries:
<!-- ##### FUNCTION gtk_menu_factory_remove_subfactory ##### -->
<para>
</para>
@factory:
@subfactory:
@path:
<!-- ##### FUNCTION gtk_menu_factory_find ##### -->
<para>
</para>
@factory:
@path:
@Returns:

48
docs/reference/gtk/tmpl/gtkmenushell.sgml
View File

@ -144,30 +144,6 @@ An enumeration representing directional movements within a menu.
@GTK_MENU_DIR_NEXT:
@GTK_MENU_DIR_PREV:
<!-- ##### SIGNAL GtkMenuShell::deactivate ##### -->
<para>
This signal is emitted when a menu shell is deactivated.
</para>
@menushell: the object which received the signal.
<!-- ##### SIGNAL GtkMenuShell::selection-done ##### -->
<para>
This signal is emitted when a selection has been completed within a menu
shell.
</para>
@menushell: the object which received the signal.
<!-- ##### SIGNAL GtkMenuShell::move-current ##### -->
<para>
An action signal which moves the current menu item in the direction
specified by @direction.
</para>
@menushell: the object which received the signal.
@direction: the direction to move.
<!-- ##### SIGNAL GtkMenuShell::activate-current ##### -->
<para>
An action signal that activates the current menu item within the menu
@ -185,3 +161,27 @@ Causes the GtkMenuShell::selection-done signal to be emitted.
@menushell: the object which received the signal.
<!-- ##### SIGNAL GtkMenuShell::deactivate ##### -->
<para>
This signal is emitted when a menu shell is deactivated.
</para>
@menushell: the object which received the signal.
<!-- ##### SIGNAL GtkMenuShell::move-current ##### -->
<para>
An action signal which moves the current menu item in the direction
specified by @direction.
</para>
@menushell: the object which received the signal.
@direction: the direction to move.
<!-- ##### SIGNAL GtkMenuShell::selection-done ##### -->
<para>
This signal is emitted when a selection has been completed within a menu
shell.
</para>
@menushell: the object which received the signal.

2
docs/reference/gtk/tmpl/gtkobject.sgml
View File

@ -210,7 +210,7 @@ there own references, if they believe they are nearly primary
ownership of the object.
GTK_CONNECTED: refers to whether are signals are connected to this
object.
@GTK_CONNECTED:
@GTK_RESERVED:
@GTK_CONSTRUCTED: refers to whether the arguments for this object are
ready.

327
docs/reference/gtk/tmpl/gtksignal.sgml
View File

@ -152,48 +152,12 @@ you might have to write a marshaller.
</para>
<!-- # Unused Parameters # -->
@struct:
@field:
<!-- ##### USER_FUNCTION GtkSignalMarshal ##### -->
<para>
This is currently a hack left in for a scheme wrapper library.
It may be removed.
</para>
<para>
Don't use it.
</para>
@object: The object which emits the signal.
@data: The user data associated with the hook.
@nparams: The number of parameters to the function.
@args: The actual values of the arguments.
@arg_types: The types of the arguments.
@return_type: The type of the return value from the function
or #GTK_TYPE_NONE for no return value.
<!-- ##### USER_FUNCTION GtkSignalDestroy ##### -->
<para>
A function which you can use to clean up when the
signal handler is destroyed.
</para>
<para>
For example, if your handler requires a few variables
that you made into a struct and allocated (using g_new()
or something), then you will probably want to free
it as soon as the hook is destroyed. This will
allow you to do that. (For this in particular
it is convenient to pass g_free() as a #GtkSignalDestroy
function).
</para>
@data: The user data associated with the hook that is being
destroyed.
<!-- ##### USER_FUNCTION GtkEmissionHook ##### -->
<!-- ##### TYPEDEF GtkEmissionHook ##### -->
<para>
A simple function pointer to get invoked when the
signal is emitted. This allows you tie a hook to the signal type,
@ -204,32 +168,6 @@ You may not attach these to signals created with the
#GTK_RUN_NO_HOOKS flag.
</para>
@object: the object which emits the signal.
@signal_id: the unique integer identify the signal type.
@n_params: the number of parameters to the function,
not including return value.
@params: the parameters to the function. A pointer to
the return value is passed as a last element.
@data: the user data associated with the hook.
@Returns: whether it wished to be removed. If it returns
TRUE, the signal hook is disconnected (and destroyed).
<!-- ##### STRUCT GtkSignalQuery ##### -->
<para>
This structure contains all the information about a particular
signal: its name, the type it affects, the signature of the handlers,
and its unique identifying integer.
</para>
@object_type:
@signal_id:
@signal_name:
@is_user_signal:
@signal_flags:
@return_val:
@nparams:
@params:
<!-- ##### ENUM GtkSignalRunType ##### -->
<para>
@ -306,7 +244,7 @@ to the signal.
@GTK_RUN_ACTION:
@GTK_RUN_NO_HOOKS:
<!-- ##### FUNCTION gtk_signal_init ##### -->
<!-- ##### MACRO gtk_signal_init ##### -->
<para>
</para>
@ -336,9 +274,11 @@ for example, gtk_marshal_BOOL__STRING() describes a marshaller
which takes a string and returns a boolean value.
@return_val: the type of return value, or GTK_TYPE_NONE for a signal
without a return value.
@nparams: the number of parameter the handlers may take.
@n_args:
@Varargs: a list of GTK_TYPE_*, one for each parameter.
@Returns: the signal id.
<!-- # Unused Parameters # -->
@nparams: the number of parameter the handlers may take.
<!-- ##### FUNCTION gtk_signal_newv ##### -->
@ -359,13 +299,16 @@ the class structure for this type.
@marshaller:
@return_val: the type of the return value, or GTK_TYPE_NONE if
you don't want a return value.
@n_args:
@args:
@Returns: the signal id.
<!-- # Unused Parameters # -->
@nparams: the number of parameters to the user-defined handlers.
@params: an array of GtkTypes, describing the prototype to
the callbacks.
@Returns: the signal id.
<!-- ##### FUNCTION gtk_signal_lookup ##### -->
<!-- ##### MACRO gtk_signal_lookup ##### -->
<para>
Given the name of the signal and the type of object it connects
to, get the signal's identifying integer. Emitting the signal
@ -375,12 +318,13 @@ by number is somewhat faster than using the name each time.
It also tries the ancestors of the given type.
</para>
@Returns: the signal's identifying number, or 0 if no signal was found.
<!-- # Unused Parameters # -->
@name: the signal's name, e.g. clicked.
@object_type: the type that the signal operates on, e.g. #GTK_TYPE_BUTTON.
@Returns: the signal's identifying number, or 0 if no signal was found.
<!-- ##### FUNCTION gtk_signal_name ##### -->
<!-- ##### MACRO gtk_signal_name ##### -->
<para>
Given the signal's identifier, find its name.
</para>
@ -388,8 +332,9 @@ Given the signal's identifier, find its name.
Two different signals may have the same name, if they have differing types.
</para>
@signal_id: the signal's identifying number.
@Returns: the signal name, or NULL if the signal number was invalid.
<!-- # Unused Parameters # -->
@signal_id: the signal's identifying number.
<!-- ##### FUNCTION gtk_signal_emit ##### -->
@ -436,6 +381,8 @@ an array of GtkArgs instead of using C's varargs mechanism.
@object: the object to emit the signal to.
@signal_id: the signal identifier.
@args:
<!-- # Unused Parameters # -->
@params: an array of GtkArgs, one for each parameter,
followed by one which is a pointer to the return type.
@ -449,44 +396,13 @@ an array of GtkArgs instead of using C's varargs mechanism.
@object: the object to emit the signal to.
@name: the name of the signal.
@args:
<!-- # Unused Parameters # -->
@params: an array of GtkArgs, one for each parameter,
followed by one which is a pointer to the return type.
<!-- ##### FUNCTION gtk_signal_n_emissions ##### -->
<para>
Find out the recursion depth of emissions for a particular type
of signal and object. (So it will
always return 0 or 1 if #GTK_RUN_NO_RECURSE is specified)
This is a way to avoid recursion: you can see if
you are currently running in that signal handler and emit it only
if you are.
</para>
<para>Another way to look at it is that this number increases
by one when #gtk_signal_emit(), et al, are called,
and decreases by one when #gtk_signal_emit() returns.
</para>
@object: the object with the signal handler.
@signal_id: the signal id.
@Returns: the recursion depth of emissions of this signal for this
object.
<!-- ##### FUNCTION gtk_signal_n_emissions_by_name ##### -->
<para>
Find out the recursion depth of emissions for a particular type
of signal and object. Just like gtk_signal_n_emissions()
except it will lookup the signal id for you.
</para>
@object: the object with the signal handler.
@name: the signal name.
@Returns: the recursion depth of emissions of this signal for this
object.
<!-- ##### FUNCTION gtk_signal_emit_stop ##### -->
<!-- ##### MACRO gtk_signal_emit_stop ##### -->
<para>
This function aborts a signal's current emission.
</para>
@ -500,6 +416,9 @@ It will print a warning if used on a signal which
isn't being emitted.
</para>
@i:
@s:
<!-- # Unused Parameters # -->
@object: the object whose signal handlers you wish to stop.
@signal_id: the signal identifier, as returned by gtk_signal_lookup().
@ -517,7 +436,7 @@ except it will lookup the signal id for you.
@name: the name of the signal you wish to stop.
<!-- ##### FUNCTION gtk_signal_connect ##### -->
<!-- ##### MACRO gtk_signal_connect ##### -->
<para>
Attach a function pointer and user data to a signal for
a particular object.
@ -556,28 +475,38 @@ static void attach_print_signal(GtkButton* button, gint to_print)
</programlisting>
</informalexample>
@o:
@s:
@f:
@d:
@Returns: the connection id.
<!-- # Unused Parameters # -->
@object: the object associated with the signal, e.g. if a button
is getting pressed, this is that button.
@name: name of the signal.
@func: function pointer to attach to the signal.
@func_data: value to pass as to your function (through the marshaller).
@Returns: the connection id.
<!-- ##### FUNCTION gtk_signal_connect_after ##### -->
<!-- ##### MACRO gtk_signal_connect_after ##### -->
<para>
Attach a function pointer and user data to a signal
so that this handler will be called after the other handlers.
</para>
@o:
@s:
@f:
@d:
@Returns: the unique identifier for this attachment: the connection id.
<!-- # Unused Parameters # -->
@object: the object associated with the signal.
@name: name of the signal.
@func: function pointer to attach to the signal.
@func_data: value to pass as to your function (through the marshaller).
@Returns: the unique identifier for this attachment: the connection id.
<!-- ##### FUNCTION gtk_signal_connect_object ##### -->
<!-- ##### MACRO gtk_signal_connect_object ##### -->
<para>
This function is for registering a callback that will
call another object's callback. That is,
@ -598,16 +527,21 @@ gtk_signal_connect_object(button, "clicked", gtk_widget_show, window);
</programlisting>
</informalexample>
@o:
@s:
@f:
@d:
@Returns: the connection id.
<!-- # Unused Parameters # -->
@object: the object which emits the signal.
@name: the name of the signal.
@func: the function to callback.
@slot_object: the object to pass as the first parameter to func.
(Though it pretends to take an object, you can
really pass any gpointer as the #slot_object .)
@Returns: the connection id.
<!-- ##### FUNCTION gtk_signal_connect_object_after ##### -->
<!-- ##### MACRO gtk_signal_connect_object_after ##### -->
<para>
Attach a signal hook to a signal, passing in an alternate
object as the first parameter, and guaranteeing
@ -615,11 +549,16 @@ that the default handler and all normal
handlers are called first.
</para>
@o:
@s:
@f:
@d:
@Returns: the connection id.
<!-- # Unused Parameters # -->
@object: the object associated with the signal.
@name: name of the signal.
@func: function pointer to attach to the signal.
@slot_object: the object to pass as the first parameter to #func.
@Returns: the connection id.
<!-- ##### FUNCTION gtk_signal_connect_full ##### -->
@ -632,14 +571,7 @@ more control.
in the button press signal.
@name: the name of the signal.
@func: function pointer to attach to the signal.
@marshal: the function marshal, see the gtkmarshall documentation for
more details, but briefly: the marshaller is a function which takes
the #GtkObject which emits the signal, the user data, the number of the
arguments, and the array of arguments. It is responsible for
calling the function in the appropriate calling convention.
gtk_signal_default_marshaller is usually fine.
(This shows up, for example, when worrying about matching
c++ or other languages' calling conventions.)
@unsupported:
@data: the user data associated with the function.
@destroy_func: function to call when this particular hook is
disconnected.
@ -651,6 +583,15 @@ object primarily.
the signal's default behavior preside (i.e. depending on #GTK_RUN_FIRST
and #GTK_RUN_LAST).
@Returns: the connection id.
<!-- # Unused Parameters # -->
@marshal: the function marshal, see the gtkmarshall documentation for
more details, but briefly: the marshaller is a function which takes
the #GtkObject which emits the signal, the user data, the number of the
arguments, and the array of arguments. It is responsible for
calling the function in the appropriate calling convention.
gtk_signal_default_marshaller is usually fine.
(This shows up, for example, when worrying about matching
c++ or other languages' calling conventions.)
<!-- ##### FUNCTION gtk_signal_connect_while_alive ##### -->
@ -706,81 +647,98 @@ should signal the removal of this signal.
@name: name of the signal.
<!-- ##### FUNCTION gtk_signal_disconnect ##### -->
<!-- ##### MACRO gtk_signal_disconnect ##### -->
<para>
Destroy a user-defined handler connection.
</para>
<!-- # Unused Parameters # -->
@object: the object which the handler pertains to.
@handler_id: the connection id.
<!-- ##### FUNCTION gtk_signal_disconnect_by_func ##### -->
<!-- ##### MACRO gtk_signal_disconnect_by_func ##### -->
<para>
Destroy all connections for a particular object, with
the given function-pointer and user-data.
</para>
@o:
@f:
@d:
<!-- # Unused Parameters # -->
@object: the object which emits the signal.
@func: the function pointer to search for.
@data: the user data to search for.
<!-- ##### FUNCTION gtk_signal_disconnect_by_data ##### -->
<!-- ##### MACRO gtk_signal_disconnect_by_data ##### -->
<para>
Destroy all connections for a particular object, with
the given user-data.
</para>
@o:
@d:
<!-- # Unused Parameters # -->
@object: the object which emits the signal.
@data: the user data to search for.
<!-- ##### FUNCTION gtk_signal_handler_block ##### -->
<!-- ##### MACRO gtk_signal_handler_block ##### -->
<para>
Prevent an user-defined handler from being invoked. All other
signal processing will go on as normal, but this particular
handler will ignore it.
</para>
<!-- # Unused Parameters # -->
@object: the object which emits the signal to block.
@handler_id: the connection id.
<!-- ##### FUNCTION gtk_signal_handler_block_by_func ##### -->
<!-- ##### MACRO gtk_signal_handler_block_by_func ##### -->
<para>
Prevent a user-defined handler from being invoked, by reference to
the user-defined handler's function pointer and user data. (It may result in
multiple hooks being blocked, if you've called connect multiple times.)
</para>
@o:
@f:
@d:
<!-- # Unused Parameters # -->
@object: the object which emits the signal to block.
@func: the function pointer of the handler to block.
@data: the user data of the handler to block.
<!-- ##### FUNCTION gtk_signal_handler_block_by_data ##### -->
<!-- ##### MACRO gtk_signal_handler_block_by_data ##### -->
<para>
Prevent all user-defined handlers with a certain user data from being invoked.
</para>
@o:
@d:
<!-- # Unused Parameters # -->
@object: the object which emits the signal we want to block.
@data: the user data of the handlers to block.
<!-- ##### FUNCTION gtk_signal_handler_unblock ##### -->
<!-- ##### MACRO gtk_signal_handler_unblock ##### -->
<para>
Undo a block, by connection id. Note that undoing a block doesn't
necessarily make the hook callable, because if you block a
hook twice, you must unblock it twice.
</para>
<!-- # Unused Parameters # -->
@object: the object which emits the signal we want to unblock.
@handler_id: the emission handler identifier, as returned by
gtk_signal_connect(), etc.
<!-- ##### FUNCTION gtk_signal_handler_unblock_by_func ##### -->
<!-- ##### MACRO gtk_signal_handler_unblock_by_func ##### -->
<para>
Undo a block, by function pointer and data.
Note that undoing a block doesn't
@ -788,22 +746,29 @@ necessarily make the hook callable, because if you block a
hook twice, you must unblock it twice.
</para>
@o:
@f:
@d:
<!-- # Unused Parameters # -->
@object: the object which emits the signal we want to unblock.
@func: the function pointer to search for.
@data: the user data to search for.
<!-- ##### FUNCTION gtk_signal_handler_unblock_by_data ##### -->
<!-- ##### MACRO gtk_signal_handler_unblock_by_data ##### -->
<para>
Undo block(s), to all signals for a particular object
with a particular user-data pointer
</para>
@o:
@d:
<!-- # Unused Parameters # -->
@object: the object which emits the signal we want to unblock.
@data: the user data to search for.
<!-- ##### FUNCTION gtk_signal_handler_pending ##### -->
<!-- ##### MACRO gtk_signal_handler_pending ##### -->
<para>
Returns a connection id corresponding to a given signal id and object.
</para>
@ -814,114 +779,62 @@ may opt to not emit the signal if no one is attached anyway,
thus saving the cost of building the arguments.
</para>
@i:
@s:
@b:
@Returns: the connection id, if a connection was found. 0 otherwise.
<!-- # Unused Parameters # -->
@object: the object to search for the desired user-defined handler.
@signal_id: the number of the signal to search for.
@may_be_blocked: whether it is acceptable to return a blocked
handler.
@Returns: the connection id, if a connection was found. 0 otherwise.
<!-- ##### FUNCTION gtk_signal_handler_pending_by_func ##### -->
<!-- ##### MACRO gtk_signal_handler_pending_by_func ##### -->
<para>
Returns a connection id corresponding to a given signal id, object, function
pointer and user data.
</para>
@o:
@s:
@b:
@f:
@d:
@Returns: the connection id, if a handler was found. 0 otherwise.
<!-- # Unused Parameters # -->
@object: the object to search for the desired handler.
@signal_id: the number of the signal to search for.
@may_be_blocked: whether it is acceptable to return a blocked
handler.
@func: the function pointer to search for.
@data: the user data to search for.
@Returns: the connection id, if a handler was found. 0 otherwise.
<!-- ##### FUNCTION gtk_signal_handler_pending_by_id ##### -->
<para>
Returns whether a connection id is valid (and optionally not blocked).
</para>
@object: the object to search for the desired handler.
@handler_id: the connection id.
@may_be_blocked: whether it is acceptable to return a blocked
handler.
@Returns: TRUE if the signal exists and wasn't blocked,
unless #may_be_blocked was specified. FALSE otherwise.
<!-- ##### FUNCTION gtk_signal_handlers_destroy ##### -->
<para>
Destroy all the signal handlers connected to an object.
This is done automatically when the object is destroyed.
</para>
<para>
This function is labeled private.
</para>
@object: the object whose signal handlers should be destroyed.
<!-- ##### FUNCTION gtk_signal_set_funcs ##### -->
<para>
These set default functions to call when the user didn't
supply a function when connecting. (These are rarely
used, and probably only for language bindings)
</para>
<para>
By default, there are no such functions.
</para>
@marshal_func: the function to invoke on every handlers for which there
isn't a function pointer. May be NULL.
@destroy_func: the function to invoke when each hook is destroyed.
May be NULL.
<!-- ##### FUNCTION gtk_signal_query ##### -->
<para>
Obtain information about a signal.
</para>
@signal_id: the signal type identifier.
@Returns: a pointer to a GtkSignalQuery structure
which contains all the information, or NULL.
The pointer is allocated just for you: you must g_free() it.
<!-- ##### FUNCTION gtk_signal_add_emission_hook ##### -->
<!-- ##### MACRO gtk_signal_add_emission_hook ##### -->
<para>
Add an emission hook for a type of signal, for any object.
</para>
@i:
@h:
@d:
@Returns: the id (that you may pass as a parameter
to gtk_signal_remove_emission_hook()).
<!-- # Unused Parameters # -->
@signal_id: the type of signal to hook for.
@hook_func: the function to invoke to handle the emission hook.
@data: the user data passed in to hook_func.
@Returns: the id (that you may pass as a parameter
to gtk_signal_remove_emission_hook()).
<!-- ##### FUNCTION gtk_signal_add_emission_hook_full ##### -->
<para>
Add an emission hook for a type of signal, for any object.
(with control of what happens when the hook is
destroyed).
</para>
@signal_id: the type of signal add the hook for.
@hook_func: the function to invoke to handle the hook.
@data: the user data passed in to hook_func.
@destroy: a function to invoke when the hook is destroyed,
to clean up any allocation done just for this
signal handler.
@Returns: the id (that you may pass as a parameter
to gtk_signal_remove_emission_hook()).
<!-- ##### FUNCTION gtk_signal_remove_emission_hook ##### -->
<!-- ##### MACRO gtk_signal_remove_emission_hook ##### -->
<para>
Delete an emission hook. (see gtk_signal_add_emission_hook())
</para>
@i:
@h:
<!-- # Unused Parameters # -->
@signal_id: the id of the signal type.
@hook_id: the id of the emission handler, returned by add_emission_hook().

18
docs/reference/gtk/tmpl/gtkstatusbar.sgml
View File

@ -109,15 +109,6 @@ Forces the removal of a message from a statusbar's stack. The exact context_id a
@message_id: a message identifier, as returned by gtk_statusbar_push().
<!-- ##### SIGNAL GtkStatusbar::text-pushed ##### -->
<para>
Is emitted whenever a new message gets pushed onto a statusbar's stack.
</para>
@statusbar: the object which received the signal.
@context_id: the context id of the relevant message/statusbar.
@text: the message that was pushed.
<!-- ##### SIGNAL GtkStatusbar::text-popped ##### -->
<para>
Is emitted whenever a new message is popped off a statusbar's stack.
@ -127,3 +118,12 @@ Is emitted whenever a new message is popped off a statusbar's stack.
@context_id: the context id of the relevant message/statusbar.
@text: the message that was just popped.
<!-- ##### SIGNAL GtkStatusbar::text-pushed ##### -->
<para>
Is emitted whenever a new message gets pushed onto a statusbar's stack.
</para>
@statusbar: the object which received the signal.
@context_id: the context id of the relevant message/statusbar.
@text: the message that was pushed.

9
docs/reference/gtk/tmpl/gtktext.sgml
View File

@ -215,6 +215,15 @@ Returns the character at the given index within the #GtkText widget.
@index: the number of characters from the upper left corner
<!-- ##### SIGNAL GtkText::set-scroll-adjustments ##### -->
<para>
</para>
@text: the object which received the signal.
@arg1:
@arg2:
<!-- ##### ARG GtkText:hadjustment ##### -->
<para>
Used by the #GtkText widget to keep track of the size of it's horizontal

56
docs/reference/gtk/tmpl/gtktextbuffer.sgml
View File

@ -23,12 +23,6 @@ types related to the text widget and how they work together.
#GtkTextView, #GtkTextIter, #GtkTextMark
</para>
<!-- ##### STRUCT GtkTextBTree ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_text_buffer_new ##### -->
<para>
@ -441,18 +435,7 @@ types related to the text widget and how they work together.
@Returns:
<!-- ##### SIGNAL GtkTextBuffer::insert-text ##### -->
<para>
</para>
@textbuffer: the object which received the signal.
@arg1:
@arg2:
@arg3:
@arg4:
<!-- ##### SIGNAL GtkTextBuffer::delete-text ##### -->
<!-- ##### SIGNAL GtkTextBuffer::apply-tag ##### -->
<para>
</para>
@ -469,12 +452,34 @@ types related to the text widget and how they work together.
@textbuffer: the object which received the signal.
<!-- ##### SIGNAL GtkTextBuffer::modified-changed ##### -->
<!-- ##### SIGNAL GtkTextBuffer::delete-text ##### -->
<para>
</para>
@textbuffer: the object which received the signal.
@arg1:
@arg2:
@arg3:
<!-- ##### SIGNAL GtkTextBuffer::insert-text ##### -->
<para>
</para>
@textbuffer: the object which received the signal.
@arg1:
@arg2:
@arg3:
@arg4:
<!-- ##### SIGNAL GtkTextBuffer::mark-deleted ##### -->
<para>
</para>
@textbuffer: the object which received the signal.
@arg1:
<!-- ##### SIGNAL GtkTextBuffer::mark-set ##### -->
<para>
@ -485,23 +490,12 @@ types related to the text widget and how they work together.
@arg1:
@arg2:
<!-- ##### SIGNAL GtkTextBuffer::mark-deleted ##### -->
<!-- ##### SIGNAL GtkTextBuffer::modified-changed ##### -->
<para>
</para>
@textbuffer: the object which received the signal.
@arg1:
<!-- ##### SIGNAL GtkTextBuffer::apply-tag ##### -->
<para>
</para>
@textbuffer: the object which received the signal.
@arg1:
@arg2:
@arg3:
<!-- ##### SIGNAL GtkTextBuffer::remove-tag ##### -->
<para>

2
docs/reference/gtk/tmpl/gtktextiter.sgml
View File

@ -521,6 +521,8 @@ types related to the text widget and how they work together.
@str:
@visible_only:
@slice:
@match_start:
@match_end:
@Returns:

19
docs/reference/gtk/tmpl/gtktextmark.sgml
View File

@ -58,6 +58,8 @@ Marks are typically created using the gtk_text_buffer_create_mark() function.
</para>
@parent_instance:
@segment:
<!-- ##### FUNCTION gtk_text_mark_set_visible ##### -->
<para>
@ -77,23 +79,6 @@ Marks are typically created using the gtk_text_buffer_create_mark() function.
@Returns:
<!-- ##### FUNCTION gtk_text_mark_ref ##### -->
<para>
</para>
@mark:
@Returns:
<!-- ##### FUNCTION gtk_text_mark_unref ##### -->
<para>
</para>
@mark:
<!-- ##### FUNCTION gtk_text_mark_get_deleted ##### -->
<para>

1
docs/reference/gtk/tmpl/gtktexttag.sgml
View File

@ -55,7 +55,6 @@ types related to the text widget and how they work together.
@refcount:
@appearance:
@relief:
@justify:
@direction:
@font_desc:

16
docs/reference/gtk/tmpl/gtktexttagtable.sgml
View File

@ -85,6 +85,14 @@ types related to the text widget and how they work together.
@Returns:
<!-- ##### SIGNAL GtkTextTagTable::tag-added ##### -->
<para>
</para>
@texttagtable: the object which received the signal.
@arg1:
<!-- ##### SIGNAL GtkTextTagTable::tag-changed ##### -->
<para>
@ -94,14 +102,6 @@ types related to the text widget and how they work together.
@arg1:
@arg2:
<!-- ##### SIGNAL GtkTextTagTable::tag-added ##### -->
<para>
</para>
@texttagtable: the object which received the signal.
@arg1:
<!-- ##### SIGNAL GtkTextTagTable::tag-removed ##### -->
<para>

32
docs/reference/gtk/tmpl/gtktextview.sgml
View File

@ -164,30 +164,19 @@ types related to the text widget and how they work together.
@location:
<!-- ##### SIGNAL GtkTextView::move ##### -->
<para>
</para>
@textview: the object which received the signal.
@arg1:
@arg2:
@arg3:
<!-- ##### SIGNAL GtkTextView::set-anchor ##### -->
<!-- ##### SIGNAL GtkTextView::copy-clipboard ##### -->
<para>
</para>
@textview: the object which received the signal.
<!-- ##### SIGNAL GtkTextView::insert ##### -->
<!-- ##### SIGNAL GtkTextView::cut-clipboard ##### -->
<para>
</para>
@textview: the object which received the signal.
@arg1:
<!-- ##### SIGNAL GtkTextView::delete ##### -->
<para>
@ -198,19 +187,23 @@ types related to the text widget and how they work together.
@arg1:
@arg2:
<!-- ##### SIGNAL GtkTextView::cut-clipboard ##### -->
<!-- ##### SIGNAL GtkTextView::insert ##### -->
<para>
</para>
@textview: the object which received the signal.
@arg1:
<!-- ##### SIGNAL GtkTextView::copy-clipboard ##### -->
<!-- ##### SIGNAL GtkTextView::move ##### -->
<para>
</para>
@textview: the object which received the signal.
@arg1:
@arg2:
@arg3:
<!-- ##### SIGNAL GtkTextView::paste-clipboard ##### -->
<para>
@ -219,7 +212,7 @@ types related to the text widget and how they work together.
@textview: the object which received the signal.
<!-- ##### SIGNAL GtkTextView::toggle-overwrite ##### -->
<!-- ##### SIGNAL GtkTextView::set-anchor ##### -->
<para>
</para>
@ -235,6 +228,13 @@ types related to the text widget and how they work together.
@arg1:
@arg2:
<!-- ##### SIGNAL GtkTextView::toggle-overwrite ##### -->
<para>
</para>
@textview: the object which received the signal.
<!-- ##### ARG GtkTextView:height_lines ##### -->
<para>

14
docs/reference/gtk/tmpl/gtktree.sgml
View File

@ -271,13 +271,6 @@ Removes the item @child from the #GtkTree @tree.
@child: A pointer to the #GtkWidget that is to be removed from the tree.
<!-- ##### SIGNAL GtkTree::selection-changed ##### -->
<para>
This signal is emitted by the root tree whenever the selection changes.
</para>
@tree: the object which received the signal.
<!-- ##### SIGNAL GtkTree::select-child ##### -->
<para>
This signal is emitted by @tree whenever @widget is about to be selected.
@ -286,6 +279,13 @@ This signal is emitted by @tree whenever @widget is about to be selected.
@tree: the object which received the signal.
@widget: The child that is about to be selected.
<!-- ##### SIGNAL GtkTree::selection-changed ##### -->
<para>
This signal is emitted by the root tree whenever the selection changes.
</para>
@tree: the object which received the signal.
<!-- ##### SIGNAL GtkTree::unselect-child ##### -->
<para>
This signal is emitted by @tree whenever @widget is about to be unselected.

7
docs/reference/gtk/tmpl/gtktypeutils.sgml
View File

@ -212,16 +212,11 @@ Define a function pointer.
@args: GtkArg*
<!-- ##### USER_FUNCTION GtkSignalMarshaller ##### -->
<!-- ##### TYPEDEF GtkSignalMarshaller ##### -->
<para>
Define a function pointer.
</para>
@object: GtkObject*
@func: GtkSignalFunc
@func_data: gpointer
@args: GtkArg*
<!-- ##### USER_FUNCTION GtkArgGetFunc ##### -->
<para>

9
docs/reference/gtk/tmpl/gtkviewport.sgml
View File

@ -75,6 +75,15 @@ GtkViewport
@type:
<!-- ##### SIGNAL GtkViewport::set-scroll-adjustments ##### -->
<para>
</para>
@viewport: the object which received the signal.
@arg1:
@arg2:
<!-- ##### ARG GtkViewport:hadjustment ##### -->
<para>

640
docs/reference/gtk/tmpl/gtkwidget.sgml
View File

@ -1278,118 +1278,6 @@ GtkWidget
@Returns:
<!-- ##### SIGNAL GtkWidget::show ##### -->
<para>
</para>
@widget: the object which received the signal.
<!-- ##### SIGNAL GtkWidget::hide ##### -->
<para>
</para>
@widget: the object which received the signal.
<!-- ##### SIGNAL GtkWidget::map ##### -->
<para>
</para>
@widget: the object which received the signal.
<!-- ##### SIGNAL GtkWidget::unmap ##### -->
<para>
</para>
@widget: the object which received the signal.
<!-- ##### SIGNAL GtkWidget::realize ##### -->
<para>
</para>
@widget: the object which received the signal.
<!-- ##### SIGNAL GtkWidget::unrealize ##### -->
<para>
</para>
@widget: the object which received the signal.
<!-- ##### SIGNAL GtkWidget::draw ##### -->
<para>
</para>
@widget: the object which received the signal.
@area:
<!-- ##### SIGNAL GtkWidget::draw-focus ##### -->
<para>
</para>
@widget: the object which received the signal.
<!-- ##### SIGNAL GtkWidget::draw-default ##### -->
<para>
</para>
@widget: the object which received the signal.
<!-- ##### SIGNAL GtkWidget::size-request ##### -->
<para>
</para>
@widget: the object which received the signal.
@requisition:
<!-- ##### SIGNAL GtkWidget::size-allocate ##### -->
<para>
</para>
@widget: the object which received the signal.
@allocation:
<!-- ##### SIGNAL GtkWidget::state-changed ##### -->
<para>
</para>
@widget: the object which received the signal.
@state:
<!-- ##### SIGNAL GtkWidget::parent-set ##### -->
<para>
</para>
@widget: the object which received the signal.
@old_parent:
<!-- ##### SIGNAL GtkWidget::style-set ##### -->
<para>
</para>
@widget: the object which received the signal.
@previous_style:
<!-- ##### SIGNAL GtkWidget::direction-changed ##### -->
<para>
</para>
@widget: the object which received the signal.
@arg1:
<!-- ##### SIGNAL GtkWidget::add-accelerator ##### -->
<para>
@ -1402,32 +1290,6 @@ GtkWidget
@accel_mods:
@accel_flags:
<!-- ##### SIGNAL GtkWidget::remove-accelerator ##### -->
<para>
</para>
@widget: the object which received the signal.
@accel_group:
@accel_key:
@accel_mods:
<!-- ##### SIGNAL GtkWidget::grab-focus ##### -->
<para>
</para>
@widget: the object which received the signal.
<!-- ##### SIGNAL GtkWidget::event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::button-press-event ##### -->
<para>
@ -1446,7 +1308,7 @@ GtkWidget
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::scroll-event ##### -->
<!-- ##### SIGNAL GtkWidget::client-event ##### -->
<para>
</para>
@ -1455,7 +1317,7 @@ GtkWidget
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::motion-notify-event ##### -->
<!-- ##### SIGNAL GtkWidget::configure-event ##### -->
<para>
</para>
@ -1464,6 +1326,14 @@ GtkWidget
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::debug-msg ##### -->
<para>
</para>
@widget: the object which received the signal.
@message:
<!-- ##### SIGNAL GtkWidget::delete-event ##### -->
<para>
@ -1482,168 +1352,13 @@ GtkWidget
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::expose-event ##### -->
<!-- ##### SIGNAL GtkWidget::direction-changed ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::key-press-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::key-release-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::enter-notify-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::leave-notify-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::configure-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::focus-in-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::focus-out-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::map-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::unmap-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::property-notify-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::selection-clear-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::selection-request-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::selection-notify-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::selection-get ##### -->
<para>
</para>
@widget: the object which received the signal.
@data:
@info:
@time:
<!-- ##### SIGNAL GtkWidget::selection-received ##### -->
<para>
</para>
@widget: the object which received the signal.
@data:
@time:
<!-- ##### SIGNAL GtkWidget::proximity-in-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::proximity-out-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns:
@arg1:
<!-- ##### SIGNAL GtkWidget::drag-begin ##### -->
<para>
@ -1653,7 +1368,7 @@ GtkWidget
@widget: the object which received the signal.
@drag_context:
<!-- ##### SIGNAL GtkWidget::drag-end ##### -->
<!-- ##### SIGNAL GtkWidget::drag-data-delete ##### -->
<para>
</para>
@ -1661,7 +1376,43 @@ GtkWidget
@widget: the object which received the signal.
@drag_context:
<!-- ##### SIGNAL GtkWidget::drag-data-delete ##### -->
<!-- ##### SIGNAL GtkWidget::drag-data-get ##### -->
<para>
</para>
@widget: the object which received the signal.
@drag_context:
@data:
@info:
@time:
<!-- ##### SIGNAL GtkWidget::drag-data-received ##### -->
<para>
</para>
@widget: the object which received the signal.
@drag_context:
@x:
@y:
@data:
@info:
@time:
<!-- ##### SIGNAL GtkWidget::drag-drop ##### -->
<para>
</para>
@widget: the object which received the signal.
@drag_context:
@x:
@y:
@time:
@Returns:
<!-- ##### SIGNAL GtkWidget::drag-end ##### -->
<para>
</para>
@ -1690,43 +1441,131 @@ GtkWidget
@time:
@Returns:
<!-- ##### SIGNAL GtkWidget::drag-drop ##### -->
<!-- ##### SIGNAL GtkWidget::draw ##### -->
<para>
</para>
@widget: the object which received the signal.
@drag_context:
@x:
@y:
@time:
@area:
<!-- ##### SIGNAL GtkWidget::draw-default ##### -->
<para>
</para>
@widget: the object which received the signal.
<!-- ##### SIGNAL GtkWidget::draw-focus ##### -->
<para>
</para>
@widget: the object which received the signal.
<!-- ##### SIGNAL GtkWidget::enter-notify-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::drag-data-get ##### -->
<!-- ##### SIGNAL GtkWidget::event ##### -->
<para>
</para>
@widget: the object which received the signal.
@drag_context:
@data:
@info:
@time:
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::drag-data-received ##### -->
<!-- ##### SIGNAL GtkWidget::expose-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@drag_context:
@x:
@y:
@data:
@info:
@time:
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::client-event ##### -->
<!-- ##### SIGNAL GtkWidget::focus-in-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::focus-out-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::grab-focus ##### -->
<para>
</para>
@widget: the object which received the signal.
<!-- ##### SIGNAL GtkWidget::hide ##### -->
<para>
</para>
@widget: the object which received the signal.
<!-- ##### SIGNAL GtkWidget::key-press-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::key-release-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::leave-notify-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::map ##### -->
<para>
</para>
@widget: the object which received the signal.
<!-- ##### SIGNAL GtkWidget::map-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::motion-notify-event ##### -->
<para>
</para>
@ -1744,7 +1583,15 @@ GtkWidget
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::visibility-notify-event ##### -->
<!-- ##### SIGNAL GtkWidget::parent-set ##### -->
<para>
</para>
@widget: the object which received the signal.
@old_parent:
<!-- ##### SIGNAL GtkWidget::property-notify-event ##### -->
<para>
</para>
@ -1753,13 +1600,166 @@ GtkWidget
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::debug-msg ##### -->
<!-- ##### SIGNAL GtkWidget::proximity-in-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@message:
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::proximity-out-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::realize ##### -->
<para>
</para>
@widget: the object which received the signal.
<!-- ##### SIGNAL GtkWidget::remove-accelerator ##### -->
<para>
</para>
@widget: the object which received the signal.
@accel_group:
@accel_key:
@accel_mods:
<!-- ##### SIGNAL GtkWidget::scroll-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::selection-clear-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::selection-get ##### -->
<para>
</para>
@widget: the object which received the signal.
@data:
@info:
@time:
<!-- ##### SIGNAL GtkWidget::selection-notify-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::selection-received ##### -->
<para>
</para>
@widget: the object which received the signal.
@data:
@time:
<!-- ##### SIGNAL GtkWidget::selection-request-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::show ##### -->
<para>
</para>
@widget: the object which received the signal.
<!-- ##### SIGNAL GtkWidget::size-allocate ##### -->
<para>
</para>
@widget: the object which received the signal.
@allocation:
<!-- ##### SIGNAL GtkWidget::size-request ##### -->
<para>
</para>
@widget: the object which received the signal.
@requisition:
<!-- ##### SIGNAL GtkWidget::state-changed ##### -->
<para>
</para>
@widget: the object which received the signal.
@state:
<!-- ##### SIGNAL GtkWidget::style-set ##### -->
<para>
</para>
@widget: the object which received the signal.
@previous_style:
<!-- ##### SIGNAL GtkWidget::unmap ##### -->
<para>
</para>
@widget: the object which received the signal.
<!-- ##### SIGNAL GtkWidget::unmap-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkWidget::unrealize ##### -->
<para>
</para>
@widget: the object which received the signal.
<!-- ##### SIGNAL GtkWidget::visibility-notify-event ##### -->
<para>
</para>
@widget: the object which received the signal.
@event:
@Returns:
<!-- ##### ARG GtkWidget:name ##### -->
<para>