libinfinity-0.6-doc 0.6.7-1~deb8u1 / usr / share / gtk-doc / html / libinfinity-0.6 / InfBuffer.html

This file is indexed.

/usr/share/gtk-doc/html/libinfinity-0.6/InfBuffer.html is in libinfinity-0.6-doc 0.6.7-1~deb8u1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>libinfinity-0.6 Reference Manual: InfBuffer</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libinfinity-0.6 Reference Manual">
<link rel="up" href="ch02.html" title="Common libinfinity API">
<link rel="prev" href="libinfinity-0.6-InfNativeSocket.html" title="InfNativeSocket">
<link rel="next" href="ch03.html" title="Libinfinity's adOPTed implementation">
<meta name="generator" content="GTK-Doc V1.21 (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="#InfBuffer.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#InfBuffer.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites">  <span class="dim">|</span> 
                  <a href="#InfBuffer.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_implementations">  <span class="dim">|</span> 
                  <a href="#InfBuffer.implementations" class="shortcut">Known Implementations</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#InfBuffer.properties" class="shortcut">Properties</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libinfinity-0.6-InfNativeSocket.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ch03.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="InfBuffer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfBuffer.top_of_page"></a>InfBuffer</span></h2>
<p>InfBuffer — Abstract document interface</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfBuffer.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="InfBuffer.html#inf-buffer-get-modified" title="inf_buffer_get_modified ()">inf_buffer_get_modified</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="InfBuffer.html#inf-buffer-set-modified" title="inf_buffer_set_modified ()">inf_buffer_set_modified</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfBuffer.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="InfBuffer.html#InfBuffer--modified" title="The “modified” property">modified</a></td>
<td class="property_flags">Read / Write</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfBuffer.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table 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="InfBuffer.html#InfBuffer-struct" title="InfBuffer">InfBuffer</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfBuffer.html#InfBufferIface" title="struct InfBufferIface">InfBufferIface</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfBuffer.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GInterface
    <span class="lineart">╰──</span> InfBuffer
</pre>
</div>
<div class="refsect1">
<a name="InfBuffer.prerequisites"></a><h2>Prerequisites</h2>
<p>
InfBuffer requires
 GObject.</p>
</div>
<div class="refsect1">
<a name="InfBuffer.implementations"></a><h2>Known Implementations</h2>
<p>
InfBuffer is implemented by
 <a class="link" href="InfChatBuffer.html" title="InfChatBuffer">InfChatBuffer</a>.</p>
</div>
<div class="refsect1">
<a name="InfBuffer.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libinfinity/common/inf-buffer.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="InfBuffer.description"></a><h2>Description</h2>
<p><a class="link" href="InfBuffer.html" title="InfBuffer"><span class="type">InfBuffer</span></a> represents a document containing a session's content. It does
not cope with keeping its content in-sync with other participants but just
offers an interface to modify the document.</p>
<p>The <a class="link" href="InfBuffer.html" title="InfBuffer"><span class="type">InfBuffer</span></a> interface itself is probably not too useful, but actual
documents implementing functionality (such as text editing or graphics
editing) need to implement this interface to be passed to <a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a>.</p>
</div>
<div class="refsect1">
<a name="InfBuffer.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="inf-buffer-get-modified"></a><h3>inf_buffer_get_modified ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
inf_buffer_get_modified (<em class="parameter"><code><a class="link" href="InfBuffer.html" title="InfBuffer"><span class="type">InfBuffer</span></a> *buffer</code></em>);</pre>
<p>Indicates whether the buffer has been modified since the last call to
<a class="link" href="InfBuffer.html#inf-buffer-set-modified" title="inf_buffer_set_modified ()"><code class="function">inf_buffer_set_modified()</code></a> set the modification flag to <code class="literal">FALSE</code>.</p>
<div class="refsect3">
<a name="id-1.3.36.11.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>buffer</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfBuffer.html" title="InfBuffer"><span class="type">InfBuffer</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.36.11.2.6"></a><h4>Returns</h4>
<p> Whether the buffer has been modified.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-buffer-set-modified"></a><h3>inf_buffer_set_modified ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_buffer_set_modified (<em class="parameter"><code><a class="link" href="InfBuffer.html" title="InfBuffer"><span class="type">InfBuffer</span></a> *buffer</code></em>,
                         <em class="parameter"><code><span class="type">gboolean</span> modified</code></em>);</pre>
<p>Sets the modification flag of <em class="parameter"><code>buffer</code></em>
 to <em class="parameter"><code>modified</code></em>
. You should normally set
the flag to <code class="literal">FALSE</code> every time the document is saved onto disk. The buffer
itself will set it to <code class="literal">TRUE</code> when it has been changed.</p>
<p>To get notified when the modification flag changes, connect to
GObject::notify for the InfBuffer:modified property.</p>
<div class="refsect3">
<a name="id-1.3.36.11.3.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>buffer</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfBuffer.html" title="InfBuffer"><span class="type">InfBuffer</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>modified</p></td>
<td class="parameter_description"><p>Whether the buffer is considered modified or not.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfBuffer.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfBuffer-struct"></a><h3>InfBuffer</h3>
<pre class="programlisting">typedef struct _InfBuffer InfBuffer;</pre>
<p><a class="link" href="InfBuffer.html" title="InfBuffer"><span class="type">InfBuffer</span></a> is an opaque data type. You should only access it
via the public API functions.</p>
</div>
<hr>
<div class="refsect2">
<a name="InfBufferIface"></a><h3>struct InfBufferIface</h3>
<pre class="programlisting">struct InfBufferIface {
  gboolean (*get_modified)(InfBuffer* buffer);

  void (*set_modified)(InfBuffer* buffer,
                       gboolean modified);
};
</pre>
<p>The virtual methods of <a class="link" href="InfBuffer.html" title="InfBuffer"><span class="type">InfBuffer</span></a>.</p>
<div class="refsect3">
<a name="id-1.3.36.12.3.5"></a><h4>Members</h4>
<div class="informaltable"><table 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><em class="structfield"><code><a name="InfBufferIface.get-modified"></a>get_modified</code></em> ()</p></td>
<td class="struct_member_description"><p>Returns whether the buffer has been modified since the last
call to <em class="parameter"><code>set_modified</code></em>
set modified flag to <code class="literal">FALSE</code>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfBufferIface.set-modified"></a>set_modified</code></em> ()</p></td>
<td class="struct_member_description"><p>Set the current modified state of the buffer.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfBuffer.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="InfBuffer--modified"></a><h3>The <code class="literal">“modified”</code> property</h3>
<pre class="programlisting">  “modified”                 <span class="type">gboolean</span></pre>
<p>Whether the buffer was modified since it has been saved.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.21</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.