1 <!-- ##### SECTION ./tmpl/gtkdebug.sgml:Title ##### -->
5 <!-- ##### SECTION ./tmpl/gtkenums.sgml.sgml:Title ##### -->
9 <!-- ##### SECTION ./tmpl/gtkimcontextsimple.sgml:Title ##### -->
13 <!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Long_Description ##### -->
15 <title>What are Signal Marshallers?</title>
17 Marshals are functions which all have the same prototype:
18 they take a #GtkObject, a #GtkSignalFunc, a #gpointer,
19 and an array of argument values.
20 The functions are names gtk_marshall_RETURNTYPE__PARAMTYPE1_PARAMTYPE2....
23 They then call a native function: the GtkObject is the first
24 parameter passed in. The arguments are passed in the native
25 calling convention: chars, shorts, ints, longs may be packed
26 on the stack, or tucked in registers: it doesn't matter
27 because the same calling convention will be generated
28 inside the gtkmarshal code as is expected where you define
32 So the function named:
34 gtk_marshal_BOOL__POINTER_INT_INT_UINT(GtkObject*, GtkSignalFunc, gpointer, GtkArg*);
36 will call the #GtkSignalFunc assuming it was a function with signature:
38 gboolean sigfunc(gpointer,gint,gint,guint);
43 <title>Writing Custom Marshals</title>
45 Marshals are primarily used as arguments to gtk_signal_new().
46 Sometimes, you may find that a marshaller you need isn't available
47 in the standard list. Then you have to write your own.
50 If you wish to define a signal with a new type of argument list.
51 Suppose you want 2 pointers and 2 integers.
54 typedef int (*GtkSignal_INT__POINTER_POINTER_INT_INT)(
55 gpointer, gpointer, gint, gint
58 void marshal_INT__POINTER_POINTER_INT_INT(GtkObject* object,
63 GtkSignal_NONE__POINTER_POINTER_INT_INT rfunc;
65 return_val = GTK_RETLOC_INT(args[4]);
66 rfunc = (GtkSignal_INT__POINTER_POINTER_INT_INT)func;
67 *return_val = (*rfunc)(object,
68 GTK_VALUE_POINTER(args[0]),
69 GTK_VALUE_POINTER(args[1]),
70 GTK_VALUE_INT(args[2]),
71 GTK_VALUE_INT(args[3]),
79 <!-- ##### SECTION ./tmpl/gtkmarshal.sgml:See_Also ##### -->
84 <term>#GtkSignal</term>
85 <listitem><para>The signal handling functions (of which marshallers are
86 really an implementation detail).</para></listitem>
93 <!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Short_Description ##### -->
94 Functions to adapt C structures to native calling convention.
97 <!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Title ##### -->
101 <!-- ##### SECTION ./tmpl/gtkprivate.sgml:Title ##### -->
105 <!-- ##### MACRO GTK_CLIST_CHILD_HAS_FOCUS ##### -->
107 A macro to check whether a child widget of the CList
111 @clist: The #GtkCList widget to check.
113 <!-- ##### MACRO GTK_OBJECT_CONSTRUCTED ##### -->
115 Test whether a GtkObject's arguments have been prepared.
118 @obj: the object to examine.
120 <!-- ##### MACRO GTK_OBJECT_NSIGNALS ##### -->
122 Get the number of signals defined by this object.
125 @obj: the object to query.
127 <!-- ##### MACRO GTK_OBJECT_SIGNALS ##### -->
129 Get the array of signals defined for this object.
132 @obj: the object to fetch the signals from.
134 <!-- ##### MACRO GTK_TREE_SELECTION ##### -->
136 A macro that returns a GList that contains the selection of the root tree of @obj.
139 @obj: A pointer to the #GtkTree. @obj will accept any pointer, but it the pointer does not point to a #GtkTree, the results are undefined.
141 <!-- ##### MACRO GTK_TYPE_FLAT_FIRST ##### -->
143 The first "flat" (no struct) enumerated type value.
147 <!-- ##### MACRO GTK_TYPE_FLAT_LAST ##### -->
149 The last "flat" (no struct) enumerated type value.
153 <!-- ##### MACRO GTK_TYPE_IDENTIFIER ##### -->
155 Hide the name of gtk_identifier_get_type
159 <!-- ##### MACRO GTK_TYPE_MAKE ##### -->
161 Combine a fundemantal type and a sequence number to create a gtk type.
167 <!-- ##### MACRO GTK_TYPE_NUM_BUILTINS ##### -->
173 <!-- ##### MACRO GTK_TYPE_SEQNO ##### -->
175 Convert a gtk type into its sequence number
180 <!-- ##### MACRO GTK_TYPE_STRUCTURED_FIRST ##### -->
182 The first structured enumerated type value.
186 <!-- ##### MACRO GTK_TYPE_STRUCTURED_LAST ##### -->
188 The last structured enumerated type value.
192 <!-- ##### MACRO GTK_VALUE_ARGS ##### -->
194 Use to get the value of a GtkArg whose GtkType is GTK_TYPE_ARGS
199 <!-- ##### MACRO GTK_VALUE_CALLBACK ##### -->
201 Use to get the value of a GtkArg whose GtkType is GTK_TYPE_CALLBACK
206 <!-- ##### MACRO GTK_VALUE_C_CALLBACK ##### -->
208 Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_CALLBACK
213 <!-- ##### MACRO GTK_VALUE_FOREIGN ##### -->
215 Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_FOREIGN
220 <!-- ##### SIGNAL GtkEditable::activate ##### -->
222 Indicates that the user has activated the widget
223 in some fashion. Generally, this will be done
224 with a keystroke. (The default binding for this
225 action is Return for #GtkEntry and
226 Control-Return for #GtkText.)
229 @editable: the object which received the signal.
231 <!-- ##### SIGNAL GtkEditable::changed ##### -->
233 Indicates that the user has changed the contents
237 @editable: the object which received the signal.
239 <!-- ##### SIGNAL GtkEditable::copy-clipboard ##### -->
241 An action signal. Causes the characters in the current selection to
242 be copied to the clipboard.
245 @editable: the object which received the signal.
247 <!-- ##### SIGNAL GtkEditable::cut-clipboard ##### -->
249 An action signal. Causes the characters in the current
250 selection to be copied to the clipboard and then deleted from
254 @editable: the object which received the signal.
256 <!-- ##### SIGNAL GtkEditable::delete-text ##### -->
258 This signal is emitted when text is deleted from
259 the widget by the user. The default handler for
260 this signal will normally be responsible for inserting
261 the text, so by connecting to this signal and then
262 stopping the signal with gtk_signal_emit_stop(), it
263 is possible to modify the inserted text, or prevent
264 it from being inserted entirely. The @start_pos
265 and @end_pos parameters are interpreted as for
266 gtk_editable_delete_text()
269 @editable: the object which received the signal.
270 @start_pos: the starting position.
271 @end_pos: the end position.
273 <!-- ##### SIGNAL GtkEditable::insert-text ##### -->
275 This signal is emitted when text is inserted into
276 the widget by the user. The default handler for
277 this signal will normally be responsible for inserting
278 the text, so by connecting to this signal and then
279 stopping the signal with gtk_signal_emit_stop(), it
280 is possible to modify the inserted text, or prevent
281 it from being inserted entirely.
284 @editable: the object which received the signal.
285 @new_text: the new text to insert.
286 @new_text_length: the length of the new text.
287 @position: the position at which to insert the new text.
288 this is an in-out paramter. After the signal
289 emission is finished, it should point after
290 the newly inserted text.
292 <!-- ##### SIGNAL GtkEditable::kill-char ##### -->
294 An action signal. Delete a single character.
297 @editable: the object which received the signal.
298 @direction: the direction in which to delete. Positive
299 indicates forward deletion, negative, backwards deletion.
301 <!-- ##### SIGNAL GtkEditable::kill-line ##### -->
303 An action signal. Delete a single line.
306 @editable: the object which received the signal.
307 @direction: the direction in which to delete. Positive
308 indicates forward deletion, negative, backwards deletion.
310 <!-- ##### SIGNAL GtkEditable::kill-word ##### -->
312 An action signal. Delete a single word.
315 @editable: the object which received the signal.
316 @direction: the direction in which to delete. Positive
317 indicates forward deletion, negative, backwards deletion.
319 <!-- ##### SIGNAL GtkEditable::move-cursor ##### -->
321 An action signal. Move the cursor position.
324 @editable: the object which received the signal.
325 @x: horizontal distance to move the cursor.
326 @y: vertical distance to move the cursor.
328 <!-- ##### SIGNAL GtkEditable::move-page ##### -->
330 An action signal. Move the cursor by pages.
333 @editable: the object which received the signal.
334 @x: Number of pages to move the cursor horizontally.
335 @y: Number of pages to move the cursor vertically.
337 <!-- ##### SIGNAL GtkEditable::move-to-column ##### -->
339 An action signal. Move the cursor to the given column.
342 @editable: the object which received the signal.
343 @column: the column to move to. (A negative value indicates
346 <!-- ##### SIGNAL GtkEditable::move-to-row ##### -->
348 An action signal. Move the cursor to the given row.
351 @editable: the object which received the signal.
352 @row: the row to move to. (A negative value indicates
355 <!-- ##### SIGNAL GtkEditable::move-word ##### -->
357 An action signal. Move the cursor by words.
360 @editable: the object which received the signal.
361 @num_words: The number of words to move the
362 cursor. (Can be negative).
364 <!-- ##### SIGNAL GtkEditable::paste-clipboard ##### -->
366 An action signal. Causes the contents of the clipboard to
367 be pasted into the editable widget at the current cursor
371 @editable: the object which received the signal.
373 <!-- ##### SIGNAL GtkEditable::set-editable ##### -->
375 Determines if the user can edit the text in the editable
376 widget or not. This is meant to be overriden by
377 child classes and should not generally useful to
381 @editable: the object which received the signal.
382 @is_editable: %TRUE if the user is allowed to edit the text
385 <!-- ##### ARG GtkEditable:editable ##### -->
387 A boolean indicating whether the widget is editable by
392 <!-- ##### ARG GtkEditable:text-position ##### -->
394 The position of the cursor.
398 <!-- ##### ENUM GtkFontFilterType ##### -->
400 A set of bit flags used to specify the filter being set
401 when calling gtk_font_selection_dialog_set_filter() or
402 gtk_font_selection_set_filter().
405 @GTK_FONT_FILTER_BASE: the base filter, which can't be changed by the user.
406 @GTK_FONT_FILTER_USER: the user filter, which can be changed from within the
407 'Filter' page of the #GtkFontSelection widget.
409 <!-- ##### ENUM GtkFontType ##### -->
411 A set of bit flags used to specify the type of fonts shown
412 when calling gtk_font_selection_dialog_set_filter() or
413 gtk_font_selection_set_filter().
416 @GTK_FONT_BITMAP: bitmap fonts.
417 @GTK_FONT_SCALABLE: scalable fonts.
418 @GTK_FONT_SCALABLE_BITMAP: scaled bitmap fonts.
419 @GTK_FONT_ALL: a bitwise combination of all of the above.
421 <!-- ##### STRUCT GtkIMContextSimple ##### -->
430 @tentative_match_len:
432 <!-- ##### ARG GtkObject:object-signal ##### -->
434 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
435 the signal to the object, so that the user data and objects
436 and swapped when the signal handler is invoked.
439 This is useful for handlers that are primarily notifying
440 other objects and could just invoke an already existing function
441 if the parameters were swapped.
442 See gtk_signal_connect_object() for more details.
446 <!-- ##### ARG GtkObject:object-signal-after ##### -->
448 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
449 the signal to the object, so that the user data and objects
450 and swapped when the signal handler is invoked,
451 and so that the handler is invoked after all others.
454 See gtk_signal_connect_object_after() for more details.
458 <!-- ##### ARG GtkObject:signal ##### -->
460 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
461 the signal to the object.
465 <!-- ##### ARG GtkObject:signal-after ##### -->
467 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
468 the signal to the object, so that the signal is always run
469 after other user handlers and the default handler.
473 <!-- ##### ENUM GtkPrivateFlags ##### -->
478 @PRIVATE_GTK_USER_STYLE:
479 @PRIVATE_GTK_RESIZE_PENDING:
480 @PRIVATE_GTK_RESIZE_NEEDED:
481 @PRIVATE_GTK_LEAVE_PENDING:
482 @PRIVATE_GTK_HAS_SHAPE_MASK:
483 @PRIVATE_GTK_IN_REPARENT:
484 @PRIVATE_GTK_DIRECTION_SET:
485 @PRIVATE_GTK_DIRECTION_LTR:
487 <!-- ##### USER_FUNCTION GtkSignalDestroy ##### -->
489 A function which you can use to clean up when the
490 signal handler is destroyed.
493 For example, if your handler requires a few variables
494 that you made into a struct and allocated (using g_new()
495 or something), then you will probably want to free
496 it as soon as the hook is destroyed. This will
497 allow you to do that. (For this in particular
498 it is convenient to pass g_free() as a #GtkSignalDestroy
502 @data: The user data associated with the hook that is being
505 <!-- ##### USER_FUNCTION GtkSignalMarshal ##### -->
507 This is currently a hack left in for a scheme wrapper library.
514 @object: The object which emits the signal.
515 @data: The user data associated with the hook.
516 @nparams: The number of parameters to the function.
517 @args: The actual values of the arguments.
518 @arg_types: The types of the arguments.
519 @return_type: The type of the return value from the function
520 or #GTK_TYPE_NONE for no return value.
522 <!-- ##### STRUCT GtkSignalQuery ##### -->
524 This structure contains all the information about a particular
525 signal: its name, the type it affects, the signature of the handlers,
526 and its unique identifying integer.
538 <!-- ##### STRUCT GtkStatusbarMsg ##### -->
540 Holds the data for a statusbar message. <structfield>text</structfield> holds the actual text string. <structfield>context_id</structfield> is the context that this message is associated with, and <structfield>message_id</structfield> is this particular message's identifier. However, these fields should not be modified directly.
547 <!-- ##### ARG GtkTextTag:justify ##### -->
549 A #GtkJustification for the text. This is only used when the tag is
550 applied to the first character in a paragraph.
554 <!-- ##### ARG GtkTextTag:left-wrapped-line-margin ##### -->
556 Pixel width of the left margin of the text for lines after the first
557 line in a wrapped paragraph.
561 <!-- ##### ARG GtkTextTag:left-wrapped-line-margin-set ##### -->
567 <!-- ##### ARG GtkTextTag:offset ##### -->
569 Pixels to offset the text horizontally or vertically, useful to
570 produce superscript and subscript.
574 <!-- ##### SIGNAL GtkWidget::draw ##### -->
579 @widget: the object which received the signal.
582 <!-- ##### SIGNAL GtkWidget::draw-default ##### -->
587 @widget: the object which received the signal.
589 <!-- ##### SIGNAL GtkWidget::draw-focus ##### -->
594 @widget: the object which received the signal.
596 <!-- ##### FUNCTION gtk_clist_construct ##### -->
598 Initializes a previously allocated #GtkCList widget for use. This should not
599 normally be used to create a #GtkCList widget. Use gtk_clist_new() instead.
602 @clist: A pointer to an uninitialized #GtkCList widget.
603 @columns: The number of columns the #GtkCList should have.
604 @titles: An array of strings that should be used as the titles i
605 of the columns. There should be enough strings in the array for
606 the number of columns specified.
608 <!-- ##### FUNCTION gtk_color_selection_set_opacity ##### -->
610 Controls whether opacity can be set with the #GtkColorSelection.
611 If this functionality is enabled, the necessary additional widgets
612 are added to the #GtkColorSelection and the opacity value can be
613 retrieved via the fourth value in the color array returned by
614 the gtk_color_selection_get_color() function.
617 @colorsel: a #GtkColorSelection.
618 @use_opacity: a boolean indicating whether the opacity selection
621 <!-- ##### FUNCTION gtk_ctree_construct ##### -->
623 This function is not usually used by users.
631 <!-- ##### FUNCTION gtk_editable_changed ##### -->
633 Causes the "changed" signal to be emitted.
636 @editable: a #GtkEditable widget.
638 <!-- ##### FUNCTION gtk_editable_claim_selection ##### -->
640 Claim or disclaim ownership of the PRIMARY X selection.
643 @editable: a #GtkEditable widget.
644 @claim: if %TRUE, claim the selection, otherwise, disclaim it.
645 @time: the timestamp for claiming the selection.
647 <!-- ##### FUNCTION gtk_font_selection_dialog_set_filter ##### -->
649 Sets one of the two font filters, to limit the fonts shown.
652 @fsd: a #GtkFontSelectionDialog.
653 @filter_type: which of the two font filters to set, either
654 #GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter
655 can be changed by the user, but the base filter is permanent.
656 @font_type: the types of font to be shown. This is a bitwise combination of
657 #GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP,
658 or #GTK_FONT_ALL to show all three font types.
659 @foundries: a NULL-terminated array of strings containing foundry names which
660 will be shown, or NULL to show all foundries.
661 @weights: a NULL-terminated array of strings containing weight names which
662 will be shown, or NULL to show all weights.
663 @slants: a NULL-terminated array of strings containing slant names which
664 will be shown, or NULL to show all slants.
665 @setwidths: a NULL-terminated array of strings containing setwidth names which
666 will be shown, or NULL to show all setwidths.
667 @spacings: a NULL-terminated array of strings containing spacings which
668 will be shown, or NULL to show all spacings.
669 @charsets: a NULL-terminated array of strings containing charset names which
670 will be shown, or NULL to show all charsets.
672 <!-- ##### FUNCTION gtk_font_selection_set_filter ##### -->
674 Sets one of the two font filters, to limit the fonts shown.
677 @fontsel: a #GtkFontSelection.
678 @filter_type: which of the two font filters to set, either
679 #GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter
680 can be changed by the user, but the base filter is permanent.
681 @font_type: the types of font to be shown. This is a bitwise combination of
682 #GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP,
683 or #GTK_FONT_ALL to show all three font types.
684 @foundries: a NULL-terminated array of strings containing foundry names which
685 will be shown, or NULL to show all foundries.
686 @weights: a NULL-terminated array of strings containing weight names which
687 will be shown, or NULL to show all weights.
688 @slants: a NULL-terminated array of strings containing slant names which
689 will be shown, or NULL to show all slants.
690 @setwidths: a NULL-terminated array of strings containing setwidth names which
691 will be shown, or NULL to show all setwidths.
692 @spacings: a NULL-terminated array of strings containing spacings which
693 will be shown, or NULL to show all spacings.
694 @charsets: a NULL-terminated array of strings containing charset names which
695 will be shown, or NULL to show all charsets.
697 <!-- ##### FUNCTION gtk_identifier_get_type ##### -->
699 Get the type of GtkIdentifier.
702 @Returns: GtkType -- the enumerated type of something.
704 <!-- ##### FUNCTION gtk_object_arg_get ##### -->
706 Private function to get an argument and argument info from an object.
709 @object: the object whose argument should be retrieved.
710 @arg: the argument, for the name on input, the rest is filled on output.
711 @info: a #GtkArgInfo structure to optionally fill in.
713 <!-- ##### FUNCTION gtk_object_arg_get_info ##### -->
715 Query information about an argument type.
718 @object_type: type of object to query about.
719 @arg_name: name of the argument.
720 @info_p: pointer to be filled in with a pointer to the GtkArgInfo.
721 @Returns: an error message, or NULL on success.
722 It is the caller's responsibility to call g_free() in the event of error.
724 <!-- ##### FUNCTION gtk_object_arg_set ##### -->
726 Private function to set an argument and argument info to an object.
729 @object: the object whose argument should be set.
731 @info: infomation about this type of argument in general.
733 <!-- ##### FUNCTION gtk_object_args_collect ##### -->
735 Private: Gets an array of #GtkArgs from a va_list C structure.
738 @object_type: the type of object to collect arguments for.
739 @arg_list_p: pointer to be filled in with a list of parsed arguments.
740 @info_list_p: optional pointer for a returned list #GtkArgInfos.
741 @first_arg_name: name of first argument.
742 @var_args: value of first argument, followed by more key/value pairs,
744 @Returns: an error message, or NULL on success.
745 It is the caller's responsibility to call g_free() in the event of error.
747 <!-- ##### FUNCTION gtk_object_class_add_signals ##### -->
749 Add an array of signals to a #GtkObjectClass.
750 Usually this is called when registering a new type of object.
753 @klass: the object class to append signals to.
754 @signals: the signals to append.
755 @nsignals: the number of signals being appended.
757 <!-- ##### FUNCTION gtk_object_class_user_signal_new ##### -->
759 Define a signal-handler for a new signal on an already defined
763 See the signal documentation for more general information.
766 @klass: the object class to define the signal for.
767 @name: the name of the signal.
768 @signal_flags: the default emission behavior for the signal.
769 See gtk_signal_new().
770 @marshaller: a function that will take an array of GtkArgs
771 and invoke the appropriate handler with the normal calling
773 @return_val: specify the return-value type for the signal
774 (or GTK_TYPE_NONE for no return-value).
775 @nparams: specify the number of parameters the signal
776 receives from the caller of gtk_signal_emit().
777 @Varargs: list of nparams #GtkTypes to pass to the signal handlers.
778 @Returns: the signal id. (See #GtkSignals)
780 <!-- ##### FUNCTION gtk_object_class_user_signal_newv ##### -->
782 Define a signal-handler for a new signal on an already defined
786 @klass: the object class to define the signal for.
787 @name: the name of the signal.
788 @signal_flags: the default emission behavior for the signal.
789 See gtk_signal_new().
790 @marshaller: takes a GtkObject, a #GtkSignalFunc, and an array
791 of arguments, and invokes the function using the appropriate
792 calling conventions. Usually just select a function
794 @return_val: specify the return-value type for the signal (possibly
796 @nparams: specify the number of parameters the signal
797 receives from the caller of gtk_signal_emit().
798 @params: array of #GtkTypes the signal handlers for this signal
799 should have in their prototype (of length nparams).
800 @Returns: the signal id. (See #GtkSignals)
802 <!-- ##### FUNCTION gtk_object_constructed ##### -->
804 Mark an allocated object as constructed.
805 This is used for situations
806 that require precise control of the construction process.
809 This is done when gtk_object_default_construct() is inadequate.
810 In #GtkCList the need arises because #GtkCList does construction work that
811 must happen <emphasis>after</emphasis> its derivers. This work
812 cannot be done in an initializer function, so an alternate
813 constructor is mandatory. It calls gtk_object_constructed() to
814 indicate it has done its job, so that no other constructor will
818 Normally this function is just automatically run from
819 gtk_object_default_construct().
822 @object: object which has been constructed. This is usually
823 done automatically by gtk_object_new() and gtk_object_newv().
825 <!-- ##### FUNCTION gtk_object_default_construct ##### -->
827 This function is called to construct arguments that haven't been initialized
828 but have the #GTK_ARG_CONSTRUCT flag set.
831 All number arguments are set to 0. All pointers and strings
835 Normally invoked by gtk_object_new() automatically; gtk_type_new() can
836 be used to bypass it.
839 @object: the object to initialize.
841 <!-- ##### FUNCTION gtk_object_getv ##### -->
843 Gets an array of argument values from an object.
846 @object: the object to get arguments from.
847 @n_args: the number of arguments to query.
848 @args: the arguments to fill in.
850 <!-- ##### FUNCTION gtk_object_newv ##### -->
852 Construct an object with an array of arguments.
855 @object_type: the type of the object to create.
856 @n_args: the number of arguments to set.
857 @args: an array of n_args arguments (which are name and value pairs).
858 @Returns: the new GtkObject.
860 <!-- ##### FUNCTION gtk_object_query_args ##### -->
862 Get all the arguments that may be used for a given type.
865 In Java, this type of mechanism is called
866 <wordasword>introspection</wordasword>. It is used by applications
867 like Glade, that have to determine what can be done to an object
871 @class_type: the GtkType of the ObjectClass
872 (returned from GTK_OBJECT_CLASS(class)->type for example).
873 @arg_flags: if non-NULL, obtains the #GtkArgFlags that apply to
874 each argument. You must g_free() this if you request it.
875 @n_args: the number of arguments is returned in this field.
876 @Returns: an array of arguments, that you must deallocate with g_free().
878 <!-- ##### FUNCTION gtk_object_setv ##### -->
880 Set an array of arguments.
883 @object: the object whose arguments should be set.
884 @n_args: the number of arguments to set.
885 @args: the desired values, as an array of #GtkArgs (which contain
886 the names, types, and values of the arguments).
888 <!-- ##### FUNCTION gtk_paned_compute_position ##### -->
890 Internal function used by #GtkHPaned and #GtkVPaned
898 <!-- ##### FUNCTION gtk_rc_init ##### -->
904 <!-- ##### FUNCTION gtk_ruler_draw_pos ##### -->
911 <!-- ##### FUNCTION gtk_ruler_draw_ticks ##### -->
918 <!-- ##### FUNCTION gtk_signal_add_emission_hook_full ##### -->
920 Add an emission hook for a type of signal, for any object.
921 (with control of what happens when the hook is
925 @signal_id: the type of signal add the hook for.
926 @hook_func: the function to invoke to handle the hook.
927 @data: the user data passed in to hook_func.
928 @destroy: a function to invoke when the hook is destroyed,
929 to clean up any allocation done just for this
931 @Returns: the id (that you may pass as a parameter
932 to gtk_signal_remove_emission_hook()).
934 <!-- ##### FUNCTION gtk_signal_handler_pending_by_id ##### -->
936 Returns whether a connection id is valid (and optionally not blocked).
939 @object: the object to search for the desired handler.
940 @handler_id: the connection id.
941 @may_be_blocked: whether it is acceptable to return a blocked
943 @Returns: TRUE if the signal exists and wasn't blocked,
944 unless #may_be_blocked was specified. FALSE otherwise.
946 <!-- ##### FUNCTION gtk_signal_handlers_destroy ##### -->
948 Destroy all the signal handlers connected to an object.
949 This is done automatically when the object is destroyed.
952 This function is labeled private.
955 @object: the object whose signal handlers should be destroyed.
957 <!-- ##### FUNCTION gtk_signal_n_emissions ##### -->
959 Find out the recursion depth of emissions for a particular type
960 of signal and object. (So it will
961 always return 0 or 1 if #GTK_RUN_NO_RECURSE is specified)
962 This is a way to avoid recursion: you can see if
963 you are currently running in that signal handler and emit it only
966 <para>Another way to look at it is that this number increases
967 by one when #gtk_signal_emit(), et al, are called,
968 and decreases by one when #gtk_signal_emit() returns.
971 @object: the object with the signal handler.
972 @signal_id: the signal id.
973 @Returns: the recursion depth of emissions of this signal for this
976 <!-- ##### FUNCTION gtk_signal_n_emissions_by_name ##### -->
978 Find out the recursion depth of emissions for a particular type
979 of signal and object. Just like gtk_signal_n_emissions()
980 except it will lookup the signal id for you.
983 @object: the object with the signal handler.
984 @name: the signal name.
985 @Returns: the recursion depth of emissions of this signal for this
988 <!-- ##### FUNCTION gtk_signal_query ##### -->
990 Obtain information about a signal.
993 @signal_id: the signal type identifier.
994 @Returns: a pointer to a GtkSignalQuery structure
995 which contains all the information, or NULL.
996 The pointer is allocated just for you: you must g_free() it.
998 <!-- ##### FUNCTION gtk_signal_set_funcs ##### -->
1000 These set default functions to call when the user didn't
1001 supply a function when connecting. (These are rarely
1002 used, and probably only for language bindings)
1005 By default, there are no such functions.
1008 @marshal_func: the function to invoke on every handlers for which there
1009 isn't a function pointer. May be NULL.
1010 @destroy_func: the function to invoke when each hook is destroyed.
1013 <!-- ##### FUNCTION gtk_trace_referencing ##### -->
1015 Private: print debugging information while doing a gtk_object_ref() or
1016 a gtk_object_unref().
1019 @object: object to reference or unreference.
1020 @func: name of caller's function to print (used within macros).
1022 @line: line number (used within macros).
1023 @do_ref: whether to reference or unreference.
1025 <!-- ##### FUNCTION gtk_type_check_class_cast ##### -->
1027 Given a GtkTypeClass pointer @klass, and a GtkType @cast_type, make
1028 sure that it's okay to cast something of that @klass into a @cast_type.
1031 @klass: GtkTypeClass*
1033 @Returns: Always return @klass.
1035 <!-- ##### FUNCTION gtk_type_check_object_cast ##### -->
1037 Given a pointer to a GtkTypeObject @type_object, and a GtkType @cast_type,
1038 make sure that it's okay to cast @type_object into a @cast_type.
1041 @type_object: GtkTypeObject*
1043 @Returns: the same GtkTypeObject* as @type_object
1045 <!-- ##### FUNCTION gtk_type_children_types ##### -->
1047 Return the pointer to the type's children's types.
1051 @Returns: pointer to a GList
1053 <!-- ##### FUNCTION gtk_type_describe_heritage ##### -->
1055 Print the types @type inherits from.
1060 <!-- ##### FUNCTION gtk_type_describe_tree ##### -->
1062 Given a @type, describe all of its children, and their children. Only
1063 show the size if @show_size is true.
1067 @show_size: gboolean
1069 <!-- ##### FUNCTION gtk_type_free ##### -->
1071 Given the type of an object and a pointer to it, the object is freed.
1075 @mem: gpointer to the object
1077 <!-- ##### FUNCTION gtk_type_get_varargs_type ##### -->
1079 Get the varargs type associated with @foreign_type
1082 @foreign_type: GtkType
1085 <!-- ##### FUNCTION gtk_type_parent_class ##### -->
1087 Return the class of the parent. Initialize the class if necessary.
1088 Return NULL if anything goes wrong.
1092 @Returns: gpointer to the klass.
1094 <!-- ##### FUNCTION gtk_type_query ##### -->
1096 Given a type, return various interesting parameters of the type.
1100 @Returns: GtkTypeQuery*
1102 <!-- ##### FUNCTION gtk_type_register_enum ##### -->
1104 Register a new set of enum @values and give them the name in
1108 @type_name: must not be null.
1109 @values: GtkEnumValue*
1112 <!-- ##### FUNCTION gtk_type_register_flags ##### -->
1114 Register a new set of flags @values and give them the name in
1118 @type_name: must not be null.
1119 @values: GtkFlagValue*
1122 <!-- ##### FUNCTION gtk_type_set_chunk_alloc ##### -->
1124 Set the mem_chunk size so it will hold @n_chunks of the objects of that @type.
1127 @type: There must be an unlocked TypeNode associated with this type otherwise nothing happens.
1130 <!-- ##### FUNCTION gtk_type_set_varargs_type ##### -->
1132 Set the varargs type for a fundamental type @foreign_type.
1135 @foreign_type: Must be a GtkType with a sequence number of zero. Must not be a
1137 @varargs_type: Must be a GtkType which is either structured or flag, or NONE.