← Back to branch summary

~ubuntu-branches/ubuntu/trusty/gcr/trusty-proposed

« back to all changes in this revision

Viewing changes to docs/reference/gcr/html/gcr-GcrColumn.html

  • Committer: Package Import Robot
  • Author(s): Jordi Mallach
  • Date: 2012-05-03 10:18:39 UTC
  • Revision ID: package-import@ubuntu.com-20120503101839-wuvloldm7gmdsnij
Tags: upstream-3.4.1
Import upstream version 3.4.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gcr/html/gcr-GcrColumn.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>GcrColumn</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
7
<link rel="home" href="index.html" title="Gcr Library Reference Manual">
 
8
<link rel="up" href="widgets.html" title="Part III. Widgets">
 
9
<link rel="prev" href="GcrKeyWidget.html" title="GcrKeyWidget">
 
10
<link rel="next" href="GcrComboSelector.html" title="GcrComboSelector">
 
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="GcrKeyWidget.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="widgets.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">Gcr Library Reference Manual</th>
 
21
<td><a accesskey="n" href="GcrComboSelector.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#gcr-GcrColumn.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#gcr-GcrColumn.description" class="shortcut">Description</a>
 
27
</td></tr>
 
28
</table>
 
29
<div class="refentry">
 
30
<a name="gcr-GcrColumn"></a><div class="titlepage"></div>
 
31
<div class="refnamediv"><table width="100%"><tr>
 
32
<td valign="top">
 
33
<h2><span class="refentrytitle"><a name="gcr-GcrColumn.top_of_page"></a>GcrColumn</span></h2>
 
34
<p>GcrColumn — Column information for selector or model.</p>
 
35
</td>
 
36
<td valign="top" align="right"></td>
 
37
</tr></table></div>
 
38
<div class="refsynopsisdiv">
 
39
<a name="gcr-GcrColumn.synopsis"></a><h2>Synopsis</h2>
 
40
<pre class="synopsis">                    <a class="link" href="gcr-GcrColumn.html#GcrColumn" title="GcrColumn">GcrColumn</a>;
 
41
enum                <a class="link" href="gcr-GcrColumn.html#GcrColumnFlags" title="enum GcrColumnFlags">GcrColumnFlags</a>;
 
42
</pre>
 
43
</div>
 
44
<div class="refsect1">
 
45
<a name="gcr-GcrColumn.description"></a><h2>Description</h2>
 
46
<p>
 
47
A <a class="link" href="gcr-GcrColumn.html#GcrColumn" title="GcrColumn"><span class="type">GcrColumn</span></a> is used with <a class="link" href="GcrTreeSelector.html" title="GcrTreeSelector"><span class="type">GcrTreeSelector</span></a> or <a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="type">GcrCollectionModel</span></a> to define
 
48
the columns to display.
 
49
</p>
 
50
</div>
 
51
<div class="refsect1">
 
52
<a name="gcr-GcrColumn.details"></a><h2>Details</h2>
 
53
<div class="refsect2">
 
54
<a name="GcrColumn"></a><h3>GcrColumn</h3>
 
55
<pre class="programlisting">typedef struct {
 
56
        const gchar *property_name;     /* The property to retrieve */
 
57
        GType property_type;            /* The property type */
 
58
        GType column_type;              /* The resulting property type for this column */
 
59
 
 
60
        const gchar *label;             /* The label for this column, or NULL */
 
61
        GcrColumnFlags flags;           /* Column flags */
 
62
 
 
63
        GValueTransform transformer;    /* The way to transform to this type or NULL */
 
64
 
 
65
        gpointer user_data;
 
66
} GcrColumn;
 
67
</pre>
 
68
<p>
 
69
Represents a column to display in a <a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="type">GcrCollectionModel</span></a> or <a class="link" href="GcrTreeSelector.html" title="GcrTreeSelector"><span class="type">GcrTreeSelector</span></a>.
 
70
</p>
 
71
<p>
 
72
The label should be set as a translatable string with a context of
 
73
<code class="code">"column"</code>. This should be done with with this macro:
 
74
</p>
 
75
<p>
 
76
</p>
 
77
<div class="informalexample">
 
78
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 
79
    <tbody>
 
80
      <tr>
 
81
        <td class="listing_lines" align="right"><pre>1</pre></td>
 
82
        <td class="listing_code"><pre class="programlisting"><span class="function"><a href="http://library.gnome.org/devel/glib/unstable/glib-I18N.html#NC-:CAPS">NC_</a></span><span class="symbol">(</span><span class="string">"column"</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"My Column Name"</span><span class="symbol">)</span></pre></td>
 
83
      </tr>
 
84
    </tbody>
 
85
  </table>
 
86
</div>
 
87
 
 
88
<p>
 
89
</p>
 
90
<div class="variablelist"><table border="0">
 
91
<col align="left" valign="top">
 
92
<tbody>
 
93
<tr>
 
94
<td><p><span class="term">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GcrColumn.property-name"></a>property_name</code></em>;</span></p></td>
 
95
<td>The name of the property this column will display</td>
 
96
</tr>
 
97
<tr>
 
98
<td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> <em class="structfield"><code><a name="GcrColumn.property-type"></a>property_type</code></em>;</span></p></td>
 
99
<td>The type of the property</td>
 
100
</tr>
 
101
<tr>
 
102
<td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> <em class="structfield"><code><a name="GcrColumn.column-type"></a>column_type</code></em>;</span></p></td>
 
103
<td>The eventual type of the column</td>
 
104
</tr>
 
105
<tr>
 
106
<td><p><span class="term">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GcrColumn.label"></a>label</code></em>;</span></p></td>
 
107
<td>The display label for the column</td>
 
108
</tr>
 
109
<tr>
 
110
<td><p><span class="term"><a class="link" href="gcr-GcrColumn.html#GcrColumnFlags" title="enum GcrColumnFlags"><span class="type">GcrColumnFlags</span></a> <em class="structfield"><code><a name="GcrColumn.flags"></a>flags</code></em>;</span></p></td>
 
111
<td>Flags from <a class="link" href="gcr-GcrColumn.html#GcrColumnFlags" title="enum GcrColumnFlags"><span class="type">GcrColumnFlags</span></a>
 
112
</td>
 
113
</tr>
 
114
<tr>
 
115
<td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValueTransform"><span class="type">GValueTransform</span></a> <em class="structfield"><code><a name="GcrColumn.transformer"></a>transformer</code></em>;</span></p></td>
 
116
<td>A transformer function used to convert the value from
 
117
the property type to the column type. Can be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the types
 
118
are the same.</td>
 
119
</tr>
 
120
<tr>
 
121
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> <em class="structfield"><code><a name="GcrColumn.user-data"></a>user_data</code></em>;</span></p></td>
 
122
<td>User data associated with the column</td>
 
123
</tr>
 
124
</tbody>
 
125
</table></div>
 
126
</div>
 
127
<hr>
 
128
<div class="refsect2">
 
129
<a name="GcrColumnFlags"></a><h3>enum GcrColumnFlags</h3>
 
130
<pre class="programlisting">typedef enum {
 
131
        GCR_COLUMN_NONE = 0,
 
132
        GCR_COLUMN_HIDDEN = 1 &lt;&lt; 1,
 
133
        GCR_COLUMN_SORTABLE = 1 &lt;&lt; 2,
 
134
} GcrColumnFlags;
 
135
</pre>
 
136
<p>
 
137
Flags to be used with <a class="link" href="gcr-GcrColumn.html#GcrColumn" title="GcrColumn"><span class="type">GcrColumn</span></a>
 
138
</p>
 
139
<div class="variablelist"><table border="0">
 
140
<col align="left" valign="top">
 
141
<tbody>
 
142
<tr>
 
143
<td><p><a name="GCR-COLUMN-NONE:CAPS"></a><span class="term"><code class="literal">GCR_COLUMN_NONE</code></span></p></td>
 
144
<td>No column flags
 
145
</td>
 
146
</tr>
 
147
<tr>
 
148
<td><p><a name="GCR-COLUMN-HIDDEN:CAPS"></a><span class="term"><code class="literal">GCR_COLUMN_HIDDEN</code></span></p></td>
 
149
<td>Don't display this column.
 
150
</td>
 
151
</tr>
 
152
<tr>
 
153
<td><p><a name="GCR-COLUMN-SORTABLE:CAPS"></a><span class="term"><code class="literal">GCR_COLUMN_SORTABLE</code></span></p></td>
 
154
<td>This column is sortable.
 
155
</td>
 
156
</tr>
 
157
</tbody>
 
158
</table></div>
 
159
</div>
 
160
</div>
 
161
</div>
 
162
<div class="footer">
 
163
<hr>
 
164
          Generated by GTK-Doc V1.18</div>
 
165
</body>
 
166
</html>
 
 
b'\\ No newline at end of file'