Blob Blame History Raw
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GcrColumn: Gcr Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Gcr Library Reference Manual">
<link rel="up" href="widgets.html" title="Part III. Widgets">
<link rel="prev" href="GcrKeyWidget.html" title="GcrKeyWidget">
<link rel="next" href="GcrComboSelector.html" title="GcrComboSelector">
<meta name="generator" content="GTK-Doc V1.27.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#gcr-GcrColumn.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="widgets.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GcrKeyWidget.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GcrComboSelector.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gcr-GcrColumn"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gcr-GcrColumn.top_of_page"></a>GcrColumn</span></h2>
<p>GcrColumn — Column information for selector or model.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gcr-GcrColumn.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="gcr-GcrColumn.html#GcrColumn" title="GcrColumn">GcrColumn</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="gcr-GcrColumn.html#GcrColumnFlags" title="enum GcrColumnFlags">GcrColumnFlags</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gcr-GcrColumn.description"></a><h2>Description</h2>
<p>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
the columns to display.</p>
</div>
<div class="refsect1">
<a name="gcr-GcrColumn.functions_details"></a><h2>Functions</h2>
<p></p>
</div>
<div class="refsect1">
<a name="gcr-GcrColumn.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GcrColumn"></a><h3>GcrColumn</h3>
<pre class="programlisting">typedef struct {
	const gchar *property_name;     /* The property to retrieve */
	GType property_type;            /* The property type */
	GType column_type;              /* The resulting property type for this column */

	const gchar *label;             /* The label for this column, or NULL */
	GcrColumnFlags flags;           /* Column flags */

	GValueTransform transformer;    /* The way to transform to this type or NULL */

	gpointer user_data;
} GcrColumn;
</pre>
<p>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>.</p>
<p>The label should be set as a translatable string with a context of</p>
<code class="code">"column"</code>. This should be done with with this macro:
<div class="informalexample">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1</pre></td>
        <td class="listing_code"><pre class="programlisting"><span class="function">NC_</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>
      </tr>
    </tbody>
  </table>
</div>

<div class="refsect3">
<a name="GcrColumn.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p>const <span class="type">gchar</span> *<em class="structfield"><code><a name="GcrColumn.property-name"></a>property_name</code></em>;</p></td>
<td class="struct_member_description"><p>The name of the property this column will display</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">GType</span> <em class="structfield"><code><a name="GcrColumn.property-type"></a>property_type</code></em>;</p></td>
<td class="struct_member_description"><p>The type of the property</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">GType</span> <em class="structfield"><code><a name="GcrColumn.column-type"></a>column_type</code></em>;</p></td>
<td class="struct_member_description"><p>The eventual type of the column</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p>const <span class="type">gchar</span> *<em class="structfield"><code><a name="GcrColumn.label"></a>label</code></em>;</p></td>
<td class="struct_member_description"><p>The display label for the column</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><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>;</p></td>
<td class="struct_member_description"><p>Flags from <a class="link" href="gcr-GcrColumn.html#GcrColumnFlags" title="enum GcrColumnFlags"><span class="type">GcrColumnFlags</span></a></p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">GValueTransform</span> <em class="structfield"><code><a name="GcrColumn.transformer"></a>transformer</code></em>;</p></td>
<td class="struct_member_description"><p>A transformer function used to convert the value from
the property type to the column type. Can be <code class="literal">NULL</code> if the types
are the same.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">gpointer</span> <em class="structfield"><code><a name="GcrColumn.user-data"></a>user_data</code></em>;</p></td>
<td class="struct_member_description"><p>User data associated with the column</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="GcrColumnFlags"></a><h3>enum GcrColumnFlags</h3>
<p>Flags to be used with <a class="link" href="gcr-GcrColumn.html#GcrColumn" title="GcrColumn"><span class="type">GcrColumn</span></a></p>
<div class="refsect3">
<a name="GcrColumnFlags.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GCR-COLUMN-NONE:CAPS"></a>GCR_COLUMN_NONE</p></td>
<td class="enum_member_description">
<p>No column flags</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GCR-COLUMN-HIDDEN:CAPS"></a>GCR_COLUMN_HIDDEN</p></td>
<td class="enum_member_description">
<p>Don't display this column.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GCR-COLUMN-SORTABLE:CAPS"></a>GCR_COLUMN_SORTABLE</p></td>
<td class="enum_member_description">
<p>This column is sortable.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27.1</div>
</body>
</html>