gtk-unused.sgml

This GTK+ version 2.12.3. GTK+ is a multi-platform toolkit for creating graphical user interfaces.

<para>
Add an array of signals to a #GtkObjectClass.
Usually this is called when registering a new type of object.
</para>

@klass: the object class to append signals to.
@signals: the signals to append.
@nsignals: the number of signals being appended.

<!-- ##### FUNCTION gtk_object_class_user_signal_new ##### -->
<para>
Define a signal-handler for a new signal on an already defined
object.
</para>
<para>
See the signal documentation for more general information.
</para>

@klass: the object class to define the signal for.
@name: the name of the signal.
@signal_flags: the default emission behavior for the signal.
See gtk_signal_new().
@marshaller: a function that will take an array of GtkArgs
and invoke the appropriate handler with the normal calling
conventions.
@return_val: specify the return-value type for the signal
(or GTK_TYPE_NONE for no return-value).
@nparams: specify the number of parameters the signal
receives from the caller of gtk_signal_emit().
@Varargs: list of nparams #GtkTypes to pass to the signal handlers.
@Returns: the signal id.  (See #GtkSignals)

<!-- ##### FUNCTION gtk_object_class_user_signal_newv ##### -->
<para>
Define a signal-handler for a new signal on an already defined
object.
</para>

@klass: the object class to define the signal for.
@name: the name of the signal.
@signal_flags: the default emission behavior for the signal.
See gtk_signal_new().
@marshaller: takes a GtkObject, a #GtkSignalFunc, and an array
of arguments, and invokes the function using the appropriate
calling conventions.  Usually just select a function
out of gtkmarshal.h.
@return_val: specify the return-value type for the signal (possibly
#GTK_TYPE_NONE).
@nparams: specify the number of parameters the signal
receives from the caller of gtk_signal_emit().
@params: array of #GtkTypes the signal handlers for this signal
should have in their prototype (of length nparams).
@Returns: the signal id.  (See #GtkSignals)

<!-- ##### FUNCTION gtk_object_constructed ##### -->
<para>
Mark an allocated object as constructed.
This is used for situations
that require precise control of the construction process.
</para>
<para>
This is done when gtk_object_default_construct() is inadequate.
In #GtkCList the need arises because #GtkCList does construction work that
must happen <emphasis>after</emphasis> its derivers.  This work
cannot be done in an initializer function, so an alternate
constructor is mandatory.  It calls gtk_object_constructed() to
indicate it has done its job, so that no other constructor will
be invoked.
</para>
<para>
Normally this function is just automatically run from
gtk_object_default_construct().
</para>

@object: object which has been constructed.  This is usually
done automatically by gtk_object_new() and gtk_object_newv().

<!-- ##### FUNCTION gtk_object_default_construct ##### -->
<para>
This function is called to construct arguments that haven't been initialized
but have the #GTK_ARG_CONSTRUCT flag set.
</para>
<para>
All number arguments are set to 0.  All pointers and strings
are set to NULL.
</para>
<para>
Normally invoked by gtk_object_new() automatically; gtk_type_new() can
be used to bypass it.
</para>

@object: the object to initialize.

<!-- ##### FUNCTION gtk_object_getv ##### -->
<para>
Gets an array of argument values from an object.
</para>

@object: the object to get arguments from.
@n_args: the number of arguments to query.
@args: the arguments to fill in.

<!-- ##### FUNCTION gtk_object_newv ##### -->
<para>
Construct an object with an array of arguments.
</para>

@object_type: the type of the object to create.
@n_args: the number of arguments to set.
@args: an array of n_args arguments (which are name and value pairs).
@Returns: the new GtkObject.

<!-- ##### FUNCTION gtk_object_query_args ##### -->
<para>
Get all the arguments that may be used for a given type.
</para>
<para>
In Java, this type of mechanism is called 
<wordasword>introspection</wordasword>.  It is used by applications
like Glade, that have to determine what can be done to an object
at run-time.
</para>

@class_type: the GtkType of the ObjectClass
(returned from GTK_OBJECT_CLASS(class)-&gt;type for example).
@arg_flags: if non-NULL, obtains the #GtkArgFlags that apply to
each argument.  You must g_free() this if you request it.
@n_args: the number of arguments is returned in this field.
@Returns: an array of arguments, that you must deallocate with g_free().

<!-- ##### FUNCTION gtk_object_setv ##### -->
<para>
Set an array of arguments.
</para>

@object: the object whose arguments should be set.
@n_args: the number of arguments to set.
@args: the desired values, as an array of #GtkArgs (which contain 
the names, types, and values of the arguments).

<!-- ##### FUNCTION gtk_packer_add ##### -->
<para>

</para>

@packer: 
@child: 
@side: 
@anchor: 
@options: 
@border_width: 
@pad_x: 
@pad_y: 
@i_pad_x: 
@i_pad_y: 

<!-- ##### FUNCTION gtk_packer_add_defaults ##### -->
<para>

</para>

@packer: 
@child: 
@side: 
@anchor: 
@options: 

<!-- ##### MACRO gtk_packer_configure ##### -->
<para>

</para>


<!-- ##### FUNCTION gtk_packer_new ##### -->
<para>

</para>

@Returns: 

<!-- ##### FUNCTION gtk_packer_reorder_child ##### -->
<para>

</para>

@packer: 
@child: 
@position: 

<!-- ##### FUNCTION gtk_packer_set_child_packing ##### -->
<para>

</para>

@packer: 
@child: 
@side: 
@anchor: 
@options: 
@border_width: 
@pad_x: 
@pad_y: 
@i_pad_x: 
@i_pad_y: 

<!-- ##### FUNCTION gtk_packer_set_default_border_width ##### -->
<para>

</para>

@packer: 
@border: 

<!-- ##### FUNCTION gtk_packer_set_default_ipad ##### -->
<para>

</para>

@packer: 
@i_pad_x: 
@i_pad_y: 

<!-- ##### FUNCTION gtk_packer_set_default_pad ##### -->
<para>

</para>

@packer: 
@pad_x: 
@pad_y: 

<!-- ##### FUNCTION gtk_packer_set_spacing ##### -->
<para>

</para>

@packer: 
@spacing: 

<!-- ##### FUNCTION gtk_paned_compute_position ##### -->
<para>
Internal function used by #GtkHPaned and #GtkVPaned
</para>

@paned: 
@allocation: 
@child1_req: 
@child2_req: 

<!-- ##### MACRO gtk_paned_handle_size ##### -->
<para>
Old name for gtk_paned_set_handle_size().
</para>


<!-- ##### FUNCTION gtk_paned_set_handle_size ##### -->
<para>
Set the the handle size to @size x @size pixels.
</para>

@paned: a paned widget
@size: the size in pixels

<!-- ##### FUNCTION gtk_pattern_match ##### -->
<para>

</para>

@pspec: 
@string_length: 
@string: 
@string_reversed: 
@Returns: 

<!-- ##### FUNCTION gtk_pattern_match_simple ##### -->
<para>

</para>

@pattern: 
@string: 
@Returns: 

<!-- ##### FUNCTION gtk_pattern_match_string ##### -->
<para>

</para>

@pspec: 
@string: 
@Returns: 

<!-- ##### FUNCTION gtk_pattern_spec_free_segs ##### -->
<para>

</para>

@pspec: 

<!-- ##### FUNCTION gtk_pattern_spec_init ##### -->
<para>

</para>

@pspec: 
@pattern: 

<!-- ##### FUNCTION gtk_print_context_create_context ##### -->
<para>

</para>

@context: 
@Returns: 

<!-- ##### FUNCTION gtk_print_context_create_layout ##### -->
<para>

</para>

@context: 
@Returns: 

<!-- ##### FUNCTION gtk_print_context_get_cairo ##### -->
<para>

</para>

@context: 
@Returns: 

<!-- ##### FUNCTION gtk_print_context_get_fontmap ##### -->
<para>

</para>

@context: 
@Returns: 

<!-- ##### FUNCTION gtk_print_operation_set_nr_of_pages ##### -->
<para>

</para>

@op: 
@n_pages: 

<!-- ##### FUNCTION gtk_print_settings_get_num_copies ##### -->
<para>

</para>

@settings: 
@Returns: 

<!-- ##### FUNCTION gtk_print_settings_get_print_to_file ##### -->
<para>

</para>

@settings: 
@Returns: 

<!-- ##### FUNCTION gtk_print_settings_set_num_copies ##### -->
<para>

</para>

@settings: 
@num_copies: 

<!-- ##### FUNCTION gtk_print_settings_set_print_to_file ##### -->
<para>

</para>

@settings: 
@print_to_file: 

<!-- ##### FUNCTION gtk_rc_init ##### -->
<para>
Internal function.
</para>


<!-- ##### FUNCTION gtk_rc_load_image ##### -->
<para>
Internal function. Loads an image using the current
image loader.
</para>

@colormap: the colormap to use for the image
@transparent_color: the transparent color for the image
@filename: the filename of the image file
@Returns: a #GtkPixmap representing @filename

<!-- ##### FUNCTION gtk_rc_set_image_loader ##### -->
<para>
Sets the function that GTK+ will use to load images 
</para>

@loader: the #GtkImageLoader to use

<!-- ##### FUNCTION gtk_ruler_draw_pos ##### -->
<para>

</para>

@ruler: the gtkruler

<!-- ##### FUNCTION gtk_ruler_draw_ticks ##### -->
<para>

</para>

@ruler: the gtkruler

<!-- ##### FUNCTION gtk_selection_incr_event ##### -->
<para>
Internal function.
</para>

@window: 
@event: 
@Returns: 

<!-- ##### FUNCTION gtk_selection_notify ##### -->
<para>
Internal function.
</para>

@widget: 
@event: 
@Returns: 

<!-- ##### FUNCTION gtk_selection_property_notify ##### -->
<para>
Internal function.
</para>

@widget: 
@event: 
@Returns: 

<!-- ##### FUNCTION gtk_selection_request ##### -->
<para>
Internal function.
</para>

@widget: 
@event: 
@Returns: 

<!-- ##### FUNCTION gtk_settings_get_global ##### -->
<para>

</para>

@Returns: 

<!-- ##### FUNCTION gtk_signal_add_emission_hook ##### -->
<para>
Add an emission hook for a type of signal, for any object.
</para>

@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()).
@i: 
@h: 
@d: 

<!-- ##### 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_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_init ##### -->
<para>

</para>


<!-- ##### 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_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_remove_emission_hook ##### -->
<para>
Delete an emission hook. (see gtk_signal_add_emission_hook())
</para>

@signal_id: the id of the signal type.
@hook_id: the id of the emission handler, returned by add_emission_hook().
@i: 
@h: 

<!-- ##### 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_spin_button_set_shadow_type ##### -->
<para>
Creates a border around the arrows of a #GtkSpinButton. The type of border is determined by @shadow_type.
</para>

@spin_button: a #GtkSpinButton
@shadow_type: the new border type.

<!-- ##### FUNCTION gtk_stock_list_items ##### -->
<para>

</para>

@Returns: 

<!-- ##### FUNCTION gtk_style_get_font_for_display ##### -->
<para>

</para>

@display: 
@style: 
@Returns: 

<!-- ##### FUNCTION gtk_text_buffer_paste_primary ##### -->
<para>

</para>

@buffer: 
@override_location: 
@default_editable: 

<!-- ##### FUNCTION gtk_text_iter_reorder ##### -->
<para>

</para>

@first: 
@second: 

<!-- ##### FUNCTION gtk_text_iter_spew ##### -->
<para>

</para>

@iter: 
@desc: 

<!-- ##### FUNCTION gtk_text_view_set_text_window_size ##### -->
<para>

</para>

@text_view: 
@width: 
@height: 

<!-- ##### FUNCTION gtk_tips_query_get_type ##### -->
<para>

</para>

@Returns: 

<!-- ##### FUNCTION gtk_tool_item_get_pack_end ##### --