diff options
author | Owen Taylor <otaylor@redhat.com> | 2001-06-21 17:44:27 +0000 |
---|---|---|
committer | Owen Taylor <otaylor@src.gnome.org> | 2001-06-21 17:44:27 +0000 |
commit | 9c3c1cd3b514ec9f5aef5b7b19f7acf7a5ccdaea (patch) | |
tree | bb8ac8c805c34b90e03a83bbe7fe5308d6f8f2cb /docs | |
parent | f1e23c401330615b16d9b3820c16e3792572b325 (diff) | |
download | gdk-pixbuf-9c3c1cd3b514ec9f5aef5b7b19f7acf7a5ccdaea.tar.gz |
Update a bit.
Thu Jun 21 12:31:29 2001 Owen Taylor <otaylor@redhat.com>
* gtk/gtk-sections.txt: Update a bit.
* Makefile.am: build GTK+ docs.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/reference/ChangeLog | 6 | ||||
-rw-r--r-- | docs/reference/Makefile.am | 2 | ||||
-rw-r--r-- | docs/reference/gtk/gtk-sections.txt | 37 | ||||
-rw-r--r-- | docs/reference/gtk/gtk.types | 1 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtk-unused.sgml | 388 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkarg.sgml | 186 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkclist.sgml | 12 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkcontainer.sgml | 120 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkfilesel.sgml | 4 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtknotebook.sgml | 34 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkpacker.sgml | 38 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkprogressbar.sgml | 34 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkrc.sgml | 35 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtktable.sgml | 8 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtktexttag.sgml | 138 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtktreemodelsort.sgml | 4 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkwidget.sgml | 8 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkwindow.sgml | 1 |
18 files changed, 534 insertions, 522 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 2bc011643..6ddd47698 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,9 @@ +Thu Jun 21 12:31:29 2001 Owen Taylor <otaylor@redhat.com> + + * gtk/gtk-sections.txt: Update a bit. + + * Makefile.am: build GTK+ docs. + Fri Jun 8 12:33:29 2001 Jonathan Blandford <jrb@redhat.com> * gtk/tmpl/gtktable.sgml: fix bug #55921 diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am index 1ce203f97..26da15420 100644 --- a/docs/reference/Makefile.am +++ b/docs/reference/Makefile.am @@ -1,4 +1,4 @@ ## Process this file with automake to produce Makefile.in -SUBDIRS = gdk-pixbuf gdk # gtk +SUBDIRS = gdk-pixbuf gdk gtk diff --git a/docs/reference/gtk/gtk-sections.txt b/docs/reference/gtk/gtk-sections.txt index b5bf9399c..a6e323e59 100644 --- a/docs/reference/gtk/gtk-sections.txt +++ b/docs/reference/gtk/gtk-sections.txt @@ -448,19 +448,9 @@ gtk_container_set_focus_vadjustment gtk_container_set_focus_hadjustment gtk_container_resize_children gtk_container_child_type -gtk_container_add_child_arg_type -gtk_container_query_child_args -gtk_container_child_getv -gtk_container_child_setv -gtk_container_add_with_args -gtk_container_addv gtk_container_child_set gtk_container_queue_resize gtk_container_clear_resize_widgets -gtk_container_arg_set -gtk_container_arg_get -gtk_container_child_args_collect -gtk_container_child_arg_get_info gtk_container_forall gtk_container_child_composite_name gtk_container_set_border_width @@ -1517,7 +1507,6 @@ GTK_IS_OBJECT_CLASS GTK_OBJECT_GET_CLASS <SUBSECTION Private> -GTK_ARG_MASK GTK_ARG_READWRITE </SECTION> @@ -3408,7 +3397,6 @@ gtk_theme_engine_get_type GtkRcStyle GtkRcStyleClass GtkRcFlags -GtkImageLoader GtkRcTokenType gtk_rc_scanner_new gtk_rc_get_style @@ -3430,8 +3418,6 @@ gtk_rc_get_module_dir gtk_rc_get_im_module_path gtk_rc_get_im_module_file gtk_rc_get_theme_dir -gtk_rc_set_image_loader -gtk_rc_load_image gtk_rc_style_new gtk_rc_style_copy gtk_rc_style_ref @@ -3445,9 +3431,6 @@ gtk_rc_style_get_type GTK_RC_STYLE_CLASS GTK_IS_RC_STYLE_CLASS GTK_RC_STYLE_GET_CLASS - -<SUBSECTION Private> -gtk_rc_init </SECTION> <SECTION> @@ -3608,26 +3591,6 @@ gtk_signal_compat_matched </SECTION> <SECTION> -<FILE>gtkarg</FILE> -<TITLE>Object Properties</TITLE> -GtkArgInfo -gtk_arg_new -gtk_arg_copy -gtk_arg_free -gtk_arg_reset -gtk_arg_values_equal -gtk_args_collect -gtk_args_collect_cleanup -gtk_arg_get_info -gtk_arg_type_new_static -gtk_args_query -gtk_arg_name_strip_type -gtk_arg_info_equal -gtk_arg_info_hash -gtk_arg_to_valueloc -</SECTION> - -<SECTION> <FILE>gtktypeutils</FILE> <TITLE>Types</TITLE> GtkType diff --git a/docs/reference/gtk/gtk.types b/docs/reference/gtk/gtk.types index a3d7a8f62..e13ae7b72 100644 --- a/docs/reference/gtk/gtk.types +++ b/docs/reference/gtk/gtk.types @@ -58,7 +58,6 @@ gtk_notebook_get_type gtk_old_editable_get_type gtk_object_get_type gtk_option_menu_get_type -gtk_packer_get_type gtk_paned_get_type gtk_pixmap_get_type gtk_plug_get_type diff --git a/docs/reference/gtk/tmpl/gtk-unused.sgml b/docs/reference/gtk/tmpl/gtk-unused.sgml index ae135db43..5e03313b2 100644 --- a/docs/reference/gtk/tmpl/gtk-unused.sgml +++ b/docs/reference/gtk/tmpl/gtk-unused.sgml @@ -1,3 +1,50 @@ +<!-- ##### SECTION ./tmpl/gtkarg.sgml:Long_Description ##### --> +<para> +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. +</para> +<para> +Arguments are a way of describing a named parameter to a function. +They have two important roles within gtk+: +<itemizedlist> +<listitem> +<para> +they describe <wordasword>object properties</wordasword>. +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). +</para> +</listitem> +<listitem> +<para> +they describe <wordasword>signal arguments</wordasword>. +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(). +</para> +</listitem> +</itemizedlist> +</para> + + +<!-- ##### SECTION ./tmpl/gtkarg.sgml:See_Also ##### --> +<para> +#GtkObject. +</para> + + +<!-- ##### SECTION ./tmpl/gtkarg.sgml:Short_Description ##### --> +Utility function to manipulate lists of named, typed arguments. + + +<!-- ##### SECTION ./tmpl/gtkarg.sgml:Title ##### --> +Implementation of Object Properties + + <!-- ##### SECTION ./tmpl/gtkdata.sgml:Long_Description ##### --> <para> The #GtkData object is a very simple object intended to be used as a base @@ -352,6 +399,23 @@ Define a function pointer. Deprecated. @arg: @arg_id: +<!-- ##### STRUCT GtkArgInfo ##### --> +<para> +A structure containing information about the argument. +Returned by gtk_arg_get_info(). +</para> + +@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: ??? + <!-- ##### USER_FUNCTION GtkArgSetFunc ##### --> <para> Define a function pointer. Deprecated. @@ -638,6 +702,19 @@ the #GtkAdjustment which sets the range of the scale. @tentative_match: @tentative_match_len: +<!-- ##### USER_FUNCTION GtkImageLoader ##### --> +<para> +A GtkImageLoader is used to load a filename found in +a RC file. +</para> + +@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 + <!-- ##### ARG GtkLabel:accel-keyval ##### --> <para> @@ -685,6 +762,42 @@ after other user handlers and the default handler. </para> +<!-- ##### ARG GtkPacker:default-border-width ##### --> +<para> + +</para> + + +<!-- ##### ARG GtkPacker:default-ipad-x ##### --> +<para> + +</para> + + +<!-- ##### ARG GtkPacker:default-ipad-y ##### --> +<para> + +</para> + + +<!-- ##### ARG GtkPacker:default-pad-x ##### --> +<para> + +</para> + + +<!-- ##### ARG GtkPacker:default-pad-y ##### --> +<para> + +</para> + + +<!-- ##### ARG GtkPacker:spacing ##### --> +<para> + +</para> + + <!-- ##### ARG GtkPaned:handle-size ##### --> <para> @@ -867,6 +980,161 @@ the #GtkAdjustment which sets the range of the scale. @widget: the object which received the signal. +<!-- ##### FUNCTION gtk_arg_copy ##### --> +<para> +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.) +</para> +<para> +You should call gtk_arg_reset() on dest_arg before calling this +if the argument may contain string data that you want freed. +</para> + +@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). + +<!-- ##### FUNCTION gtk_arg_free ##### --> +<para> +Frees the argument, and optionally its contents. +</para> + +@arg: the argument to free. +@free_contents: whether to free the string, if it is a string. + +<!-- ##### FUNCTION gtk_arg_get_info ##### --> +<para> +Private: get information about an argument. +</para> + +@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. + +<!-- ##### FUNCTION gtk_arg_info_equal ##### --> +<para> +A #GCompareFunc for hashing #GtkArgInfos. +</para> + +@arg_info_1: a #GtkArgInfo. +@arg_info_2: a #GtkArgInfo. +@Returns: whether the arguments are the same. + +<!-- ##### FUNCTION gtk_arg_info_hash ##### --> +<para> +A #GHashFunc for hashing #GtkArgInfos. +</para> + +@arg_info: a #GtkArgInfo. +@Returns: a hash value for that #GtkArgInfo. + +<!-- ##### FUNCTION gtk_arg_name_strip_type ##### --> +<para> +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. +</para> + +@arg_name: the fully-qualified argument name. +@Returns: the base argument name. + +<!-- ##### FUNCTION gtk_arg_new ##### --> +<para> +Creates a new argument of a certain type, set to 0 or NULL. +</para> + +@arg_type: the type of the argument. +@Returns: the newly created #GtkArg. + +<!-- ##### FUNCTION gtk_arg_reset ##### --> +<para> + +</para> + +@arg: + +<!-- ##### FUNCTION gtk_arg_to_valueloc ##### --> +<para> + +</para> + +@arg: +@value_pointer: + +<!-- ##### FUNCTION gtk_arg_type_new_static ##### --> +<para> +Create a new argument registered with a class. +</para> + +@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. + +<!-- ##### FUNCTION gtk_arg_values_equal ##### --> +<para> + +</para> + +@arg1: +@arg2: +@Returns: + +<!-- ##### FUNCTION gtk_args_collect ##### --> +<para> +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. +</para> +<para> +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. +</para> + +@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. + +<!-- ##### FUNCTION gtk_args_collect_cleanup ##### --> +<para> +Private: erase lists of arguments returned from gtk_args_collect(). +</para> + +@arg_list: arg_list_p returned from gtk_args_collect(). +@info_list: info_list_p returned from gtk_args_collect(). + +<!-- ##### FUNCTION gtk_args_query ##### --> +<para> +Private: from a class type and its arginfo hashtable, +get an array of #GtkArgs that this object accepts. +</para> + +@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). + <!-- ##### FUNCTION gtk_button_box_child_requisition ##### --> <para>
This is an internally used function and should never be called from an
@@ -1005,6 +1273,98 @@ is enabled. @colorsel: @use_palette: +<!-- ##### FUNCTION gtk_container_add_child_arg_type ##### --> +<para> + +</para> + +@arg_name: +@arg_type: +@arg_flags: +@arg_id: + +<!-- ##### FUNCTION gtk_container_add_with_args ##### --> +<para> + +</para> + +@container: +@widget: +@first_arg_name: +@Varargs: + +<!-- ##### FUNCTION gtk_container_addv ##### --> +<para> + +</para> + +@container: +@widget: +@n_args: +@args: + +<!-- ##### FUNCTION gtk_container_arg_get ##### --> +<para> + +</para> + +@container: +@child: +@arg: +@info: + +<!-- ##### FUNCTION gtk_container_arg_set ##### --> +<para> + +</para> + +@container: +@child: +@arg: +@info: + +<!-- ##### FUNCTION gtk_container_child_arg_get_info ##### --> +<para> + +</para> + +@object_type: +@arg_name: +@info_p: +@Returns: + +<!-- ##### FUNCTION gtk_container_child_args_collect ##### --> +<para> + +</para> + +@object_type: +@arg_list_p: +@info_list_p: +@first_arg_name: +@args: +@Returns: + +<!-- ##### FUNCTION gtk_container_child_getv ##### --> +<para> + +</para> + +@container: +@child: +@n_args: +@args: + +<!-- ##### FUNCTION gtk_container_child_setv ##### --> +<para> + +</para> + +@container: +@child: +@n_args: +@args: + <!-- ##### FUNCTION gtk_container_focus ##### --> <para> @@ -1014,6 +1374,16 @@ is enabled. @direction: @Returns: +<!-- ##### FUNCTION gtk_container_query_child_args ##### --> +<para> + +</para> + +@class_type: +@arg_flags: +@nargs: +@Returns: + <!-- ##### FUNCTION gtk_ctree_construct ##### --> <para> This function is not usually used by users. @@ -1392,6 +1762,24 @@ Internal function. </para> +<!-- ##### FUNCTION gtk_rc_load_image ##### --> +<para> +Internal function. Loads an image using the current +image loader. +</para> + +@colormap: the colormap to use for the image +@transparent_color: the transparent color for the image +@filename: the filename of the image file +@Returns: a #GtkPixmap representing @filename + +<!-- ##### FUNCTION gtk_rc_set_image_loader ##### --> +<para> +Sets the function that GTK+ will use to load images +</para> + +@loader: the #GtkImageLoader to use + <!-- ##### FUNCTION gtk_ruler_draw_pos ##### --> <para> diff --git a/docs/reference/gtk/tmpl/gtkarg.sgml b/docs/reference/gtk/tmpl/gtkarg.sgml index a268fd805..7c2d95061 100644 --- a/docs/reference/gtk/tmpl/gtkarg.sgml +++ b/docs/reference/gtk/tmpl/gtkarg.sgml @@ -41,189 +41,3 @@ signal, you must use gtk_signal_emitv() or gtk_signal_newv(). #GtkObject. </para> -<!-- ##### STRUCT GtkArgInfo ##### --> -<para> -A structure containing information about the argument. -Returned by gtk_arg_get_info(). -</para> - -@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: ??? - -<!-- ##### FUNCTION gtk_arg_new ##### --> -<para> -Creates a new argument of a certain type, set to 0 or NULL. -</para> - -@arg_type: the type of the argument. -@Returns: the newly created #GtkArg. - - -<!-- ##### FUNCTION gtk_arg_copy ##### --> -<para> -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.) -</para> -<para> -You should call gtk_arg_reset() on dest_arg before calling this -if the argument may contain string data that you want freed. -</para> - -@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). - - -<!-- ##### FUNCTION gtk_arg_free ##### --> -<para> -Frees the argument, and optionally its contents. -</para> - -@arg: the argument to free. -@free_contents: whether to free the string, if it is a string. - - -<!-- ##### FUNCTION gtk_arg_reset ##### --> -<para> - -</para> - -@arg: - - -<!-- ##### FUNCTION gtk_arg_values_equal ##### --> -<para> - -</para> - -@arg1: -@arg2: -@Returns: - - -<!-- ##### FUNCTION gtk_args_collect ##### --> -<para> -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. -</para> -<para> -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. -</para> - -@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. - - -<!-- ##### FUNCTION gtk_args_collect_cleanup ##### --> -<para> -Private: erase lists of arguments returned from gtk_args_collect(). -</para> - -@arg_list: arg_list_p returned from gtk_args_collect(). -@info_list: info_list_p returned from gtk_args_collect(). - - -<!-- ##### FUNCTION gtk_arg_get_info ##### --> -<para> -Private: get information about an argument. -</para> - -@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. - - -<!-- ##### FUNCTION gtk_arg_type_new_static ##### --> -<para> -Create a new argument registered with a class. -</para> - -@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. - - -<!-- ##### FUNCTION gtk_args_query ##### --> -<para> -Private: from a class type and its arginfo hashtable, -get an array of #GtkArgs that this object accepts. -</para> - -@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). - - -<!-- ##### FUNCTION gtk_arg_name_strip_type ##### --> -<para> -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. -</para> - -@arg_name: the fully-qualified argument name. -@Returns: the base argument name. - - -<!-- ##### FUNCTION gtk_arg_info_equal ##### --> -<para> -A #GCompareFunc for hashing #GtkArgInfos. -</para> - -@arg_info_1: a #GtkArgInfo. -@arg_info_2: a #GtkArgInfo. -@Returns: whether the arguments are the same. - - -<!-- ##### FUNCTION gtk_arg_info_hash ##### --> -<para> -A #GHashFunc for hashing #GtkArgInfos. -</para> - -@arg_info: a #GtkArgInfo. -@Returns: a hash value for that #GtkArgInfo. - - -<!-- ##### FUNCTION gtk_arg_to_valueloc ##### --> -<para> - -</para> - -@arg: -@value_pointer: - - diff --git a/docs/reference/gtk/tmpl/gtkclist.sgml b/docs/reference/gtk/tmpl/gtkclist.sgml index 7e3d2d15c..8d80576b8 100644 --- a/docs/reference/gtk/tmpl/gtkclist.sgml +++ b/docs/reference/gtk/tmpl/gtkclist.sgml @@ -1279,18 +1279,18 @@ Sets the type of selection mode for the CList. An integer value representing the height of a row in pixels. </para> -<!-- ##### ARG GtkCList:reorderable ##### --> -<para> -A boolean value for determining if the user can re-order the CList's -columns. -</para> - <!-- ##### ARG GtkCList:titles-active ##### --> <para> A boolean value for setting whether the column titles can be clicked. </para> +<!-- ##### ARG GtkCList:reorderable ##### --> +<para> +A boolean value for determining if the user can re-order the CList's +columns. +</para> + <!-- ##### ARG GtkCList:use-drag-icons ##### --> <para> A boolean value for setting whether to use icons during drag diff --git a/docs/reference/gtk/tmpl/gtkcontainer.sgml b/docs/reference/gtk/tmpl/gtkcontainer.sgml index 4632a7f11..2cecd0a39 100644 --- a/docs/reference/gtk/tmpl/gtkcontainer.sgml +++ b/docs/reference/gtk/tmpl/gtkcontainer.sgml @@ -154,72 +154,6 @@ GtkContainer @Returns: -<!-- ##### FUNCTION gtk_container_add_child_arg_type ##### --> -<para> - -</para> - -@arg_name: -@arg_type: -@arg_flags: -@arg_id: - - -<!-- ##### FUNCTION gtk_container_query_child_args ##### --> -<para> - -</para> - -@class_type: -@arg_flags: -@nargs: -@Returns: - - -<!-- ##### FUNCTION gtk_container_child_getv ##### --> -<para> - -</para> - -@container: -@child: -@n_args: -@args: - - -<!-- ##### FUNCTION gtk_container_child_setv ##### --> -<para> - -</para> - -@container: -@child: -@n_args: -@args: - - -<!-- ##### FUNCTION gtk_container_add_with_args ##### --> -<para> - -</para> - -@container: -@widget: -@first_arg_name: -@Varargs: - - -<!-- ##### FUNCTION gtk_container_addv ##### --> -<para> - -</para> - -@container: -@widget: -@n_args: -@args: - - <!-- ##### FUNCTION gtk_container_child_set ##### --> <para> @@ -227,8 +161,10 @@ GtkContainer @container: @child: -@first_arg_name: +@first_prop_name: @Varargs: +<!-- # Unused Parameters # --> +@first_arg_name: <!-- ##### FUNCTION gtk_container_queue_resize ##### --> @@ -247,52 +183,6 @@ GtkContainer @container: -<!-- ##### FUNCTION gtk_container_arg_set ##### --> -<para> - -</para> - -@container: -@child: -@arg: -@info: - - -<!-- ##### FUNCTION gtk_container_arg_get ##### --> -<para> - -</para> - -@container: -@child: -@arg: -@info: - - -<!-- ##### FUNCTION gtk_container_child_args_collect ##### --> -<para> - -</para> - -@object_type: -@arg_list_p: -@info_list_p: -@first_arg_name: -@args: -@Returns: - - -<!-- ##### FUNCTION gtk_container_child_arg_get_info ##### --> -<para> - -</para> - -@object_type: -@arg_name: -@info_p: -@Returns: - - <!-- ##### FUNCTION gtk_container_forall ##### --> <para> @@ -388,12 +278,12 @@ GtkContainer @container: the object which received the signal. @widget: -<!-- ##### ARG GtkContainer:resize-mode ##### --> +<!-- ##### ARG GtkContainer:border-width ##### --> <para> </para> -<!-- ##### ARG GtkContainer:border-width ##### --> +<!-- ##### ARG GtkContainer:resize-mode ##### --> <para> </para> diff --git a/docs/reference/gtk/tmpl/gtkfilesel.sgml b/docs/reference/gtk/tmpl/gtkfilesel.sgml index 5c7a2ef8c..055d52322 100644 --- a/docs/reference/gtk/tmpl/gtkfilesel.sgml +++ b/docs/reference/gtk/tmpl/gtkfilesel.sgml @@ -169,12 +169,12 @@ Hides the file operation buttons that normally appear at the top of the dialog. @filesel: a #GtkFileSelection. -<!-- ##### ARG GtkFileSelection:filename ##### --> +<!-- ##### ARG GtkFileSelection:show-fileops ##### --> <para> </para> -<!-- ##### ARG GtkFileSelection:show-fileops ##### --> +<!-- ##### ARG GtkFileSelection:filename ##### --> <para> </para> diff --git a/docs/reference/gtk/tmpl/gtknotebook.sgml b/docs/reference/gtk/tmpl/gtknotebook.sgml index 9ff69802b..338d8259d 100644 --- a/docs/reference/gtk/tmpl/gtknotebook.sgml +++ b/docs/reference/gtk/tmpl/gtknotebook.sgml @@ -361,45 +361,45 @@ Emitted when the user or a function changes the current page. @page: the new current page @page_num: the index of the page -<!-- ##### ARG GtkNotebook:page ##### --> +<!-- ##### ARG GtkNotebook:tab-pos ##### --> <para> -The current page +The edge at which the tabs for switching pages are drawn. </para> -<!-- ##### ARG GtkNotebook:tab-pos ##### --> +<!-- ##### ARG GtkNotebook:show-tabs ##### --> <para> -The edge at which the tabs for switching pages are drawn. +Whether to show tabs for the notebook pages. </para> -<!-- ##### ARG GtkNotebook:tab-border ##### --> +<!-- ##### ARG GtkNotebook:show-border ##### --> <para> -Whether the tab labels have a border on all sides. +Whether to draw a bevel around the noteobook. </para> -<!-- ##### ARG GtkNotebook:tab-hborder ##### --> +<!-- ##### ARG GtkNotebook:scrollable ##### --> <para> -Whether the tab labels have a horizontal border. +Whether the tab label area will have arrows for scrolling if there +are too many tabs to fit in the area. </para> -<!-- ##### ARG GtkNotebook:tab-vborder ##### --> +<!-- ##### ARG GtkNotebook:tab-border ##### --> <para> -Whether the tab labels have a vertical border. +Whether the tab labels have a border on all sides. </para> -<!-- ##### ARG GtkNotebook:show-tabs ##### --> +<!-- ##### ARG GtkNotebook:tab-hborder ##### --> <para> -Whether to show tabs for the notebook pages. +Whether the tab labels have a horizontal border. </para> -<!-- ##### ARG GtkNotebook:show-border ##### --> +<!-- ##### ARG GtkNotebook:tab-vborder ##### --> <para> -Whether to draw a bevel around the noteobook. +Whether the tab labels have a vertical border. </para> -<!-- ##### ARG GtkNotebook:scrollable ##### --> +<!-- ##### ARG GtkNotebook:page ##### --> <para> -Whether the tab label area will have arrows for scrolling if there -are too many tabs to fit in the area. +The current page </para> <!-- ##### ARG GtkNotebook:enable-popup ##### --> diff --git a/docs/reference/gtk/tmpl/gtkpacker.sgml b/docs/reference/gtk/tmpl/gtkpacker.sgml index c2bdafecc..eb8f8f70f 100644 --- a/docs/reference/gtk/tmpl/gtkpacker.sgml +++ b/docs/reference/gtk/tmpl/gtkpacker.sgml @@ -19,6 +19,14 @@ GtkPacker </para> +@parent: +@children: +@spacing: +@default_border_width: +@default_pad_x: +@default_pad_y: +@default_i_pad_x: +@default_i_pad_y: <!-- ##### ENUM GtkPackerOptions ##### --> <para> @@ -187,33 +195,3 @@ GtkPacker @i_pad_y: -<!-- ##### ARG GtkPacker:spacing ##### --> -<para> - -</para> - -<!-- ##### ARG GtkPacker:default-border-width ##### --> -<para> - -</para> - -<!-- ##### ARG GtkPacker:default-pad-x ##### --> -<para> - -</para> - -<!-- ##### ARG GtkPacker:default-pad-y ##### --> -<para> - -</para> - -<!-- ##### ARG GtkPacker:default-ipad-x ##### --> -<para> - -</para> - -<!-- ##### ARG GtkPacker:default-ipad-y ##### --> -<para> - -</para> - diff --git a/docs/reference/gtk/tmpl/gtkprogressbar.sgml b/docs/reference/gtk/tmpl/gtkprogressbar.sgml index 3943f02aa..317902b93 100644 --- a/docs/reference/gtk/tmpl/gtkprogressbar.sgml +++ b/docs/reference/gtk/tmpl/gtkprogressbar.sgml @@ -261,9 +261,14 @@ gtk_progress_set_percentage() instead. @percentage: the new percent complete value. -<!-- ##### ARG GtkProgressBar:adjustment ##### --> +<!-- ##### ARG GtkProgressBar:fraction ##### --> <para> -a #GtkAdjustment to be used with the #GtkProgressBar. + +</para> + +<!-- ##### ARG GtkProgressBar:pulse-step ##### --> +<para> + </para> <!-- ##### ARG GtkProgressBar:orientation ##### --> @@ -272,6 +277,16 @@ a #GtkProgressBarOrientation value which specifies the orientation and growth direction of the bar. </para> +<!-- ##### ARG GtkProgressBar:text ##### --> +<para> + +</para> + +<!-- ##### ARG GtkProgressBar:adjustment ##### --> +<para> +a #GtkAdjustment to be used with the #GtkProgressBar. +</para> + <!-- ##### ARG GtkProgressBar:bar-style ##### --> <para> a #GtkProgressBarStyle value which specifies the @@ -295,18 +310,3 @@ The number of blocks which which make up progress bar when it is shown in %GTK_PROGRESS_DISCRETE style. </para> -<!-- ##### ARG GtkProgressBar:fraction ##### --> -<para> - -</para> - -<!-- ##### ARG GtkProgressBar:pulse-step ##### --> -<para> - -</para> - -<!-- ##### ARG GtkProgressBar:text ##### --> -<para> - -</para> - diff --git a/docs/reference/gtk/tmpl/gtkrc.sgml b/docs/reference/gtk/tmpl/gtkrc.sgml index 244dd09a1..5f8876c8f 100644 --- a/docs/reference/gtk/tmpl/gtkrc.sgml +++ b/docs/reference/gtk/tmpl/gtkrc.sgml @@ -495,7 +495,6 @@ This can later be composited together with other #GtkRcStyle structures to form a #GtkStyle. </para> -@parent_instance: @name: @bg_pixmap_name: @font_desc: @@ -555,20 +554,6 @@ set for each state. @GTK_RC_TEXT: @GTK_RC_BASE: -<!-- ##### USER_FUNCTION GtkImageLoader ##### --> -<para> -A GtkImageLoader is used to load a filename found in -a RC file. -</para> - -@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 - - <!-- ##### ENUM GtkRcTokenType ##### --> <para> The #GtkRcTokenType enumeration represents the tokens @@ -835,26 +820,6 @@ itself.) @Returns: The directory. (Must be freed with g_free()) -<!-- ##### FUNCTION gtk_rc_set_image_loader ##### --> -<para> -Sets the function that GTK+ will use to load images -</para> - -@loader: the #GtkImageLoader to use - - -<!-- ##### FUNCTION gtk_rc_load_image ##### --> -<para> -Internal function. Loads an image using the current -image loader. -</para> - -@colormap: the colormap to use for the image -@transparent_color: the transparent color for the image -@filename: the filename of the image file -@Returns: a #GtkPixmap representing @filename - - <!-- ##### FUNCTION gtk_rc_style_new ##### --> <para> Create a new #GtkRcStyle with no fields set and diff --git a/docs/reference/gtk/tmpl/gtktable.sgml b/docs/reference/gtk/tmpl/gtktable.sgml index 59242d40b..1251f6345 100644 --- a/docs/reference/gtk/tmpl/gtktable.sgml +++ b/docs/reference/gtk/tmpl/gtktable.sgml @@ -214,14 +214,14 @@ set or retrieve the number of rows in a table. set or retrieve the number of columnsin a table. </para> -<!-- ##### ARG GtkTable:row-spacing ##### --> +<!-- ##### ARG GtkTable:column-spacing ##### --> <para> -set or retrieve the number of pixels of space between each row. +set or retrieve the number of pixels of space between each column. </para> -<!-- ##### ARG GtkTable:column-spacing ##### --> +<!-- ##### ARG GtkTable:row-spacing ##### --> <para> -set or retrieve the number of pixels of space between each column. +set or retrieve the number of pixels of space between each row. </para> <!-- ##### ARG GtkTable:homogeneous ##### --> diff --git a/docs/reference/gtk/tmpl/gtktexttag.sgml b/docs/reference/gtk/tmpl/gtktexttag.sgml index 7cff611ab..12b6de795 100644 --- a/docs/reference/gtk/tmpl/gtktexttag.sgml +++ b/docs/reference/gtk/tmpl/gtktexttag.sgml @@ -198,16 +198,19 @@ when the tag is created. Background color, as a string such as "red" or "#FFFFFF" </para> +<!-- ##### ARG GtkTextTag:foreground ##### --> +<para> +Foreground color as a string such as "red" or "#FFFFFF". +</para> + <!-- ##### ARG GtkTextTag:background-gdk ##### --> <para> Background color, as a #GdkColor. </para> -<!-- ##### ARG GtkTextTag:background-full-height ##### --> +<!-- ##### ARG GtkTextTag:foreground-gdk ##### --> <para> -Whether to make the background color for each character the height of -the highest font used on the current line, or the height of the font -used for the current character. +Foreground color as a #GdkColor. </para> <!-- ##### ARG GtkTextTag:background-stipple ##### --> @@ -215,31 +218,11 @@ used for the current character. A #GdkBitmap to use for stippling the background color. </para> -<!-- ##### ARG GtkTextTag:foreground ##### --> -<para> -Foreground color as a string such as "red" or "#FFFFFF". -</para> - -<!-- ##### ARG GtkTextTag:foreground-gdk ##### --> -<para> -Foreground color as a #GdkColor. -</para> - <!-- ##### ARG GtkTextTag:foreground-stipple ##### --> <para> A #GdkBitmap to use as a stipple pattern for the foreground. </para> -<!-- ##### ARG GtkTextTag:direction ##### --> -<para> -The #GtkTextDirection for the tagged text. -</para> - -<!-- ##### ARG GtkTextTag:editable ##### --> -<para> -Whether the user can modify the tagged text. -</para> - <!-- ##### ARG GtkTextTag:font ##### --> <para> Font as a Pango font name, e.g. "Sans Italic 12" @@ -280,62 +263,61 @@ Font as a #PangoFontDescription. </para> -<!-- ##### ARG GtkTextTag:scale ##### --> +<!-- ##### ARG GtkTextTag:size-points ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:size-points ##### --> +<!-- ##### ARG GtkTextTag:scale ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:justification ##### --> +<!-- ##### ARG GtkTextTag:pixels-above-lines ##### --> <para> - +Pixels of blank space to leave above each newline-terminated line. </para> -<!-- ##### ARG GtkTextTag:language ##### --> +<!-- ##### ARG GtkTextTag:pixels-below-lines ##### --> <para> -The language this text is in, as an ISO code. Pango can use this as a -hint when rendering the text. If you don't understand this argument, -you probably don't need it. +Pixels of blank space to leave below each newline-terminated line. </para> -<!-- ##### ARG GtkTextTag:left-margin ##### --> +<!-- ##### ARG GtkTextTag:pixels-inside-wrap ##### --> <para> -Pixel width of left margin of the text. +Pixels of blank space to leave between wrapped lines inside the same +newline-terminated line (paragraph). </para> -<!-- ##### ARG GtkTextTag:right-margin ##### --> +<!-- ##### ARG GtkTextTag:editable ##### --> <para> -Pixel width of right margin. +Whether the user can modify the tagged text. </para> -<!-- ##### ARG GtkTextTag:indent ##### --> +<!-- ##### ARG GtkTextTag:wrap-mode ##### --> <para> - +A #GtkWrapMode value. Only used if the tag applies to the first +character in a paragraph. </para> -<!-- ##### ARG GtkTextTag:rise ##### --> +<!-- ##### ARG GtkTextTag:justification ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:pixels-above-lines ##### --> +<!-- ##### ARG GtkTextTag:direction ##### --> <para> -Pixels of blank space to leave above each newline-terminated line. +The #GtkTextDirection for the tagged text. </para> -<!-- ##### ARG GtkTextTag:pixels-below-lines ##### --> +<!-- ##### ARG GtkTextTag:left-margin ##### --> <para> -Pixels of blank space to leave below each newline-terminated line. +Pixel width of left margin of the text. </para> -<!-- ##### ARG GtkTextTag:pixels-inside-wrap ##### --> +<!-- ##### ARG GtkTextTag:indent ##### --> <para> -Pixels of blank space to leave between wrapped lines inside the same -newline-terminated line (paragraph). + </para> <!-- ##### ARG GtkTextTag:strikethrough ##### --> @@ -343,39 +325,47 @@ newline-terminated line (paragraph). %TRUE to draw a line through the text. </para> +<!-- ##### ARG GtkTextTag:right-margin ##### --> +<para> +Pixel width of right margin. +</para> + <!-- ##### ARG GtkTextTag:underline ##### --> <para> A #PangoUnderline value. </para> -<!-- ##### ARG GtkTextTag:wrap-mode ##### --> +<!-- ##### ARG GtkTextTag:rise ##### --> <para> -A #GtkWrapMode value. Only used if the tag applies to the first -character in a paragraph. + </para> -<!-- ##### ARG GtkTextTag:tabs ##### --> +<!-- ##### ARG GtkTextTag:background-full-height ##### --> <para> -A #PangoTabArray indicating tabs for this text. Only used if the tag -applies to the first character in a paragraph. +Whether to make the background color for each character the height of +the highest font used on the current line, or the height of the font +used for the current character. </para> -<!-- ##### ARG GtkTextTag:invisible ##### --> +<!-- ##### ARG GtkTextTag:language ##### --> <para> - +The language this text is in, as an ISO code. Pango can use this as a +hint when rendering the text. If you don't understand this argument, +you probably don't need it. </para> -<!-- ##### ARG GtkTextTag:background-set ##### --> +<!-- ##### ARG GtkTextTag:tabs ##### --> <para> - +A #PangoTabArray indicating tabs for this text. Only used if the tag +applies to the first character in a paragraph. </para> -<!-- ##### ARG GtkTextTag:background-full-height-set ##### --> +<!-- ##### ARG GtkTextTag:invisible ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:background-stipple-set ##### --> +<!-- ##### ARG GtkTextTag:background-set ##### --> <para> </para> @@ -385,12 +375,12 @@ applies to the first character in a paragraph. </para> -<!-- ##### ARG GtkTextTag:foreground-stipple-set ##### --> +<!-- ##### ARG GtkTextTag:background-stipple-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:editable-set ##### --> +<!-- ##### ARG GtkTextTag:foreground-stipple-set ##### --> <para> </para> @@ -430,42 +420,42 @@ applies to the first character in a paragraph. </para> -<!-- ##### ARG GtkTextTag:justification-set ##### --> +<!-- ##### ARG GtkTextTag:pixels-above-lines-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:language-set ##### --> +<!-- ##### ARG GtkTextTag:pixels-below-lines-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:left-margin-set ##### --> +<!-- ##### ARG GtkTextTag:pixels-inside-wrap-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:indent-set ##### --> +<!-- ##### ARG GtkTextTag:editable-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:rise-set ##### --> +<!-- ##### ARG GtkTextTag:wrap-mode-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:pixels-above-lines-set ##### --> +<!-- ##### ARG GtkTextTag:justification-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:pixels-below-lines-set ##### --> +<!-- ##### ARG GtkTextTag:left-margin-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:pixels-inside-wrap-set ##### --> +<!-- ##### ARG GtkTextTag:indent-set ##### --> <para> </para> @@ -485,7 +475,17 @@ applies to the first character in a paragraph. </para> -<!-- ##### ARG GtkTextTag:wrap-mode-set ##### --> +<!-- ##### ARG GtkTextTag:rise-set ##### --> +<para> + +</para> + +<!-- ##### ARG GtkTextTag:background-full-height-set ##### --> +<para> + +</para> + +<!-- ##### ARG GtkTextTag:language-set ##### --> <para> </para> diff --git a/docs/reference/gtk/tmpl/gtktreemodelsort.sgml b/docs/reference/gtk/tmpl/gtktreemodelsort.sgml index 68c71cd16..20dbfc571 100644 --- a/docs/reference/gtk/tmpl/gtktreemodelsort.sgml +++ b/docs/reference/gtk/tmpl/gtktreemodelsort.sgml @@ -45,10 +45,10 @@ GtkTreeModelSort </para> @child_model: -@func: -@sort_col: @Returns: <!-- # Unused Parameters # --> +@func: +@sort_col: @model: diff --git a/docs/reference/gtk/tmpl/gtkwidget.sgml b/docs/reference/gtk/tmpl/gtkwidget.sgml index b58107328..ab9a35559 100644 --- a/docs/reference/gtk/tmpl/gtkwidget.sgml +++ b/docs/reference/gtk/tmpl/gtkwidget.sgml @@ -1378,6 +1378,14 @@ GtkWidget @event: @Returns: +<!-- ##### SIGNAL GtkWidget::child-notify ##### --> +<para> + +</para> + +@widget: the object which received the signal. +@arg1: + <!-- ##### SIGNAL GtkWidget::client-event ##### --> <para> diff --git a/docs/reference/gtk/tmpl/gtkwindow.sgml b/docs/reference/gtk/tmpl/gtkwindow.sgml index 6f4ab3766..2f34d9feb 100644 --- a/docs/reference/gtk/tmpl/gtkwindow.sgml +++ b/docs/reference/gtk/tmpl/gtkwindow.sgml @@ -411,6 +411,7 @@ it's larger </para> @window: +@setting: <!-- ##### FUNCTION gtk_window_set_mnemonic_modifier ##### --> |