1 <!-- ##### SECTION ./tmpl/gtkarg.sgml:Long_Description ##### -->
3 All the functions in here are marked a Non-public.
4 We describe it anyway because it is occasionally useful
5 to understand how the work is done.
8 Arguments are a way of describing a named parameter to a function.
9 They have two important roles within gtk+:
13 they describe <wordasword>object properties</wordasword>.
14 This means that they present an interface to get and set a named-type
15 for any type of object in a consistent way.
16 (All the relevant functions to do this start with gtk_object_set
22 they describe <wordasword>signal arguments</wordasword>.
23 This is a lot less often needed but still useful.
24 Usually if you are just emitting or creating a particular signal
25 it is more convenient to just use gtk_signal_emit() or gtk_signal_new().
26 However if you are writing a function to emit or create an arbitrary
27 signal, you must use gtk_signal_emitv() or gtk_signal_newv().
34 <!-- ##### SECTION ./tmpl/gtkarg.sgml:See_Also ##### -->
40 <!-- ##### SECTION ./tmpl/gtkarg.sgml:Short_Description ##### -->
41 Utility function to manipulate lists of named, typed arguments.
44 <!-- ##### SECTION ./tmpl/gtkarg.sgml:Title ##### -->
45 Implementation of Object Properties
48 <!-- ##### SECTION ./tmpl/gtkdata.sgml:Long_Description ##### -->
50 The #GtkData object is a very simple object intended to be used as a base
51 class for objects which contain data (i.e. the 'Model' in the object-oriented
52 Model/View/Controller framework).
55 Currently it is not very useful since all it provides is a "disconnect" signal.
56 This signal could be emitted by a #GtkData subclass to notify any 'Views'
57 that they should disconnect from the #GtkData (the 'Model'), possibly just
58 before the #GtkData is destroyed.
62 <!-- ##### SECTION ./tmpl/gtkdata.sgml:See_Also ##### -->
68 <!-- ##### SECTION ./tmpl/gtkdata.sgml:Short_Description ##### -->
69 abstract base class for objects containing data.
72 <!-- ##### SECTION ./tmpl/gtkdata.sgml:Title ##### -->
76 <!-- ##### SECTION ./tmpl/gtkdebug.sgml:Title ##### -->
80 <!-- ##### SECTION ./tmpl/gtkenums.sgml.sgml:Title ##### -->
84 <!-- ##### SECTION ./tmpl/gtkimcontextsimple.sgml:Title ##### -->
88 <!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Long_Description ##### -->
90 <title>What are Signal Marshallers?</title>
92 Marshals are functions which all have the same prototype:
93 they take a #GtkObject, a #GtkSignalFunc, a #gpointer,
94 and an array of argument values.
95 The functions are names gtk_marshall_RETURNTYPE__PARAMTYPE1_PARAMTYPE2....
98 They then call a native function: the GtkObject is the first
99 parameter passed in. The arguments are passed in the native
100 calling convention: chars, shorts, ints, longs may be packed
101 on the stack, or tucked in registers: it doesn't matter
102 because the same calling convention will be generated
103 inside the gtkmarshal code as is expected where you define
107 So the function named:
109 gtk_marshal_BOOL__POINTER_INT_INT_UINT(GtkObject*, GtkSignalFunc, gpointer, GtkArg*);
111 will call the #GtkSignalFunc assuming it was a function with signature:
113 gboolean sigfunc(gpointer,gint,gint,guint);
118 <title>Writing Custom Marshals</title>
120 Marshals are primarily used as arguments to gtk_signal_new().
121 Sometimes, you may find that a marshaller you need isn't available
122 in the standard list. Then you have to write your own.
125 If you wish to define a signal with a new type of argument list.
126 Suppose you want 2 pointers and 2 integers.
129 typedef int (*GtkSignal_INT__POINTER_POINTER_INT_INT)(
130 gpointer, gpointer, gint, gint
133 void marshal_INT__POINTER_POINTER_INT_INT(GtkObject* object,
138 GtkSignal_NONE__POINTER_POINTER_INT_INT rfunc;
140 return_val = GTK_RETLOC_INT(args[4]);
141 rfunc = (GtkSignal_INT__POINTER_POINTER_INT_INT)func;
142 *return_val = (*rfunc)(object,
143 GTK_VALUE_POINTER(args[0]),
144 GTK_VALUE_POINTER(args[1]),
145 GTK_VALUE_INT(args[2]),
146 GTK_VALUE_INT(args[3]),
154 <!-- ##### SECTION ./tmpl/gtkmarshal.sgml:See_Also ##### -->
159 <term>#GtkSignal</term>
160 <listitem><para>The signal handling functions (of which marshallers are
161 really an implementation detail).</para></listitem>
168 <!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Short_Description ##### -->
169 Functions to adapt C structures to native calling convention.
172 <!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Title ##### -->
176 <!-- ##### SECTION ./tmpl/gtkprivate.sgml:Title ##### -->
180 <!-- ##### SECTION ./tmpl/gtktreemodelsimple.sgml:Long_Description ##### -->
186 <!-- ##### SECTION ./tmpl/gtktreemodelsimple.sgml:See_Also ##### -->
192 <!-- ##### SECTION ./tmpl/gtktreemodelsimple.sgml:Short_Description ##### -->
196 <!-- ##### SECTION ./tmpl/gtktreemodelsimple.sgml:Title ##### -->
200 <!-- ##### MACRO GTK_CLIST_CHILD_HAS_FOCUS ##### -->
202 A macro to check whether a child widget of the CList
206 @clist: The #GtkCList widget to check.
208 <!-- ##### MACRO GTK_ICON_SIZE_BUTTON ##### -->
214 <!-- ##### MACRO GTK_ICON_SIZE_DIALOG ##### -->
220 <!-- ##### MACRO GTK_ICON_SIZE_LARGE_TOOLBAR ##### -->
226 <!-- ##### MACRO GTK_ICON_SIZE_MENU ##### -->
232 <!-- ##### MACRO GTK_ICON_SIZE_SMALL_TOOLBAR ##### -->
238 <!-- ##### MACRO GTK_OBJECT_CONSTRUCTED ##### -->
240 Test whether a GtkObject's arguments have been prepared.
243 @obj: the object to examine.
245 <!-- ##### MACRO GTK_OBJECT_NSIGNALS ##### -->
247 Get the number of signals defined by this object.
250 @obj: the object to query.
252 <!-- ##### MACRO GTK_OBJECT_SIGNALS ##### -->
254 Get the array of signals defined for this object.
257 @obj: the object to fetch the signals from.
259 <!-- ##### MACRO GTK_STOCK_BUTTON_APPLY ##### -->
265 <!-- ##### MACRO GTK_STOCK_BUTTON_CANCEL ##### -->
271 <!-- ##### MACRO GTK_STOCK_BUTTON_CLOSE ##### -->
277 <!-- ##### MACRO GTK_STOCK_BUTTON_NO ##### -->
283 <!-- ##### MACRO GTK_STOCK_BUTTON_OK ##### -->
289 <!-- ##### MACRO GTK_STOCK_BUTTON_YES ##### -->
295 <!-- ##### MACRO GTK_TREE_SELECTION ##### -->
297 A macro that returns a GList that contains the selection of the root tree of @obj.
300 @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.
302 <!-- ##### MACRO GTK_TYPE_FLAT_FIRST ##### -->
304 The first "flat" (no struct) enumerated type value.
308 <!-- ##### MACRO GTK_TYPE_FLAT_LAST ##### -->
310 The last "flat" (no struct) enumerated type value.
314 <!-- ##### MACRO GTK_TYPE_IDENTIFIER ##### -->
316 Hide the name of gtk_identifier_get_type
320 <!-- ##### MACRO GTK_TYPE_MAKE ##### -->
322 Combine a fundemantal type and a sequence number to create a gtk type.
328 <!-- ##### MACRO GTK_TYPE_NUM_BUILTINS ##### -->
334 <!-- ##### MACRO GTK_TYPE_SEQNO ##### -->
336 Convert a gtk type into its sequence number
341 <!-- ##### MACRO GTK_TYPE_STRUCTURED_FIRST ##### -->
343 The first structured enumerated type value.
347 <!-- ##### MACRO GTK_TYPE_STRUCTURED_LAST ##### -->
349 The last structured enumerated type value.
353 <!-- ##### MACRO GTK_TYPE_TREE_COLUMN ##### -->
359 <!-- ##### MACRO GTK_VALUE_ARGS ##### -->
361 Use to get the value of a GtkArg whose GtkType is GTK_TYPE_ARGS
366 <!-- ##### MACRO GTK_VALUE_CALLBACK ##### -->
368 Use to get the value of a GtkArg whose GtkType is GTK_TYPE_CALLBACK
373 <!-- ##### MACRO GTK_VALUE_C_CALLBACK ##### -->
375 Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_CALLBACK
380 <!-- ##### MACRO GTK_VALUE_FOREIGN ##### -->
382 Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_FOREIGN
387 <!-- ##### USER_FUNCTION GValueCompareFunc ##### -->
396 <!-- ##### ARG GtkAccelLabel:accel-widget ##### -->
398 The widget whose accelerators are to be shown by the #GtkAccelLabel.
402 <!-- ##### ARG GtkAccelLabel:accel-width ##### -->
408 <!-- ##### USER_FUNCTION GtkArgGetFunc ##### -->
410 Define a function pointer. Deprecated.
417 <!-- ##### STRUCT GtkArgInfo ##### -->
419 A structure containing information about the argument.
420 Returned by gtk_arg_get_info().
423 @class_type: if the argument is an object, this is the object class type.
424 @name: the name of the argument.
425 @type: the type of the argument; it may be an object's type
426 or a fundamental type.
427 @arg_flags: flags applicable to the argument (i.e. readable, writable,
428 and whether it needs to be constructed).
429 @full_name: the object name and argument name separated by ::,
430 e.g. "GtkObject::user_data" or "GtkButton::label".
431 @arg_id: the unique argument identified.
434 <!-- ##### USER_FUNCTION GtkArgSetFunc ##### -->
436 Define a function pointer. Deprecated.
443 <!-- ##### ARG GtkColorSelection:previous-alpha ##### -->
449 <!-- ##### ARG GtkColorSelection:previous-color ##### -->
455 <!-- ##### SIGNAL GtkContainer::focus ##### -->
460 @container: the object which received the signal.
464 <!-- ##### ARG GtkContainer:reallocate-redraws ##### -->
470 <!-- ##### STRUCT GtkData ##### -->
472 The #GtkData-struct struct contains no public fields.
476 <!-- ##### SIGNAL GtkData::disconnect ##### -->
478 Emitted to notify any views on the #GtkData object to disconnect from it,
479 possibly because the #GtkData object is about to be destroyed.
482 @data: the object which received the signal.
484 <!-- ##### SIGNAL GtkEditable::activate ##### -->
486 Indicates that the user has activated the widget
487 in some fashion. Generally, this will be done
488 with a keystroke. (The default binding for this
489 action is Return for #GtkEntry and
490 Control-Return for #GtkText.)
493 @editable: the object which received the signal.
495 <!-- ##### SIGNAL GtkEditable::changed ##### -->
497 Indicates that the user has changed the contents
501 @editable: the object which received the signal.
503 <!-- ##### SIGNAL GtkEditable::copy-clipboard ##### -->
505 An action signal. Causes the characters in the current selection to
506 be copied to the clipboard.
509 @editable: the object which received the signal.
511 <!-- ##### SIGNAL GtkEditable::cut-clipboard ##### -->
513 An action signal. Causes the characters in the current
514 selection to be copied to the clipboard and then deleted from
518 @editable: the object which received the signal.
520 <!-- ##### SIGNAL GtkEditable::delete-text ##### -->
522 This signal is emitted when text is deleted from
523 the widget by the user. The default handler for
524 this signal will normally be responsible for inserting
525 the text, so by connecting to this signal and then
526 stopping the signal with gtk_signal_emit_stop(), it
527 is possible to modify the inserted text, or prevent
528 it from being inserted entirely. The @start_pos
529 and @end_pos parameters are interpreted as for
530 gtk_editable_delete_text()
533 @editable: the object which received the signal.
534 @start_pos: the starting position.
535 @end_pos: the end position.
537 <!-- ##### SIGNAL GtkEditable::insert-text ##### -->
539 This signal is emitted when text is inserted into
540 the widget by the user. The default handler for
541 this signal will normally be responsible for inserting
542 the text, so by connecting to this signal and then
543 stopping the signal with gtk_signal_emit_stop(), it
544 is possible to modify the inserted text, or prevent
545 it from being inserted entirely.
548 @editable: the object which received the signal.
549 @new_text: the new text to insert.
550 @new_text_length: the length of the new text.
551 @position: the position at which to insert the new text.
552 this is an in-out paramter. After the signal
553 emission is finished, it should point after
554 the newly inserted text.
556 <!-- ##### SIGNAL GtkEditable::kill-char ##### -->
558 An action signal. Delete a single character.
561 @editable: the object which received the signal.
562 @direction: the direction in which to delete. Positive
563 indicates forward deletion, negative, backwards deletion.
565 <!-- ##### SIGNAL GtkEditable::kill-line ##### -->
567 An action signal. Delete a single line.
570 @editable: the object which received the signal.
571 @direction: the direction in which to delete. Positive
572 indicates forward deletion, negative, backwards deletion.
574 <!-- ##### SIGNAL GtkEditable::kill-word ##### -->
576 An action signal. Delete a single word.
579 @editable: the object which received the signal.
580 @direction: the direction in which to delete. Positive
581 indicates forward deletion, negative, backwards deletion.
583 <!-- ##### SIGNAL GtkEditable::move-cursor ##### -->
585 An action signal. Move the cursor position.
588 @editable: the object which received the signal.
589 @x: horizontal distance to move the cursor.
590 @y: vertical distance to move the cursor.
592 <!-- ##### SIGNAL GtkEditable::move-page ##### -->
594 An action signal. Move the cursor by pages.
597 @editable: the object which received the signal.
598 @x: Number of pages to move the cursor horizontally.
599 @y: Number of pages to move the cursor vertically.
601 <!-- ##### SIGNAL GtkEditable::move-to-column ##### -->
603 An action signal. Move the cursor to the given column.
606 @editable: the object which received the signal.
607 @column: the column to move to. (A negative value indicates
610 <!-- ##### SIGNAL GtkEditable::move-to-row ##### -->
612 An action signal. Move the cursor to the given row.
615 @editable: the object which received the signal.
616 @row: the row to move to. (A negative value indicates
619 <!-- ##### SIGNAL GtkEditable::move-word ##### -->
621 An action signal. Move the cursor by words.
624 @editable: the object which received the signal.
625 @num_words: The number of words to move the
626 cursor. (Can be negative).
628 <!-- ##### SIGNAL GtkEditable::paste-clipboard ##### -->
630 An action signal. Causes the contents of the clipboard to
631 be pasted into the editable widget at the current cursor
635 @editable: the object which received the signal.
637 <!-- ##### SIGNAL GtkEditable::set-editable ##### -->
639 Determines if the user can edit the text in the editable
640 widget or not. This is meant to be overriden by
641 child classes and should not generally useful to
645 @editable: the object which received the signal.
646 @is_editable: %TRUE if the user is allowed to edit the text
649 <!-- ##### ARG GtkEditable:editable ##### -->
651 A boolean indicating whether the widget is editable by
656 <!-- ##### ARG GtkEditable:text-position ##### -->
658 The position of the cursor.
662 <!-- ##### USER_FUNCTION GtkEmissionHook ##### -->
664 A simple function pointer to get invoked when the
665 signal is emitted. This allows you tie a hook to the signal type,
666 so that it will trap all emissions of that signal, from any object.
669 You may not attach these to signals created with the
670 #GTK_RUN_NO_HOOKS flag.
680 <!-- ##### ENUM GtkFontFilterType ##### -->
682 A set of bit flags used to specify the filter being set
683 when calling gtk_font_selection_dialog_set_filter() or
684 gtk_font_selection_set_filter().
687 @GTK_FONT_FILTER_BASE: the base filter, which can't be changed by the user.
688 @GTK_FONT_FILTER_USER: the user filter, which can be changed from within the
689 'Filter' page of the #GtkFontSelection widget.
691 <!-- ##### ENUM GtkFontType ##### -->
693 A set of bit flags used to specify the type of fonts shown
694 when calling gtk_font_selection_dialog_set_filter() or
695 gtk_font_selection_set_filter().
698 @GTK_FONT_BITMAP: bitmap fonts.
699 @GTK_FONT_SCALABLE: scalable fonts.
700 @GTK_FONT_SCALABLE_BITMAP: scaled bitmap fonts.
701 @GTK_FONT_ALL: a bitwise combination of all of the above.
703 <!-- ##### ARG GtkFrame:shadow-type ##### -->
709 <!-- ##### ARG GtkHScale:adjustment ##### -->
711 the #GtkAdjustment which sets the range of the scale.
715 <!-- ##### ARG GtkHScrollbar:adjustment ##### -->
721 <!-- ##### STRUCT GtkIMContextSimple ##### -->
730 @tentative_match_len:
732 <!-- ##### USER_FUNCTION GtkImageLoader ##### -->
734 A GtkImageLoader is used to load a filename found in
738 @window: the window for creating image
739 @colormap: the colormap for this image
740 @mask: a pointer to the location to store the mask
741 @transparent_color: the transparent color for the image
742 @filename: filename to load
743 @Returns: a #GtkPixmap representing @filename
745 <!-- ##### ARG GtkLabel:accel-keyval ##### -->
751 <!-- ##### ARG GtkObject:object-signal ##### -->
753 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
754 the signal to the object, so that the user data and objects
755 and swapped when the signal handler is invoked.
758 This is useful for handlers that are primarily notifying
759 other objects and could just invoke an already existing function
760 if the parameters were swapped.
761 See gtk_signal_connect_object() for more details.
765 <!-- ##### ARG GtkObject:object-signal-after ##### -->
767 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
768 the signal to the object, so that the user data and objects
769 and swapped when the signal handler is invoked,
770 and so that the handler is invoked after all others.
773 See gtk_signal_connect_object_after() for more details.
777 <!-- ##### ARG GtkObject:signal ##### -->
779 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
780 the signal to the object.
784 <!-- ##### ARG GtkObject:signal-after ##### -->
786 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
787 the signal to the object, so that the signal is always run
788 after other user handlers and the default handler.
792 <!-- ##### ARG GtkPacker:default-border-width ##### -->
798 <!-- ##### ARG GtkPacker:default-ipad-x ##### -->
804 <!-- ##### ARG GtkPacker:default-ipad-y ##### -->
810 <!-- ##### ARG GtkPacker:default-pad-x ##### -->
816 <!-- ##### ARG GtkPacker:default-pad-y ##### -->
822 <!-- ##### ARG GtkPacker:spacing ##### -->
828 <!-- ##### ARG GtkPaned:handle-size ##### -->
834 <!-- ##### STRUCT GtkPatternSpec ##### -->
846 <!-- ##### ENUM GtkPrivateFlags ##### -->
851 @PRIVATE_GTK_USER_STYLE:
852 @PRIVATE_GTK_RESIZE_PENDING:
853 @PRIVATE_GTK_RESIZE_NEEDED:
854 @PRIVATE_GTK_LEAVE_PENDING:
855 @PRIVATE_GTK_HAS_SHAPE_MASK:
856 @PRIVATE_GTK_IN_REPARENT:
857 @PRIVATE_GTK_DIRECTION_SET:
858 @PRIVATE_GTK_DIRECTION_LTR:
860 <!-- ##### ARG GtkScrolledWindow:shadow ##### -->
866 <!-- ##### USER_FUNCTION GtkSignalDestroy ##### -->
868 A function which you can use to clean up when the
869 signal handler is destroyed.
872 For example, if your handler requires a few variables
873 that you made into a struct and allocated (using g_new()
874 or something), then you will probably want to free
875 it as soon as the hook is destroyed. This will
876 allow you to do that. (For this in particular
877 it is convenient to pass g_free() as a #GtkSignalDestroy
881 @data: The user data associated with the hook that is being
884 <!-- ##### USER_FUNCTION GtkSignalMarshal ##### -->
886 This is currently a hack left in for a scheme wrapper library.
893 @object: The object which emits the signal.
894 @data: The user data associated with the hook.
895 @nparams: The number of parameters to the function.
896 @args: The actual values of the arguments.
897 @arg_types: The types of the arguments.
898 @return_type: The type of the return value from the function
899 or #GTK_TYPE_NONE for no return value.
901 <!-- ##### STRUCT GtkSignalQuery ##### -->
903 This structure contains all the information about a particular
904 signal: its name, the type it affects, the signature of the handlers,
905 and its unique identifying integer.
917 <!-- ##### ARG GtkSpinButton:shadow-type ##### -->
919 the type of border that surrounds the arrows of a spin button.
923 <!-- ##### STRUCT GtkStatusbarMsg ##### -->
925 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.
932 <!-- ##### ARG GtkTextTag:justify ##### -->
934 A #GtkJustification for the text. This is only used when the tag is
935 applied to the first character in a paragraph.
939 <!-- ##### ARG GtkTextTag:left-wrapped-line-margin ##### -->
941 Pixel width of the left margin of the text for lines after the first
942 line in a wrapped paragraph.
946 <!-- ##### ARG GtkTextTag:left-wrapped-line-margin-set ##### -->
952 <!-- ##### ARG GtkTextTag:offset ##### -->
954 Pixels to offset the text horizontally or vertically, useful to
955 produce superscript and subscript.
959 <!-- ##### ARG GtkTextView:justify ##### -->
965 <!-- ##### ENUM GtkTreeSelectionMode ##### -->
970 @GTK_TREE_SELECTION_SINGLE:
971 @GTK_TREE_SELECTION_MULTI:
973 <!-- ##### ARG GtkVScale:adjustment ##### -->
975 the #GtkAdjustment which sets the range of the scale.
979 <!-- ##### ARG GtkVScrollbar:adjustment ##### -->
985 <!-- ##### SIGNAL GtkWidget::activate-mnemonic ##### -->
990 @widget: the object which received the signal.
994 <!-- ##### SIGNAL GtkWidget::debug-msg ##### -->
999 @widget: the object which received the signal.
1002 <!-- ##### SIGNAL GtkWidget::draw ##### -->
1007 @widget: the object which received the signal.
1010 <!-- ##### SIGNAL GtkWidget::draw-default ##### -->
1015 @widget: the object which received the signal.
1017 <!-- ##### SIGNAL GtkWidget::draw-focus ##### -->
1022 @widget: the object which received the signal.
1024 <!-- ##### ARG GtkWidget:height ##### -->
1030 <!-- ##### ARG GtkWidget:width ##### -->
1036 <!-- ##### ARG GtkWidget:x ##### -->
1042 <!-- ##### ARG GtkWidget:y ##### -->
1048 <!-- ##### ARG GtkWindow:auto-shrink ##### -->
1050 If the window shrinks automatically when widgets within it shrink.
1054 <!-- ##### ARG GtkWindow:icon-list ##### -->
1060 <!-- ##### FUNCTION gtk_arg_copy ##### -->
1062 It will either copy data into an existing argument or allocate a new argument
1063 and copy the data. Strings are duplicated. All other pointers and
1064 values are copied (shallowly-- that is the pointers themselves are
1065 copied, not the data they point to.)
1068 You should call gtk_arg_reset() on dest_arg before calling this
1069 if the argument may contain string data that you want freed.
1072 @src_arg: the argument to duplicate.
1073 @dest_arg: the argument to copy over (or NULL to create a new #GtkArg).
1074 @Returns: the new #GtkArg (or dest_arg, if it was not NULL).
1076 <!-- ##### FUNCTION gtk_arg_free ##### -->
1078 Frees the argument, and optionally its contents.
1081 @arg: the argument to free.
1082 @free_contents: whether to free the string, if it is a string.
1084 <!-- ##### FUNCTION gtk_arg_get_info ##### -->
1086 Private: get information about an argument.
1089 @object_type: the type of object.
1090 @arg_info_hash_table: the hashtable of #GtkArgInfos.
1091 @arg_name: the name of the argument to lookup.
1092 @info_p: the argument info.
1093 @Returns: an error message on failure, or NULL otherwise.
1095 <!-- ##### FUNCTION gtk_arg_info_equal ##### -->
1097 A #GCompareFunc for hashing #GtkArgInfos.
1100 @arg_info_1: a #GtkArgInfo.
1101 @arg_info_2: a #GtkArgInfo.
1102 @Returns: whether the arguments are the same.
1104 <!-- ##### FUNCTION gtk_arg_info_hash ##### -->
1106 A #GHashFunc for hashing #GtkArgInfos.
1109 @arg_info: a #GtkArgInfo.
1110 @Returns: a hash value for that #GtkArgInfo.
1112 <!-- ##### FUNCTION gtk_arg_name_strip_type ##### -->
1114 Given a fully qualified argument name (e.g. "GtkButton::label")
1115 it returns just the argument name (e.g. "label") unless
1116 the argument name was invalid, in which case it returns NULL.
1119 @arg_name: the fully-qualified argument name.
1120 @Returns: the base argument name.
1122 <!-- ##### FUNCTION gtk_arg_new ##### -->
1124 Creates a new argument of a certain type, set to 0 or NULL.
1127 @arg_type: the type of the argument.
1128 @Returns: the newly created #GtkArg.
1130 <!-- ##### FUNCTION gtk_arg_reset ##### -->
1137 <!-- ##### FUNCTION gtk_arg_to_valueloc ##### -->
1145 <!-- ##### FUNCTION gtk_arg_type_new_static ##### -->
1147 Create a new argument registered with a class.
1150 @base_class_type: the basic type having the arguments, almost alway
1151 GTK_TYPE_OBJECT, except if your defining a different type argument
1152 that gets a different namespace. #GtkContainer does this to define
1153 per-child arguments of the container.
1154 @arg_name: name of the argument to create. (must be a static constant string)
1155 @class_n_args_offset: offset into the base class structure that tells
1156 the number of arguments.
1157 @arg_info_hash_table: hashtable of #GtkArgInfos.
1158 @arg_type: type of the argument.
1159 @arg_flags: flags of the argument.
1161 @Returns: the new #GtkArgInfo.
1163 <!-- ##### FUNCTION gtk_arg_values_equal ##### -->
1172 <!-- ##### FUNCTION gtk_args_collect ##### -->
1174 Private: given a hashtable of argument information it takes a vararg
1175 list and parses it into arguments (in the form of lists of #GtkArgs
1176 and lists of #GtkArgInfos.
1179 The list of arguments starts with first_arg_name then the first argument's
1180 value. Followed by any number of additional name/argument pairs,
1181 terminated with NULL.
1184 @object_type: the type of object we are collecting arguments for.
1185 @arg_info_hash_table: a hashtable mapping from names of arguments
1186 to their #GtkArgInfos.
1187 @arg_list_p: a returned list of arguments obtained from parsing the
1189 @info_list_p: a returned list of the #GtkArgInfos.
1190 @first_arg_name: the name of the first argument.
1191 @var_args: a va_list containing the value of the first argument,
1192 followed by name/value pairs, followed by NULL.
1193 @Returns: an error message on failure, or NULL otherwise.
1195 <!-- ##### FUNCTION gtk_args_collect_cleanup ##### -->
1197 Private: erase lists of arguments returned from gtk_args_collect().
1200 @arg_list: arg_list_p returned from gtk_args_collect().
1201 @info_list: info_list_p returned from gtk_args_collect().
1203 <!-- ##### FUNCTION gtk_args_query ##### -->
1205 Private: from a class type and its arginfo hashtable,
1206 get an array of #GtkArgs that this object accepts.
1209 @class_type: the class type.
1210 @arg_info_hash_table: the hashtable of #GtkArgInfos.
1211 @arg_flags: returned array of argument flags.
1212 @n_args_p: the number of arguments this object accepts.
1213 @Returns: the array of arguments (or NULL on error).
1215 <!-- ##### FUNCTION gtk_button_box_child_requisition ##### -->
1217 This is an internally used function and should never be called from an
\r
1226 <!-- ##### FUNCTION gtk_button_box_get_child_ipadding_default ##### -->
1228 The internal padding of a button is the amount of space between the outside
\r
1229 of the button and the widget it contains. This function gets the default
\r
1230 amount of horizontal and vertical padding, placing the results in @ipad_x
\r
1231 and @ipad_y, respectively.
\r
1234 @ipad_x: the default horizontal internal button padding.
1235 @ipad_y: the default vertical internal button padding.
1237 <!-- ##### FUNCTION gtk_button_box_get_child_size_default ##### -->
1239 Retrieves the default minimum width and height for all button boxes, and
\r
1240 places the values in @min_width and @min_height, respectively.
\r
1243 @min_width: the default minimum width of a child widget.
1244 @min_height: the default minimum height of a child widget.
1246 <!-- ##### FUNCTION gtk_button_box_set_child_ipadding_default ##### -->
1248 Sets the default number of pixels that pad each button in every button box.
\r
1251 @ipad_x: new default horizontal padding.
1252 @ipad_y: new default vertical padding.
1254 <!-- ##### FUNCTION gtk_button_box_set_child_size_default ##### -->
1256 Sets the default size of child buttons.
\r
1259 @min_width: minimum default width for child buttons.
1260 @min_height: minimum default height for child buttons.
1262 <!-- ##### FUNCTION gtk_button_new_accel ##### -->
1271 <!-- ##### FUNCTION gtk_button_new_stock ##### -->
1280 <!-- ##### FUNCTION gtk_clist_construct ##### -->
1282 Initializes a previously allocated #GtkCList widget for use. This should not
1283 normally be used to create a #GtkCList widget. Use gtk_clist_new() instead.
1286 @clist: A pointer to an uninitialized #GtkCList widget.
1287 @columns: The number of columns the #GtkCList should have.
1288 @titles: An array of strings that should be used as the titles i
1289 of the columns. There should be enough strings in the array for
1290 the number of columns specified.
1292 <!-- ##### FUNCTION gtk_color_selection_get_old_color ##### -->
1300 <!-- ##### FUNCTION gtk_color_selection_get_use_opacity ##### -->
1308 <!-- ##### FUNCTION gtk_color_selection_get_use_palette ##### -->
1316 <!-- ##### FUNCTION gtk_color_selection_set_old_color ##### -->
1324 <!-- ##### FUNCTION gtk_color_selection_set_opacity ##### -->
1326 Controls whether opacity can be set with the #GtkColorSelection.
1327 If this functionality is enabled, the necessary additional widgets
1328 are added to the #GtkColorSelection and the opacity value can be
1329 retrieved via the fourth value in the color array returned by
1330 the gtk_color_selection_get_color() function.
1333 @colorsel: a #GtkColorSelection.
1334 @use_opacity: a boolean indicating whether the opacity selection
1337 <!-- ##### FUNCTION gtk_color_selection_set_use_opacity ##### -->
1345 <!-- ##### FUNCTION gtk_color_selection_set_use_palette ##### -->
1353 <!-- ##### FUNCTION gtk_container_add_child_arg_type ##### -->
1363 <!-- ##### FUNCTION gtk_container_add_with_args ##### -->
1373 <!-- ##### FUNCTION gtk_container_addv ##### -->
1383 <!-- ##### FUNCTION gtk_container_arg_get ##### -->
1393 <!-- ##### FUNCTION gtk_container_arg_set ##### -->
1403 <!-- ##### FUNCTION gtk_container_child_arg_get_info ##### -->
1413 <!-- ##### FUNCTION gtk_container_child_args_collect ##### -->
1425 <!-- ##### FUNCTION gtk_container_child_getv ##### -->
1435 <!-- ##### FUNCTION gtk_container_child_setv ##### -->
1445 <!-- ##### FUNCTION gtk_container_dequeue_resize_handler ##### -->
1452 <!-- ##### FUNCTION gtk_container_focus ##### -->
1461 <!-- ##### FUNCTION gtk_container_query_child_args ##### -->
1471 <!-- ##### FUNCTION gtk_ctree_construct ##### -->
1473 This function is not usually used by users.
1481 <!-- ##### FUNCTION gtk_drag_dest_handle_event ##### -->
1489 <!-- ##### FUNCTION gtk_drag_source_handle_event ##### -->
1497 <!-- ##### FUNCTION gtk_editable_changed ##### -->
1499 Causes the "changed" signal to be emitted.
1502 @editable: a #GtkEditable widget.
1504 <!-- ##### FUNCTION gtk_editable_claim_selection ##### -->
1506 Claim or disclaim ownership of the PRIMARY X selection.
1509 @editable: a #GtkEditable widget.
1510 @claim: if %TRUE, claim the selection, otherwise, disclaim it.
1511 @time: the timestamp for claiming the selection.
1513 <!-- ##### FUNCTION gtk_font_selection_dialog_set_filter ##### -->
1515 Sets one of the two font filters, to limit the fonts shown.
1518 @fsd: a #GtkFontSelectionDialog.
1519 @filter_type: which of the two font filters to set, either
1520 #GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter
1521 can be changed by the user, but the base filter is permanent.
1522 @font_type: the types of font to be shown. This is a bitwise combination of
1523 #GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP,
1524 or #GTK_FONT_ALL to show all three font types.
1525 @foundries: a NULL-terminated array of strings containing foundry names which
1526 will be shown, or NULL to show all foundries.
1527 @weights: a NULL-terminated array of strings containing weight names which
1528 will be shown, or NULL to show all weights.
1529 @slants: a NULL-terminated array of strings containing slant names which
1530 will be shown, or NULL to show all slants.
1531 @setwidths: a NULL-terminated array of strings containing setwidth names which
1532 will be shown, or NULL to show all setwidths.
1533 @spacings: a NULL-terminated array of strings containing spacings which
1534 will be shown, or NULL to show all spacings.
1535 @charsets: a NULL-terminated array of strings containing charset names which
1536 will be shown, or NULL to show all charsets.
1538 <!-- ##### FUNCTION gtk_font_selection_set_filter ##### -->
1540 Sets one of the two font filters, to limit the fonts shown.
1543 @fontsel: a #GtkFontSelection.
1544 @filter_type: which of the two font filters to set, either
1545 #GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter
1546 can be changed by the user, but the base filter is permanent.
1547 @font_type: the types of font to be shown. This is a bitwise combination of
1548 #GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP,
1549 or #GTK_FONT_ALL to show all three font types.
1550 @foundries: a NULL-terminated array of strings containing foundry names which
1551 will be shown, or NULL to show all foundries.
1552 @weights: a NULL-terminated array of strings containing weight names which
1553 will be shown, or NULL to show all weights.
1554 @slants: a NULL-terminated array of strings containing slant names which
1555 will be shown, or NULL to show all slants.
1556 @setwidths: a NULL-terminated array of strings containing setwidth names which
1557 will be shown, or NULL to show all setwidths.
1558 @spacings: a NULL-terminated array of strings containing spacings which
1559 will be shown, or NULL to show all spacings.
1560 @charsets: a NULL-terminated array of strings containing charset names which
1561 will be shown, or NULL to show all charsets.
1563 <!-- ##### FUNCTION gtk_identifier_get_type ##### -->
1565 Get the type of GtkIdentifier.
1568 @Returns: GtkType -- the enumerated type of something.
1570 <!-- ##### FUNCTION gtk_image_menu_item_add_image ##### -->
1578 <!-- ##### FUNCTION gtk_label_set_markup_with_accel ##### -->
1587 <!-- ##### FUNCTION gtk_list_store_new_with_types ##### -->
1596 <!-- ##### FUNCTION gtk_list_store_set_cell ##### -->
1606 <!-- ##### FUNCTION gtk_list_store_set_column_type ##### -->
1615 <!-- ##### FUNCTION gtk_list_store_set_n_columns ##### -->
1623 <!-- ##### FUNCTION gtk_menu_ensure_uline_accel_group ##### -->
1631 <!-- ##### FUNCTION gtk_menu_get_uline_accel_group ##### -->
1639 <!-- ##### FUNCTION gtk_menu_item_configure ##### -->
1641 Sets whether the menu item should show a submenu indicator, which is a right
1645 @menu_item: the menu item
1646 @show_toggle_indicator: unused
1647 @show_submenu_indicator: whether to show the arrow or not
1649 <!-- ##### FUNCTION gtk_object_arg_get ##### -->
1651 Private function to get an argument and argument info from an object.
1654 @object: the object whose argument should be retrieved.
1655 @arg: the argument, for the name on input, the rest is filled on output.
1656 @info: a #GtkArgInfo structure to optionally fill in.
1658 <!-- ##### FUNCTION gtk_object_arg_get_info ##### -->
1660 Query information about an argument type.
1663 @object_type: type of object to query about.
1664 @arg_name: name of the argument.
1665 @info_p: pointer to be filled in with a pointer to the GtkArgInfo.
1666 @Returns: an error message, or NULL on success.
1667 It is the caller's responsibility to call g_free() in the event of error.
1669 <!-- ##### FUNCTION gtk_object_arg_set ##### -->
1671 Private function to set an argument and argument info to an object.
1674 @object: the object whose argument should be set.
1676 @info: infomation about this type of argument in general.
1678 <!-- ##### FUNCTION gtk_object_args_collect ##### -->
1680 Private: Gets an array of #GtkArgs from a va_list C structure.
1683 @object_type: the type of object to collect arguments for.
1684 @arg_list_p: pointer to be filled in with a list of parsed arguments.
1685 @info_list_p: optional pointer for a returned list #GtkArgInfos.
1686 @first_arg_name: name of first argument.
1687 @var_args: value of first argument, followed by more key/value pairs,
1689 @Returns: an error message, or NULL on success.
1690 It is the caller's responsibility to call g_free() in the event of error.
1692 <!-- ##### FUNCTION gtk_object_class_add_signals ##### -->
1694 Add an array of signals to a #GtkObjectClass.
1695 Usually this is called when registering a new type of object.
1698 @klass: the object class to append signals to.
1699 @signals: the signals to append.
1700 @nsignals: the number of signals being appended.
1702 <!-- ##### FUNCTION gtk_object_class_user_signal_new ##### -->
1704 Define a signal-handler for a new signal on an already defined
1708 See the signal documentation for more general information.
1711 @klass: the object class to define the signal for.
1712 @name: the name of the signal.
1713 @signal_flags: the default emission behavior for the signal.
1714 See gtk_signal_new().
1715 @marshaller: a function that will take an array of GtkArgs
1716 and invoke the appropriate handler with the normal calling
1718 @return_val: specify the return-value type for the signal
1719 (or GTK_TYPE_NONE for no return-value).
1720 @nparams: specify the number of parameters the signal
1721 receives from the caller of gtk_signal_emit().
1722 @Varargs: list of nparams #GtkTypes to pass to the signal handlers.
1723 @Returns: the signal id. (See #GtkSignals)
1725 <!-- ##### FUNCTION gtk_object_class_user_signal_newv ##### -->
1727 Define a signal-handler for a new signal on an already defined
1731 @klass: the object class to define the signal for.
1732 @name: the name of the signal.
1733 @signal_flags: the default emission behavior for the signal.
1734 See gtk_signal_new().
1735 @marshaller: takes a GtkObject, a #GtkSignalFunc, and an array
1736 of arguments, and invokes the function using the appropriate
1737 calling conventions. Usually just select a function
1738 out of gtkmarshal.h.
1739 @return_val: specify the return-value type for the signal (possibly
1741 @nparams: specify the number of parameters the signal
1742 receives from the caller of gtk_signal_emit().
1743 @params: array of #GtkTypes the signal handlers for this signal
1744 should have in their prototype (of length nparams).
1745 @Returns: the signal id. (See #GtkSignals)
1747 <!-- ##### FUNCTION gtk_object_constructed ##### -->
1749 Mark an allocated object as constructed.
1750 This is used for situations
1751 that require precise control of the construction process.
1754 This is done when gtk_object_default_construct() is inadequate.
1755 In #GtkCList the need arises because #GtkCList does construction work that
1756 must happen <emphasis>after</emphasis> its derivers. This work
1757 cannot be done in an initializer function, so an alternate
1758 constructor is mandatory. It calls gtk_object_constructed() to
1759 indicate it has done its job, so that no other constructor will
1763 Normally this function is just automatically run from
1764 gtk_object_default_construct().
1767 @object: object which has been constructed. This is usually
1768 done automatically by gtk_object_new() and gtk_object_newv().
1770 <!-- ##### FUNCTION gtk_object_default_construct ##### -->
1772 This function is called to construct arguments that haven't been initialized
1773 but have the #GTK_ARG_CONSTRUCT flag set.
1776 All number arguments are set to 0. All pointers and strings
1780 Normally invoked by gtk_object_new() automatically; gtk_type_new() can
1781 be used to bypass it.
1784 @object: the object to initialize.
1786 <!-- ##### FUNCTION gtk_object_getv ##### -->
1788 Gets an array of argument values from an object.
1791 @object: the object to get arguments from.
1792 @n_args: the number of arguments to query.
1793 @args: the arguments to fill in.
1795 <!-- ##### FUNCTION gtk_object_newv ##### -->
1797 Construct an object with an array of arguments.
1800 @object_type: the type of the object to create.
1801 @n_args: the number of arguments to set.
1802 @args: an array of n_args arguments (which are name and value pairs).
1803 @Returns: the new GtkObject.
1805 <!-- ##### FUNCTION gtk_object_query_args ##### -->
1807 Get all the arguments that may be used for a given type.
1810 In Java, this type of mechanism is called
1811 <wordasword>introspection</wordasword>. It is used by applications
1812 like Glade, that have to determine what can be done to an object
1816 @class_type: the GtkType of the ObjectClass
1817 (returned from GTK_OBJECT_CLASS(class)->type for example).
1818 @arg_flags: if non-NULL, obtains the #GtkArgFlags that apply to
1819 each argument. You must g_free() this if you request it.
1820 @n_args: the number of arguments is returned in this field.
1821 @Returns: an array of arguments, that you must deallocate with g_free().
1823 <!-- ##### FUNCTION gtk_object_setv ##### -->
1825 Set an array of arguments.
1828 @object: the object whose arguments should be set.
1829 @n_args: the number of arguments to set.
1830 @args: the desired values, as an array of #GtkArgs (which contain
1831 the names, types, and values of the arguments).
1833 <!-- ##### FUNCTION gtk_paned_compute_position ##### -->
1835 Internal function used by #GtkHPaned and #GtkVPaned
1843 <!-- ##### FUNCTION gtk_paned_set_handle_size ##### -->
1845 Set the the handle size to @size x @size pixels.
1848 @paned: a paned widget
1849 @size: the size in pixels
1851 <!-- ##### FUNCTION gtk_pattern_match ##### -->
1862 <!-- ##### FUNCTION gtk_pattern_match_simple ##### -->
1871 <!-- ##### FUNCTION gtk_pattern_match_string ##### -->
1880 <!-- ##### FUNCTION gtk_pattern_spec_free_segs ##### -->
1887 <!-- ##### FUNCTION gtk_pattern_spec_init ##### -->
1895 <!-- ##### FUNCTION gtk_rc_init ##### -->
1901 <!-- ##### FUNCTION gtk_rc_load_image ##### -->
1903 Internal function. Loads an image using the current
1907 @colormap: the colormap to use for the image
1908 @transparent_color: the transparent color for the image
1909 @filename: the filename of the image file
1910 @Returns: a #GtkPixmap representing @filename
1912 <!-- ##### FUNCTION gtk_rc_set_image_loader ##### -->
1914 Sets the function that GTK+ will use to load images
1917 @loader: the #GtkImageLoader to use
1919 <!-- ##### FUNCTION gtk_ruler_draw_pos ##### -->
1924 @ruler: the gtkruler
1926 <!-- ##### FUNCTION gtk_ruler_draw_ticks ##### -->
1931 @ruler: the gtkruler
1933 <!-- ##### FUNCTION gtk_settings_get_global ##### -->
1940 <!-- ##### FUNCTION gtk_signal_add_emission_hook ##### -->
1942 Add an emission hook for a type of signal, for any object.
1945 @signal_id: the type of signal to hook for.
1946 @hook_func: the function to invoke to handle the emission hook.
1947 @data: the user data passed in to hook_func.
1948 @Returns: the id (that you may pass as a parameter
1949 to gtk_signal_remove_emission_hook()).
1954 <!-- ##### FUNCTION gtk_signal_add_emission_hook_full ##### -->
1956 Add an emission hook for a type of signal, for any object.
1957 (with control of what happens when the hook is
1961 @signal_id: the type of signal add the hook for.
1962 @hook_func: the function to invoke to handle the hook.
1963 @data: the user data passed in to hook_func.
1964 @destroy: a function to invoke when the hook is destroyed,
1965 to clean up any allocation done just for this
1967 @Returns: the id (that you may pass as a parameter
1968 to gtk_signal_remove_emission_hook()).
1970 <!-- ##### FUNCTION gtk_signal_handler_pending_by_id ##### -->
1972 Returns whether a connection id is valid (and optionally not blocked).
1975 @object: the object to search for the desired handler.
1976 @handler_id: the connection id.
1977 @may_be_blocked: whether it is acceptable to return a blocked
1979 @Returns: TRUE if the signal exists and wasn't blocked,
1980 unless #may_be_blocked was specified. FALSE otherwise.
1982 <!-- ##### FUNCTION gtk_signal_handlers_destroy ##### -->
1984 Destroy all the signal handlers connected to an object.
1985 This is done automatically when the object is destroyed.
1988 This function is labeled private.
1991 @object: the object whose signal handlers should be destroyed.
1993 <!-- ##### FUNCTION gtk_signal_init ##### -->
1999 <!-- ##### FUNCTION gtk_signal_n_emissions ##### -->
2001 Find out the recursion depth of emissions for a particular type
2002 of signal and object. (So it will
2003 always return 0 or 1 if #GTK_RUN_NO_RECURSE is specified)
2004 This is a way to avoid recursion: you can see if
2005 you are currently running in that signal handler and emit it only
2008 <para>Another way to look at it is that this number increases
2009 by one when #gtk_signal_emit(), et al, are called,
2010 and decreases by one when #gtk_signal_emit() returns.
2013 @object: the object with the signal handler.
2014 @signal_id: the signal id.
2015 @Returns: the recursion depth of emissions of this signal for this
2018 <!-- ##### FUNCTION gtk_signal_n_emissions_by_name ##### -->
2020 Find out the recursion depth of emissions for a particular type
2021 of signal and object. Just like gtk_signal_n_emissions()
2022 except it will lookup the signal id for you.
2025 @object: the object with the signal handler.
2026 @name: the signal name.
2027 @Returns: the recursion depth of emissions of this signal for this
2030 <!-- ##### FUNCTION gtk_signal_query ##### -->
2032 Obtain information about a signal.
2035 @signal_id: the signal type identifier.
2036 @Returns: a pointer to a GtkSignalQuery structure
2037 which contains all the information, or NULL.
2038 The pointer is allocated just for you: you must g_free() it.
2040 <!-- ##### FUNCTION gtk_signal_remove_emission_hook ##### -->
2042 Delete an emission hook. (see gtk_signal_add_emission_hook())
2045 @signal_id: the id of the signal type.
2046 @hook_id: the id of the emission handler, returned by add_emission_hook().
2050 <!-- ##### FUNCTION gtk_signal_set_funcs ##### -->
2052 These set default functions to call when the user didn't
2053 supply a function when connecting. (These are rarely
2054 used, and probably only for language bindings)
2057 By default, there are no such functions.
2060 @marshal_func: the function to invoke on every handlers for which there
2061 isn't a function pointer. May be NULL.
2062 @destroy_func: the function to invoke when each hook is destroyed.
2065 <!-- ##### FUNCTION gtk_spin_button_set_shadow_type ##### -->
2067 Creates a border around the arrows of a #GtkSpinButton. The type of border is determined by @shadow_type.
2070 @spin_button: a #GtkSpinButton
2071 @shadow_type: the new border type.
2073 <!-- ##### FUNCTION gtk_stock_list_items ##### -->
2080 <!-- ##### FUNCTION gtk_text_buffer_paste_primary ##### -->
2089 <!-- ##### FUNCTION gtk_text_iter_reorder ##### -->
2097 <!-- ##### FUNCTION gtk_text_view_set_text_window_size ##### -->
2106 <!-- ##### FUNCTION gtk_trace_referencing ##### -->
2108 Private: print debugging information while doing a gtk_object_ref() or
2109 a gtk_object_unref().
2112 @object: object to reference or unreference.
2113 @func: name of caller's function to print (used within macros).
2115 @line: line number (used within macros).
2116 @do_ref: whether to reference or unreference.
2118 <!-- ##### FUNCTION gtk_tree_model_ref_iter ##### -->
2126 <!-- ##### FUNCTION gtk_tree_model_sort_set_compare ##### -->
2134 <!-- ##### FUNCTION gtk_tree_model_sort_set_sort_column ##### -->
2142 <!-- ##### FUNCTION gtk_tree_model_unref_iter ##### -->
2150 <!-- ##### FUNCTION gtk_tree_store_new_with_types ##### -->
2159 <!-- ##### FUNCTION gtk_tree_store_set_cell ##### -->
2169 <!-- ##### FUNCTION gtk_tree_store_set_column_type ##### -->
2179 <!-- ##### FUNCTION gtk_tree_store_set_n_columns ##### -->
2187 <!-- ##### FUNCTION gtk_tree_view_column_set_cell_data ##### -->
2196 <!-- ##### FUNCTION gtk_type_check_class_cast ##### -->
2198 Given a GtkTypeClass pointer @klass, and a GtkType @cast_type, make
2199 sure that it's okay to cast something of that @klass into a @cast_type.
2202 @klass: GtkTypeClass*
2204 @Returns: Always return @klass.
2206 <!-- ##### FUNCTION gtk_type_check_object_cast ##### -->
2208 Given a pointer to a GtkTypeObject @type_object, and a GtkType @cast_type,
2209 make sure that it's okay to cast @type_object into a @cast_type.
2212 @type_object: GtkTypeObject*
2214 @Returns: the same GtkTypeObject* as @type_object
2216 <!-- ##### FUNCTION gtk_type_children_types ##### -->
2218 Return the pointer to the type's children's types.
2222 @Returns: pointer to a GList
2224 <!-- ##### FUNCTION gtk_type_describe_heritage ##### -->
2226 Print the types @type inherits from.
2231 <!-- ##### FUNCTION gtk_type_describe_tree ##### -->
2233 Given a @type, describe all of its children, and their children. Only
2234 show the size if @show_size is true.
2238 @show_size: gboolean
2240 <!-- ##### FUNCTION gtk_type_free ##### -->
2242 Given the type of an object and a pointer to it, the object is freed.
2246 @mem: gpointer to the object
2248 <!-- ##### FUNCTION gtk_type_get_varargs_type ##### -->
2250 Get the varargs type associated with @foreign_type
2253 @foreign_type: GtkType
2256 <!-- ##### FUNCTION gtk_type_parent_class ##### -->
2258 Return the class of the parent. Initialize the class if necessary.
2259 Return NULL if anything goes wrong.
2263 @Returns: gpointer to the klass.
2265 <!-- ##### FUNCTION gtk_type_query ##### -->
2267 Given a type, return various interesting parameters of the type.
2271 @Returns: GtkTypeQuery*
2273 <!-- ##### FUNCTION gtk_type_register_enum ##### -->
2275 Register a new set of enum @values and give them the name in
2279 @type_name: must not be null.
2280 @values: GtkEnumValue*
2283 <!-- ##### FUNCTION gtk_type_register_flags ##### -->
2285 Register a new set of flags @values and give them the name in
2289 @type_name: must not be null.
2290 @values: GtkFlagValue*
2293 <!-- ##### FUNCTION gtk_type_set_chunk_alloc ##### -->
2295 Set the mem_chunk size so it will hold @n_chunks of the objects of that @type.
2298 @type: There must be an unlocked TypeNode associated with this type otherwise nothing happens.
2301 <!-- ##### FUNCTION gtk_type_set_varargs_type ##### -->
2303 Set the varargs type for a fundamental type @foreign_type.
2306 @foreign_type: Must be a GtkType with a sequence number of zero. Must not be a
2308 @varargs_type: Must be a GtkType which is either structured or flag, or NONE.
2310 <!-- ##### FUNCTION gtk_widget_activate_mnemonic ##### -->
2319 <!-- ##### FUNCTION gtk_widget_pop_style ##### -->
2325 <!-- ##### FUNCTION gtk_widget_popup ##### -->
2334 <!-- ##### FUNCTION gtk_widget_push_style ##### -->
2341 <!-- ##### FUNCTION gtk_widget_set_default_style ##### -->
2348 <!-- ##### FUNCTION gtk_window_activate_mnemonic ##### -->
2358 <!-- ##### FUNCTION gtk_window_get_default_accel_group ##### -->
2366 <!-- ##### FUNCTION gtk_window_get_resizeable ##### -->
2374 <!-- ##### FUNCTION gtk_window_set_decorations_hint ##### -->
2382 <!-- ##### FUNCTION gtk_window_set_functions_hint ##### -->
2390 <!-- ##### FUNCTION gtk_window_set_resizeable ##### -->