diff options
author | Matthias Clasen <mclasen@redhat.com> | 2004-11-02 07:06:02 +0000 |
---|---|---|
committer | Matthias Clasen <matthiasc@src.gnome.org> | 2004-11-02 07:06:02 +0000 |
commit | be5ee811e6f1a1f22c57f3afc7320fb2fc521ce6 (patch) | |
tree | dc4f5cc365323048055b827b0b60f3252c3b15ee /docs | |
parent | f4ad581e96c95b7e481b3747250b974cd194818b (diff) | |
download | gtk+-be5ee811e6f1a1f22c57f3afc7320fb2fc521ce6.tar.gz |
Doc additions.
2004-11-02 Matthias Clasen <mclasen@redhat.com>
* gtk/gtkcellrenderercombo.c (gtk_cell_renderer_combo_class_init):
Doc additions.
2004-11-02 Matthias Clasen <mclasen@redhat.com>
* gtk/tmpl/gtkcellrenderercombo.sgml:
* gtk/tmpl/gtkcellrenderertoggle.sgml:
* gtk/tmpl/gtkcellrenderertext.sgml: Add introductions.
* gtk/tmpl/gtkcellrenderer.sgml: Additions.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/reference/ChangeLog | 6 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkcellrenderer.sgml | 15 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkcellrenderercombo.sgml | 13 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkcellrendererpixbuf.sgml | 24 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkcellrenderertext.sgml | 8 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkcellrenderertoggle.sgml | 5 |
6 files changed, 56 insertions, 15 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index a8e95fd19b..cf4d3e9c4c 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,5 +1,11 @@ 2004-11-02 Matthias Clasen <mclasen@redhat.com> + * gtk/tmpl/gtkcellrenderercombo.sgml: + * gtk/tmpl/gtkcellrenderertoggle.sgml: + * gtk/tmpl/gtkcellrenderertext.sgml: Add introductions. + + * gtk/tmpl/gtkcellrenderer.sgml: Additions. + * gtk/gtk-sections.txt: Remove GtkFileChooserEmbed, since it is not in the headers we parse. diff --git a/docs/reference/gtk/tmpl/gtkcellrenderer.sgml b/docs/reference/gtk/tmpl/gtkcellrenderer.sgml index 47d16ece1e..fc27be321b 100644 --- a/docs/reference/gtk/tmpl/gtkcellrenderer.sgml +++ b/docs/reference/gtk/tmpl/gtkcellrenderer.sgml @@ -19,8 +19,8 @@ elements on a #GdkDrawable. Typically, one cell renderer is used to draw many cells on the screen. To this extent, it isn't expected that a CellRenderer keep any permanent state around. Instead, any state is set just prior to use using #GObject<!-- -->s property system. Then, the -cell is measured using @gtk_cell_renderer_get_size. Finally, the cell -is rendered in the correct location using @gtk_cell_renderer_render. +cell is measured using gtk_cell_renderer_get_size(). Finally, the cell +is rendered in the correct location using gtk_cell_renderer_render(). </para> <para> @@ -31,6 +31,17 @@ barring a #GtkStyle change. The #GtkCellRenderer also has a number of generic properties that are expected to be honored by all children. </para> +<para> +Beyond merely rendering a cell, cell renderers can optionally +provide active user interface elements. A cell renderer can be +<firstterm>activatable</firstterm> like #GtkCellRendererToggle, +which toggles when it gets activated by a mouse click, or it can be +<firstterm>editable</firstterm> like #GtkCellRendererText, which +allows the user to edit the text using a #GtkEntry. +To make a cell renderer activatable or editable, you have to +implement the @activate or @start_editing virtual functions, +respectively. +</para> <!-- ##### SECTION See_Also ##### --> <para> #GtkCellRendererText,#GtkCellRendererPixbuf,#GtkCellRendererToggle diff --git a/docs/reference/gtk/tmpl/gtkcellrenderercombo.sgml b/docs/reference/gtk/tmpl/gtkcellrenderercombo.sgml index e0353c1119..fa9490e7e9 100644 --- a/docs/reference/gtk/tmpl/gtkcellrenderercombo.sgml +++ b/docs/reference/gtk/tmpl/gtkcellrenderercombo.sgml @@ -2,11 +2,22 @@ GtkCellRendererCombo <!-- ##### SECTION Short_Description ##### --> - +Renders a combobox in a cell <!-- ##### SECTION Long_Description ##### --> <para> +#GtkCellRendererCombo renders text in a cell like #GtkCellRendererText from which it +is derived. But while #GtkCellRendererText offers a simple entry to edit the text, +#GtkCellRendererCombo offers a #GtkComboBox or #GtkComboBoxEntry widget to edit +the text. The values to display in the combo box are taken from the tree model +specified in the <link linkend="GtkCellRendererCombo--model">model</link> property. +</para> +<para> +The combo cell renderer takes care of adding a text cell renderer to the combo box +and sets it to display the column specified by its +<link linkend="GtkCellRendererCombo--text-column">text-column</link> property. Further +cell renderers can be added in a handler for the editing-started signal. </para> <!-- ##### SECTION See_Also ##### --> diff --git a/docs/reference/gtk/tmpl/gtkcellrendererpixbuf.sgml b/docs/reference/gtk/tmpl/gtkcellrendererpixbuf.sgml index b574076f70..7ff0da00d1 100644 --- a/docs/reference/gtk/tmpl/gtkcellrendererpixbuf.sgml +++ b/docs/reference/gtk/tmpl/gtkcellrendererpixbuf.sgml @@ -7,20 +7,22 @@ Renders a pixbuf in a cell <!-- ##### SECTION Long_Description ##### --> <para> A #GtkCellRendererPixbuf can be used to render an image in a cell. It allows to render -either a given #GdkPixbuf (set via the <link linkend="GtkCellRendererPixbuf--pixbuf">pixbuf</link> -property) or a stock icon (set via the <link linkend="GtkCellRendererPixbuf--stock-id">stock-id</link> -property). +either a given #GdkPixbuf (set via the +<link linkend="GtkCellRendererPixbuf--pixbuf">pixbuf</link> property) or a stock icon +(set via the <link linkend="GtkCellRendererPixbuf--stock-id">stock-id</link> property). </para> <para> -To support the tree view, #GtkCellRendererPixbuf also supports rendering two alternative pixbufs, -when the <link linkend="GtkCellRenderer--is-expander">is-expander</link> property is %TRUE. -If the <link linkend="GtkCellRenderer--is-expander">is-expander</link> property is %TRUE and -the <link linkend="GtkCellRendererPixbuf--pixbuf-expander-open">pixbuf-expander-open</link> property -is set to a pixbuf, it renders that pixbuf, if the -<link linkend="GtkCellRenderer--is-expander">is-expander</link> property is %FALSE and -the <link linkend="GtkCellRendererPixbuf--pixbuf-expander-closed">pixbuf-expander-closed</link> property -is set to a pixbuf, it renders that one. +To support the tree view, #GtkCellRendererPixbuf also supports rendering two alternative +pixbufs, when the <link linkend="GtkCellRenderer--is-expander">is-expander</link> property +is %TRUE. If the <link linkend="GtkCellRenderer--is-expanded">is-expanded</link> property +is %TRUE and the +<link linkend="GtkCellRendererPixbuf--pixbuf-expander-open">pixbuf-expander-open</link> +property is set to a pixbuf, it renders that pixbuf, if the +<link linkend="GtkCellRenderer--is-expanded">is-expanded</link> property is %FALSE and +the +<link linkend="GtkCellRendererPixbuf--pixbuf-expander-closed">pixbuf-expander-closed</link> +property is set to a pixbuf, it renders that one. </para> <!-- ##### SECTION See_Also ##### --> diff --git a/docs/reference/gtk/tmpl/gtkcellrenderertext.sgml b/docs/reference/gtk/tmpl/gtkcellrenderertext.sgml index 572408a34d..1dcd31fc04 100644 --- a/docs/reference/gtk/tmpl/gtkcellrenderertext.sgml +++ b/docs/reference/gtk/tmpl/gtkcellrenderertext.sgml @@ -6,7 +6,15 @@ Renders text in a cell <!-- ##### SECTION Long_Description ##### --> <para> +A #GtkCellRendererText renders a given text in its cell, using the font, color and +style information provided by its properties. The text will be ellipsized if it is +too long and the <link linkend="GtkCellRendererText--ellipsize">ellipsize</link> +property allows it. +</para> +<para> +If the <link linkend="GtkCellRenderer--mode">mode</link> is %GTK_CELL_RENDERER_MODE_EDITABLE, +the #GtkCellRendererText allows to edit its text using an entry. </para> <!-- ##### SECTION See_Also ##### --> diff --git a/docs/reference/gtk/tmpl/gtkcellrenderertoggle.sgml b/docs/reference/gtk/tmpl/gtkcellrenderertoggle.sgml index 12f75faf9d..34c49b336a 100644 --- a/docs/reference/gtk/tmpl/gtkcellrenderertoggle.sgml +++ b/docs/reference/gtk/tmpl/gtkcellrenderertoggle.sgml @@ -6,7 +6,10 @@ Renders a toggle button in a cell <!-- ##### SECTION Long_Description ##### --> <para> - +#GtkCellRendererToggle renders a toggle button in a cell. The +button is drawn as a radio- or checkbutton, depending on the +<link linkend="GtkCellRendererToggle--radio">radio</link> +property. When activated, it emits the toggled signal. </para> <!-- ##### SECTION See_Also ##### --> |