← Back to branch summary

~ubuntu-branches/ubuntu/utopic/telepathy-glib/utopic

« back to all changes in this revision

Viewing changes to docs/reference/html/TpStaticHandleRepo.html

  • Committer: Package Import Robot
  • Author(s): Simon McVittie
  • Date: 2014-09-16 15:49:50 UTC
  • mfrom: (60.1.5 sid)
  • Revision ID: package-import@ubuntu.com-20140916154950-krvowuvofhu8u6sp
Tags: 0.24.1-1
* New upstream stable release
* debian/copyright: clean up syntax (*.[ch] is unsupported),
  drop deleted files
* debian/watch: only match 0.x versions, 1.0 will be a separate
  source package

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/html/TpStaticHandleRepo.html
2
2
<html>
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>telepathy-glib API Reference Manual: TpStaticHandleRepo</title>
 
5
<title>TpStaticHandleRepo</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="telepathy-glib API Reference Manual">
8
8
<link rel="up" href="ch-service-handles.html" title="Service-side handle repositories">
9
9
<link rel="prev" href="telepathy-glib-handle-repo.html" title="TpHandleRepoIface">
10
10
<link rel="next" href="TpDynamicHandleRepo.html" title="TpDynamicHandleRepo">
11
 
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
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="10"><tr valign="middle">
16
 
<td width="100%" align="left" class="shortcuts">
17
 
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
18
 
                  <a href="#TpStaticHandleRepo.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
19
 
                  <a href="#TpStaticHandleRepo.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> 
20
 
                  <a href="#TpStaticHandleRepo.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> 
21
 
                  <a href="#TpStaticHandleRepo.properties" class="shortcut">Properties</a></span>
22
 
</td>
23
 
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
24
 
<td><a accesskey="u" href="ch-service-handles.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
25
 
<td><a accesskey="p" href="telepathy-glib-handle-repo.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
26
 
<td><a accesskey="n" href="TpDynamicHandleRepo.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
27
 
</tr></table>
 
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="telepathy-glib-handle-repo.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="ch-service-handles.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">telepathy-glib API Reference Manual</th>
 
21
<td><a accesskey="n" href="TpDynamicHandleRepo.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="#TpStaticHandleRepo.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#TpStaticHandleRepo.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#TpStaticHandleRepo.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
                   | 
 
30
                  <a href="#TpStaticHandleRepo.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 
31
                   | 
 
32
                  <a href="#TpStaticHandleRepo.properties" class="shortcut">Properties</a>
 
33
</td></tr>
 
34
</table>
28
35
<div class="refentry">
29
36
<a name="TpStaticHandleRepo"></a><div class="titlepage"></div>
30
37
<div class="refnamediv"><table width="100%"><tr>
33
40
<p>TpStaticHandleRepo — handle repository implementation with a fixed, static
34
41
 set of handle names</p>
35
42
</td>
36
 
<td class="gallery_image" valign="top" align="right"></td>
 
43
<td valign="top" align="right"></td>
37
44
</tr></table></div>
38
 
<div class="refsect1">
39
 
<a name="TpStaticHandleRepo.functions"></a><h2>Functions</h2>
40
 
<div class="informaltable"><table width="100%" border="0">
41
 
<colgroup>
42
 
<col width="150px" class="functions_return">
43
 
<col class="functions_name">
44
 
</colgroup>
45
 
<tbody><tr>
46
 
<td class="function_type">
47
 
<a class="link" href="telepathy-glib-handle-repo.html#TpHandleRepoIface"><span class="returnvalue">TpHandleRepoIface</span></a> *
48
 
</td>
49
 
<td class="function_name">
50
 
<a class="link" href="TpStaticHandleRepo.html#tp-static-handle-repo-new" title="tp_static_handle_repo_new ()">tp_static_handle_repo_new</a> <span class="c_punctuation">()</span>
51
 
</td>
52
 
</tr></tbody>
53
 
</table></div>
54
 
</div>
55
 
<div class="refsect1">
56
 
<a name="TpStaticHandleRepo.properties"></a><h2>Properties</h2>
57
 
<div class="informaltable"><table border="0">
58
 
<colgroup>
59
 
<col width="150px" class="properties_type">
60
 
<col width="300px" class="properties_name">
61
 
<col width="200px" class="properties_flags">
62
 
</colgroup>
63
 
<tbody><tr>
64
 
<td class="property_type"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Boxed-Types.html#GStrv"><span class="type">GStrv</span></a></td>
65
 
<td class="property_name"><a class="link" href="TpStaticHandleRepo.html#TpStaticHandleRepo--handle-names" title="The “handle-names” property">handle-names</a></td>
66
 
<td class="property_flags">Read / Write / Construct Only</td>
67
 
</tr></tbody>
68
 
</table></div>
69
 
</div>
70
 
<div class="refsect1">
71
 
<a name="TpStaticHandleRepo.other"></a><h2>Types and Values</h2>
72
 
<div class="informaltable"><table width="100%" border="0">
73
 
<colgroup>
74
 
<col width="150px" class="name">
75
 
<col class="description">
76
 
</colgroup>
77
 
<tbody>
78
 
<tr>
79
 
<td class="datatype_keyword"> </td>
80
 
<td class="function_name"><a class="link" href="TpStaticHandleRepo.html#TpStaticHandleRepo-struct" title="TpStaticHandleRepo">TpStaticHandleRepo</a></td>
81
 
</tr>
82
 
<tr>
83
 
<td class="datatype_keyword"> </td>
84
 
<td class="function_name"><a class="link" href="TpStaticHandleRepo.html#TpStaticHandleRepoClass" title="TpStaticHandleRepoClass">TpStaticHandleRepoClass</a></td>
85
 
</tr>
86
 
</tbody>
87
 
</table></div>
 
45
<div class="refsynopsisdiv">
 
46
<a name="TpStaticHandleRepo.synopsis"></a><h2>Synopsis</h2>
 
47
<pre class="synopsis">
 
48
#include &lt;telepathy-glib/telepathy-glib.h&gt;
 
49
 
 
50
<a class="link" href="telepathy-glib-handle-repo.html#TpHandleRepoIface"><span class="returnvalue">TpHandleRepoIface</span></a> * <a class="link" href="TpStaticHandleRepo.html#tp-static-handle-repo-new" title="tp_static_handle_repo_new ()">tp_static_handle_repo_new</a>           (<em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpHandleType" title="enum TpHandleType"><span class="type">TpHandleType</span></a> handle_type</code></em>,
 
51
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **handle_names</code></em>);
 
52
                    <a class="link" href="TpStaticHandleRepo.html#TpStaticHandleRepo-struct" title="TpStaticHandleRepo">TpStaticHandleRepo</a>;
 
53
                    <a class="link" href="TpStaticHandleRepo.html#TpStaticHandleRepoClass" title="TpStaticHandleRepoClass">TpStaticHandleRepoClass</a>;
 
54
</pre>
88
55
</div>
89
56
<div class="refsect1">
90
57
<a name="TpStaticHandleRepo.object-hierarchy"></a><h2>Object Hierarchy</h2>
91
 
<pre class="screen">    <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
92
 
    <span class="lineart">╰──</span> TpStaticHandleRepo
 
58
<pre class="synopsis">
 
59
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
60
   +----TpStaticHandleRepo
93
61
</pre>
94
62
</div>
95
63
<div class="refsect1">
99
67
 <a class="link" href="telepathy-glib-handle-repo.html#TpHandleRepoIface">TpHandleRepoIface</a>.</p>
100
68
</div>
101
69
<div class="refsect1">
102
 
<a name="TpStaticHandleRepo.includes"></a><h2>Includes</h2>
103
 
<pre class="synopsis">#include &lt;telepathy-glib/telepathy-glib.h&gt;
 
70
<a name="TpStaticHandleRepo.properties"></a><h2>Properties</h2>
 
71
<pre class="synopsis">
 
72
  "<a class="link" href="TpStaticHandleRepo.html#TpStaticHandleRepo--handle-names" title='The "handle-names" property'>handle-names</a>"             <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Boxed-Types.html#GStrv"><span class="type">GStrv</span></a>                 : Read / Write / Construct Only
104
73
</pre>
105
74
</div>
106
75
<div class="refsect1">
107
76
<a name="TpStaticHandleRepo.description"></a><h2>Description</h2>
108
 
<p>A static handle repository has a fixed, static set of allowed names;
 
77
<p>
 
78
A static handle repository has a fixed, static set of allowed names;
109
79
these handles can never be destroyed, and no more can be created, so
110
 
no reference counting is performed.</p>
111
 
<p>The <a class="link" href="telepathy-glib-handle-repo.html#TpHandleRepoIface--handle-type" title="The “handle-type” property"><span class="type">“handle-type”</span></a> property must be set at construction
112
 
time.</p>
113
 
<p>Most connection managers will use this for handles of type
114
 
<a class="link" href="telepathy-glib-enums.html#TP-HANDLE-TYPE-LIST:CAPS"><code class="literal">TP_HANDLE_TYPE_LIST</code></a>.</p>
 
80
no reference counting is performed.
 
81
</p>
 
82
<p>
 
83
The <a class="link" href="telepathy-glib-handle-repo.html#TpHandleRepoIface--handle-type" title='The "handle-type" property'><span class="type">"handle-type"</span></a> property must be set at construction
 
84
time.
 
85
</p>
 
86
<p>
 
87
Most connection managers will use this for handles of type
 
88
<a class="link" href="telepathy-glib-enums.html#TP-HANDLE-TYPE-LIST:CAPS"><code class="literal">TP_HANDLE_TYPE_LIST</code></a>.
 
89
</p>
115
90
</div>
116
91
<div class="refsect1">
117
 
<a name="TpStaticHandleRepo.functions_details"></a><h2>Functions</h2>
 
92
<a name="TpStaticHandleRepo.details"></a><h2>Details</h2>
118
93
<div class="refsect2">
119
 
<a name="tp-static-handle-repo-new"></a><h3>tp_static_handle_repo_new ()</h3>
120
 
<pre class="programlisting"><a class="link" href="telepathy-glib-handle-repo.html#TpHandleRepoIface"><span class="returnvalue">TpHandleRepoIface</span></a> *
121
 
tp_static_handle_repo_new (<em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpHandleType" title="enum TpHandleType"><span class="type">TpHandleType</span></a> handle_type</code></em>,
122
 
                           <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **handle_names</code></em>);</pre>
123
 
<p></p>
124
 
<div class="refsect3">
125
 
<a name="id-1.7.3.10.2.5"></a><h4>Parameters</h4>
126
 
<div class="informaltable"><table width="100%" border="0">
 
94
<a name="tp-static-handle-repo-new"></a><h3>tp_static_handle_repo_new ()</h3>
 
95
<pre class="programlisting"><a class="link" href="telepathy-glib-handle-repo.html#TpHandleRepoIface"><span class="returnvalue">TpHandleRepoIface</span></a> * tp_static_handle_repo_new           (<em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpHandleType" title="enum TpHandleType"><span class="type">TpHandleType</span></a> handle_type</code></em>,
 
96
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **handle_names</code></em>);</pre>
 
97
<p>
 
98
 
 
99
</p>
 
100
<div class="variablelist"><table border="0" class="variablelist">
127
101
<colgroup>
128
 
<col width="150px" class="parameters_name">
129
 
<col class="parameters_description">
130
 
<col width="200px" class="parameters_annotations">
 
102
<col align="left" valign="top">
 
103
<col>
131
104
</colgroup>
132
105
<tbody>
133
106
<tr>
134
 
<td class="parameter_name"><p>handle_type</p></td>
135
 
<td class="parameter_description"><p>The type of handle to store in the
136
 
new repository</p></td>
137
 
<td class="parameter_annotations"> </td>
138
 
</tr>
139
 
<tr>
140
 
<td class="parameter_name"><p>handle_names</p></td>
141
 
<td class="parameter_description"><p>Same as <a class="link" href="TpStaticHandleRepo.html#TpStaticHandleRepo--handle-names" title="The “handle-names” property"><span class="type">“handle-names”</span></a></p></td>
142
 
<td class="parameter_annotations"> </td>
 
107
<td><p><span class="term"><em class="parameter"><code>handle_type</code></em> :</span></p></td>
 
108
<td>The type of handle to store in the
 
109
new repository</td>
 
110
</tr>
 
111
<tr>
 
112
<td><p><span class="term"><em class="parameter"><code>handle_names</code></em> :</span></p></td>
 
113
<td>Same as <a class="link" href="TpStaticHandleRepo.html#TpStaticHandleRepo--handle-names" title='The "handle-names" property'><span class="type">"handle-names"</span></a>
 
114
</td>
 
115
</tr>
 
116
<tr>
 
117
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
118
<td>a new static handle repository</td>
143
119
</tr>
144
120
</tbody>
145
121
</table></div>
146
122
</div>
147
 
<div class="refsect3">
148
 
<a name="id-1.7.3.10.2.6"></a><h4>Returns</h4>
149
 
<p> a new static handle repository</p>
150
 
<p></p>
151
 
</div>
152
 
</div>
153
 
</div>
154
 
<div class="refsect1">
155
 
<a name="TpStaticHandleRepo.other_details"></a><h2>Types and Values</h2>
 
123
<hr>
156
124
<div class="refsect2">
157
125
<a name="TpStaticHandleRepo-struct"></a><h3>TpStaticHandleRepo</h3>
158
126
<pre class="programlisting">typedef struct _TpStaticHandleRepo TpStaticHandleRepo;</pre>
159
 
<p>A static handle repository contains a fixed set of handles.</p>
160
 
<p>As well as setting the <a class="link" href="telepathy-glib-handle-repo.html#TpHandleRepoIface--handle-type" title="The “handle-type” property"><span class="type">“handle-type”</span></a> property, code
 
127
<p>
 
128
A static handle repository contains a fixed set of handles.
 
129
</p>
 
130
<p>
 
131
As well as setting the <a class="link" href="telepathy-glib-handle-repo.html#TpHandleRepoIface--handle-type" title='The "handle-type" property'><span class="type">"handle-type"</span></a> property, code
161
132
which creates a static handle repository must set the
162
 
<a class="link" href="TpStaticHandleRepo.html#TpStaticHandleRepo--handle-names" title="The “handle-names” property"><span class="type">“handle-names”</span></a> construction property to a strv of
 
133
<a class="link" href="TpStaticHandleRepo.html#TpStaticHandleRepo--handle-names" title='The "handle-names" property'><span class="type">"handle-names"</span></a> construction property to a strv of
163
134
valid handle names. All of these are preallocated; no more may be
164
 
created, and attempts to do so will fail.</p>
165
 
<p>Handles in this repository are 1 more than the index in the string
 
135
created, and attempts to do so will fail.
 
136
</p>
 
137
<p>
 
138
Handles in this repository are 1 more than the index in the string
166
139
vector of the handle's name, so the first name in the vector has
167
140
handle 1 and so on. Connection managers which use a static repository
168
141
may assume this to be true, and use an enumeration starting at 1, in the
169
142
same order as the string vector, to avoid having to look up handles
170
 
internally.</p>
171
 
<p>This is intended for handles of type <a class="link" href="telepathy-glib-enums.html#TP-HANDLE-TYPE-LIST:CAPS"><code class="literal">TP_HANDLE_TYPE_LIST</code></a>,
 
143
internally.
 
144
</p>
 
145
<p>
 
146
This is intended for handles of type <a class="link" href="telepathy-glib-enums.html#TP-HANDLE-TYPE-LIST:CAPS"><code class="literal">TP_HANDLE_TYPE_LIST</code></a>,
172
147
for which the connection manager should only accept a static list of
173
 
supported handle names.</p>
174
 
<p>All structure fields are private.</p>
 
148
supported handle names.
 
149
</p>
 
150
<p>
 
151
All structure fields are private.
 
152
</p>
175
153
</div>
176
154
<hr>
177
155
<div class="refsect2">
178
156
<a name="TpStaticHandleRepoClass"></a><h3>TpStaticHandleRepoClass</h3>
179
157
<pre class="programlisting">typedef struct _TpStaticHandleRepoClass TpStaticHandleRepoClass;</pre>
180
 
<p>The class of a TpStaticHandleRepo. All fields are private.</p>
 
158
<p>
 
159
The class of a TpStaticHandleRepo. All fields are private.
 
160
</p>
181
161
</div>
182
162
</div>
183
163
<div class="refsect1">
184
164
<a name="TpStaticHandleRepo.property-details"></a><h2>Property Details</h2>
185
165
<div class="refsect2">
186
 
<a name="TpStaticHandleRepo--handle-names"></a><h3>The <code class="literal">“handle-names”</code> property</h3>
187
 
<pre class="programlisting">  “handle-names”             <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Boxed-Types.html#GStrv"><span class="type">GStrv</span></a></pre>
 
166
<a name="TpStaticHandleRepo--handle-names"></a><h3>The <code class="literal">"handle-names"</code> property</h3>
 
167
<pre class="programlisting">  "handle-names"             <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Boxed-Types.html#GStrv"><span class="type">GStrv</span></a>                 : Read / Write / Construct Only</pre>
188
168
<p>The static set of handle names supported by this repo.</p>
189
 
<p>Flags: Read / Write / Construct Only</p>
190
169
</div>
191
170
</div>
192
171
<div class="refsect1">
193
172
<a name="TpStaticHandleRepo.see-also"></a><h2>See Also</h2>
194
 
<p>TpHandleRepoIface, TpDynamicHandleRepo</p>
 
173
TpHandleRepoIface, TpDynamicHandleRepo
195
174
</div>
196
175
</div>
197
176
<div class="footer">
198
177
<hr>
199
 
          Generated by GTK-Doc V1.20</div>
 
178
          Generated by GTK-Doc V1.19</div>
200
179
</body>
201
180
</html>
 
 
b'\\ No newline at end of file'