← Back to branch summary

~ubuntu-branches/ubuntu/karmic/exo/karmic

« back to all changes in this revision

Viewing changes to docs/reference/xml/exo-cell-renderer-ellipsized-text.xml

  • Committer: Bazaar Package Importer
  • Author(s): Lionel Le Folgoc
  • Date: 2009-08-21 14:28:56 UTC
  • mfrom: (1.1.22 upstream)
  • Revision ID: james.westby@ubuntu.com-20090821142856-xp7o7hl7x9xa2213
Tags: 0.3.102-1ubuntu1
* Merge from Debian unstable, remaining Ubuntu changes:
  - debian/rules:
    + Removed mangling of helpers.rc
    + Add --enable-gtk-doc switch to configure
  - debian/control:
    + Add build-dep on gtk-doc-tools
    + Update Vcs-* fields
  - debian/patches:
    + 04_update_helpers.patch: patched libexo's firefox helper desktop file
      to use firefox-3.0 icon instead of firefox icon
    + xubuntu-default-mount-options.patch: change default mount options for
      vfat, iso9660, ntfs
    + series: refreshed.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/xml/exo-cell-renderer-ellipsized-text.xml
8
8
<refnamediv>
9
9
<refname>ExoCellRendererEllipsizedText</refname>
10
10
<refpurpose>Renders text in a cell</refpurpose>
11
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
12
11
</refnamediv>
13
12
 
14
13
<refsynopsisdiv id="ExoCellRendererEllipsizedText.synopsis" role="synopsis">
19
18
#include &lt;exo/exo.h&gt;
20
19
 
21
20
                    <link linkend="ExoCellRendererEllipsizedText-struct">ExoCellRendererEllipsizedText</link>;
22
 
<link linkend="GtkCellRenderer">GtkCellRenderer</link>*    <link linkend="exo-cell-renderer-ellipsized-text-new">exo_cell_renderer_ellipsized_text_new</link>
 
21
<link linkend="GtkCellRenderer">GtkCellRenderer</link> *   <link linkend="exo-cell-renderer-ellipsized-text-new">exo_cell_renderer_ellipsized_text_new</link>
23
22
                                                        (void);
24
23
</synopsis>
25
24
</refsynopsisdiv>
34
33
                     +----<link linkend="GtkCellRendererText">GtkCellRendererText</link>
35
34
                           +----ExoCellRendererEllipsizedText
36
35
</synopsis>
37
 
 
38
36
</refsect1>
39
37
 
40
38
 
56
54
  The <link linkend="ExoCellRendererEllipsizedText"><type>ExoCellRendererEllipsizedText</type></link> renders a given text in its cell, using the font, color and
57
55
  style information provided by its properties (which are actually inherited from <link linkend="GtkCellRendererText"><type>GtkCellRendererText</type></link>).
58
56
</para>
59
 
 
60
57
<para>
61
58
  Despite the rather confusing name of this class, it is mainly useful to render text in an <link linkend="ExoIconView"><type>ExoIconView</type></link>
62
59
  (or a <link linkend="GtkIconView"><type>GtkIconView</type></link>), which require the renderers to actually draw the state indicators. State indicators
63
60
  will be drawn only if the <link linkend="ExoCellRendererEllipsizedText--follow-state">follow-state</link>
64
 
  property is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>.
 
61
  property is <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>.
65
62
</para>
66
63
</refsect1>
67
64
 
69
66
<title role="details.title">Details</title>
70
67
<refsect2 id="ExoCellRendererEllipsizedText-struct" role="struct">
71
68
<title>ExoCellRendererEllipsizedText</title>
72
 
<indexterm zone="ExoCellRendererEllipsizedText-struct"><primary>ExoCellRendererEllipsizedText</primary></indexterm><programlisting>typedef struct _ExoCellRendererEllipsizedText ExoCellRendererEllipsizedText;</programlisting>
 
69
<indexterm zone="ExoCellRendererEllipsizedText-struct"><primary sortas="ExoCellRendererEllipsizedText">ExoCellRendererEllipsizedText</primary></indexterm><programlisting>typedef struct _ExoCellRendererEllipsizedText ExoCellRendererEllipsizedText;</programlisting>
73
70
<para>
74
71
  The <structname>ExoIconCellRendererEllipsizedText</structname> struct contains only private fields and should not be directly accessed.
75
72
</para></refsect2>
76
73
<refsect2 id="exo-cell-renderer-ellipsized-text-new" role="function">
77
74
<title>exo_cell_renderer_ellipsized_text_new ()</title>
78
 
<indexterm zone="exo-cell-renderer-ellipsized-text-new"><primary>exo_cell_renderer_ellipsized_text_new</primary></indexterm><programlisting><link linkend="GtkCellRenderer">GtkCellRenderer</link>*    exo_cell_renderer_ellipsized_text_new
 
75
<indexterm zone="exo-cell-renderer-ellipsized-text-new"><primary sortas="exo_cell_renderer_ellipsized_text_new">exo_cell_renderer_ellipsized_text_new</primary></indexterm><programlisting><link linkend="GtkCellRenderer">GtkCellRenderer</link> *   exo_cell_renderer_ellipsized_text_new
79
76
                                                        (void);</programlisting>
80
77
<para>
81
78
Creates a new <link linkend="ExoCellRendererEllipsizedText"><type>ExoCellRendererEllipsizedText</type></link>. Adjust rendering parameters using gobject properties,
82
79
which can be set globally via <link linkend="g-object-set"><function>g_object_set()</function></link>. Also, with <link linkend="GtkCellLayout"><type>GtkCellLayout</type></link> and <link linkend="GtkTreeViewColumn"><type>GtkTreeViewColumn</type></link>, you
83
80
can bind a property to a value in a <link linkend="GtkTreeModel"><type>GtkTreeModel</type></link>.</para>
84
81
<para>
85
 
 
86
82
</para><variablelist role="params">
87
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the newly allocated <link linkend="ExoCellRendererEllipsizedText"><type>ExoCellRendererEllipsizedText</type></link>.
 
83
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the newly allocated <link linkend="ExoCellRendererEllipsizedText"><type>ExoCellRendererEllipsizedText</type></link>.
88
84
</simpara></listitem></varlistentry>
89
85
</variablelist></refsect2>
90
86
 
91
87
</refsect1>
92
88
<refsect1 id="ExoCellRendererEllipsizedText.property-details" role="property_details">
93
89
<title role="property_details.title">Property Details</title>
94
 
<refsect2 id="ExoCellRendererEllipsizedText--follow-state"><title>The <literal>&quot;follow-state&quot;</literal> property</title>
95
 
<indexterm zone="ExoCellRendererEllipsizedText--follow-state" role="0.3.1.9"><primary>ExoCellRendererEllipsizedText:follow-state</primary></indexterm><programlisting>  &quot;follow-state&quot;             <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
 
90
<refsect2 id="ExoCellRendererEllipsizedText--follow-state" role="property"><title>The <literal>&quot;follow-state&quot;</literal> property</title>
 
91
<indexterm zone="ExoCellRendererEllipsizedText--follow-state" role="0.3.1.9"><primary sortas="ExoCellRendererEllipsizedText:follow-state">ExoCellRendererEllipsizedText:follow-state</primary></indexterm><programlisting>  &quot;follow-state&quot;             <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
96
92
<para>
97
93
Specifies whether the text renderer should render the text based on
98
94
the selection state of the items. This is necessary for <link linkend="ExoIconView"><type>ExoIconView</type></link>
99
95
which doesn't draw any item state indicators itself.</para>
100
96
<para>
101
 
 
102
97
</para><para>Default value: FALSE</para>
103
 
<para>Since  0.3.1.9
104
 
</para>
 
98
<para>Since 0.3.1.9</para>
105
99
</refsect2>
106
 
 
107
100
</refsect1>
108
101
 
109
102