1 <!-- ##### SECTION ./tmpl/gtkdata.sgml:Long_Description ##### -->
3 The #GtkData object is a very simple object intended to be used as a base
4 class for objects which contain data (i.e. the 'Model' in the object-oriented
5 Model/View/Controller framework).
8 Currently it is not very useful since all it provides is a "disconnect" signal.
9 This signal could be emitted by a #GtkData subclass to notify any 'Views'
10 that they should disconnect from the #GtkData (the 'Model'), possibly just
11 before the #GtkData is destroyed.
15 <!-- ##### SECTION ./tmpl/gtkdata.sgml:See_Also ##### -->
21 <!-- ##### SECTION ./tmpl/gtkdata.sgml:Short_Description ##### -->
22 abstract base class for objects containing data.
25 <!-- ##### SECTION ./tmpl/gtkdata.sgml:Title ##### -->
29 <!-- ##### SECTION ./tmpl/gtkdebug.sgml:Title ##### -->
33 <!-- ##### SECTION ./tmpl/gtkenums.sgml.sgml:Title ##### -->
37 <!-- ##### SECTION ./tmpl/gtkimcontextsimple.sgml:Title ##### -->
41 <!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Long_Description ##### -->
43 <title>What are Signal Marshallers?</title>
45 Marshals are functions which all have the same prototype:
46 they take a #GtkObject, a #GtkSignalFunc, a #gpointer,
47 and an array of argument values.
48 The functions are names gtk_marshall_RETURNTYPE__PARAMTYPE1_PARAMTYPE2....
51 They then call a native function: the GtkObject is the first
52 parameter passed in. The arguments are passed in the native
53 calling convention: chars, shorts, ints, longs may be packed
54 on the stack, or tucked in registers: it doesn't matter
55 because the same calling convention will be generated
56 inside the gtkmarshal code as is expected where you define
60 So the function named:
62 gtk_marshal_BOOL__POINTER_INT_INT_UINT(GtkObject*, GtkSignalFunc, gpointer, GtkArg*);
64 will call the #GtkSignalFunc assuming it was a function with signature:
66 gboolean sigfunc(gpointer,gint,gint,guint);
71 <title>Writing Custom Marshals</title>
73 Marshals are primarily used as arguments to gtk_signal_new().
74 Sometimes, you may find that a marshaller you need isn't available
75 in the standard list. Then you have to write your own.
78 If you wish to define a signal with a new type of argument list.
79 Suppose you want 2 pointers and 2 integers.
82 typedef int (*GtkSignal_INT__POINTER_POINTER_INT_INT)(
83 gpointer, gpointer, gint, gint
86 void marshal_INT__POINTER_POINTER_INT_INT(GtkObject* object,
91 GtkSignal_NONE__POINTER_POINTER_INT_INT rfunc;
93 return_val = GTK_RETLOC_INT(args[4]);
94 rfunc = (GtkSignal_INT__POINTER_POINTER_INT_INT)func;
95 *return_val = (*rfunc)(object,
96 GTK_VALUE_POINTER(args[0]),
97 GTK_VALUE_POINTER(args[1]),
98 GTK_VALUE_INT(args[2]),
99 GTK_VALUE_INT(args[3]),
107 <!-- ##### SECTION ./tmpl/gtkmarshal.sgml:See_Also ##### -->
112 <term>#GtkSignal</term>
113 <listitem><para>The signal handling functions (of which marshallers are
114 really an implementation detail).</para></listitem>
121 <!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Short_Description ##### -->
122 Functions to adapt C structures to native calling convention.
125 <!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Title ##### -->
129 <!-- ##### SECTION ./tmpl/gtkprivate.sgml:Title ##### -->
133 <!-- ##### SECTION ./tmpl/gtktreemodelsimple.sgml:Long_Description ##### -->
139 <!-- ##### SECTION ./tmpl/gtktreemodelsimple.sgml:See_Also ##### -->
145 <!-- ##### SECTION ./tmpl/gtktreemodelsimple.sgml:Short_Description ##### -->
149 <!-- ##### SECTION ./tmpl/gtktreemodelsimple.sgml:Title ##### -->
153 <!-- ##### MACRO GTK_CLIST_CHILD_HAS_FOCUS ##### -->
155 A macro to check whether a child widget of the CList
159 @clist: The #GtkCList widget to check.
161 <!-- ##### MACRO GTK_ICON_SIZE_BUTTON ##### -->
167 <!-- ##### MACRO GTK_ICON_SIZE_DIALOG ##### -->
173 <!-- ##### MACRO GTK_ICON_SIZE_LARGE_TOOLBAR ##### -->
179 <!-- ##### MACRO GTK_ICON_SIZE_MENU ##### -->
185 <!-- ##### MACRO GTK_ICON_SIZE_SMALL_TOOLBAR ##### -->
191 <!-- ##### MACRO GTK_OBJECT_CONSTRUCTED ##### -->
193 Test whether a GtkObject's arguments have been prepared.
196 @obj: the object to examine.
198 <!-- ##### MACRO GTK_OBJECT_NSIGNALS ##### -->
200 Get the number of signals defined by this object.
203 @obj: the object to query.
205 <!-- ##### MACRO GTK_OBJECT_SIGNALS ##### -->
207 Get the array of signals defined for this object.
210 @obj: the object to fetch the signals from.
212 <!-- ##### MACRO GTK_TREE_SELECTION ##### -->
214 A macro that returns a GList that contains the selection of the root tree of @obj.
217 @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.
219 <!-- ##### MACRO GTK_TYPE_FLAT_FIRST ##### -->
221 The first "flat" (no struct) enumerated type value.
225 <!-- ##### MACRO GTK_TYPE_FLAT_LAST ##### -->
227 The last "flat" (no struct) enumerated type value.
231 <!-- ##### MACRO GTK_TYPE_IDENTIFIER ##### -->
233 Hide the name of gtk_identifier_get_type
237 <!-- ##### MACRO GTK_TYPE_MAKE ##### -->
239 Combine a fundemantal type and a sequence number to create a gtk type.
245 <!-- ##### MACRO GTK_TYPE_NUM_BUILTINS ##### -->
251 <!-- ##### MACRO GTK_TYPE_SEQNO ##### -->
253 Convert a gtk type into its sequence number
258 <!-- ##### MACRO GTK_TYPE_STRUCTURED_FIRST ##### -->
260 The first structured enumerated type value.
264 <!-- ##### MACRO GTK_TYPE_STRUCTURED_LAST ##### -->
266 The last structured enumerated type value.
270 <!-- ##### MACRO GTK_TYPE_TREE_COLUMN ##### -->
276 <!-- ##### MACRO GTK_VALUE_ARGS ##### -->
278 Use to get the value of a GtkArg whose GtkType is GTK_TYPE_ARGS
283 <!-- ##### MACRO GTK_VALUE_CALLBACK ##### -->
285 Use to get the value of a GtkArg whose GtkType is GTK_TYPE_CALLBACK
290 <!-- ##### MACRO GTK_VALUE_C_CALLBACK ##### -->
292 Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_CALLBACK
297 <!-- ##### MACRO GTK_VALUE_FOREIGN ##### -->
299 Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_FOREIGN
304 <!-- ##### STRUCT GtkData ##### -->
306 The #GtkData-struct struct contains no public fields.
310 <!-- ##### SIGNAL GtkData::disconnect ##### -->
312 Emitted to notify any views on the #GtkData object to disconnect from it,
313 possibly because the #GtkData object is about to be destroyed.
316 @data: the object which received the signal.
318 <!-- ##### SIGNAL GtkEditable::activate ##### -->
320 Indicates that the user has activated the widget
321 in some fashion. Generally, this will be done
322 with a keystroke. (The default binding for this
323 action is Return for #GtkEntry and
324 Control-Return for #GtkText.)
327 @editable: the object which received the signal.
329 <!-- ##### SIGNAL GtkEditable::changed ##### -->
331 Indicates that the user has changed the contents
335 @editable: the object which received the signal.
337 <!-- ##### SIGNAL GtkEditable::copy-clipboard ##### -->
339 An action signal. Causes the characters in the current selection to
340 be copied to the clipboard.
343 @editable: the object which received the signal.
345 <!-- ##### SIGNAL GtkEditable::cut-clipboard ##### -->
347 An action signal. Causes the characters in the current
348 selection to be copied to the clipboard and then deleted from
352 @editable: the object which received the signal.
354 <!-- ##### SIGNAL GtkEditable::delete-text ##### -->
356 This signal is emitted when text is deleted from
357 the widget by the user. The default handler for
358 this signal will normally be responsible for inserting
359 the text, so by connecting to this signal and then
360 stopping the signal with gtk_signal_emit_stop(), it
361 is possible to modify the inserted text, or prevent
362 it from being inserted entirely. The @start_pos
363 and @end_pos parameters are interpreted as for
364 gtk_editable_delete_text()
367 @editable: the object which received the signal.
368 @start_pos: the starting position.
369 @end_pos: the end position.
371 <!-- ##### SIGNAL GtkEditable::insert-text ##### -->
373 This signal is emitted when text is inserted into
374 the widget by the user. The default handler for
375 this signal will normally be responsible for inserting
376 the text, so by connecting to this signal and then
377 stopping the signal with gtk_signal_emit_stop(), it
378 is possible to modify the inserted text, or prevent
379 it from being inserted entirely.
382 @editable: the object which received the signal.
383 @new_text: the new text to insert.
384 @new_text_length: the length of the new text.
385 @position: the position at which to insert the new text.
386 this is an in-out paramter. After the signal
387 emission is finished, it should point after
388 the newly inserted text.
390 <!-- ##### SIGNAL GtkEditable::kill-char ##### -->
392 An action signal. Delete a single character.
395 @editable: the object which received the signal.
396 @direction: the direction in which to delete. Positive
397 indicates forward deletion, negative, backwards deletion.
399 <!-- ##### SIGNAL GtkEditable::kill-line ##### -->
401 An action signal. Delete a single line.
404 @editable: the object which received the signal.
405 @direction: the direction in which to delete. Positive
406 indicates forward deletion, negative, backwards deletion.
408 <!-- ##### SIGNAL GtkEditable::kill-word ##### -->
410 An action signal. Delete a single word.
413 @editable: the object which received the signal.
414 @direction: the direction in which to delete. Positive
415 indicates forward deletion, negative, backwards deletion.
417 <!-- ##### SIGNAL GtkEditable::move-cursor ##### -->
419 An action signal. Move the cursor position.
422 @editable: the object which received the signal.
423 @x: horizontal distance to move the cursor.
424 @y: vertical distance to move the cursor.
426 <!-- ##### SIGNAL GtkEditable::move-page ##### -->
428 An action signal. Move the cursor by pages.
431 @editable: the object which received the signal.
432 @x: Number of pages to move the cursor horizontally.
433 @y: Number of pages to move the cursor vertically.
435 <!-- ##### SIGNAL GtkEditable::move-to-column ##### -->
437 An action signal. Move the cursor to the given column.
440 @editable: the object which received the signal.
441 @column: the column to move to. (A negative value indicates
444 <!-- ##### SIGNAL GtkEditable::move-to-row ##### -->
446 An action signal. Move the cursor to the given row.
449 @editable: the object which received the signal.
450 @row: the row to move to. (A negative value indicates
453 <!-- ##### SIGNAL GtkEditable::move-word ##### -->
455 An action signal. Move the cursor by words.
458 @editable: the object which received the signal.
459 @num_words: The number of words to move the
460 cursor. (Can be negative).
462 <!-- ##### SIGNAL GtkEditable::paste-clipboard ##### -->
464 An action signal. Causes the contents of the clipboard to
465 be pasted into the editable widget at the current cursor
469 @editable: the object which received the signal.
471 <!-- ##### SIGNAL GtkEditable::set-editable ##### -->
473 Determines if the user can edit the text in the editable
474 widget or not. This is meant to be overriden by
475 child classes and should not generally useful to
479 @editable: the object which received the signal.
480 @is_editable: %TRUE if the user is allowed to edit the text
483 <!-- ##### ARG GtkEditable:editable ##### -->
485 A boolean indicating whether the widget is editable by
490 <!-- ##### ARG GtkEditable:text-position ##### -->
492 The position of the cursor.
496 <!-- ##### USER_FUNCTION GtkEmissionHook ##### -->
498 A simple function pointer to get invoked when the
499 signal is emitted. This allows you tie a hook to the signal type,
500 so that it will trap all emissions of that signal, from any object.
503 You may not attach these to signals created with the
504 #GTK_RUN_NO_HOOKS flag.
514 <!-- ##### ENUM GtkFontFilterType ##### -->
516 A set of bit flags used to specify the filter being set
517 when calling gtk_font_selection_dialog_set_filter() or
518 gtk_font_selection_set_filter().
521 @GTK_FONT_FILTER_BASE: the base filter, which can't be changed by the user.
522 @GTK_FONT_FILTER_USER: the user filter, which can be changed from within the
523 'Filter' page of the #GtkFontSelection widget.
525 <!-- ##### ENUM GtkFontType ##### -->
527 A set of bit flags used to specify the type of fonts shown
528 when calling gtk_font_selection_dialog_set_filter() or
529 gtk_font_selection_set_filter().
532 @GTK_FONT_BITMAP: bitmap fonts.
533 @GTK_FONT_SCALABLE: scalable fonts.
534 @GTK_FONT_SCALABLE_BITMAP: scaled bitmap fonts.
535 @GTK_FONT_ALL: a bitwise combination of all of the above.
537 <!-- ##### ARG GtkFrame:shadow-type ##### -->
543 <!-- ##### STRUCT GtkIMContextSimple ##### -->
552 @tentative_match_len:
554 <!-- ##### ARG GtkLabel:accel-keyval ##### -->
560 <!-- ##### ARG GtkObject:object-signal ##### -->
562 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
563 the signal to the object, so that the user data and objects
564 and swapped when the signal handler is invoked.
567 This is useful for handlers that are primarily notifying
568 other objects and could just invoke an already existing function
569 if the parameters were swapped.
570 See gtk_signal_connect_object() for more details.
574 <!-- ##### ARG GtkObject:object-signal-after ##### -->
576 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
577 the signal to the object, so that the user data and objects
578 and swapped when the signal handler is invoked,
579 and so that the handler is invoked after all others.
582 See gtk_signal_connect_object_after() for more details.
586 <!-- ##### ARG GtkObject:signal ##### -->
588 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
589 the signal to the object.
593 <!-- ##### ARG GtkObject:signal-after ##### -->
595 Setting this with a GtkType of GTK_TYPE_SIGNAL connects
596 the signal to the object, so that the signal is always run
597 after other user handlers and the default handler.
601 <!-- ##### ARG GtkPaned:handle-size ##### -->
607 <!-- ##### STRUCT GtkPatternSpec ##### -->
619 <!-- ##### ENUM GtkPrivateFlags ##### -->
624 @PRIVATE_GTK_USER_STYLE:
625 @PRIVATE_GTK_RESIZE_PENDING:
626 @PRIVATE_GTK_RESIZE_NEEDED:
627 @PRIVATE_GTK_LEAVE_PENDING:
628 @PRIVATE_GTK_HAS_SHAPE_MASK:
629 @PRIVATE_GTK_IN_REPARENT:
630 @PRIVATE_GTK_DIRECTION_SET:
631 @PRIVATE_GTK_DIRECTION_LTR:
633 <!-- ##### USER_FUNCTION GtkSignalDestroy ##### -->
635 A function which you can use to clean up when the
636 signal handler is destroyed.
639 For example, if your handler requires a few variables
640 that you made into a struct and allocated (using g_new()
641 or something), then you will probably want to free
642 it as soon as the hook is destroyed. This will
643 allow you to do that. (For this in particular
644 it is convenient to pass g_free() as a #GtkSignalDestroy
648 @data: The user data associated with the hook that is being
651 <!-- ##### USER_FUNCTION GtkSignalMarshal ##### -->
653 This is currently a hack left in for a scheme wrapper library.
660 @object: The object which emits the signal.
661 @data: The user data associated with the hook.
662 @nparams: The number of parameters to the function.
663 @args: The actual values of the arguments.
664 @arg_types: The types of the arguments.
665 @return_type: The type of the return value from the function
666 or #GTK_TYPE_NONE for no return value.
668 <!-- ##### STRUCT GtkSignalQuery ##### -->
670 This structure contains all the information about a particular
671 signal: its name, the type it affects, the signature of the handlers,
672 and its unique identifying integer.
684 <!-- ##### ARG GtkSpinButton:shadow-type ##### -->
686 the type of border that surrounds the arrows of a spin button.
690 <!-- ##### STRUCT GtkStatusbarMsg ##### -->
692 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.
699 <!-- ##### ARG GtkTextTag:justify ##### -->
701 A #GtkJustification for the text. This is only used when the tag is
702 applied to the first character in a paragraph.
706 <!-- ##### ARG GtkTextTag:left-wrapped-line-margin ##### -->
708 Pixel width of the left margin of the text for lines after the first
709 line in a wrapped paragraph.
713 <!-- ##### ARG GtkTextTag:left-wrapped-line-margin-set ##### -->
719 <!-- ##### ARG GtkTextTag:offset ##### -->
721 Pixels to offset the text horizontally or vertically, useful to
722 produce superscript and subscript.
726 <!-- ##### ARG GtkTextView:justify ##### -->
732 <!-- ##### ARG GtkTextView:wrap-mode ##### -->
738 <!-- ##### SIGNAL GtkWidget::activate-mnemonic ##### -->
743 @widget: the object which received the signal.
747 <!-- ##### SIGNAL GtkWidget::debug-msg ##### -->
752 @widget: the object which received the signal.
755 <!-- ##### SIGNAL GtkWidget::draw ##### -->
760 @widget: the object which received the signal.
763 <!-- ##### SIGNAL GtkWidget::draw-default ##### -->
768 @widget: the object which received the signal.
770 <!-- ##### SIGNAL GtkWidget::draw-focus ##### -->
775 @widget: the object which received the signal.
777 <!-- ##### FUNCTION gtk_button_box_child_requisition ##### -->
779 This is an internally used function and should never be called from an
\r
788 <!-- ##### FUNCTION gtk_button_box_get_child_ipadding_default ##### -->
790 The internal padding of a button is the amount of space between the outside
\r
791 of the button and the widget it contains. This function gets the default
\r
792 amount of horizontal and vertical padding, placing the results in @ipad_x
\r
793 and @ipad_y, respectively.
\r
796 @ipad_x: the default horizontal internal button padding.
797 @ipad_y: the default vertical internal button padding.
799 <!-- ##### FUNCTION gtk_button_box_get_child_size_default ##### -->
801 Retrieves the default minimum width and height for all button boxes, and
\r
802 places the values in @min_width and @min_height, respectively.
\r
805 @min_width: the default minimum width of a child widget.
806 @min_height: the default minimum height of a child widget.
808 <!-- ##### FUNCTION gtk_button_box_set_child_ipadding_default ##### -->
810 Sets the default number of pixels that pad each button in every button box.
\r
813 @ipad_x: new default horizontal padding.
814 @ipad_y: new default vertical padding.
816 <!-- ##### FUNCTION gtk_button_box_set_child_size_default ##### -->
818 Sets the default size of child buttons.
\r
821 @min_width: minimum default width for child buttons.
822 @min_height: minimum default height for child buttons.
824 <!-- ##### FUNCTION gtk_button_new_accel ##### -->
833 <!-- ##### FUNCTION gtk_button_new_stock ##### -->
842 <!-- ##### FUNCTION gtk_clist_construct ##### -->
844 Initializes a previously allocated #GtkCList widget for use. This should not
845 normally be used to create a #GtkCList widget. Use gtk_clist_new() instead.
848 @clist: A pointer to an uninitialized #GtkCList widget.
849 @columns: The number of columns the #GtkCList should have.
850 @titles: An array of strings that should be used as the titles i
851 of the columns. There should be enough strings in the array for
852 the number of columns specified.
854 <!-- ##### FUNCTION gtk_color_selection_set_opacity ##### -->
856 Controls whether opacity can be set with the #GtkColorSelection.
857 If this functionality is enabled, the necessary additional widgets
858 are added to the #GtkColorSelection and the opacity value can be
859 retrieved via the fourth value in the color array returned by
860 the gtk_color_selection_get_color() function.
863 @colorsel: a #GtkColorSelection.
864 @use_opacity: a boolean indicating whether the opacity selection
867 <!-- ##### FUNCTION gtk_ctree_construct ##### -->
869 This function is not usually used by users.
877 <!-- ##### FUNCTION gtk_editable_changed ##### -->
879 Causes the "changed" signal to be emitted.
882 @editable: a #GtkEditable widget.
884 <!-- ##### FUNCTION gtk_editable_claim_selection ##### -->
886 Claim or disclaim ownership of the PRIMARY X selection.
889 @editable: a #GtkEditable widget.
890 @claim: if %TRUE, claim the selection, otherwise, disclaim it.
891 @time: the timestamp for claiming the selection.
893 <!-- ##### FUNCTION gtk_font_selection_dialog_set_filter ##### -->
895 Sets one of the two font filters, to limit the fonts shown.
898 @fsd: a #GtkFontSelectionDialog.
899 @filter_type: which of the two font filters to set, either
900 #GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter
901 can be changed by the user, but the base filter is permanent.
902 @font_type: the types of font to be shown. This is a bitwise combination of
903 #GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP,
904 or #GTK_FONT_ALL to show all three font types.
905 @foundries: a NULL-terminated array of strings containing foundry names which
906 will be shown, or NULL to show all foundries.
907 @weights: a NULL-terminated array of strings containing weight names which
908 will be shown, or NULL to show all weights.
909 @slants: a NULL-terminated array of strings containing slant names which
910 will be shown, or NULL to show all slants.
911 @setwidths: a NULL-terminated array of strings containing setwidth names which
912 will be shown, or NULL to show all setwidths.
913 @spacings: a NULL-terminated array of strings containing spacings which
914 will be shown, or NULL to show all spacings.
915 @charsets: a NULL-terminated array of strings containing charset names which
916 will be shown, or NULL to show all charsets.
918 <!-- ##### FUNCTION gtk_font_selection_set_filter ##### -->
920 Sets one of the two font filters, to limit the fonts shown.
923 @fontsel: a #GtkFontSelection.
924 @filter_type: which of the two font filters to set, either
925 #GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter
926 can be changed by the user, but the base filter is permanent.
927 @font_type: the types of font to be shown. This is a bitwise combination of
928 #GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP,
929 or #GTK_FONT_ALL to show all three font types.
930 @foundries: a NULL-terminated array of strings containing foundry names which
931 will be shown, or NULL to show all foundries.
932 @weights: a NULL-terminated array of strings containing weight names which
933 will be shown, or NULL to show all weights.
934 @slants: a NULL-terminated array of strings containing slant names which
935 will be shown, or NULL to show all slants.
936 @setwidths: a NULL-terminated array of strings containing setwidth names which
937 will be shown, or NULL to show all setwidths.
938 @spacings: a NULL-terminated array of strings containing spacings which
939 will be shown, or NULL to show all spacings.
940 @charsets: a NULL-terminated array of strings containing charset names which
941 will be shown, or NULL to show all charsets.
943 <!-- ##### FUNCTION gtk_identifier_get_type ##### -->
945 Get the type of GtkIdentifier.
948 @Returns: GtkType -- the enumerated type of something.
950 <!-- ##### FUNCTION gtk_label_set_markup_with_accel ##### -->
959 <!-- ##### FUNCTION gtk_list_store_set_cell ##### -->
969 <!-- ##### FUNCTION gtk_menu_ensure_uline_accel_group ##### -->
977 <!-- ##### FUNCTION gtk_menu_get_uline_accel_group ##### -->
985 <!-- ##### FUNCTION gtk_object_arg_get ##### -->
987 Private function to get an argument and argument info from an object.
990 @object: the object whose argument should be retrieved.
991 @arg: the argument, for the name on input, the rest is filled on output.
992 @info: a #GtkArgInfo structure to optionally fill in.
994 <!-- ##### FUNCTION gtk_object_arg_get_info ##### -->
996 Query information about an argument type.
999 @object_type: type of object to query about.
1000 @arg_name: name of the argument.
1001 @info_p: pointer to be filled in with a pointer to the GtkArgInfo.
1002 @Returns: an error message, or NULL on success.
1003 It is the caller's responsibility to call g_free() in the event of error.
1005 <!-- ##### FUNCTION gtk_object_arg_set ##### -->
1007 Private function to set an argument and argument info to an object.
1010 @object: the object whose argument should be set.
1012 @info: infomation about this type of argument in general.
1014 <!-- ##### FUNCTION gtk_object_args_collect ##### -->
1016 Private: Gets an array of #GtkArgs from a va_list C structure.
1019 @object_type: the type of object to collect arguments for.
1020 @arg_list_p: pointer to be filled in with a list of parsed arguments.
1021 @info_list_p: optional pointer for a returned list #GtkArgInfos.
1022 @first_arg_name: name of first argument.
1023 @var_args: value of first argument, followed by more key/value pairs,
1025 @Returns: an error message, or NULL on success.
1026 It is the caller's responsibility to call g_free() in the event of error.
1028 <!-- ##### FUNCTION gtk_object_class_add_signals ##### -->
1030 Add an array of signals to a #GtkObjectClass.
1031 Usually this is called when registering a new type of object.
1034 @klass: the object class to append signals to.
1035 @signals: the signals to append.
1036 @nsignals: the number of signals being appended.
1038 <!-- ##### FUNCTION gtk_object_class_user_signal_new ##### -->
1040 Define a signal-handler for a new signal on an already defined
1044 See the signal documentation for more general information.
1047 @klass: the object class to define the signal for.
1048 @name: the name of the signal.
1049 @signal_flags: the default emission behavior for the signal.
1050 See gtk_signal_new().
1051 @marshaller: a function that will take an array of GtkArgs
1052 and invoke the appropriate handler with the normal calling
1054 @return_val: specify the return-value type for the signal
1055 (or GTK_TYPE_NONE for no return-value).
1056 @nparams: specify the number of parameters the signal
1057 receives from the caller of gtk_signal_emit().
1058 @Varargs: list of nparams #GtkTypes to pass to the signal handlers.
1059 @Returns: the signal id. (See #GtkSignals)
1061 <!-- ##### FUNCTION gtk_object_class_user_signal_newv ##### -->
1063 Define a signal-handler for a new signal on an already defined
1067 @klass: the object class to define the signal for.
1068 @name: the name of the signal.
1069 @signal_flags: the default emission behavior for the signal.
1070 See gtk_signal_new().
1071 @marshaller: takes a GtkObject, a #GtkSignalFunc, and an array
1072 of arguments, and invokes the function using the appropriate
1073 calling conventions. Usually just select a function
1074 out of gtkmarshal.h.
1075 @return_val: specify the return-value type for the signal (possibly
1077 @nparams: specify the number of parameters the signal
1078 receives from the caller of gtk_signal_emit().
1079 @params: array of #GtkTypes the signal handlers for this signal
1080 should have in their prototype (of length nparams).
1081 @Returns: the signal id. (See #GtkSignals)
1083 <!-- ##### FUNCTION gtk_object_constructed ##### -->
1085 Mark an allocated object as constructed.
1086 This is used for situations
1087 that require precise control of the construction process.
1090 This is done when gtk_object_default_construct() is inadequate.
1091 In #GtkCList the need arises because #GtkCList does construction work that
1092 must happen <emphasis>after</emphasis> its derivers. This work
1093 cannot be done in an initializer function, so an alternate
1094 constructor is mandatory. It calls gtk_object_constructed() to
1095 indicate it has done its job, so that no other constructor will
1099 Normally this function is just automatically run from
1100 gtk_object_default_construct().
1103 @object: object which has been constructed. This is usually
1104 done automatically by gtk_object_new() and gtk_object_newv().
1106 <!-- ##### FUNCTION gtk_object_default_construct ##### -->
1108 This function is called to construct arguments that haven't been initialized
1109 but have the #GTK_ARG_CONSTRUCT flag set.
1112 All number arguments are set to 0. All pointers and strings
1116 Normally invoked by gtk_object_new() automatically; gtk_type_new() can
1117 be used to bypass it.
1120 @object: the object to initialize.
1122 <!-- ##### FUNCTION gtk_object_getv ##### -->
1124 Gets an array of argument values from an object.
1127 @object: the object to get arguments from.
1128 @n_args: the number of arguments to query.
1129 @args: the arguments to fill in.
1131 <!-- ##### FUNCTION gtk_object_newv ##### -->
1133 Construct an object with an array of arguments.
1136 @object_type: the type of the object to create.
1137 @n_args: the number of arguments to set.
1138 @args: an array of n_args arguments (which are name and value pairs).
1139 @Returns: the new GtkObject.
1141 <!-- ##### FUNCTION gtk_object_query_args ##### -->
1143 Get all the arguments that may be used for a given type.
1146 In Java, this type of mechanism is called
1147 <wordasword>introspection</wordasword>. It is used by applications
1148 like Glade, that have to determine what can be done to an object
1152 @class_type: the GtkType of the ObjectClass
1153 (returned from GTK_OBJECT_CLASS(class)->type for example).
1154 @arg_flags: if non-NULL, obtains the #GtkArgFlags that apply to
1155 each argument. You must g_free() this if you request it.
1156 @n_args: the number of arguments is returned in this field.
1157 @Returns: an array of arguments, that you must deallocate with g_free().
1159 <!-- ##### FUNCTION gtk_object_setv ##### -->
1161 Set an array of arguments.
1164 @object: the object whose arguments should be set.
1165 @n_args: the number of arguments to set.
1166 @args: the desired values, as an array of #GtkArgs (which contain
1167 the names, types, and values of the arguments).
1169 <!-- ##### FUNCTION gtk_paned_compute_position ##### -->
1171 Internal function used by #GtkHPaned and #GtkVPaned
1179 <!-- ##### FUNCTION gtk_paned_set_handle_size ##### -->
1181 Set the the handle size to @size x @size pixels.
1184 @paned: a paned widget
1185 @size: the size in pixels
1187 <!-- ##### FUNCTION gtk_pattern_match ##### -->
1198 <!-- ##### FUNCTION gtk_pattern_match_simple ##### -->
1207 <!-- ##### FUNCTION gtk_pattern_match_string ##### -->
1216 <!-- ##### FUNCTION gtk_pattern_spec_free_segs ##### -->
1223 <!-- ##### FUNCTION gtk_pattern_spec_init ##### -->
1231 <!-- ##### FUNCTION gtk_rc_init ##### -->
1237 <!-- ##### FUNCTION gtk_ruler_draw_pos ##### -->
1242 @ruler: the gtkruler
1244 <!-- ##### FUNCTION gtk_ruler_draw_ticks ##### -->
1249 @ruler: the gtkruler
1251 <!-- ##### FUNCTION gtk_signal_add_emission_hook ##### -->
1253 Add an emission hook for a type of signal, for any object.
1256 @signal_id: the type of signal to hook for.
1257 @hook_func: the function to invoke to handle the emission hook.
1258 @data: the user data passed in to hook_func.
1259 @Returns: the id (that you may pass as a parameter
1260 to gtk_signal_remove_emission_hook()).
1265 <!-- ##### FUNCTION gtk_signal_add_emission_hook_full ##### -->
1267 Add an emission hook for a type of signal, for any object.
1268 (with control of what happens when the hook is
1272 @signal_id: the type of signal add the hook for.
1273 @hook_func: the function to invoke to handle the hook.
1274 @data: the user data passed in to hook_func.
1275 @destroy: a function to invoke when the hook is destroyed,
1276 to clean up any allocation done just for this
1278 @Returns: the id (that you may pass as a parameter
1279 to gtk_signal_remove_emission_hook()).
1281 <!-- ##### FUNCTION gtk_signal_handler_pending_by_id ##### -->
1283 Returns whether a connection id is valid (and optionally not blocked).
1286 @object: the object to search for the desired handler.
1287 @handler_id: the connection id.
1288 @may_be_blocked: whether it is acceptable to return a blocked
1290 @Returns: TRUE if the signal exists and wasn't blocked,
1291 unless #may_be_blocked was specified. FALSE otherwise.
1293 <!-- ##### FUNCTION gtk_signal_handlers_destroy ##### -->
1295 Destroy all the signal handlers connected to an object.
1296 This is done automatically when the object is destroyed.
1299 This function is labeled private.
1302 @object: the object whose signal handlers should be destroyed.
1304 <!-- ##### FUNCTION gtk_signal_init ##### -->
1310 <!-- ##### FUNCTION gtk_signal_n_emissions ##### -->
1312 Find out the recursion depth of emissions for a particular type
1313 of signal and object. (So it will
1314 always return 0 or 1 if #GTK_RUN_NO_RECURSE is specified)
1315 This is a way to avoid recursion: you can see if
1316 you are currently running in that signal handler and emit it only
1319 <para>Another way to look at it is that this number increases
1320 by one when #gtk_signal_emit(), et al, are called,
1321 and decreases by one when #gtk_signal_emit() returns.
1324 @object: the object with the signal handler.
1325 @signal_id: the signal id.
1326 @Returns: the recursion depth of emissions of this signal for this
1329 <!-- ##### FUNCTION gtk_signal_n_emissions_by_name ##### -->
1331 Find out the recursion depth of emissions for a particular type
1332 of signal and object. Just like gtk_signal_n_emissions()
1333 except it will lookup the signal id for you.
1336 @object: the object with the signal handler.
1337 @name: the signal name.
1338 @Returns: the recursion depth of emissions of this signal for this
1341 <!-- ##### FUNCTION gtk_signal_query ##### -->
1343 Obtain information about a signal.
1346 @signal_id: the signal type identifier.
1347 @Returns: a pointer to a GtkSignalQuery structure
1348 which contains all the information, or NULL.
1349 The pointer is allocated just for you: you must g_free() it.
1351 <!-- ##### FUNCTION gtk_signal_remove_emission_hook ##### -->
1353 Delete an emission hook. (see gtk_signal_add_emission_hook())
1356 @signal_id: the id of the signal type.
1357 @hook_id: the id of the emission handler, returned by add_emission_hook().
1361 <!-- ##### FUNCTION gtk_signal_set_funcs ##### -->
1363 These set default functions to call when the user didn't
1364 supply a function when connecting. (These are rarely
1365 used, and probably only for language bindings)
1368 By default, there are no such functions.
1371 @marshal_func: the function to invoke on every handlers for which there
1372 isn't a function pointer. May be NULL.
1373 @destroy_func: the function to invoke when each hook is destroyed.
1376 <!-- ##### FUNCTION gtk_spin_button_set_shadow_type ##### -->
1378 Creates a border around the arrows of a #GtkSpinButton. The type of border is determined by @shadow_type.
1381 @spin_button: a #GtkSpinButton
1382 @shadow_type: the new border type.
1384 <!-- ##### FUNCTION gtk_trace_referencing ##### -->
1386 Private: print debugging information while doing a gtk_object_ref() or
1387 a gtk_object_unref().
1390 @object: object to reference or unreference.
1391 @func: name of caller's function to print (used within macros).
1393 @line: line number (used within macros).
1394 @do_ref: whether to reference or unreference.
1396 <!-- ##### FUNCTION gtk_tree_model_ref_iter ##### -->
1404 <!-- ##### FUNCTION gtk_tree_model_unref_iter ##### -->
1412 <!-- ##### FUNCTION gtk_tree_store_set_cell ##### -->
1422 <!-- ##### FUNCTION gtk_type_check_class_cast ##### -->
1424 Given a GtkTypeClass pointer @klass, and a GtkType @cast_type, make
1425 sure that it's okay to cast something of that @klass into a @cast_type.
1428 @klass: GtkTypeClass*
1430 @Returns: Always return @klass.
1432 <!-- ##### FUNCTION gtk_type_check_object_cast ##### -->
1434 Given a pointer to a GtkTypeObject @type_object, and a GtkType @cast_type,
1435 make sure that it's okay to cast @type_object into a @cast_type.
1438 @type_object: GtkTypeObject*
1440 @Returns: the same GtkTypeObject* as @type_object
1442 <!-- ##### FUNCTION gtk_type_children_types ##### -->
1444 Return the pointer to the type's children's types.
1448 @Returns: pointer to a GList
1450 <!-- ##### FUNCTION gtk_type_describe_heritage ##### -->
1452 Print the types @type inherits from.
1457 <!-- ##### FUNCTION gtk_type_describe_tree ##### -->
1459 Given a @type, describe all of its children, and their children. Only
1460 show the size if @show_size is true.
1464 @show_size: gboolean
1466 <!-- ##### FUNCTION gtk_type_free ##### -->
1468 Given the type of an object and a pointer to it, the object is freed.
1472 @mem: gpointer to the object
1474 <!-- ##### FUNCTION gtk_type_get_varargs_type ##### -->
1476 Get the varargs type associated with @foreign_type
1479 @foreign_type: GtkType
1482 <!-- ##### FUNCTION gtk_type_parent_class ##### -->
1484 Return the class of the parent. Initialize the class if necessary.
1485 Return NULL if anything goes wrong.
1489 @Returns: gpointer to the klass.
1491 <!-- ##### FUNCTION gtk_type_query ##### -->
1493 Given a type, return various interesting parameters of the type.
1497 @Returns: GtkTypeQuery*
1499 <!-- ##### FUNCTION gtk_type_register_enum ##### -->
1501 Register a new set of enum @values and give them the name in
1505 @type_name: must not be null.
1506 @values: GtkEnumValue*
1509 <!-- ##### FUNCTION gtk_type_register_flags ##### -->
1511 Register a new set of flags @values and give them the name in
1515 @type_name: must not be null.
1516 @values: GtkFlagValue*
1519 <!-- ##### FUNCTION gtk_type_set_chunk_alloc ##### -->
1521 Set the mem_chunk size so it will hold @n_chunks of the objects of that @type.
1524 @type: There must be an unlocked TypeNode associated with this type otherwise nothing happens.
1527 <!-- ##### FUNCTION gtk_type_set_varargs_type ##### -->
1529 Set the varargs type for a fundamental type @foreign_type.
1532 @foreign_type: Must be a GtkType with a sequence number of zero. Must not be a
1534 @varargs_type: Must be a GtkType which is either structured or flag, or NONE.
1536 <!-- ##### FUNCTION gtk_widget_activate_mnemonic ##### -->
1545 <!-- ##### FUNCTION gtk_widget_popup ##### -->
1554 <!-- ##### FUNCTION gtk_window_activate_mnemonic ##### -->
1564 <!-- ##### FUNCTION gtk_window_get_default_accel_group ##### -->