diff options
author | Havoc Pennington <hp@redhat.com> | 2001-02-03 01:09:41 +0000 |
---|---|---|
committer | Havoc Pennington <hp@src.gnome.org> | 2001-02-03 01:09:41 +0000 |
commit | 2c5d938ff81480846539d9659dd92ca90cfb9e40 (patch) | |
tree | 023e97fe3fa238c3a2104859ac082b5f52505a43 /docs | |
parent | cc00e1c5ee5c8bb971d00b7bca465f257b989424 (diff) | |
download | gtk+-2c5d938ff81480846539d9659dd92ca90cfb9e40.tar.gz |
CVS is doing its broken pipe thing, this is more of the previous commit
2001-02-02 Havoc Pennington <hp@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/reference/ChangeLog | 22 | ||||
-rw-r--r-- | docs/reference/gtk/gtk-docs.sgml | 20 | ||||
-rw-r--r-- | docs/reference/gtk/gtk-sections.txt | 17 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtk-unused.sgml | 26 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkcurve.sgml | 9 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkgamma.sgml | 9 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkhruler.sgml | 9 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkiconfactory.sgml | 18 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkinputdialog.sgml | 10 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtklabel.sgml | 6 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkruler.sgml | 9 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkstatusbar.sgml | 9 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkstock.sgml | 8 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtktextbuffer.sgml | 12 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtktreeview.sgml | 12 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml | 27 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkvruler.sgml | 9 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkwidget.sgml | 2 |
18 files changed, 197 insertions, 37 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 89b57955c7..e327fbb904 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,25 @@ +2001-02-01 Havoc Pennington <hp@redhat.com> + + * gtk/gtk-sections.txt: updated + + * gtk/gtk-docs.sgml: Move the below from "Deprecated" section to + "special-purpose" section; move GtkItem out of deprecated section, + since GtkMenuItem uses it, though probably the GtkItem signals + should just migrate down to GtkMenuItem someday it won't happen + for 2.0 + + * gtk/tmpl/gtkgamma.sgml: add note about eventual removal + + * gtk/tmpl/gtkcurve.sgml: add note about eventual removal + + * gtk/tmpl/gtkruler.sgml: add note about eventual removal + + * gtk/tmpl/gtkhruler.sgml: add note about eventual removal + + * gtk/tmpl/gtkvruler.sgml: add note about eventual removal + + * gtk/tmpl/gtkinputdialog.sgml: add note about eventual removal + 2001-01-30 Havoc Pennington <hp@pobox.com> Also committed a bunch of automatic changes made by gtk-doc, diff --git a/docs/reference/gtk/gtk-docs.sgml b/docs/reference/gtk/gtk-docs.sgml index 4792e3d616..7f4bc58b41 100644 --- a/docs/reference/gtk/gtk-docs.sgml +++ b/docs/reference/gtk/gtk-docs.sgml @@ -357,10 +357,11 @@ An advanced widget set. <title>Abstract Base Classes</title> &GtkBin; &GtkBox; + &GtkButtonBox; &GtkContainer; >k-GtkEditable; &GtkOldEditable; - &GtkButtonBox; + &GtkItem; &GtkMisc; &GtkObject; &GtkPaned; @@ -376,27 +377,30 @@ An advanced widget set. &GtkSocket; </sect1> + <sect1 id="SpecialObjects"> + <title>Special-purpose features</title> + &GtkCurve; + &GtkGammaCurve; + &GtkHRuler; + &GtkRuler; + &GtkVRuler; + </sect1> + <sect1 id="DeprecatedObjects"> <title>Deprecated</title> &GtkCList; &GtkCTree; - &GtkCurve; &GtkData; - &GtkGammaCurve; - &GtkHRuler; - &GtkItem; &GtkList; &GtkListItem; &GtkPacker; &GtkPixmap; - &GtkPreview; &GtkProgress; - &GtkRuler; + &GtkPreview; &GtkText; &GtkTipsQuery; &GtkTree; &GtkTreeItem; - &GtkVRuler; </sect1> </chapter> diff --git a/docs/reference/gtk/gtk-sections.txt b/docs/reference/gtk/gtk-sections.txt index 8206ca5d98..02d47762a7 100644 --- a/docs/reference/gtk/gtk-sections.txt +++ b/docs/reference/gtk/gtk-sections.txt @@ -1143,7 +1143,6 @@ GTK_ITEM_FACTORY_GET_CLASS <FILE>gtklabel</FILE> <TITLE>GtkLabel</TITLE> GtkLabel -GtkLabelWord gtk_label_new gtk_label_set_text gtk_label_set_attributes @@ -1893,7 +1892,6 @@ GTK_SPIN_BUTTON_GET_CLASS <FILE>gtkstatusbar</FILE> <TITLE>GtkStatusbar</TITLE> GtkStatusbar -GtkStatusbarMsg gtk_statusbar_new gtk_statusbar_get_context_id gtk_statusbar_push @@ -2525,16 +2523,13 @@ gtk_tree_store_set_n_columns gtk_tree_store_set_column_type gtk_tree_store_set_cell gtk_tree_store_set -gtk_tree_store_setv gtk_tree_store_get -gtk_tree_store_getv gtk_tree_store_remove gtk_tree_store_insert gtk_tree_store_insert_before gtk_tree_store_insert_after gtk_tree_store_prepend gtk_tree_store_append -gtk_tree_store_get_root_iter gtk_tree_store_is_ancestor gtk_tree_store_iter_depth <SUBSECTION Standard> @@ -2562,8 +2557,8 @@ gtk_tree_view_column_set_cell_data gtk_tree_view_column_set_visible gtk_tree_view_column_get_visible gtk_tree_view_column_set_sizing -gtk_tree_view_column_get_col_type -gtk_tree_view_column_get_size +gtk_tree_view_column_get_sizing +gtk_tree_view_column_get_width gtk_tree_view_column_set_width gtk_tree_view_column_set_min_width gtk_tree_view_column_get_min_width @@ -2571,7 +2566,7 @@ gtk_tree_view_column_set_max_width gtk_tree_view_column_get_max_width gtk_tree_view_column_set_title gtk_tree_view_column_get_title -gtk_tree_view_column_set_header_clickable +gtk_tree_view_column_set_clickable gtk_tree_view_column_set_widget gtk_tree_view_column_get_widget gtk_tree_view_column_set_justification @@ -2608,7 +2603,7 @@ gtk_tree_view_append_column gtk_tree_view_remove_column gtk_tree_view_insert_column gtk_tree_view_get_column -gtk_tree_view_move_to +gtk_tree_view_scroll_to_cell gtk_tree_view_get_path_at_pos gtk_tree_view_expand_all gtk_tree_view_collapse_all @@ -2637,7 +2632,7 @@ gtk_tree_model_simple_deleted <SUBSECTION Standard> GTK_TREE_MODEL_SIMPLE GTK_IS_TREE_MODEL_SIMPLE -GTK_TYPE_MODEL_SIMPLE +GTK_TYPE_TREE_MODEL_SIMPLE gtk_tree_model_simple_get_type GTK_TREE_MODEL_SIMPLE_CLASS GTK_IS_TREE_MODEL_SIMPLE_CLASS @@ -3002,7 +2997,7 @@ gtk_widget_modify_font gtk_widget_create_pango_context gtk_widget_get_pango_context gtk_widget_create_pango_layout -gtk_widget_render_stock_icon +gtk_widget_render_icon gtk_widget_pop_composite_child gtk_widget_push_composite_child gtk_widget_queue_clear diff --git a/docs/reference/gtk/tmpl/gtk-unused.sgml b/docs/reference/gtk/tmpl/gtk-unused.sgml index 25cbfa812d..7f37ff2cab 100644 --- a/docs/reference/gtk/tmpl/gtk-unused.sgml +++ b/docs/reference/gtk/tmpl/gtk-unused.sgml @@ -1626,6 +1626,26 @@ Given the type of an object and a pointer to it, the object is freed. </para> +<!-- ##### STRUCT GtkStatusbarMsg ##### --> +<para> +Holds the data for a statusbar message. <structfield>text</structfield> holds the actual text string. <structfield>context_id</structfield> is the context that this message is associated with, and <structfield>message_id</structfield> is this particular message's identifier. However, these fields should not be modified directly. +</para> + +@text: +@context_id: +@message_id: + +<!-- ##### FUNCTION gtk_widget_render_stock_icon ##### --> +<para> + +</para> + +@widget: +@stock_id: +@size: +@detail: +@Returns: + <!-- ##### SECTION ./tmpl/gtkprivate.sgml:Title ##### --> Private Information @@ -1943,6 +1963,12 @@ be used to bypass it. </para> +<!-- ##### STRUCT GtkLabelWord ##### --> +<para>
+Internal to #GtkLabel.
+</para> + + <!-- ##### FUNCTION gtk_text_buffer_spew ##### --> <para> diff --git a/docs/reference/gtk/tmpl/gtkcurve.sgml b/docs/reference/gtk/tmpl/gtkcurve.sgml index 919f6295f5..8701b8517d 100644 --- a/docs/reference/gtk/tmpl/gtkcurve.sgml +++ b/docs/reference/gtk/tmpl/gtkcurve.sgml @@ -6,6 +6,15 @@ allows direct editing of a curve. <!-- ##### SECTION Long_Description ##### --> <para> + NOTE this widget is considered too specialized/little-used for + GTK+, and will in the future be moved to some other package. If + your application needs this widget, feel free to use it, as the + widget does work and is useful in some applications; it's just not + of general interest. However, we are not accepting new features for + the widget, and it will eventually move out of the GTK+ + distribution. +</para> +<para> The #GtkCurve widget allows the user to edit a curve covering a range of values. It is typically used to fine-tune color balances in graphics applications like the Gimp. diff --git a/docs/reference/gtk/tmpl/gtkgamma.sgml b/docs/reference/gtk/tmpl/gtkgamma.sgml index 28f392d5c1..a3326cee5f 100644 --- a/docs/reference/gtk/tmpl/gtkgamma.sgml +++ b/docs/reference/gtk/tmpl/gtkgamma.sgml @@ -6,6 +6,15 @@ a subclass of #GtkCurve for editing gamma curves. <!-- ##### SECTION Long_Description ##### --> <para> + NOTE this widget is considered too specialized/little-used for + GTK+, and will in the future be moved to some other package. If + your application needs this widget, feel free to use it, as the + widget does work and is useful in some applications; it's just not + of general interest. However, we are not accepting new features for + the widget, and it will eventually move out of the GTK+ + distribution. +</para> +<para> The #GtkGammaCurve widget is a subclass of #GtkCurve specifically for editing gamma curves, which are used in graphics applications such as the Gimp. diff --git a/docs/reference/gtk/tmpl/gtkhruler.sgml b/docs/reference/gtk/tmpl/gtkhruler.sgml index e6ceadc291..ef99f9b00b 100644 --- a/docs/reference/gtk/tmpl/gtkhruler.sgml +++ b/docs/reference/gtk/tmpl/gtkhruler.sgml @@ -6,6 +6,15 @@ A horizontal ruler. <!-- ##### SECTION Long_Description ##### --> <para> + NOTE this widget is considered too specialized/little-used for + GTK+, and will in the future be moved to some other package. If + your application needs this widget, feel free to use it, as the + widget does work and is useful in some applications; it's just not + of general interest. However, we are not accepting new features for + the widget, and it will eventually move out of the GTK+ + distribution. +</para> +<para> The HRuler widget is a widget arranged horizontally creating a ruler that is utilized around other widgets such as a text widget. The ruler is used to show the location of the mouse on the window and to show the size of the window in diff --git a/docs/reference/gtk/tmpl/gtkiconfactory.sgml b/docs/reference/gtk/tmpl/gtkiconfactory.sgml index 933586279b..d617f266bb 100644 --- a/docs/reference/gtk/tmpl/gtkiconfactory.sgml +++ b/docs/reference/gtk/tmpl/gtkiconfactory.sgml @@ -3,10 +3,28 @@ Themeable Stock Images <!-- ##### SECTION Short_Description ##### --> +Manipulating stock icons <!-- ##### SECTION Long_Description ##### --> <para> + An icon factory manages a collection of #GtkIconSet; a #GtkIconSet manages a + set of variants of a particular icon (i.e. a #GtkIconSet contains variants for + different sizes and widget states). Icons in an icon factory are named by a + stock ID, which is a simple string identifying the icon. Each #GtkStyle has a + list of #GtkIconFactory derived from the current theme; those icon factories + are consulted first when searching for an icon. If the theme doesn't set a + particular icon, GTK+ looks for the icon in a list of default icon factories, + maintained by gtk_icon_factory_add_default() and + gtk_icon_factory_remove_default(). Applications with icons should add a default + icon factory with their icons, which will allow themes to override the icons + for the application. +</para> +<para> +To display an icon, always use gtk_style_lookup_icon_set() on the widget that +will display the icon, or the convenience function +gtk_widget_render_icon(). These functions take the theme into account when +looking up the icon to use for a given stock ID. </para> <!-- ##### SECTION See_Also ##### --> diff --git a/docs/reference/gtk/tmpl/gtkinputdialog.sgml b/docs/reference/gtk/tmpl/gtkinputdialog.sgml index 2abb5bc1a6..436f014e0f 100644 --- a/docs/reference/gtk/tmpl/gtkinputdialog.sgml +++ b/docs/reference/gtk/tmpl/gtkinputdialog.sgml @@ -6,6 +6,16 @@ Configure devices for the XInput extension. <!-- ##### SECTION Long_Description ##### --> <para> + NOTE this widget is considered too specialized/little-used for + GTK+, and will in the future be moved to some other package. If + your application needs this widget, feel free to use it, as the + widget does work and is useful in some applications; it's just not + of general interest. However, we are not accepting new features for + the widget, and it will eventually move out of the GTK+ + distribution. +</para> + +<para> #GtkInputDialog displays a dialog which allows the user to configure XInput extension devices. For each device, they can control the mode of the device diff --git a/docs/reference/gtk/tmpl/gtklabel.sgml b/docs/reference/gtk/tmpl/gtklabel.sgml index f26cf204ca..921328c1fc 100644 --- a/docs/reference/gtk/tmpl/gtklabel.sgml +++ b/docs/reference/gtk/tmpl/gtklabel.sgml @@ -24,12 +24,6 @@ described below. </para> -<!-- ##### STRUCT GtkLabelWord ##### --> -<para>
-Internal to #GtkLabel.
-</para> - - <!-- ##### FUNCTION gtk_label_new ##### --> <para>
Creates a new label with the given string of text inside it. You can
diff --git a/docs/reference/gtk/tmpl/gtkruler.sgml b/docs/reference/gtk/tmpl/gtkruler.sgml index 679d284306..ab4af18d3d 100644 --- a/docs/reference/gtk/tmpl/gtkruler.sgml +++ b/docs/reference/gtk/tmpl/gtkruler.sgml @@ -6,6 +6,15 @@ Base class for horizontal or vertical rulers <!-- ##### SECTION Long_Description ##### --> <para> + NOTE this widget is considered too specialized/little-used for + GTK+, and will in the future be moved to some other package. If + your application needs this widget, feel free to use it, as the + widget does work and is useful in some applications; it's just not + of general interest. However, we are not accepting new features for + the widget, and it will eventually move out of the GTK+ + distribution. +</para> +<para> The GTKRuler widget is a base class for horizontal and vertical rulers. Rulers are used to show the mouse pointer's location in a window. The ruler can either be horizontal or vertical on the window. Within the ruler a small triangle diff --git a/docs/reference/gtk/tmpl/gtkstatusbar.sgml b/docs/reference/gtk/tmpl/gtkstatusbar.sgml index 09e7b1dd2e..c4b37a46eb 100644 --- a/docs/reference/gtk/tmpl/gtkstatusbar.sgml +++ b/docs/reference/gtk/tmpl/gtkstatusbar.sgml @@ -50,15 +50,6 @@ Contains private data that should be modified with the functions described below </para> -<!-- ##### STRUCT GtkStatusbarMsg ##### --> -<para> -Holds the data for a statusbar message. <structfield>text</structfield> holds the actual text string. <structfield>context_id</structfield> is the context that this message is associated with, and <structfield>message_id</structfield> is this particular message's identifier. However, these fields should not be modified directly. -</para> - -@text: -@context_id: -@message_id: - <!-- ##### FUNCTION gtk_statusbar_new ##### --> <para> Creates a new #GtkStatusbar ready for messages. diff --git a/docs/reference/gtk/tmpl/gtkstock.sgml b/docs/reference/gtk/tmpl/gtkstock.sgml index 24280e4b5c..0345dc380e 100644 --- a/docs/reference/gtk/tmpl/gtkstock.sgml +++ b/docs/reference/gtk/tmpl/gtkstock.sgml @@ -30,8 +30,10 @@ Stock Items </para> -@item: +@items: @n_items: +<!-- # Unused Parameters # --> +@item: <!-- ##### FUNCTION gtk_stock_add_static ##### --> @@ -39,8 +41,10 @@ Stock Items </para> -@item: +@items: @n_items: +<!-- # Unused Parameters # --> +@item: <!-- ##### FUNCTION gtk_stock_item_copy ##### --> diff --git a/docs/reference/gtk/tmpl/gtktextbuffer.sgml b/docs/reference/gtk/tmpl/gtktextbuffer.sgml index 64ad8b4001..980fb9c0fa 100644 --- a/docs/reference/gtk/tmpl/gtktextbuffer.sgml +++ b/docs/reference/gtk/tmpl/gtktextbuffer.sgml @@ -334,6 +334,9 @@ types related to the text widget and how they work together. @buffer: @tag: +@start: +@end: +<!-- # Unused Parameters # --> @start_index: @end_index: @@ -345,6 +348,9 @@ types related to the text widget and how they work together. @buffer: @tag: +@start: +@end: +<!-- # Unused Parameters # --> @start_index: @end_index: @@ -356,6 +362,9 @@ types related to the text widget and how they work together. @buffer: @name: +@start: +@end: +<!-- # Unused Parameters # --> @start_index: @end_index: @@ -367,6 +376,9 @@ types related to the text widget and how they work together. @buffer: @name: +@start: +@end: +<!-- # Unused Parameters # --> @start_index: @end_index: diff --git a/docs/reference/gtk/tmpl/gtktreeview.sgml b/docs/reference/gtk/tmpl/gtktreeview.sgml index aaf95374b1..83b41ba5ab 100644 --- a/docs/reference/gtk/tmpl/gtktreeview.sgml +++ b/docs/reference/gtk/tmpl/gtktreeview.sgml @@ -203,6 +203,18 @@ GtkTreeView @Returns: +<!-- ##### FUNCTION gtk_tree_view_scroll_to_cell ##### --> +<para> + +</para> + +@tree_view: +@path: +@column: +@row_align: +@col_align: + + <!-- ##### FUNCTION gtk_tree_view_get_path_at_pos ##### --> <para> diff --git a/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml b/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml index ff4911e87f..11ebd19021 100644 --- a/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml +++ b/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml @@ -151,6 +151,24 @@ GtkTreeViewColumn @type: +<!-- ##### FUNCTION gtk_tree_view_column_get_sizing ##### --> +<para> + +</para> + +@tree_column: +@Returns: + + +<!-- ##### FUNCTION gtk_tree_view_column_get_width ##### --> +<para> + +</para> + +@tree_column: +@Returns: + + <!-- ##### FUNCTION gtk_tree_view_column_set_width ##### --> <para> @@ -214,6 +232,15 @@ GtkTreeViewColumn @Returns: +<!-- ##### FUNCTION gtk_tree_view_column_set_clickable ##### --> +<para> + +</para> + +@tree_column: +@active: + + <!-- ##### FUNCTION gtk_tree_view_column_set_widget ##### --> <para> diff --git a/docs/reference/gtk/tmpl/gtkvruler.sgml b/docs/reference/gtk/tmpl/gtkvruler.sgml index aad5d12e25..15f4980121 100644 --- a/docs/reference/gtk/tmpl/gtkvruler.sgml +++ b/docs/reference/gtk/tmpl/gtkvruler.sgml @@ -6,6 +6,15 @@ A vertical ruler. <!-- ##### SECTION Long_Description ##### --> <para> + NOTE this widget is considered too specialized/little-used for + GTK+, and will in the future be moved to some other package. If + your application needs this widget, feel free to use it, as the + widget does work and is useful in some applications; it's just not + of general interest. However, we are not accepting new features for + the widget, and it will eventually move out of the GTK+ + distribution. +</para> +<para> The VRuler widget is a widget arranged vertically creating a ruler that is utilized around other widgets such as a text widget. The ruler is used to show the location of the mouse on the window and to show the size of the window in diff --git a/docs/reference/gtk/tmpl/gtkwidget.sgml b/docs/reference/gtk/tmpl/gtkwidget.sgml index 2790ec369f..9180b2ede4 100644 --- a/docs/reference/gtk/tmpl/gtkwidget.sgml +++ b/docs/reference/gtk/tmpl/gtkwidget.sgml @@ -1142,7 +1142,7 @@ GtkWidget @Returns: -<!-- ##### FUNCTION gtk_widget_render_stock_icon ##### --> +<!-- ##### FUNCTION gtk_widget_render_icon ##### --> <para> </para> |