From 7b0e05fcca7607292e3fd0c94b7236ca45577641 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Mon, 16 May 2005 18:16:42 +0000 Subject: [PATCH] Use gtk-doc abbrevs instead of spelled out links. 2005-05-16 Matthias Clasen * gtk/tree_widget.sgml: Use gtk-doc abbrevs instead of spelled out links. * gtk/gtk-docs.sgml: Included the processed file xml/tree_widget.sgml. * gtk/Makefile.am (expand_content_files): Add tree_widget.sgml. --- ChangeLog | 2 + ChangeLog.pre-2-10 | 2 + ChangeLog.pre-2-8 | 2 + configure.in | 2 +- docs/reference/ChangeLog | 9 +++ docs/reference/gtk/Makefile.am | 3 + docs/reference/gtk/gtk-docs.sgml | 2 +- docs/reference/gtk/tree_widget.sgml | 96 ++++++++++++----------------- 8 files changed, 61 insertions(+), 57 deletions(-) diff --git a/ChangeLog b/ChangeLog index fa62e34792..587146eecc 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,7 @@ 2005-05-16 Matthias Clasen + * configure.in (GTK_DOC_CHECK): Check for gtk-doc 1.4. + * gtk/gtktoggleaction.c (connect_proxy): Be more careful when casting. (#304089, Philip Langdale) diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10 index fa62e34792..587146eecc 100644 --- a/ChangeLog.pre-2-10 +++ b/ChangeLog.pre-2-10 @@ -1,5 +1,7 @@ 2005-05-16 Matthias Clasen + * configure.in (GTK_DOC_CHECK): Check for gtk-doc 1.4. + * gtk/gtktoggleaction.c (connect_proxy): Be more careful when casting. (#304089, Philip Langdale) diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8 index fa62e34792..587146eecc 100644 --- a/ChangeLog.pre-2-8 +++ b/ChangeLog.pre-2-8 @@ -1,5 +1,7 @@ 2005-05-16 Matthias Clasen + * configure.in (GTK_DOC_CHECK): Check for gtk-doc 1.4. + * gtk/gtktoggleaction.c (connect_proxy): Be more careful when casting. (#304089, Philip Langdale) diff --git a/configure.in b/configure.in index fb613fe07c..6259965607 100644 --- a/configure.in +++ b/configure.in @@ -1543,7 +1543,7 @@ fi # Checks for gtk-doc and docbook-tools ################################################## -GTK_DOC_CHECK([1.0]) +GTK_DOC_CHECK([1.4]) AC_CHECK_PROG(DB2HTML, db2html, true, false) AM_CONDITIONAL(HAVE_DOCBOOK, $DB2HTML) diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 366d7a7081..650c58dc08 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,12 @@ +2005-05-16 Matthias Clasen + + * gtk/tree_widget.sgml: Use gtk-doc abbrevs instead of + spelled out links. + + * gtk/gtk-docs.sgml: Included the processed file xml/tree_widget.sgml. + + * gtk/Makefile.am (expand_content_files): Add tree_widget.sgml. + 2005-05-08 Matthias Clasen * gdk/tmpl/visuals.sgml: Fix a typo (#303473, Masao Mutoh) diff --git a/docs/reference/gtk/Makefile.am b/docs/reference/gtk/Makefile.am index e7b32b5218..98955f5232 100644 --- a/docs/reference/gtk/Makefile.am +++ b/docs/reference/gtk/Makefile.am @@ -110,6 +110,9 @@ content_files = \ gtk-update-icon-cache.xml \ visual_index.xml +expand_content_files = \ + tree_widget.sgml + # Images to copy into HTML directory HTML_IMAGES = \ $(top_srcdir)/gtk/stock-icons/stock_about_24.png \ diff --git a/docs/reference/gtk/gtk-docs.sgml b/docs/reference/gtk/gtk-docs.sgml index 64de5b1ec4..5903ee2dc3 100644 --- a/docs/reference/gtk/gtk-docs.sgml +++ b/docs/reference/gtk/gtk-docs.sgml @@ -176,7 +176,7 @@ - + diff --git a/docs/reference/gtk/tree_widget.sgml b/docs/reference/gtk/tree_widget.sgml index 43463e340d..d713e31bd6 100644 --- a/docs/reference/gtk/tree_widget.sgml +++ b/docs/reference/gtk/tree_widget.sgml @@ -7,18 +7,15 @@ Tree and List Widget Overview - Overview of GtkTreeModel, GtkTreeView, and other associated widgets + Overview of #GtkTreeModel, #GtkTreeView, and other + associated widgets Overview - To create a tree or list in GTK+, use the GtkTreeModel interface in - conjunction with the GtkTreeView widget. This widget is + To create a tree or list in GTK+, use the #GtkTreeModel interface in + conjunction with the #GtkTreeView widget. This widget is designed around a Model/View/Controller design and consists of four major parts: @@ -46,13 +43,12 @@ Creating a model - GTK+ provides two simple models that can be used: the GtkListStore and the GtkTreeStore. GtkListStore is used - to model list widgets, while the GtkTreeStore models trees. It - is possible to develop a new type of model, but the existing - models should be satisfactory for all but the most specialized of - situations. Creating the model is quite simple: + GTK+ provides two simple models that can be used: the #GtkListStore + and the #GtkTreeStore. GtkListStore is used to model list widgets, + while the GtkTreeStore models trees. It is possible to develop a new + type of model, but the existing models should be satisfactory for all + but the most specialized of situations. Creating the model is quite + simple: - Adding data to the model is done using - gtk_tree_store_set() or - gtk_list_store_set(), depending upon which sort of model was - created. To do this, a GtkTreeIter must - be acquired. The iterator points to the location where data will be added. + Adding data to the model is done using gtk_tree_store_set() or + gtk_list_store_set(), depending upon which sort of model was + created. To do this, a #GtkTreeIter must be acquired. The iterator + points to the location where data will be added. - Once an iterator has been acquired, - gtk_tree_store_set() is used to apply data to the part of the model - that the iterator points to. Consider the following example: + Once an iterator has been acquired, gtk_tree_store_set() is used to + apply data to the part of the model that the iterator points to. + Consider the following example: - The third argument to gtk_tree_store_append() is the parent iterator. It + The third argument to gtk_tree_store_append() is the parent iterator. It is used to add a row to a GtkTreeStore as a child of an existing row. This means that the new row will only be visible when its parent is visible and in its expanded state. Consider the following example: @@ -148,11 +143,9 @@ gtk_tree_store_set (store, &iter2, While there are several different models to choose from, there is only one view widget to deal with. It works with either the list - or the tree store. Setting up a GtkTreeView is not a difficult - matter. It needs a GtkTreeModel to know where to - retrieve its data from. + or the tree store. Setting up a #GtkTreeView is not a difficult + matter. It needs a #GtkTreeModel to know where to retrieve its data + from. Columns and cell renderers - Once the GtkTreeView widget - has a model, it will need to know how to display the model. It - does this with columns and cell renderers. + Once the #GtkTreeView widget has a model, it will need to know how + to display the model. It does this with columns and cell renderers. Cell renderers are used to draw the data in the tree model in a way. There are a number of cell renderers that come with GTK+ 2.x, - including the GtkCellRendererText, GtkCellRendererPixbuf and - the GtkCellRendererToggle. + including the #GtkCellRendererText, #GtkCellRendererPixbuf and + the #GtkCellRendererToggle. It is relatively easy to write a custom renderer. - A GtkTreeViewColumn is the - object that GtkTreeView uses to organize the vertical columns in - the tree view. It needs to know the name of the column to label - for the user, what type of cell renderer to use, and which piece of - data to retrieve from the model for a given row. + A #GtkTreeViewColumn is the object that GtkTreeView uses to organize + the vertical columns in the tree view. It needs to know the name of + the column to label for the user, what type of cell renderer to use, + and which piece of data to retrieve from the model for a given row. ); column = gtk_tree_view_column_new_with_attributes ("Author", renderer, "text", AUTHOR_COLUMN, @@ -205,9 +193,9 @@ gtk_tree_view_append_column (GTK_TREE_VIEW (tree), column); Selection handling - Most applications will need to not only deal with displaying data, but also - receiving input events from users. To do this, simply get a reference to - a selection object and connect to the "changed" signal. + Most applications will need to not only deal with displaying data, but + also receiving input events from users. To do this, simply get a + reference to a selection object and connect to the "changed" signal. Simple Example - Here is a simple example of using a GtkTreeView widget in context of the - other widgets. It simply creates a simple model and view, and - puts them together. Note that the model is never populated with - data — that is left as an exercise for the reader. More - information can be found on this in the GtkTreeModel section. + Here is a simple example of using a #GtkTreeView widget in context + of the other widgets. It simply creates a simple model and view, + and puts them together. Note that the model is never populated + with data — that is left as an exercise for the reader. + More information can be found on this in the #GtkTreeModel section. ); g_object_set (G_OBJECT (renderer), "foreground", "red", NULL); @@ -307,7 +293,7 @@ setup_tree (void) gtk_tree_view_append_column (GTK_TREE_VIEW (tree), column); /* Second column.. title of the book. */ - renderer = gtk_cell_renderer_text_new (); + renderer = gtk_cell_renderer_text_new (); column = gtk_tree_view_column_new_with_attributes ("Title", renderer, "text", TITLE_COLUMN, @@ -315,7 +301,7 @@ setup_tree (void) gtk_tree_view_append_column (GTK_TREE_VIEW (tree), column); /* Last column.. whether a book is checked out. */ - renderer = gtk_cell_renderer_toggle_new (); + renderer = gtk_cell_renderer_toggle_new (); column = gtk_tree_view_column_new_with_attributes ("Checked out", renderer, "active", CHECKED_COLUMN, -- GitLab