diff options
author | Matthias Clasen <maclas@gmx.de> | 2004-02-12 01:52:26 +0000 |
---|---|---|
committer | Matthias Clasen <matthiasc@src.gnome.org> | 2004-02-12 01:52:26 +0000 |
commit | 64aa39cd4f353dce0f5a62ce21ae80fc32706239 (patch) | |
tree | f1a621c92de7b878a8d65a5f04aee21f0de6979e /docs | |
parent | ab1f346aac4530edd896637e741f66a10cfbd229 (diff) | |
download | gtk+-64aa39cd4f353dce0f5a62ce21ae80fc32706239.tar.gz |
Correct the docs.
Thu Feb 12 02:22:02 2004 Matthias Clasen <maclas@gmx.de>
* gtk/gtktreemodelfilter.c (gtk_tree_model_filter_set_modify_func):
Correct the docs.
Thu Feb 12 02:00:53 2004 Matthias Clasen <maclas@gmx.de>
* gtk/tmpl/gtktreemodelfilter.sgml:
* gtk/tmpl/gtkentrycompletion.sgml:
* gtk/tmpl/gtkcelllayout.sgml: Additions.
Thu Feb 12 01:27:02 2004 Matthias Clasen <maclas@gmx.de>
* gtk/gtk-sections.txt: Updates.
Thu Feb 12 01:26:42 2004 Matthias Clasen <maclas@gmx.de>
* gtk/Makefile.am (IGNORE_HFILES): Add some private headers.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/reference/ChangeLog | 14 | ||||
-rw-r--r-- | docs/reference/gtk/Makefile.am | 4 | ||||
-rw-r--r-- | docs/reference/gtk/gtk-sections.txt | 14 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkcelllayout.sgml | 29 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkentrycompletion.sgml | 25 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtktreemodelfilter.sgml | 53 |
6 files changed, 106 insertions, 33 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index cf17da0d93..ac6cfe05bd 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,17 @@ +Thu Feb 12 02:00:53 2004 Matthias Clasen <maclas@gmx.de> + + * gtk/tmpl/gtktreemodelfilter.sgml: + * gtk/tmpl/gtkentrycompletion.sgml: + * gtk/tmpl/gtkcelllayout.sgml: Additions. + +Thu Feb 12 01:27:02 2004 Matthias Clasen <maclas@gmx.de> + + * gtk/gtk-sections.txt: Updates. + +Thu Feb 12 01:26:42 2004 Matthias Clasen <maclas@gmx.de> + + * gtk/Makefile.am (IGNORE_HFILES): Add some private headers. + Sat Feb 7 00:38:23 2004 Matthias Clasen <maclas@gmx.de> * gtk/gtk-sections.txt: Add GtkAccelMap, gtk_accel_map_get, diff --git a/docs/reference/gtk/Makefile.am b/docs/reference/gtk/Makefile.am index a40008fa1a..dc96cf3ed1 100644 --- a/docs/reference/gtk/Makefile.am +++ b/docs/reference/gtk/Makefile.am @@ -26,9 +26,13 @@ IGNORE_HFILES= \ fnmatch.h \ gdk-pixbuf-loader.h \ gtkcellrendererseptext.h \ + gtkcellview.h \ + gtkcellviewmenuitem.h \ gtkdebug.h \ + gtkentryprivate.h \ gtkfilechooserdefault.h \ gtkfilechooserentry.h \ + gtkfilechooserprivate.h \ gtkfilechooserutils.h \ gtkfilesystem.h \ gtkfilesystemmodel.h \ diff --git a/docs/reference/gtk/gtk-sections.txt b/docs/reference/gtk/gtk-sections.txt index ea0902f9f6..0607606eed 100644 --- a/docs/reference/gtk/gtk-sections.txt +++ b/docs/reference/gtk/gtk-sections.txt @@ -15,6 +15,7 @@ GtkAccelGroupFindFunc gtk_accel_group_disconnect gtk_accel_group_disconnect_key gtk_accel_group_query +gtk_accel_group_activate gtk_accel_group_lock gtk_accel_group_unlock gtk_accel_group_from_accel_closure @@ -59,7 +60,10 @@ gtk_accel_map_load_scanner gtk_accel_map_add_filter gtk_accel_map_foreach_unfiltered gtk_accel_map_get +gtk_accel_map_lock_path +gtk_accel_map_unlock_path <SUBSECTION Standard> +GTK_ACCEL_MAP GTK_TYPE_ACCEL_MAP GTK_IS_ACCEL_MAP GTK_ACCEL_MAP_CLASS @@ -1040,7 +1044,6 @@ GTK_ENTRY_COMPLETION_CLASS GTK_IS_ENTRY_COMPLETION GTK_IS_ENTRY_COMPLETION_CLASS GTK_ENTRY_COMPLETION_GET_CLASS -GTK_ENTRY_COMPLETION_GET_PRIVATE <SUBSECTION Private> GtkEntryCompletionPrivate gtk_entry_completion_get_type @@ -1175,6 +1178,7 @@ GtkFileChooserDialogPrivate <SECTION> <FILE>gtkfilechooserwidget</FILE> <TITLE>GtkFileChooserWidget</TITLE> +GtkFileChooserWidget gtk_file_chooser_widget_new <SUBSECTION Standard> GTK_FILE_CHOOSER_WIDGET @@ -3291,6 +3295,7 @@ GTK_SEPARATOR_TOOL_ITEM_GET_CLASS <SUBSECTION Private> gtk_separator_tool_item_get_type +GtkSeparatorToolItemPrivate </SECTION> <SECTION> @@ -3882,6 +3887,7 @@ GtkCellLayoutIface GtkCellLayoutDataFunc gtk_cell_layout_pack_start gtk_cell_layout_pack_end +gtk_cell_layout_reorder gtk_cell_layout_clear gtk_cell_layout_set_attributes gtk_cell_layout_add_attribute @@ -3906,6 +3912,7 @@ gtk_cell_renderer_get_size gtk_cell_renderer_render gtk_cell_renderer_activate gtk_cell_renderer_start_editing +gtk_cell_renderer_editing_canceled gtk_cell_renderer_get_fixed_size gtk_cell_renderer_set_fixed_size @@ -4229,6 +4236,7 @@ gtk_widget_add_accelerator gtk_widget_remove_accelerator gtk_widget_set_accel_path gtk_widget_list_accel_closures +gtk_widget_can_activate_accel gtk_widget_event gtk_widget_activate gtk_widget_reparent @@ -5075,8 +5083,10 @@ GTK_STOCK_GO_BACK GTK_STOCK_GO_DOWN GTK_STOCK_GO_FORWARD GTK_STOCK_GO_UP +GTK_STOCK_HARDDISK GTK_STOCK_HELP GTK_STOCK_HOME +GTK_STOCK_INDENT GTK_STOCK_INDEX GTK_STOCK_ITALIC GTK_STOCK_JUMP_TO @@ -5085,6 +5095,7 @@ GTK_STOCK_JUSTIFY_FILL GTK_STOCK_JUSTIFY_LEFT GTK_STOCK_JUSTIFY_RIGHT GTK_STOCK_MISSING_IMAGE +GTK_STOCK_NETWORK GTK_STOCK_NEW GTK_STOCK_NO GTK_STOCK_OK @@ -5111,6 +5122,7 @@ GTK_STOCK_STRIKETHROUGH GTK_STOCK_UNDELETE GTK_STOCK_UNDERLINE GTK_STOCK_UNDO +GTK_STOCK_UNINDENT GTK_STOCK_YES GTK_STOCK_ZOOM_100 GTK_STOCK_ZOOM_FIT diff --git a/docs/reference/gtk/tmpl/gtkcelllayout.sgml b/docs/reference/gtk/tmpl/gtkcelllayout.sgml index 39bf7c3209..10de4fc6fa 100644 --- a/docs/reference/gtk/tmpl/gtkcelllayout.sgml +++ b/docs/reference/gtk/tmpl/gtkcelllayout.sgml @@ -2,11 +2,13 @@ GtkCellLayout <!-- ##### SECTION Short_Description ##### --> - +An interface for packing cells <!-- ##### SECTION Long_Description ##### --> <para> - +#GtkCellLayout is an interface to be implemented by all objects which +want to provide a #GtkTreeViewColumn-like API for packing cells, setting +attributes and data funcs. </para> <!-- ##### SECTION See_Also ##### --> @@ -36,14 +38,15 @@ GtkCellLayout <!-- ##### USER_FUNCTION GtkCellLayoutDataFunc ##### --> <para> - +A function which should set the value of @cell_layout's cell renderer(s) +as appropriate. </para> -@cell_layout: -@cell: -@tree_model: -@iter: -@data: +@cell_layout: a #GtkCellLayout +@cell: the cell renderer whose value is to be set +@tree_model: the model +@iter: a #GtkTreeIter indicating the row to set the value for +@data: user data passed to gtk_cell_layout_set_cell_data_func() <!-- ##### FUNCTION gtk_cell_layout_pack_start ##### --> @@ -66,6 +69,16 @@ GtkCellLayout @expand: +<!-- ##### FUNCTION gtk_cell_layout_reorder ##### --> +<para> + +</para> + +@cell_layout: +@cell: +@position: + + <!-- ##### FUNCTION gtk_cell_layout_clear ##### --> <para> diff --git a/docs/reference/gtk/tmpl/gtkentrycompletion.sgml b/docs/reference/gtk/tmpl/gtkentrycompletion.sgml index 61214e1da9..7ead3a9edc 100644 --- a/docs/reference/gtk/tmpl/gtkentrycompletion.sgml +++ b/docs/reference/gtk/tmpl/gtkentrycompletion.sgml @@ -2,11 +2,17 @@ GtkEntryCompletion <!-- ##### SECTION Short_Description ##### --> - +completion functionality for GtkEntry <!-- ##### SECTION Long_Description ##### --> <para> - +#GtkEntryCompletion is an auxiliary object to be used in conjunction with +#GtkEntry to provide the completion functionality. It implements the +#GtkCellLayout interface, to allow the user to add extra cells to the +TreeView with completion matches. +</para> +<para> +To add completion functionality to an entry, use gtk_entry_set_completion(). </para> <!-- ##### SECTION See_Also ##### --> @@ -16,7 +22,7 @@ GtkEntryCompletion <!-- ##### STRUCT GtkEntryCompletion ##### --> <para> - +The GtkEntryCompletion struct contains only private data. </para> @@ -50,14 +56,15 @@ GtkEntryCompletion <!-- ##### USER_FUNCTION GtkEntryCompletionMatchFunc ##### --> <para> - +A function which decides whether the row indicated by @iter matches a given +@key, and should be displayed as a possible completion for @key. </para> -@completion: -@key: -@iter: -@user_data: -@Returns: +@completion: the #GtkEntryCompletion +@key: the string to match +@iter: a #GtkTreeIter indicating the row to match +@user_data: user data given to gtk_entry_completion_set_match_func() +@Returns: %TRUE if @iter should be displayed as a possible completion for @key <!-- ##### FUNCTION gtk_entry_completion_new ##### --> diff --git a/docs/reference/gtk/tmpl/gtktreemodelfilter.sgml b/docs/reference/gtk/tmpl/gtktreemodelfilter.sgml index 20af840a37..a1f7c56e94 100644 --- a/docs/reference/gtk/tmpl/gtktreemodelfilter.sgml +++ b/docs/reference/gtk/tmpl/gtktreemodelfilter.sgml @@ -2,21 +2,41 @@ GtkTreeModelFilter <!-- ##### SECTION Short_Description ##### --> - +A GtkTreeModel which hides parts of an underlying tree model <!-- ##### SECTION Long_Description ##### --> <para> - +A #GtkTreeModelFilter is a tree model which wraps another tree model, +and can do the following things: +<itemizedlist> +<listitem><para> +Filter specific rows, based on data from a "visible column", a column +storing booleans indicating whether the row should be filtered or not, +or based on the return value of a "visible function", which gets a +model, iter and user_data and returns a boolean indicating whether the +row should be filtered or not. +</para></listitem> +<listitem><para> +Modify the "appearance" of the model, using a modify function. +This is extremely powerful and allows for just changing +some values and also for creating a completely different model based on +the given child model. +</para></listitem> +<listitem><para> +Set a different root node, also known as a "virtual root". You can pass in +a #GtkTreePath indicating the root node for the filter at construction time. +</para></listitem> +</itemizedlist> </para> <!-- ##### SECTION See_Also ##### --> <para> - +#GtkTreeModelSort </para> <!-- ##### STRUCT GtkTreeModelFilter ##### --> <para> - +The GtkTreeModelFilter struct contains only private fields. </para> @@ -32,25 +52,28 @@ GtkTreeModelFilter <!-- ##### USER_FUNCTION GtkTreeModelFilterVisibleFunc ##### --> <para> - +A function which decides whether the row indicated by @iter is visible. </para> -@model: -@iter: -@data: -@Returns: +@model: the #GtkTreeModelFilter +@iter: a #GtkTreeIter pointing to the row whose visibility is determined +@data: user data given to gtk_tree_model_filter_set_visible_func() +@Returns: Whether the row indicated by @iter is visible. <!-- ##### USER_FUNCTION GtkTreeModelFilterModifyFunc ##### --> <para> - +A function which calculates display values from raw values in the model. +It must fill @value with the display value for the column @column in the +row indicated by @iter. </para> -@model: -@iter: -@value: -@column: -@data: +@model: the #GtkTreeModelFilter +@iter: a #GtkTreeIter pointing to the row whose display values are determined +@value: A #GValue which is already initialized for with the correct type for + the column @column. +@column: the column whose display value is determined +@data: user data given to gtk_tree_model_filter_set_modify_func() <!-- ##### FUNCTION gtk_tree_model_filter_new ##### --> |