← Back to branch summary

~noskcaj/ubuntu/wily/epiphany-browser/merge

« back to all changes in this revision

Viewing changes to doc/reference/xml/ephy-tree-model-node.xml

  • Committer: Package Import Robot
  • Author(s): Jeremy Bicha
  • Date: 2012-10-24 10:31:13 UTC
  • mto: (120.1.2 experimental) (1.10.1) (105.1.14 sid)
  • mto: This revision was merged to the branch mainline in revision 120.
  • Revision ID: package-import@ubuntu.com-20121024103113-9oxzkdznk03km29m
Tags: upstream-3.6.1
Import upstream version 3.6.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/xml/ephy-tree-model-node.xml
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
 
<refentry id="EphyTreeModelNode">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="EphyTreeModelNode.top_of_page">EphyTreeModelNode</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>
9
 
  EPIPHANY Library
10
 
</refmiscinfo>
11
 
</refmeta>
12
 
<refnamediv>
13
 
<refname>EphyTreeModelNode</refname>
14
 
<refpurpose>a <link linkend="GtkTreeModel"><type>GtkTreeModel</type></link> of <link linkend="EphyNode"><type>EphyNode</type></link> elements</refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="EphyTreeModelNode.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis>struct              <link linkend="EphyTreeModelNode-struct">EphyTreeModelNode</link>;
21
 
<link linkend="EphyTreeModelNode"><returnvalue>EphyTreeModelNode</returnvalue></link> * <link linkend="ephy-tree-model-node-new">ephy_tree_model_node_new</link>            (<parameter><link linkend="EphyNode"><type>EphyNode</type></link> *root</parameter>);
22
 
<link linkend="int"><returnvalue>int</returnvalue></link>                 <link linkend="ephy-tree-model-node-add-prop-column">ephy_tree_model_node_add_prop_column</link>
23
 
                                                        (<parameter><link linkend="EphyTreeModelNode"><type>EphyTreeModelNode</type></link> *model</parameter>,
24
 
                                                         <parameter><link linkend="GType"><type>GType</type></link> value_type</parameter>,
25
 
                                                         <parameter><link linkend="int"><type>int</type></link> prop_id</parameter>);
26
 
<link linkend="int"><returnvalue>int</returnvalue></link>                 <link linkend="ephy-tree-model-node-add-func-column">ephy_tree_model_node_add_func_column</link>
27
 
                                                        (<parameter><link linkend="EphyTreeModelNode"><type>EphyTreeModelNode</type></link> *model</parameter>,
28
 
                                                         <parameter><link linkend="GType"><type>GType</type></link> value_type</parameter>,
29
 
                                                         <parameter><link linkend="EphyTreeModelNodeValueFunc"><type>EphyTreeModelNodeValueFunc</type></link> func</parameter>,
30
 
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> user_data</parameter>);
31
 
<link linkend="EphyNode"><returnvalue>EphyNode</returnvalue></link> *          <link linkend="ephy-tree-model-node-node-from-iter">ephy_tree_model_node_node_from_iter</link> (<parameter><link linkend="EphyTreeModelNode"><type>EphyTreeModelNode</type></link> *model</parameter>,
32
 
                                                         <parameter><link linkend="GtkTreeIter"><type>GtkTreeIter</type></link> *iter</parameter>);
33
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="ephy-tree-model-node-iter-from-node">ephy_tree_model_node_iter_from_node</link> (<parameter><link linkend="EphyTreeModelNode"><type>EphyTreeModelNode</type></link> *model</parameter>,
34
 
                                                         <parameter><link linkend="EphyNode"><type>EphyNode</type></link> *node</parameter>,
35
 
                                                         <parameter><link linkend="GtkTreeIter"><type>GtkTreeIter</type></link> *iter</parameter>);
36
 
</synopsis>
37
 
</refsynopsisdiv>
38
 
<refsect1 id="EphyTreeModelNode.object-hierarchy" role="object_hierarchy">
39
 
<title role="object_hierarchy.title">Object Hierarchy</title>
40
 
<synopsis>
41
 
  <link linkend="GObject">GObject</link>
42
 
   +----EphyTreeModelNode
43
 
</synopsis>
44
 
</refsect1>
45
 
<refsect1 id="EphyTreeModelNode.implemented-interfaces" role="impl_interfaces">
46
 
<title role="impl_interfaces.title">Implemented Interfaces</title>
47
 
<para>
48
 
EphyTreeModelNode implements
49
 
 <link linkend="GtkTreeModel">GtkTreeModel</link>.</para>
50
 
</refsect1>
51
 
<refsect1 id="EphyTreeModelNode.properties" role="properties">
52
 
<title role="properties.title">Properties</title>
53
 
<synopsis>
54
 
  &quot;<link linkend="EphyTreeModelNode--root">root</link>&quot;                     <link linkend="gpointer"><type>gpointer</type></link>              : Read / Write / Construct Only
55
 
</synopsis>
56
 
</refsect1>
57
 
 
58
 
<refsect1 id="EphyTreeModelNode.description" role="desc">
59
 
<title role="desc.title">Description</title>
60
 
<para>
61
 
<link linkend="EphyTreeModelNode"><type>EphyTreeModelNode</type></link> implements a <link linkend="GtkTreeModel"><type>GtkTreeModel</type></link> that holds <link linkend="EphyNode"><type>EphyNode</type></link> elements.
62
 
It can be used with <link linkend="EphyNodeView"><type>EphyNodeView</type></link> and <link linkend="EphyTreeModelFilter"><type>EphyTreeModelFilter</type></link>.
63
 
</para>
64
 
</refsect1>
65
 
<refsect1 id="EphyTreeModelNode.details" role="details">
66
 
<title role="details.title">Details</title>
67
 
<refsect2 id="EphyTreeModelNode-struct" role="struct">
68
 
<title>struct EphyTreeModelNode</title>
69
 
<indexterm zone="EphyTreeModelNode-struct"><primary>EphyTreeModelNode</primary></indexterm>
70
 
<programlisting>struct EphyTreeModelNode;</programlisting>
71
 
<para>
72
 
</para></refsect2>
73
 
<refsect2 id="ephy-tree-model-node-new" role="function">
74
 
<title>ephy_tree_model_node_new ()</title>
75
 
<indexterm zone="ephy-tree-model-node-new"><primary>ephy_tree_model_node_new</primary></indexterm>
76
 
<programlisting><link linkend="EphyTreeModelNode"><returnvalue>EphyTreeModelNode</returnvalue></link> * ephy_tree_model_node_new            (<parameter><link linkend="EphyNode"><type>EphyNode</type></link> *root</parameter>);</programlisting>
77
 
<para>
78
 
Create a new <link linkend="EphyTreeModelNode"><type>EphyTreeModelNode</type></link> object and set <parameter>root</parameter> as its root node.
79
 
</para><variablelist role="params">
80
 
<varlistentry><term><parameter>root</parameter>&#160;:</term>
81
 
<listitem><simpara>root <link linkend="EphyNode"><type>EphyNode</type></link> of the model</simpara></listitem></varlistentry>
82
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>a new <link linkend="EphyTreeModelNode"><type>EphyTreeModelNode</type></link></simpara></listitem></varlistentry>
83
 
</variablelist></refsect2>
84
 
<refsect2 id="ephy-tree-model-node-add-prop-column" role="function">
85
 
<title>ephy_tree_model_node_add_prop_column ()</title>
86
 
<indexterm zone="ephy-tree-model-node-add-prop-column"><primary>ephy_tree_model_node_add_prop_column</primary></indexterm>
87
 
<programlisting><link linkend="int"><returnvalue>int</returnvalue></link>                 ephy_tree_model_node_add_prop_column
88
 
                                                        (<parameter><link linkend="EphyTreeModelNode"><type>EphyTreeModelNode</type></link> *model</parameter>,
89
 
                                                         <parameter><link linkend="GType"><type>GType</type></link> value_type</parameter>,
90
 
                                                         <parameter><link linkend="int"><type>int</type></link> prop_id</parameter>);</programlisting>
91
 
<para>
92
 
Add a new column to <parameter>model</parameter> obtaining its value from <parameter>prop_id</parameter> in <parameter>model</parameter>.
93
 
</para><variablelist role="params">
94
 
<varlistentry><term><parameter>model</parameter>&#160;:</term>
95
 
<listitem><simpara>an <link linkend="EphyTreeModelNode"><type>EphyTreeModelNode</type></link></simpara></listitem></varlistentry>
96
 
<varlistentry><term><parameter>value_type</parameter>&#160;:</term>
97
 
<listitem><simpara>type held by the new column</simpara></listitem></varlistentry>
98
 
<varlistentry><term><parameter>prop_id</parameter>&#160;:</term>
99
 
<listitem><simpara>column in <parameter>model</parameter> to get the value for this column</simpara></listitem></varlistentry>
100
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the id of the new column</simpara></listitem></varlistentry>
101
 
</variablelist></refsect2>
102
 
<refsect2 id="ephy-tree-model-node-add-func-column" role="function">
103
 
<title>ephy_tree_model_node_add_func_column ()</title>
104
 
<indexterm zone="ephy-tree-model-node-add-func-column"><primary>ephy_tree_model_node_add_func_column</primary></indexterm>
105
 
<programlisting><link linkend="int"><returnvalue>int</returnvalue></link>                 ephy_tree_model_node_add_func_column
106
 
                                                        (<parameter><link linkend="EphyTreeModelNode"><type>EphyTreeModelNode</type></link> *model</parameter>,
107
 
                                                         <parameter><link linkend="GType"><type>GType</type></link> value_type</parameter>,
108
 
                                                         <parameter><link linkend="EphyTreeModelNodeValueFunc"><type>EphyTreeModelNodeValueFunc</type></link> func</parameter>,
109
 
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> user_data</parameter>);</programlisting>
110
 
<para>
111
 
Adds a new column to <parameter>model</parameter> with its value determined by <parameter>func</parameter>.
112
 
</para><variablelist role="params">
113
 
<varlistentry><term><parameter>model</parameter>&#160;:</term>
114
 
<listitem><simpara>an <link linkend="EphyTreeModelNode"><type>EphyTreeModelNode</type></link></simpara></listitem></varlistentry>
115
 
<varlistentry><term><parameter>value_type</parameter>&#160;:</term>
116
 
<listitem><simpara>type held by the new column</simpara></listitem></varlistentry>
117
 
<varlistentry><term><parameter>func</parameter>&#160;:</term>
118
 
<listitem><simpara>data function to be used to provide the value of the new column</simpara></listitem></varlistentry>
119
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
120
 
<listitem><simpara>optional user data for <parameter>func</parameter></simpara></listitem></varlistentry>
121
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the id of the new column</simpara></listitem></varlistentry>
122
 
</variablelist></refsect2>
123
 
<refsect2 id="ephy-tree-model-node-node-from-iter" role="function">
124
 
<title>ephy_tree_model_node_node_from_iter ()</title>
125
 
<indexterm zone="ephy-tree-model-node-node-from-iter"><primary>ephy_tree_model_node_node_from_iter</primary></indexterm>
126
 
<programlisting><link linkend="EphyNode"><returnvalue>EphyNode</returnvalue></link> *          ephy_tree_model_node_node_from_iter (<parameter><link linkend="EphyTreeModelNode"><type>EphyTreeModelNode</type></link> *model</parameter>,
127
 
                                                         <parameter><link linkend="GtkTreeIter"><type>GtkTreeIter</type></link> *iter</parameter>);</programlisting>
128
 
<para>
129
 
Gets the <link linkend="EphyNode"><type>EphyNode</type></link> corresponding to <parameter>iter</parameter> from <parameter>model</parameter>.
130
 
</para><variablelist role="params">
131
 
<varlistentry><term><parameter>model</parameter>&#160;:</term>
132
 
<listitem><simpara>an <link linkend="EphyTreeModelNode"><type>EphyTreeModelNode</type></link></simpara></listitem></varlistentry>
133
 
<varlistentry><term><parameter>iter</parameter>&#160;:</term>
134
 
<listitem><simpara>iter from where to get the node</simpara></listitem></varlistentry>
135
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the <link linkend="EphyNode"><type>EphyNode</type></link> corresponding to <parameter>iter</parameter></simpara></listitem></varlistentry>
136
 
</variablelist></refsect2>
137
 
<refsect2 id="ephy-tree-model-node-iter-from-node" role="function">
138
 
<title>ephy_tree_model_node_iter_from_node ()</title>
139
 
<indexterm zone="ephy-tree-model-node-iter-from-node"><primary>ephy_tree_model_node_iter_from_node</primary></indexterm>
140
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                ephy_tree_model_node_iter_from_node (<parameter><link linkend="EphyTreeModelNode"><type>EphyTreeModelNode</type></link> *model</parameter>,
141
 
                                                         <parameter><link linkend="EphyNode"><type>EphyNode</type></link> *node</parameter>,
142
 
                                                         <parameter><link linkend="GtkTreeIter"><type>GtkTreeIter</type></link> *iter</parameter>);</programlisting>
143
 
<para>
144
 
Gets the corresponding <link linkend="GtkTreeIter"><type>GtkTreeIter</type></link> for <parameter>node</parameter> from <parameter>model</parameter>.
145
 
</para><variablelist role="params">
146
 
<varlistentry><term><parameter>model</parameter>&#160;:</term>
147
 
<listitem><simpara>an <link linkend="EphyTreeModelNode"><type>EphyTreeModelNode</type></link></simpara></listitem></varlistentry>
148
 
<varlistentry><term><parameter>node</parameter>&#160;:</term>
149
 
<listitem><simpara>the <link linkend="EphyNode"><type>EphyNode</type></link> from which we want the iter to be obtained</simpara></listitem></varlistentry>
150
 
<varlistentry><term><parameter>iter</parameter>&#160;:</term>
151
 
<listitem><simpara>location to return the <link linkend="GtkTreeIter"><type>GtkTreeIter</type></link></simpara></listitem></varlistentry>
152
 
</variablelist></refsect2>
153
 
 
154
 
</refsect1>
155
 
<refsect1 id="EphyTreeModelNode.property-details" role="property_details">
156
 
<title role="property_details.title">Property Details</title>
157
 
<refsect2 id="EphyTreeModelNode--root" role="property"><title>The <literal>&quot;root&quot;</literal> property</title>
158
 
<indexterm zone="EphyTreeModelNode--root"><primary>EphyTreeModelNode:root</primary></indexterm>
159
 
<programlisting>  &quot;root&quot;                     <link linkend="gpointer"><type>gpointer</type></link>              : Read / Write / Construct Only</programlisting>
160
 
<para>
161
 
The root <link linkend="EphyNode"><type>EphyNode</type></link> of the model.
162
 
</para></refsect2>
163
 
</refsect1>
164
 
 
165
 
</refentry>