X-Git-Url: http://pileus.org/git/?a=blobdiff_plain;f=docs%2Freference%2Fgtk%2Ftmpl%2Fgtk-unused.sgml;h=74bda7b2b877faa6e30e20f6ef3189b9902a6669;hb=fa7b7509941959605cddf14bcfbed8f5a7dbb729;hp=7f37ff2cab727d0d7eb7141f876564cd7d5698e9;hpb=2c5d938ff81480846539d9659dd92ca90cfb9e40;p=~andy%2Fgtk diff --git a/docs/reference/gtk/tmpl/gtk-unused.sgml b/docs/reference/gtk/tmpl/gtk-unused.sgml index 7f37ff2ca..74bda7b2b 100644 --- a/docs/reference/gtk/tmpl/gtk-unused.sgml +++ b/docs/reference/gtk/tmpl/gtk-unused.sgml @@ -1,52 +1,105 @@ - -Debugging + + +All the functions in here are marked a Non-public. +We describe it anyway because it is occasionally useful +to understand how the work is done. + + +Arguments are a way of describing a named parameter to a function. +They have two important roles within gtk+: + + + +they describe object properties. +This means that they present an interface to get and set a named-type +for any type of object in a consistent way. +(All the relevant functions to do this start with gtk_object_set +or gtk_object_get). + + + + +they describe signal arguments. +This is a lot less often needed but still useful. +Usually if you are just emitting or creating a particular signal +it is more convenient to just use gtk_signal_emit() or gtk_signal_new(). +However if you are writing a function to emit or create an arbitrary +signal, you must use gtk_signal_emitv() or gtk_signal_newv(). + + + + - + -An action signal. Causes the characters in the current -selection to be copied to the clipboard and then deleted from -the widget. +#GtkObject. -@editable: the object which received the signal. - + +Utility function to manipulate lists of named, typed arguments. + + +Implementation of Object Properties - + - + -@simple: -@path: -@iter: - - + + + + +GtkCellRendererTextPixbuf + + + + +The #GtkData object is a very simple object intended to be used as a base +class for objects which contain data (i.e. the 'Model' in the object-oriented +Model/View/Controller framework). + + +Currently it is not very useful since all it provides is a "disconnect" signal. +This signal could be emitted by a #GtkData subclass to notify any 'Views' +that they should disconnect from the #GtkData (the 'Model'), possibly just +before the #GtkData is destroyed. -@type: -@nargs: -@args: -@Returns: - + -A macro to check whether a child widget of the CList -has the focus. + -@clist: The #GtkCList widget to check. + + +abstract base class for objects containing data. + + + +GtkData + + + +Debugging + + + +gtkenums.sgml + @@ -114,947 +167,877 @@ void marshal_INT__POINTER_POINTER_INT_INT(GtkObject* object, - - + + + + +#GtkSignal +The signal handling functions (of which marshallers are +really an implementation detail). + - - -Add an array of signals to a #GtkObjectClass. -Usually this is called when registering a new type of object. + -@klass: the object class to append signals to. -@signals: the signals to append. -@nsignals: the number of signals being appended. - - + +Functions to adapt C structures to native calling convention. - + +Signal Marshallers - + + -@wid: -@flag: - + -@obj: - - + - -@Returns: - - + +GtkPacker - + + +Private Information - + -@engine: -@Returns: - + -@selection: -@type: - - + - - - + +GtkModelSimple + + + +A macro to check whether a child widget of the CList +has the focus. -@n_columns: -@Varargs: -@Returns: +@clist: The #GtkCList widget to check. - + -@textview: the object which received the signal. -@arg1: - + -@v: -@visual: - + -@window: -@focus: - + - + -@widget: -@arg: - + +@obj: - + -A boolean indicating whether the widget is editable by -the user. + +@klass: - + - +Tests whether a #GtkObject has had a signal connected to it. +@obj: the object to examine. - + -Sets one of the two font filters, to limit the fonts shown. +Test whether a GtkObject's arguments have been prepared. -@fontsel: a #GtkFontSelection. -@filter_type: which of the two font filters to set, either -#GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter -can be changed by the user, but the base filter is permanent. -@font_type: the types of font to be shown. This is a bitwise combination of -#GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP, -or #GTK_FONT_ALL to show all three font types. -@foundries: a NULL-terminated array of strings containing foundry names which -will be shown, or NULL to show all foundries. -@weights: a NULL-terminated array of strings containing weight names which -will be shown, or NULL to show all weights. -@slants: a NULL-terminated array of strings containing slant names which -will be shown, or NULL to show all slants. -@setwidths: a NULL-terminated array of strings containing setwidth names which -will be shown, or NULL to show all setwidths. -@spacings: a NULL-terminated array of strings containing spacings which -will be shown, or NULL to show all spacings. -@charsets: a NULL-terminated array of strings containing charset names which -will be shown, or NULL to show all charsets. +@obj: the object to examine. - + - +Test whether a GtkObject has had gtk_object_destroy() invoked on it. -@container: +@obj: the object to examine. - -Signal Marshallers + + +Get the number of signals defined by this object. + +@obj: the object to query. - + - +Turns on certain object flags. (Private) +@obj: the object to affect. +@flag: the flags to set. - + -A structure used to return values from @gtk_type_query. +Get the array of signals defined for this object. -@type: -@type_name: -@object_size: -@class_size: +@obj: the object to fetch the signals from. - + - +Turns off certain object flags. (Private) -@v: +@obj: the object to affect. +@flag: the flags to unset. - + -@buffer: -@Returns: - + -@object: -@func: -@func_data: -@args: - + -A #GtkJustification for the text. This is only used when the tag is -applied to the first character in a paragraph. + - - -This is currently a hack left in for a scheme wrapper library. -It may be removed. - + -Don't use it. + -@object: The object which emits the signal. -@data: The user data associated with the hook. -@nparams: The number of parameters to the function. -@args: The actual values of the arguments. -@arg_types: The types of the arguments. -@return_type: The type of the return value from the function -or #GTK_TYPE_NONE for no return value. - + -Add an emission hook for a type of signal, for any object. -(with control of what happens when the hook is -destroyed). + -@signal_id: the type of signal add the hook for. -@hook_func: the function to invoke to handle the hook. -@data: the user data passed in to hook_func. -@destroy: a function to invoke when the hook is destroyed, -to clean up any allocation done just for this -signal handler. -@Returns: the id (that you may pass as a parameter -to gtk_signal_remove_emission_hook()). - + -@buffer: -@override_location: -@time: -@interactive: -@default_editable: - + -@object: -@func: -@func_data: -@args: +@obj: - + -@simple: -@path: -@iter: +@klass: - + -@tree_column: -@size: -@width: +@obj: - + -@textview: the object which received the signal. +@obj: - + - +A macro that returns a GList that contains the selection of the root tree of @obj. -@text_view: -@iter: -@x: -@y: +@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. - + -Gets an array of argument values from an object. +The first "flat" (no struct) enumerated type value. -@object: the object to get arguments from. -@n_args: the number of arguments to query. -@args: the arguments to fill in. - + - +The last "flat" (no struct) enumerated type value. - + - +Hide the name of gtk_identifier_get_type -@buffer: -@iter: -@Returns: - - + + +Combine a fundemantal type and a sequence number to create a gtk type. + +@parent_t: +@seqno: - + -Get the type of GtkIdentifier. +No idea. -@Returns: GtkType -- the enumerated type of something. - + - +Convert a gtk type into its sequence number -@name: -@Returns: +@type: - + - +The first structured enumerated type value. -@parent: -@stamp: - + - +The last structured enumerated type value. - + -@simple: -@path: -@iter: - + -@object: -@func: -@func_data: -@args: - + -@engine: - + - +Use to get the value of a GtkArg whose GtkType is GTK_TYPE_ARGS -@object: -@func: -@func_data: -@args: +@a: - + - +Use to get the value of a GtkArg whose GtkType is GTK_TYPE_CALLBACK -@GTK_CELL_RENDERER_SELECTED: -@GTK_CELL_RENDERER_PRELIT: -@GTK_CELL_RENDERER_INSENSITIVE: +@a: - + - +Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_CALLBACK -@object: -@func: -@func_data: -@args: +@a: - + - +Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_FOREIGN -@mark: -@Returns: +@a: - + +@a: +@b: +@Returns: - + -Determines if the user can edit the text in the editable -widget or not. This is meant to be overriden by -child classes and should not generally useful to -applications. +This is a private struct used by GTK+ internally, don't worry about it. -@editable: the object which received the signal. -@is_editable: %TRUE if the user is allowed to edit the text - in the widget. +@accel_group: +@accelerator_key: +@accelerator_mods: +@accel_flags: +@object: +@signal_id: - + -@simple: -@path: -@iter: - + -This signal is emitted when text is deleted from -the widget by the user. The default handler for -this signal will normally be responsible for inserting -the text, so by connecting to this signal and then -stopping the signal with gtk_signal_emit_stop(), it -is possible to modify the inserted text, or prevent -it from being inserted entirely. The @start_pos -and @end_pos parameters are interpreted as for -gtk_editable_delete_text() + -@editable: the object which received the signal. -@start_pos: the starting position. -@end_pos: the end position. - + -@ruler: the gtkruler +@data: +@accel_path_quark: +@accel_key: +@accel_mods: +@accel_group: +@old_accel_key: +@old_accel_mods: - + -An action signal. Delete a single line. +Define a function pointer. Deprecated. -@editable: the object which received the signal. -@direction: the direction in which to delete. Positive - indicates forward deletion, negative, backwards deletion. +@object: +@arg: +@arg_id: - + - +A structure containing information about the argument. +Returned by gtk_arg_get_info(). -@argc: -@argv: +@class_type: if the argument is an object, this is the object class type. +@name: the name of the argument. +@type: the type of the argument; it may be an object's type +or a fundamental type. +@arg_flags: flags applicable to the argument (i.e. readable, writable, +and whether it needs to be constructed). +@full_name: the object name and argument name separated by ::, +e.g. "GtkObject::user_data" or "GtkButton::label". +@arg_id: the unique argument identified. +@seq_id: ??? - + -Register a new set of enum @values and give them the name in -@type_name. +Define a function pointer. Deprecated. -@type_name: must not be null. -@values: GtkEnumValue* -@Returns: - - -Menu Factory - +@object: +@arg: +@arg_id: - + +@parent: - + -@w: -@v: -@widget: -@visual: - + -@widget: -@nargs: -@args: - + +@container: the object which received the signal. +@direction: +@Returns: - + -Convert a gtk type into its sequence number + -@type: - + - +The #GtkData-struct struct contains no public fields. - + - +Emitted to notify any views on the #GtkData object to disconnect from it, +possibly because the #GtkData object is about to be destroyed. -@GTK_MENU_FACTORY_MENU: -@GTK_MENU_FACTORY_MENU_BAR: -@GTK_MENU_FACTORY_OPTION_MENU: +@data: the object which received the signal. - + - +Indicates that the user has activated the widget +in some fashion. Generally, this will be done +with a keystroke. (The default binding for this +action is Return for #GtkEntry and +Control-Return for #GtkText.) +@editable: the object which received the signal. - + - +An action signal. Causes the characters in the current selection to +be copied to the clipboard. +@editable: the object which received the signal. - + - +An action signal. Causes the characters in the current +selection to be copied to the clipboard and then deleted from +the widget. -@obj: +@editable: the object which received the signal. - + - +An action signal. Delete a single character. +@editable: the object which received the signal. +@direction: the direction in which to delete. Positive + indicates forward deletion, negative, backwards deletion. - + - +An action signal. Delete a single line. -@iter: -@Returns: - - - - +@editable: the object which received the signal. +@direction: the direction in which to delete. Positive + indicates forward deletion, negative, backwards deletion. - + - +An action signal. Delete a single word. -@textview: the object which received the signal. +@editable: the object which received the signal. +@direction: the direction in which to delete. Positive + indicates forward deletion, negative, backwards deletion. - + - +An action signal. Move the cursor position. -@engine: +@editable: the object which received the signal. +@x: horizontal distance to move the cursor. +@y: vertical distance to move the cursor. - + - +An action signal. Move the cursor by pages. +@editable: the object which received the signal. +@x: Number of pages to move the cursor horizontally. +@y: Number of pages to move the cursor vertically. - + -Deprecated. +An action signal. Move the cursor to the given column. +@editable: the object which received the signal. +@column: the column to move to. (A negative value indicates + the last column) - + - +An action signal. Move the cursor to the given row. -@object: -@func: -@func_data: -@args: +@editable: the object which received the signal. +@row: the row to move to. (A negative value indicates + the last row) - + - +An action signal. Move the cursor by words. -@tree_store: -@iter: -@var_args: +@editable: the object which received the signal. +@num_words: The number of words to move the +cursor. (Can be negative). - + - +An action signal. Causes the contents of the clipboard to +be pasted into the editable widget at the current cursor +position. -@buffer: -@time: -@interactive: -@default_editable: +@editable: the object which received the signal. - + -Indicates that the user has activated the widget -in some fashion. Generally, this will be done -with a keystroke. (The default binding for this -action is Return for #GtkEntry and -Control-Return for #GtkText.) +Determines if the user can edit the text in the editable +widget or not. This is meant to be overriden by +child classes and should not generally useful to +applications. @editable: the object which received the signal. +@is_editable: %TRUE if the user is allowed to edit the text + in the widget. - + - +A boolean indicating whether the widget is editable by +the user. -@GTK_TEXT_MOVEMENT_CHAR: -@GTK_TEXT_MOVEMENT_POSITIONS: -@GTK_TEXT_MOVEMENT_WORD: -@GTK_TEXT_MOVEMENT_WRAPPED_LINE: -@GTK_TEXT_MOVEMENT_LINE: -@GTK_TEXT_MOVEMENT_LINE_ENDS: -@GTK_TEXT_MOVEMENT_BUFFER_ENDS: - + +The position of the cursor. + + + + +A simple function pointer to get invoked when the +signal is emitted. This allows you tie a hook to the signal type, +so that it will trap all emissions of that signal, from any object. + + +You may not attach these to signals created with the +#GTK_RUN_NO_HOOKS flag. @object: -@func: -@func_data: -@args: +@signal_id: +@n_params: +@params: +@data: +@Returns: - + -Pixel width of the left margin of the text for lines after the first -line in a wrapped paragraph. + +@entry: the object which received the signal. - + +@entry: the object which received the signal. +@arg1: +@arg2: - + -@style: -@window: -@state_type: -@shadow_type: -@area: -@widget: -@detail: -@x: -@y: -@width: -@height: +@entry: the object which received the signal. +@arg1: +@arg2: +@arg3: - + -@obj: - + -An action signal. Causes the characters in the current selection to -be copied to the clipboard. +A set of bit flags used to specify the filter being set +when calling gtk_font_selection_dialog_set_filter() or +gtk_font_selection_set_filter(). -@editable: the object which received the signal. +@GTK_FONT_FILTER_BASE: the base filter, which can't be changed by the user. +@GTK_FONT_FILTER_USER: the user filter, which can be changed from within the +'Filter' page of the #GtkFontSelection widget. - + -Initializes a previously allocated #GtkCList widget for use. This should not -normally be used to create a #GtkCList widget. Use gtk_clist_new() instead. +A set of bit flags used to specify the type of fonts shown +when calling gtk_font_selection_dialog_set_filter() or +gtk_font_selection_set_filter(). -@clist: A pointer to an uninitialized #GtkCList widget. -@columns: The number of columns the #GtkCList should have. -@titles: An array of strings that should be used as the titles i -of the columns. There should be enough strings in the array for -the number of columns specified. +@GTK_FONT_BITMAP: bitmap fonts. +@GTK_FONT_SCALABLE: scalable fonts. +@GTK_FONT_SCALABLE_BITMAP: scaled bitmap fonts. +@GTK_FONT_ALL: a bitwise combination of all of the above. - + - +the #GtkAdjustment which sets the range of the scale. -@factory: -@entries: -@nentries: - + -@tree_view: -@path: -@column: -@row_align: -@col_align: - + - +A GtkImageLoader is used to load a filename found in +a RC file. -@buffer: -@iter: -@str: -@start: -@end: -@Returns: +@window: the window for creating image +@colormap: the colormap for this image +@mask: a pointer to the location to store the mask +@transparent_color: the transparent color for the image +@filename: filename to load +@Returns: a #GtkPixmap representing @filename - + -@object: -@func: -@func_data: -@args: - + -@object: -@func: -@func_data: -@args: - + -@object: -@func: -@func_data: -@args: +@menubar: the object which received the signal. +@arg1: - + -Internal function used by #GtkHPaned and #GtkVPaned +Setting this with a GtkType of GTK_TYPE_SIGNAL connects +the signal to the object, so that the user data and objects +and swapped when the signal handler is invoked. + + +This is useful for handlers that are primarily notifying +other objects and could just invoke an already existing function +if the parameters were swapped. +See gtk_signal_connect_object() for more details. -@paned: -@allocation: -@child1_req: -@child2_req: - + + +Setting this with a GtkType of GTK_TYPE_SIGNAL connects +the signal to the object, so that the user data and objects +and swapped when the signal handler is invoked, +and so that the handler is invoked after all others. + +See gtk_signal_connect_object_after() for more details. + + + + +Setting this with a GtkType of GTK_TYPE_SIGNAL connects +the signal to the object. - + -Private: print debugging information while doing a gtk_object_ref() or -a gtk_object_unref(). +Setting this with a GtkType of GTK_TYPE_SIGNAL connects +the signal to the object, so that the signal is always run +after other user handlers and the default handler. -@object: object to reference or unreference. -@func: name of caller's function to print (used within macros). -@dummy: unused. -@line: line number (used within macros). -@do_ref: whether to reference or unreference. - + -Use to get the value of a GtkArg whose GtkType is GTK_TYPE_CALLBACK + -@a: +@oldeditable: the object which received the signal. - + +@oldeditable: the object which received the signal. +@arg1: +@arg2: - + -Private: Gets an array of #GtkArgs from a va_list C structure. + -@object_type: the type of object to collect arguments for. -@arg_list_p: pointer to be filled in with a list of parsed arguments. -@info_list_p: optional pointer for a returned list #GtkArgInfos. -@first_arg_name: name of first argument. -@var_args: value of first argument, followed by more key/value pairs, -terminated by NULL. -@Returns: an error message, or NULL on success. -It is the caller's responsibility to call g_free() in the event of error. +@oldeditable: the object which received the signal. +@arg1: +@arg2: +@arg3: - + -A set of bit flags used to specify the type of fonts shown -when calling gtk_font_selection_dialog_set_filter() or -gtk_font_selection_set_filter(). + -@GTK_FONT_BITMAP: bitmap fonts. -@GTK_FONT_SCALABLE: scalable fonts. -@GTK_FONT_SCALABLE_BITMAP: scaled bitmap fonts. -@GTK_FONT_ALL: a bitwise combination of all of the above. +@parent: +@children: +@spacing: +@default_border_width: +@default_pad_x: +@default_pad_y: +@default_i_pad_x: +@default_i_pad_y: - + -The last structured enumerated type value. + - + -Get the number of signals defined by this object. + -@obj: the object to query. - + -Private function to get an argument and argument info from an object. + -@object: the object whose argument should be retrieved. -@arg: the argument, for the name on input, the rest is filled on output. -@info: a #GtkArgInfo structure to optionally fill in. - + -@factory: -@subfactory: -@path: - + -Return the pointer to the type's children's types. + -@type: GtkType -@Returns: pointer to a GList - + -An action signal. Move the cursor by pages. + -@editable: the object which received the signal. -@x: Number of pages to move the cursor horizontally. -@y: Number of pages to move the cursor vertically. - + -Register a new set of flags @values and give them the name in -@type_name. + -@type_name: must not be null. -@values: GtkFlagValue* -@Returns: +@widget: +@anchor: +@side: +@options: +@use_default: +@border_width: +@pad_x: +@pad_y: +@i_pad_x: +@i_pad_y: - + -@textview: the object which received the signal. -@arg1: +@GTK_PACK_EXPAND: +@GTK_FILL_X: +@GTK_FILL_Y: + + + + + + +@match_type: +@pattern_length: +@pattern: +@pattern_reversed: +@user_data: +@seq_id: @@ -1070,1217 +1053,1840 @@ Register a new set of flags @values and give them the name in @PRIVATE_GTK_DIRECTION_SET: @PRIVATE_GTK_DIRECTION_LTR: - + -Set the mem_chunk size so it will hold @n_chunks of the objects of that @type. + -@type: There must be an unlocked TypeNode associated with this type otherwise nothing happens. -@n_chunks: - + -@style: -@window: -@state_type: -@shadow_type: -@x: -@y: -@width: -@height: - + -The first structured enumerated type value. - - - - -This structure contains all the information about a particular -signal: its name, the type it affects, the signature of the handlers, -and its unique identifying integer. -@object_type: -@signal_id: -@signal_name: -@is_user_signal: -@signal_flags: -@return_val: -@nparams: -@params: - + -Given a @type, describe all of its children, and their children. Only -show the size if @show_size is true. + -@type: GtkType -@show_size: gboolean - + -@mark: -@Returns: - + -@object: -@func: -@func_data: -@args: - + -An action signal. Delete a single character. + -@editable: the object which received the signal. -@direction: the direction in which to delete. Positive - indicates forward deletion, negative, backwards deletion. - + - + -@window: -@xid: - + -@object: -@func: -@func_data: -@args: - + -@iter: -@pixmap: -@mask: -@Returns: - + -An action signal. Delete a single word. + -@editable: the object which received the signal. -@direction: the direction in which to delete. Positive - indicates forward deletion, negative, backwards deletion. - + -@context_simple: -@data: -@max_seq_len: -@n_seqs: - + - + -Test whether a GtkObject's arguments have been prepared. - -@obj: the object to examine. - - - -Sets one of the two font filters, to limit the fonts shown. -@fsd: a #GtkFontSelectionDialog. -@filter_type: which of the two font filters to set, either -#GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter -can be changed by the user, but the base filter is permanent. -@font_type: the types of font to be shown. This is a bitwise combination of -#GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP, -or #GTK_FONT_ALL to show all three font types. -@foundries: a NULL-terminated array of strings containing foundry names which -will be shown, or NULL to show all foundries. -@weights: a NULL-terminated array of strings containing weight names which -will be shown, or NULL to show all weights. -@slants: a NULL-terminated array of strings containing slant names which -will be shown, or NULL to show all slants. -@setwidths: a NULL-terminated array of strings containing setwidth names which -will be shown, or NULL to show all setwidths. -@spacings: a NULL-terminated array of strings containing spacings which -will be shown, or NULL to show all spacings. -@charsets: a NULL-terminated array of strings containing charset names which -will be shown, or NULL to show all charsets. - + -@textview: the object which received the signal. -@arg1: -@arg2: - + -@Returns: - + -No idea. + - + -Combine a fundemantal type and a sequence number to create a gtk type. - - -@parent_t: -@seqno: - -Functions to adapt C structures to native calling convention. + - + -The last "flat" (no struct) enumerated type value. + - + -@selection: -@tree_view: - + -@mark: - + -@object: -@func: -@func_data: -@args: - + -@object: -@func: -@func_data: -@args: - + -Destroy all the signal handlers connected to an object. -This is done automatically when the object is destroyed. +A function which you can use to clean up when the +signal handler is destroyed. -This function is labeled private. +For example, if your handler requires a few variables +that you made into a struct and allocated (using g_new() +or something), then you will probably want to free +it as soon as the hook is destroyed. This will +allow you to do that. (For this in particular +it is convenient to pass g_free() as a #GtkSignalDestroy +function). -@object: the object whose signal handlers should be destroyed. +@data: The user data associated with the hook that is being +destroyed. - + - +This is currently a hack left in for a scheme wrapper library. +It may be removed. - -@iter: -@start: -@end: -@Returns: - - -Get the varargs type associated with @foreign_type +Don't use it. -@foreign_type: GtkType -@Returns: GtkType +@object: The object which emits the signal. +@data: The user data associated with the hook. +@nparams: The number of parameters to the function. +@args: The actual values of the arguments. +@arg_types: The types of the arguments. +@return_type: The type of the return value from the function +or #GTK_TYPE_NONE for no return value. - + -Indicates that the user has changed the contents -of the widget. +This structure contains all the information about a particular +signal: its name, the type it affects, the signature of the handlers, +and its unique identifying integer. -@editable: the object which received the signal. +@object_type: +@signal_id: +@signal_name: +@is_user_signal: +@signal_flags: +@return_val: +@nparams: +@params: - + - +Holds the data for a statusbar message. text holds the actual text string. context_id is the context that this message is associated with, and message_id is this particular message's identifier. However, these fields should not be modified directly. -@tree_column: -@Returns: +@text: +@context_id: +@message_id: - + -@path: -@type: -@accel_group: -@widget: -@subfactories: +@parent_class: +@realize: +@unrealize: +@copy: +@clone: +@init_from_rc: +@set_background: +@render_icon: +@draw_hline: +@draw_vline: +@draw_shadow: +@draw_polygon: +@draw_arrow: +@draw_diamond: +@draw_string: +@draw_box: +@draw_flat_box: +@draw_check: +@draw_option: +@draw_tab: +@draw_shadow_gap: +@draw_box_gap: +@draw_extension: +@draw_focus: +@draw_slider: +@draw_handle: +@draw_expander: +@draw_layout: +@draw_resize_grip: +@_gtk_reserved1: +@_gtk_reserved2: +@_gtk_reserved3: +@_gtk_reserved4: +@_gtk_reserved5: +@_gtk_reserved6: +@_gtk_reserved7: +@_gtk_reserved8: +@_gtk_reserved9: +@_gtk_reserved10: +@_gtk_reserved11: +@_gtk_reserved12: - + -@textview: the object which received the signal. -@arg1: -@arg2: - + -Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_FOREIGN + -@a: - + -Define a signal-handler for a new signal on an already defined -object. +A #GtkJustification for the text. This is only used when the tag is +applied to the first character in a paragraph. + + + -See the signal documentation for more general information. +Pixel width of the left margin of the text for lines after the first +line in a wrapped paragraph. -@klass: the object class to define the signal for. -@name: the name of the signal. -@signal_flags: the default emission behavior for the signal. -See gtk_signal_new(). -@marshaller: a function that will take an array of GtkArgs -and invoke the appropriate handler with the normal calling -conventions. -@return_val: specify the return-value type for the signal -(or GTK_TYPE_NONE for no return-value). -@nparams: specify the number of parameters the signal -receives from the caller of gtk_signal_emit(). -@Varargs: list of nparams #GtkTypes to pass to the signal handlers. -@Returns: the signal id. (See #GtkSignals) - + -@textview: the object which received the signal. - + + +Pixels to offset the text horizontally or vertically, useful to +produce superscript and subscript. + + + + -@wid: -@flag: - + -@ruler: the gtkruler - + -Construct an object with an array of arguments. + -@object_type: the type of the object to create. -@n_args: the number of arguments to set. -@args: an array of n_args arguments (which are name and value pairs). -@Returns: the new GtkObject. - + -@obj: - + -@iter: -@Returns: - + -@GTK_DEBUG_OBJECTS: -@GTK_DEBUG_MISC: -@GTK_DEBUG_SIGNALS: -@GTK_DEBUG_DND: -@GTK_DEBUG_PLUGSOCKET: +@GTK_TREE_SELECTION_SINGLE: +@GTK_TREE_SELECTION_MULTI: - + -@factory: -@paths: -@npaths: +@treeview: the object which received the signal. - + -Given a type, return various interesting parameters of the type. + -@type: GtkType -@Returns: GtkTypeQuery* +@tree_view: +@context: +@path: +@user_data: +@Returns: - + -@GTK_TREE_VIEW_COLUMN_RESIZEABLE: -@GTK_TREE_VIEW_COLUMN_AUTOSIZE: -@GTK_TREE_VIEW_COLUMN_FIXED: +@tree_view: +@context: +@path: +@pos: +@user_data: +@Returns: - + +@uimanager: the object which received the signal. - + -Hide the name of gtk_identifier_get_type +the #GtkAdjustment which sets the range of the scale. - + -@object: -@func: -@func_data: -@args: - + +@widget: the object which received the signal. +@arg1: +@Returns: - + -This function is not usually used by users. + -@ctree: -@columns: -@tree_column: -@titles: +@widget: the object which received the signal. +@accel_signal_id: +@accel_group: +@accel_key: +@accel_mods: +@accel_flags: - + -@style: -@window: -@state_type: -@shadow_type: -@x: -@y: -@width: -@height: +@widget: the object which received the signal. +@message: - + -Returns whether a connection id is valid (and optionally not blocked). + -@object: the object to search for the desired handler. -@handler_id: the connection id. -@may_be_blocked: whether it is acceptable to return a blocked -handler. -@Returns: TRUE if the signal exists and wasn't blocked, -unless #may_be_blocked was specified. FALSE otherwise. +@widget: the object which received the signal. +@area: - + -@Returns: +@widget: the object which received the signal. - + -@wid: +@widget: the object which received the signal. - + -@Returns: +@widget: the object which received the signal. +@accel_group: +@accel_key: +@accel_mods: - + -@object: -@func: -@func_data: -@args: - + -Given the type of an object and a pointer to it, the object is freed. + -@type: GtkType -@mem: gpointer to the object - + + + - + -@object: -@func: -@func_data: -@args: - + -@path: -@widget: +@window: the object which received the signal. - + - +If the window shrinks automatically when widgets within it shrink. - + -Holds the data for a statusbar message. text holds the actual text string. context_id is the context that this message is associated with, and message_id is this particular message's identifier. However, these fields should not be modified directly. + -@text: -@context_id: -@message_id: - + -@widget: -@stock_id: -@size: -@detail: +@accel_group: +@accel_key: +@accel_mods: @Returns: - -Private Information + + + - +@accel_group: +@path: +@accel_key: +@accel_mods: +@accel_flags: +@object: +@accel_signal: + + -The position of the cursor. + +@accel_group: +@object: - + -@engine: -@parent_type: -@type_name: -@type_info: +@class_type: +@signal_flags: +@handler_offset: @Returns: - + -@factory: -@path: +@class_type: +@signal_flags: +@handler_offset: @Returns: - + -@path: -@accelerator: -@callback: -@callback_data: -@widget: +@accel_group: +@object: - + -An action signal. Causes the contents of the clipboard to -be pasted into the editable widget at the current cursor -position. + -@editable: the object which received the signal. +@object: +@Returns: - + -@window: -@xid: +@Returns: - + -@tree_column: -@active: +@accel_group: +@accel_key: +@accel_mods: +@Returns: - + -Define a signal-handler for a new signal on an already defined -object. + -@klass: the object class to define the signal for. -@name: the name of the signal. -@signal_flags: the default emission behavior for the signal. -See gtk_signal_new(). -@marshaller: takes a GtkObject, a #GtkSignalFunc, and an array -of arguments, and invokes the function using the appropriate -calling conventions. Usually just select a function -out of gtkmarshal.h. -@return_val: specify the return-value type for the signal (possibly -#GTK_TYPE_NONE). -@nparams: specify the number of parameters the signal -receives from the caller of gtk_signal_emit(). -@params: array of #GtkTypes the signal handlers for this signal -should have in their prototype (of length nparams). -@Returns: the signal id. (See #GtkSignals) +@Returns: - + @object: -@func: -@func_data: -@args: +@accel_signal_id: +@accel_group: +@accel_key: +@accel_mods: +@accel_flags: - + -@tree_column: -@active: +@object: +@accel_group: +@accel_key: +@accel_mods: - + -Controls whether opacity can be set with the #GtkColorSelection. -If this functionality is enabled, the necessary additional widgets -are added to the #GtkColorSelection and the opacity value can be -retrieved via the fourth value in the color array returned by -the gtk_color_selection_get_color() function. + -@colorsel: a #GtkColorSelection. -@use_opacity: a boolean indicating whether the opacity selection -is enabled. +@accel_group: +@accel_key: +@accel_mods: - + +@accel_group: +@accel_key: +@accel_mods: @object: -@func: -@func_data: -@args: - + - - - -#GtkSignal -The signal handling functions (of which marshallers are -really an implementation detail). - - +@accel_group: +@accel_key: +@accel_mods: - + -An action signal. Move the cursor by words. + -@editable: the object which received the signal. -@num_words: The number of words to move the -cursor. (Can be negative). +@accel_label: +@Returns: - + -@model: -@flags: -@tree: -@tab_offset: -@button_pressed_node: -@button_pressed_tree: -@children: -@width: -@height: -@hadjustment: -@vadjustment: -@bin_window: -@header_window: -@anchor: -@cursor: -@cursor_drag: -@xor_gc: -@drag_pos: -@x_drag: -@prelight_node: -@prelight_tree: -@prelight_offset: -@selection: -@columns: -@column: -@header_height: +@accel_label: +@accel_object: - + -@obj: +@accel_path: +@notify_data: +@notify_func: +@accel_group: - + -@type: -@action: +@accel_path: +@notify_data: +@notify_func: - + -Private function to set an argument and argument info to an object. +It will either copy data into an existing argument or allocate a new argument +and copy the data. Strings are duplicated. All other pointers and +values are copied (shallowly-- that is the pointers themselves are +copied, not the data they point to.) + + +You should call gtk_arg_reset() on dest_arg before calling this +if the argument may contain string data that you want freed. -@object: the object whose argument should be set. -@arg: the argument. -@info: infomation about this type of argument in general. +@src_arg: the argument to duplicate. +@dest_arg: the argument to copy over (or NULL to create a new #GtkArg). +@Returns: the new #GtkArg (or dest_arg, if it was not NULL). - + - +Frees the argument, and optionally its contents. -@GTK_TEXT_DELETE_CHAR: -@GTK_TEXT_DELETE_HALF_WORD: -@GTK_TEXT_DELETE_WHOLE_WORD: -@GTK_TEXT_DELETE_HALF_WRAPPED_LINE: -@GTK_TEXT_DELETE_WHOLE_WRAPPED_LINE: -@GTK_TEXT_DELETE_HALF_LINE: -@GTK_TEXT_DELETE_WHOLE_LINE: -@GTK_TEXT_DELETE_WHITESPACE: -@GTK_TEXT_DELETE_WHITESPACE_LEAVE_ONE: +@arg: the argument to free. +@free_contents: whether to free the string, if it is a string. - + - +Private: get information about an argument. -@object: -@tables: -@compose_buffer: -@tentative_match: -@tentative_match_len: +@object_type: the type of object. +@arg_info_hash_table: the hashtable of #GtkArgInfos. +@arg_name: the name of the argument to lookup. +@info_p: the argument info. +@Returns: an error message on failure, or NULL otherwise. - + -The first "flat" (no struct) enumerated type value. +A #GCompareFunc for hashing #GtkArgInfos. +@arg_info_1: a #GtkArgInfo. +@arg_info_2: a #GtkArgInfo. +@Returns: whether the arguments are the same. - + - +A #GHashFunc for hashing #GtkArgInfos. -@widget: -@nargs: -@args: +@arg_info: a #GtkArgInfo. +@Returns: a hash value for that #GtkArgInfo. - + - +Given a fully qualified argument name (e.g. "GtkButton::label") +it returns just the argument name (e.g. "label") unless +the argument name was invalid, in which case it returns NULL. -@tree_model_sort: +@arg_name: the fully-qualified argument name. +@Returns: the base argument name. - + - +Creates a new argument of a certain type, set to 0 or NULL. -@tree_column: -@Returns: +@arg_type: the type of the argument. +@Returns: the newly created #GtkArg. - + -@type: -@Returns: +@arg: - + -Mark an allocated object as constructed. -This is used for situations -that require precise control of the construction process. + + +@arg: +@value_pointer: + + -This is done when gtk_object_default_construct() is inadequate. -In #GtkCList the need arises because #GtkCList does construction work that -must happen after its derivers. This work -cannot be done in an initializer function, so an alternate -constructor is mandatory. It calls gtk_object_constructed() to -indicate it has done its job, so that no other constructor will -be invoked. +Create a new argument registered with a class. + +@base_class_type: the basic type having the arguments, almost alway +GTK_TYPE_OBJECT, except if your defining a different type argument +that gets a different namespace. #GtkContainer does this to define +per-child arguments of the container. +@arg_name: name of the argument to create. (must be a static constant string) +@class_n_args_offset: offset into the base class structure that tells +the number of arguments. +@arg_info_hash_table: hashtable of #GtkArgInfos. +@arg_type: type of the argument. +@arg_flags: flags of the argument. +@arg_id: ??? +@Returns: the new #GtkArgInfo. + + -Normally this function is just automatically run from -gtk_object_default_construct(). + -@object: object which has been constructed. This is usually -done automatically by gtk_object_new() and gtk_object_newv(). +@arg1: +@arg2: +@Returns: - + -This function is called to construct arguments that haven't been initialized -but have the #GTK_ARG_CONSTRUCT flag set. +Private: given a hashtable of argument information it takes a vararg +list and parses it into arguments (in the form of lists of #GtkArgs +and lists of #GtkArgInfos. -All number arguments are set to 0. All pointers and strings -are set to NULL. +The list of arguments starts with first_arg_name then the first argument's +value. Followed by any number of additional name/argument pairs, +terminated with NULL. + +@object_type: the type of object we are collecting arguments for. +@arg_info_hash_table: a hashtable mapping from names of arguments +to their #GtkArgInfos. +@arg_list_p: a returned list of arguments obtained from parsing the +varargs. +@info_list_p: a returned list of the #GtkArgInfos. +@first_arg_name: the name of the first argument. +@var_args: a va_list containing the value of the first argument, +followed by name/value pairs, followed by NULL. +@Returns: an error message on failure, or NULL otherwise. + + -Normally invoked by gtk_object_new() automatically; gtk_type_new() can -be used to bypass it. +Private: erase lists of arguments returned from gtk_args_collect(). -@object: the object to initialize. +@arg_list: arg_list_p returned from gtk_args_collect(). +@info_list: info_list_p returned from gtk_args_collect(). - + - +Private: from a class type and its arginfo hashtable, +get an array of #GtkArgs that this object accepts. +@class_type: the class type. +@arg_info_hash_table: the hashtable of #GtkArgInfos. +@arg_flags: returned array of argument flags. +@n_args_p: the number of arguments this object accepts. +@Returns: the array of arguments (or NULL on error). - + -Internal to #GtkLabel. +This is an internally used function and should never be called from an +application. +@widget: +@nvis_children: +@width: +@height: - - - + + +The internal padding of a button is the amount of space between the outside +of the button and the widget it contains. This function gets the default +amount of horizontal and vertical padding, placing the results in @ipad_x +and @ipad_y, respectively. -@buffer: +@ipad_x: the default horizontal internal button padding. +@ipad_y: the default vertical internal button padding. - - + + +Retrieves the default minimum width and height for all button boxes, and +places the values in @min_width and @min_height, respectively. + + +@min_width: the default minimum width of a child widget. +@min_height: the default minimum height of a child widget. + + +Sets the default number of pixels that pad each button in every button box. +@ipad_x: new default horizontal padding. +@ipad_y: new default vertical padding. - - -Query information about an argument type. + + +Sets the default size of child buttons. -@object_type: type of object to query about. -@arg_name: name of the argument. -@info_p: pointer to be filled in with a pointer to the GtkArgInfo. -@Returns: an error message, or NULL on success. -It is the caller's responsibility to call g_free() in the event of error. +@min_width: minimum default width for child buttons. +@min_height: minimum default height for child buttons. - + -@GTK_TREE_SELECTION_SINGLE: -@GTK_TREE_SELECTION_MULTI: +@uline_label: +@accel_group: +@Returns: - + -Setting this with a GtkType of GTK_TYPE_SIGNAL connects -the signal to the object, so that the signal is always run -after other user handlers and the default handler. + +@stock_id: +@accel_group: +@Returns: - + +@cell: +@event: +@widget: +@path: +@background_area: +@cell_area: +@flags: +@Returns: - + +@Returns: - + -A macro that returns a GList that contains the selection of the root tree of @obj. +Initializes a previously allocated #GtkCList widget for use. This should not +normally be used to create a #GtkCList widget. Use gtk_clist_new() instead. -@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. +@clist: A pointer to an uninitialized #GtkCList widget. +@columns: The number of columns the #GtkCList should have. +@titles: An array of strings that should be used as the titles i +of the columns. There should be enough strings in the array for +the number of columns specified. - + -Causes the "changed" signal to be emitted. + -@editable: a #GtkEditable widget. +@colorsel: +@color: - + -Set an array of arguments. + -@object: the object whose arguments should be set. -@n_args: the number of arguments to set. -@args: the desired values, as an array of #GtkArgs (which contain -the names, types, and values of the arguments). +@colorsel: +@Returns: - + -@textview: the object which received the signal. -@arg1: -@arg2: -@arg3: +@colorsel: +@Returns: - + -@obj: +@colorsel: +@color: - + - +Controls whether opacity can be set with the #GtkColorSelection. +If this functionality is enabled, the necessary additional widgets +are added to the #GtkColorSelection and the opacity value can be +retrieved via the fourth value in the color array returned by +the gtk_color_selection_get_color() function. -@buffer: -@time: +@colorsel: a #GtkColorSelection. +@use_opacity: a boolean indicating whether the opacity selection +is enabled. - + -@mark: -@Returns: +@colorsel: +@use_opacity: - + -Pixels to offset the text horizontally or vertically, useful to -produce superscript and subscript. + +@colorsel: +@use_palette: - + -This signal is emitted when text is inserted into -the widget by the user. The default handler for -this signal will normally be responsible for inserting -the text, so by connecting to this signal and then -stopping the signal with gtk_signal_emit_stop(), it -is possible to modify the inserted text, or prevent -it from being inserted entirely. + -@editable: the object which received the signal. -@new_text: the new text to insert. -@new_text_length: the length of the new text. -@position: the position at which to insert the new text. - this is an in-out paramter. After the signal - emission is finished, it should point after - the newly inserted text. +@arg_name: +@arg_type: +@arg_flags: +@arg_id: - + -Claim or disclaim ownership of the PRIMARY X selection. + -@editable: a #GtkEditable widget. -@claim: if %TRUE, claim the selection, otherwise, disclaim it. -@time: the timestamp for claiming the selection. +@container: +@widget: +@first_arg_name: +@Varargs: - + -@object: -@func: -@func_data: +@container: +@widget: +@n_args: @args: - + -Get the array of signals defined for this object. + -@obj: the object to fetch the signals from. +@container: +@child: +@arg: +@info: - - -Get all the arguments that may be used for a given type. - + -In Java, this type of mechanism is called -introspection. It is used by applications -like Glade, that have to determine what can be done to an object -at run-time. + -@class_type: the GtkType of the ObjectClass -(returned from GTK_OBJECT_CLASS(class)->type for example). -@arg_flags: if non-NULL, obtains the #GtkArgFlags that apply to -each argument. You must g_free() this if you request it. -@n_args: the number of arguments is returned in this field. -@Returns: an array of arguments, that you must deallocate with g_free(). +@container: +@child: +@arg: +@info: - + -An action signal. Move the cursor to the given column. - - -@editable: the object which received the signal. -@column: the column to move to. (A negative value indicates - the last column) - -gtkenums.sgml + +@object_type: +@arg_name: +@info_p: +@Returns: - + -@object: -@func: -@func_data: +@object_type: +@arg_list_p: +@info_list_p: +@first_arg_name: @args: +@Returns: - + -@widget: -@user_data: +@container: +@child: +@n_args: +@args: - + -Given a pointer to a GtkTypeObject @type_object, and a GtkType @cast_type, -make sure that it's okay to cast @type_object into a @cast_type. + -@type_object: GtkTypeObject* -@cast_type: GtkType -@Returns: the same GtkTypeObject* as @type_object +@container: +@child: +@n_args: +@args: - + -@tree_model_sort: -@sort_col: +@container: - + -@error_code: +@container: +@direction: +@Returns: - + -@object: -@func: -@func_data: -@args: +@class_type: +@arg_flags: +@nargs: +@Returns: - + - +This function is not usually used by users. +@ctree: +@columns: +@tree_column: +@titles: - + - +Internal function. +@toplevel: +@event: - + -Set the varargs type for a fundamental type @foreign_type. +Internal function. -@foreign_type: Must be a GtkType with a sequence number of zero. Must not be a -fundamental type. -@varargs_type: Must be a GtkType which is either structured or flag, or NONE. +@widget: +@event: - + + +Causes the "changed" signal to be emitted. + + +@editable: a #GtkEditable widget. + + + +Claim or disclaim ownership of the PRIMARY X selection. + + +@editable: a #GtkEditable widget. +@claim: if %TRUE, claim the selection, otherwise, disclaim it. +@time: the timestamp for claiming the selection. + + + +Sets one of the two font filters, to limit the fonts shown. + + +@fsd: a #GtkFontSelectionDialog. +@filter_type: which of the two font filters to set, either +#GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter +can be changed by the user, but the base filter is permanent. +@font_type: the types of font to be shown. This is a bitwise combination of +#GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP, +or #GTK_FONT_ALL to show all three font types. +@foundries: a NULL-terminated array of strings containing foundry names which +will be shown, or NULL to show all foundries. +@weights: a NULL-terminated array of strings containing weight names which +will be shown, or NULL to show all weights. +@slants: a NULL-terminated array of strings containing slant names which +will be shown, or NULL to show all slants. +@setwidths: a NULL-terminated array of strings containing setwidth names which +will be shown, or NULL to show all setwidths. +@spacings: a NULL-terminated array of strings containing spacings which +will be shown, or NULL to show all spacings. +@charsets: a NULL-terminated array of strings containing charset names which +will be shown, or NULL to show all charsets. + + + +Sets one of the two font filters, to limit the fonts shown. + + +@fontsel: a #GtkFontSelection. +@filter_type: which of the two font filters to set, either +#GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter +can be changed by the user, but the base filter is permanent. +@font_type: the types of font to be shown. This is a bitwise combination of +#GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP, +or #GTK_FONT_ALL to show all three font types. +@foundries: a NULL-terminated array of strings containing foundry names which +will be shown, or NULL to show all foundries. +@weights: a NULL-terminated array of strings containing weight names which +will be shown, or NULL to show all weights. +@slants: a NULL-terminated array of strings containing slant names which +will be shown, or NULL to show all slants. +@setwidths: a NULL-terminated array of strings containing setwidth names which +will be shown, or NULL to show all setwidths. +@spacings: a NULL-terminated array of strings containing spacings which +will be shown, or NULL to show all spacings. +@charsets: a NULL-terminated array of strings containing charset names which +will be shown, or NULL to show all charsets. + + + +Get the type of GtkIdentifier. + + +@Returns: GtkType -- the enumerated type of something. + + + + + + +@image_menu_item: +@child: + + + + + + +@Returns: + + + + + + +@path_pspec: +@modified_only: +@print_func: +@func_data: + + + + + + +@file_name: +@path_pspec: +@modified_only: + + + + + + +@file_name: + + + + + + +@scanner: + + + + + + +@rc_string: + + + + + + +@FILE_pointer: +@string: + + + + + + +@label: +@str: +@Returns: + + + + + + +@store: +@iter: +@position: + + + + + + +@n_columns: +@Varargs: +@Returns: + + + + + + +@store: +@iter: +@column: +@value: + + + + + + +@store: +@column: +@type: + + + + + + +@store: +@n_columns: + + + + + + +@menu: +@Returns: + + + + + + +@menu: +@Returns: + + + +Sets whether the menu item should show a submenu indicator, which is a right +arrow. + + +@menu_item: the menu item +@show_toggle_indicator: unused +@show_submenu_indicator: whether to show the arrow or not + + + +Specifies the placement of the submenu around the menu item. The placement +is usually #GTK_LEFT_RIGHT for menu items in a popup menu and +#GTK_TOP_BOTTOM in menu bars. + + +This function is useless in usual applications. + + +@menu_item: the menu item +@placement: the submenu placement + + + +Private function to get an argument and argument info from an object. + + +@object: the object whose argument should be retrieved. +@arg: the argument, for the name on input, the rest is filled on output. +@info: a #GtkArgInfo structure to optionally fill in. + + + +Query information about an argument type. + + +@object_type: type of object to query about. +@arg_name: name of the argument. +@info_p: pointer to be filled in with a pointer to the GtkArgInfo. +@Returns: an error message, or NULL on success. +It is the caller's responsibility to call g_free() in the event of error. + + + +Private function to set an argument and argument info to an object. + + +@object: the object whose argument should be set. +@arg: the argument. +@info: infomation about this type of argument in general. + + + +Private: Gets an array of #GtkArgs from a va_list C structure. + + +@object_type: the type of object to collect arguments for. +@arg_list_p: pointer to be filled in with a list of parsed arguments. +@info_list_p: optional pointer for a returned list #GtkArgInfos. +@first_arg_name: name of first argument. +@var_args: value of first argument, followed by more key/value pairs, +terminated by NULL. +@Returns: an error message, or NULL on success. +It is the caller's responsibility to call g_free() in the event of error. + + + +Add an array of signals to a #GtkObjectClass. +Usually this is called when registering a new type of object. + + +@klass: the object class to append signals to. +@signals: the signals to append. +@nsignals: the number of signals being appended. + + + +Define a signal-handler for a new signal on an already defined +object. + + +See the signal documentation for more general information. + + +@klass: the object class to define the signal for. +@name: the name of the signal. +@signal_flags: the default emission behavior for the signal. +See gtk_signal_new(). +@marshaller: a function that will take an array of GtkArgs +and invoke the appropriate handler with the normal calling +conventions. +@return_val: specify the return-value type for the signal +(or GTK_TYPE_NONE for no return-value). +@nparams: specify the number of parameters the signal +receives from the caller of gtk_signal_emit(). +@Varargs: list of nparams #GtkTypes to pass to the signal handlers. +@Returns: the signal id. (See #GtkSignals) + + + +Define a signal-handler for a new signal on an already defined +object. + + +@klass: the object class to define the signal for. +@name: the name of the signal. +@signal_flags: the default emission behavior for the signal. +See gtk_signal_new(). +@marshaller: takes a GtkObject, a #GtkSignalFunc, and an array +of arguments, and invokes the function using the appropriate +calling conventions. Usually just select a function +out of gtkmarshal.h. +@return_val: specify the return-value type for the signal (possibly +#GTK_TYPE_NONE). +@nparams: specify the number of parameters the signal +receives from the caller of gtk_signal_emit(). +@params: array of #GtkTypes the signal handlers for this signal +should have in their prototype (of length nparams). +@Returns: the signal id. (See #GtkSignals) + + + +Mark an allocated object as constructed. +This is used for situations +that require precise control of the construction process. + + +This is done when gtk_object_default_construct() is inadequate. +In #GtkCList the need arises because #GtkCList does construction work that +must happen after its derivers. This work +cannot be done in an initializer function, so an alternate +constructor is mandatory. It calls gtk_object_constructed() to +indicate it has done its job, so that no other constructor will +be invoked. + + +Normally this function is just automatically run from +gtk_object_default_construct(). + + +@object: object which has been constructed. This is usually +done automatically by gtk_object_new() and gtk_object_newv(). + + + +This function is called to construct arguments that haven't been initialized +but have the #GTK_ARG_CONSTRUCT flag set. + + +All number arguments are set to 0. All pointers and strings +are set to NULL. + + +Normally invoked by gtk_object_new() automatically; gtk_type_new() can +be used to bypass it. + + +@object: the object to initialize. + + + +Gets an array of argument values from an object. + + +@object: the object to get arguments from. +@n_args: the number of arguments to query. +@args: the arguments to fill in. + + + +Construct an object with an array of arguments. + + +@object_type: the type of the object to create. +@n_args: the number of arguments to set. +@args: an array of n_args arguments (which are name and value pairs). +@Returns: the new GtkObject. + + + +Get all the arguments that may be used for a given type. + + +In Java, this type of mechanism is called +introspection. It is used by applications +like Glade, that have to determine what can be done to an object +at run-time. + + +@class_type: the GtkType of the ObjectClass +(returned from GTK_OBJECT_CLASS(class)->type for example). +@arg_flags: if non-NULL, obtains the #GtkArgFlags that apply to +each argument. You must g_free() this if you request it. +@n_args: the number of arguments is returned in this field. +@Returns: an array of arguments, that you must deallocate with g_free(). + + + +Set an array of arguments. + + +@object: the object whose arguments should be set. +@n_args: the number of arguments to set. +@args: the desired values, as an array of #GtkArgs (which contain +the names, types, and values of the arguments). + + + + + + +@packer: +@child: +@side: +@anchor: +@options: +@border_width: +@pad_x: +@pad_y: +@i_pad_x: +@i_pad_y: + + + + + + +@packer: +@child: +@side: +@anchor: +@options: + + + + + + + + + + + + +@Returns: + + + + + + +@packer: +@child: +@position: + + + + + + +@packer: +@child: +@side: +@anchor: +@options: +@border_width: +@pad_x: +@pad_y: +@i_pad_x: +@i_pad_y: + + + + + + +@packer: +@border: + + + + + + +@packer: +@i_pad_x: +@i_pad_y: + + + + + + +@packer: +@pad_x: +@pad_y: + + + + + + +@packer: +@spacing: + + + +Internal function used by #GtkHPaned and #GtkVPaned + + +@paned: +@allocation: +@child1_req: +@child2_req: + + + +Old name for gtk_paned_set_handle_size(). + + + + + +Set the the handle size to @size x @size pixels. + + +@paned: a paned widget +@size: the size in pixels + + + + + + +@pspec: +@string_length: +@string: +@string_reversed: +@Returns: + + -Given a GtkTypeClass pointer @klass, and a GtkType @cast_type, make -sure that it's okay to cast something of that @klass into a @cast_type. + -@klass: GtkTypeClass* -@cast_type: GtkType -@Returns: Always return @klass. +@pattern: +@string: +@Returns: - + -Setting this with a GtkType of GTK_TYPE_SIGNAL connects -the signal to the object, so that the user data and objects -and swapped when the signal handler is invoked, -and so that the handler is invoked after all others. + + +@pspec: +@string: +@Returns: + + -See gtk_signal_connect_object_after() for more details. + +@pspec: - + -@factory: +@pspec: +@pattern: - + +Internal function. + + + + +Internal function. Loads an image using the current +image loader. + + +@colormap: the colormap to use for the image +@transparent_color: the transparent color for the image +@filename: the filename of the image file +@Returns: a #GtkPixmap representing @filename + + + +Sets the function that GTK+ will use to load images + + +@loader: the #GtkImageLoader to use + + + + + + +@ruler: the gtkruler + + + + + + +@ruler: the gtkruler + + + +Internal function. -@style: @window: -@state_type: -@shadow_type: -@area: +@event: +@Returns: + + + +Internal function. + + @widget: -@detail: -@arrow_type: -@x: -@y: -@width: -@height: +@event: +@Returns: + + + +Internal function. + + +@widget: +@event: +@Returns: + + + +Internal function. + + +@widget: +@event: +@Returns: + + + + + + +@Returns: + + + +Add an emission hook for a type of signal, for any object. + + +@signal_id: the type of signal to hook for. +@hook_func: the function to invoke to handle the emission hook. +@data: the user data passed in to hook_func. +@Returns: the id (that you may pass as a parameter +to gtk_signal_remove_emission_hook()). +@i: +@h: +@d: + + + +Add an emission hook for a type of signal, for any object. +(with control of what happens when the hook is +destroyed). + + +@signal_id: the type of signal add the hook for. +@hook_func: the function to invoke to handle the hook. +@data: the user data passed in to hook_func. +@destroy: a function to invoke when the hook is destroyed, +to clean up any allocation done just for this +signal handler. +@Returns: the id (that you may pass as a parameter +to gtk_signal_remove_emission_hook()). + + + +Returns whether a connection id is valid (and optionally not blocked). + + +@object: the object to search for the desired handler. +@handler_id: the connection id. +@may_be_blocked: whether it is acceptable to return a blocked +handler. +@Returns: TRUE if the signal exists and wasn't blocked, +unless #may_be_blocked was specified. FALSE otherwise. + + + +Destroy all the signal handlers connected to an object. +This is done automatically when the object is destroyed. + + +This function is labeled private. + + +@object: the object whose signal handlers should be destroyed. + + + + + + @@ -2301,511 +2907,565 @@ and decreases by one when #gtk_signal_emit() returns. @Returns: the recursion depth of emissions of this signal for this object. - + - +Find out the recursion depth of emissions for a particular type +of signal and object. Just like gtk_signal_n_emissions() +except it will lookup the signal id for you. -@buffer: -@iter: -@pixmap: -@mask: +@object: the object with the signal handler. +@name: the signal name. +@Returns: the recursion depth of emissions of this signal for this +object. - + +Obtain information about a signal. + + +@signal_id: the signal type identifier. +@Returns: a pointer to a GtkSignalQuery structure +which contains all the information, or NULL. +The pointer is allocated just for you: you must g_free() it. + + +Delete an emission hook. (see gtk_signal_add_emission_hook()) +@signal_id: the id of the signal type. +@hook_id: the id of the emission handler, returned by add_emission_hook(). +@i: +@h: - + +These set default functions to call when the user didn't +supply a function when connecting. (These are rarely +used, and probably only for language bindings) + + +By default, there are no such functions. + + +@marshal_func: the function to invoke on every handlers for which there +isn't a function pointer. May be NULL. +@destroy_func: the function to invoke when each hook is destroyed. +May be NULL. + + +Creates a border around the arrows of a #GtkSpinButton. The type of border is determined by @shadow_type. -@object: -@func: -@func_data: -@args: +@spin_button: a #GtkSpinButton +@shadow_type: the new border type. - + -@object: -@func: -@func_data: -@args: +@Returns: - + -Use to get the value of a GtkArg whose GtkType is GTK_TYPE_ARGS + -@a: +@display: +@style: +@Returns: - + -@factory: -@entries: -@nentries: +@buffer: +@override_location: +@default_editable: - + -An action signal. Move the cursor to the given row. + -@editable: the object which received the signal. -@row: the row to move to. (A negative value indicates - the last row) +@first: +@second: - + -These set default functions to call when the user didn't -supply a function when connecting. (These are rarely -used, and probably only for language bindings) + + +@iter: +@desc: + + -By default, there are no such functions. + -@marshal_func: the function to invoke on every handlers for which there -isn't a function pointer. May be NULL. -@destroy_func: the function to invoke when each hook is destroyed. -May be NULL. +@text_view: +@width: +@height: - + @Returns: - + -@style: -@window: -@state_type: -@shadow_type: -@area: -@widget: -@detail: -@x: -@y: -@width: -@height: +@tool_item: - + -Setting this with a GtkType of GTK_TYPE_SIGNAL connects -the signal to the object. +Private: print debugging information while doing a gtk_object_ref() or +a gtk_object_unref(). + + +@object: object to reference or unreference. +@func: name of caller's function to print (used within macros). +@dummy: unused. +@line: line number (used within macros). +@do_ref: whether to reference or unreference. + + + + +@tree_model: +@iter: - + -Print the types @type inherits from. + -@type: GtkType +@tree_model_sort: +@sort_iter: +@child_iter: + + + + + + +@tree_model_sort: +@child_path: +@Returns: +@path: + + + + + + +@Returns: + + + + + + +@tree_model_sort: +@func: - + -@buffer: -@text: +@tree_model_sort: +@child_model: +@model: - + -A set of bit flags used to specify the filter being set -when calling gtk_font_selection_dialog_set_filter() or -gtk_font_selection_set_filter(). + -@GTK_FONT_FILTER_BASE: the base filter, which can't be changed by the user. -@GTK_FONT_FILTER_USER: the user filter, which can be changed from within the -'Filter' page of the #GtkFontSelection widget. +@tree_model_sort: +@sort_col: - + -An action signal. Move the cursor position. + -@editable: the object which received the signal. -@x: horizontal distance to move the cursor. -@y: vertical distance to move the cursor. +@tree_model: +@iter: - + -Return the class of the parent. Initialize the class if necessary. -Return NULL if anything goes wrong. + -@type: GtkType -@Returns: gpointer to the klass. +@tree_store: +@iter: +@position: - - -A function which you can use to clean up when the -signal handler is destroyed. - + -For example, if your handler requires a few variables -that you made into a struct and allocated (using g_new() -or something), then you will probably want to free -it as soon as the hook is destroyed. This will -allow you to do that. (For this in particular -it is convenient to pass g_free() as a #GtkSignalDestroy -function). + -@data: The user data associated with the hook that is being -destroyed. +@n_columns: +@Varargs: +@Returns: - + -@window: -@defaultw: +@tree_store: +@iter: +@column: +@value: - + @tree_store: -@iter: -@var_args: +@column: +@type: +@store: - + -@textbuffer: the object which received the signal. -@arg1: -@arg2: -@arg3: +@tree_store: +@n_columns: - + -@tree_view: +@tree_column: +@event: +@path_string: +@background_area: +@cell_area: +@flags: @Returns: - + -@object: -@func: -@func_data: -@args: +@tree_column: +@tree_model: +@iter: - - -Setting this with a GtkType of GTK_TYPE_SIGNAL connects -the signal to the object, so that the user data and objects -and swapped when the signal handler is invoked. - + -This is useful for handlers that are primarily notifying -other objects and could just invoke an already existing function -if the parameters were swapped. -See gtk_signal_connect_object() for more details. + +@tree_column: +@cell: - + -@style: -@window: -@state_type: -@shadow_type: -@arrow_type: -@x: -@y: +@tree_column: @width: -@height: +@size: - + -@obj: +@tree_view: +@targets: +@n_targets: +@actions: +@location_droppable_func: +@user_data: - + +@tree_view: +@start_button_mask: +@targets: +@n_targets: +@actions: +@row_draggable_func: +@user_data: - + - +Given a GtkTypeClass pointer @klass, and a GtkType @cast_type, make +sure that it's okay to cast something of that @klass into a @cast_type. -@obj: +@klass: GtkTypeClass* +@cast_type: GtkType +@Returns: Always return @klass. - + - +Given a pointer to a GtkTypeObject @type_object, and a GtkType @cast_type, +make sure that it's okay to cast @type_object into a @cast_type. -@object: -@func: -@func_data: -@args: +@type_object: GtkTypeObject* +@cast_type: GtkType +@Returns: the same GtkTypeObject* as @type_object - + - +Return the pointer to the type's children's types. -@tree_column: -@type: +@type: GtkType +@Returns: pointer to a GList - + - +Print the types @type inherits from. +@type: GtkType - + - +Given a @type, describe all of its children, and their children. Only +show the size if @show_size is true. -@object: -@func: -@func_data: -@args: +@type: GtkType +@show_size: gboolean - + - +Given the type of an object and a pointer to it, the object is freed. -@object: -@func: -@func_data: -@args: +@type: GtkType +@mem: gpointer to the object - + - +Get the varargs type associated with @foreign_type -@object: -@func: -@func_data: -@args: +@foreign_type: GtkType +@Returns: GtkType - + - +Return the class of the parent. Initialize the class if necessary. +Return NULL if anything goes wrong. -@widget: the object which received the signal. -@area: +@type: GtkType +@Returns: gpointer to the klass. - + - +Given a type, return various interesting parameters of the type. +@type: GtkType +@Returns: GtkTypeQuery* - + - +Register a new set of enum @values and give them the name in +@type_name. -@object: -@func: -@func_data: -@args: +@type_name: must not be null. +@values: GtkEnumValue* +@Returns: - + -Internal function. +Register a new set of flags @values and give them the name in +@type_name. +@type_name: must not be null. +@values: GtkFlagValue* +@Returns: - + -Obtain information about a signal. +Set the mem_chunk size so it will hold @n_chunks of the objects of that @type. -@signal_id: the signal type identifier. -@Returns: a pointer to a GtkSignalQuery structure -which contains all the information, or NULL. -The pointer is allocated just for you: you must g_free() it. +@type: There must be an unlocked TypeNode associated with this type otherwise nothing happens. +@n_chunks: - + -Find out the recursion depth of emissions for a particular type -of signal and object. Just like gtk_signal_n_emissions() -except it will lookup the signal id for you. +Set the varargs type for a fundamental type @foreign_type. -@object: the object with the signal handler. -@name: the signal name. -@Returns: the recursion depth of emissions of this signal for this -object. +@foreign_type: Must be a GtkType with a sequence number of zero. Must not be a +fundamental type. +@varargs_type: Must be a GtkType which is either structured or flag, or NONE. - + +@widget: +@accel_group: +@accel_key: +@accel_mods: +@Returns: - + -@textview: the object which received the signal. -@arg1: -@arg2: +@widget: +@Returns: - + +@widget: +@group_cycling: +@Returns: - + -@v: -@visual: +@widget: +@width: +@height: - + -@container: - - -GtkIMContextSimple - +@widget: - + - + -Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_CALLBACK + -@a: +@widget: +@x: +@y: - + -@object: -@func: -@func_data: -@args: +@style: - + -@textview: the object which received the signal. -@arg1: -@arg2: -@arg3: +@widget: +@accel_signal: +@visible_only: - + +@style: - + -@tree_view: -@active: +@widget: - + -@buffer: -@regexp: -@start: -@end: +@window: +@keyval: +@modifier: @Returns: - + -@factory: -@subfactory: -@path: +@window: +@Returns: - + -@GTK_TEXT_SCROLL_TO_TOP: -@GTK_TEXT_SCROLL_TO_BOTTOM: -@GTK_TEXT_SCROLL_PAGE_DOWN: -@GTK_TEXT_SCROLL_PAGE_UP: +@window: +@Returns: - + -@iter: -@Returns: +@window: +@decorations: - + -@tree_store: -@iter: +@window: +@functions: - + +@window: +@setting: +@resizeable: