← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/libinfinity/oneiric

« back to all changes in this revision

Viewing changes to docs/reference/libinftextgtk/html/InfTextGtkViewport.html

  • Committer: Bazaar Package Importer
  • Author(s): Philipp Kern
  • Date: 2011-04-03 15:50:33 UTC
  • mfrom: (1.2.4 upstream) (1.4.10 sid)
  • Revision ID: james.westby@ubuntu.com-20110403155033-eqntz262lxzt0d8s
Tags: 0.5.0-2
http://bugs.debian.org/620687
* Fix infinoted postinst and prerm.  (Closes: #620687)
* Updated debian/copyright.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libinftextgtk/html/InfTextGtkViewport.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>InfTextGtkViewport</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
7
<link rel="home" href="index.html" title="libinftextgtk-0.5 Reference Manual">
 
8
<link rel="up" href="ch01.html" title="libinftextgtk API">
 
9
<link rel="prev" href="InfTextGtkView.html" title="InfTextGtkView">
 
10
<link rel="next" href="InfTextGtkHueChooser.html" title="InfTextGtkHueChooser">
 
11
<meta name="generator" content="GTK-Doc V1.17 (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="InfTextGtkView.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="ch01.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">libinftextgtk-0.5 Reference Manual</th>
 
21
<td><a accesskey="n" href="InfTextGtkHueChooser.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="#InfTextGtkViewport.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#InfTextGtkViewport.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#InfTextGtkViewport.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
                   | 
 
30
                  <a href="#InfTextGtkViewport.properties" class="shortcut">Properties</a>
 
31
</td></tr>
 
32
</table>
 
33
<div class="refentry">
 
34
<a name="InfTextGtkViewport"></a><div class="titlepage"></div>
 
35
<div class="refnamediv"><table width="100%"><tr>
 
36
<td valign="top">
 
37
<h2><span class="refentrytitle"><a name="InfTextGtkViewport.top_of_page"></a>InfTextGtkViewport</span></h2>
 
38
<p>InfTextGtkViewport</p>
 
39
</td>
 
40
<td valign="top" align="right"></td>
 
41
</tr></table></div>
 
42
<div class="refsynopsisdiv">
 
43
<a name="InfTextGtkViewport.synopsis"></a><h2>Synopsis</h2>
 
44
<pre class="synopsis">                    <a class="link" href="InfTextGtkViewport.html#InfTextGtkViewport-struct" title="InfTextGtkViewport">InfTextGtkViewport</a>;
 
45
<a class="link" href="InfTextGtkViewport.html" title="InfTextGtkViewport"><span class="returnvalue">InfTextGtkViewport</span></a> * <a class="link" href="InfTextGtkViewport.html#inf-text-gtk-viewport-new" title="inf_text_gtk_viewport_new ()">inf_text_gtk_viewport_new</a>          (<em class="parameter"><code><span class="type">GtkScrolledWindow</span> *scroll</code></em>,
 
46
                                                         <em class="parameter"><code><a href="http://infinote.0x539.de/libinfinity/API/libinfinity/InfUserTable.html"><span class="type">InfUserTable</span></a> *user_table</code></em>);
 
47
<span class="returnvalue">GtkScrolledWindow</span> * <a class="link" href="InfTextGtkViewport.html#inf-text-gtk-viewport-get-scrolled-window" title="inf_text_gtk_viewport_get_scrolled_window ()">inf_text_gtk_viewport_get_scrolled_window</a>
 
48
                                                        (<em class="parameter"><code><a class="link" href="InfTextGtkViewport.html" title="InfTextGtkViewport"><span class="type">InfTextGtkViewport</span></a> *viewport</code></em>);
 
49
<a href="http://infinote.0x539.de/libinfinity/API/libinfinity/InfUserTable.html"><span class="returnvalue">InfUserTable</span></a> *      <a class="link" href="InfTextGtkViewport.html#inf-text-gtk-viewport-get-user-table" title="inf_text_gtk_viewport_get_user_table ()">inf_text_gtk_viewport_get_user_table</a>
 
50
                                                        (<em class="parameter"><code><a class="link" href="InfTextGtkViewport.html" title="InfTextGtkViewport"><span class="type">InfTextGtkViewport</span></a> *viewport</code></em>);
 
51
<span class="returnvalue">void</span>                <a class="link" href="InfTextGtkViewport.html#inf-text-gtk-viewport-set-active-user" title="inf_text_gtk_viewport_set_active_user ()">inf_text_gtk_viewport_set_active_user</a>
 
52
                                                        (<em class="parameter"><code><a class="link" href="InfTextGtkViewport.html" title="InfTextGtkViewport"><span class="type">InfTextGtkViewport</span></a> *viewport</code></em>,
 
53
                                                         <em class="parameter"><code><a href="http://infinote.0x539.de/libinfinity/API/libinftext/InfTextUser.html"><span class="type">InfTextUser</span></a> *user</code></em>);
 
54
<a href="http://infinote.0x539.de/libinfinity/API/libinftext/InfTextUser.html"><span class="returnvalue">InfTextUser</span></a> *       <a class="link" href="InfTextGtkViewport.html#inf-text-gtk-viewport-get-active-user" title="inf_text_gtk_viewport_get_active_user ()">inf_text_gtk_viewport_get_active_user</a>
 
55
                                                        (<em class="parameter"><code><a class="link" href="InfTextGtkViewport.html" title="InfTextGtkViewport"><span class="type">InfTextGtkViewport</span></a> *viewport</code></em>);
 
56
<span class="returnvalue">void</span>                <a class="link" href="InfTextGtkViewport.html#inf-text-gtk-viewport-set-show-user-markers" title="inf_text_gtk_viewport_set_show_user_markers ()">inf_text_gtk_viewport_set_show_user_markers</a>
 
57
                                                        (<em class="parameter"><code><a class="link" href="InfTextGtkViewport.html" title="InfTextGtkViewport"><span class="type">InfTextGtkViewport</span></a> *viewport</code></em>,
 
58
                                                         <em class="parameter"><code><span class="type">gboolean</span> show</code></em>);
 
59
</pre>
 
60
</div>
 
61
<div class="refsect1">
 
62
<a name="InfTextGtkViewport.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
63
<pre class="synopsis">
 
64
  GObject
 
65
   +----InfTextGtkViewport
 
66
</pre>
 
67
</div>
 
68
<div class="refsect1">
 
69
<a name="InfTextGtkViewport.properties"></a><h2>Properties</h2>
 
70
<pre class="synopsis">
 
71
  "<a class="link" href="InfTextGtkViewport.html#InfTextGtkViewport--active-user" title='The "active-user" property'>active-user</a>"              <a href="http://infinote.0x539.de/libinfinity/API/libinftext/InfTextUser.html"><span class="type">InfTextUser</span></a>*          : Read / Write
 
72
  "<a class="link" href="InfTextGtkViewport.html#InfTextGtkViewport--scrolled-window" title='The "scrolled-window" property'>scrolled-window</a>"          <span class="type">GtkScrolledWindow</span>*    : Read / Write / Construct Only
 
73
  "<a class="link" href="InfTextGtkViewport.html#InfTextGtkViewport--show-user-markers" title='The "show-user-markers" property'>show-user-markers</a>"        <span class="type">gboolean</span>              : Read / Write
 
74
  "<a class="link" href="InfTextGtkViewport.html#InfTextGtkViewport--user-table" title='The "user-table" property'>user-table</a>"               <a href="http://infinote.0x539.de/libinfinity/API/libinfinity/InfUserTable.html"><span class="type">InfUserTable</span></a>*         : Read / Write / Construct Only
 
75
</pre>
 
76
</div>
 
77
<div class="refsect1">
 
78
<a name="InfTextGtkViewport.description"></a><h2>Description</h2>
 
79
<p>
 
80
</p>
 
81
</div>
 
82
<div class="refsect1">
 
83
<a name="InfTextGtkViewport.details"></a><h2>Details</h2>
 
84
<div class="refsect2">
 
85
<a name="InfTextGtkViewport-struct"></a><h3>InfTextGtkViewport</h3>
 
86
<pre class="programlisting">typedef struct _InfTextGtkViewport InfTextGtkViewport;</pre>
 
87
<p>
 
88
</p>
 
89
</div>
 
90
<hr>
 
91
<div class="refsect2">
 
92
<a name="inf-text-gtk-viewport-new"></a><h3>inf_text_gtk_viewport_new ()</h3>
 
93
<pre class="programlisting"><a class="link" href="InfTextGtkViewport.html" title="InfTextGtkViewport"><span class="returnvalue">InfTextGtkViewport</span></a> * inf_text_gtk_viewport_new          (<em class="parameter"><code><span class="type">GtkScrolledWindow</span> *scroll</code></em>,
 
94
                                                         <em class="parameter"><code><a href="http://infinote.0x539.de/libinfinity/API/libinfinity/InfUserTable.html"><span class="type">InfUserTable</span></a> *user_table</code></em>);</pre>
 
95
<p>
 
96
Creates a new <a class="link" href="InfTextGtkViewport.html" title="InfTextGtkViewport"><span class="type">InfTextGtkViewport</span></a> for <em class="parameter"><code>scroll</code></em>. This draws the position of
 
97
remote user's cursors into the scrollbars of <em class="parameter"><code>scroll</code></em>.
 
98
</p>
 
99
<div class="variablelist"><table border="0">
 
100
<col align="left" valign="top">
 
101
<tbody>
 
102
<tr>
 
103
<td><p><span class="term"><em class="parameter"><code>scroll</code></em> :</span></p></td>
 
104
<td>A <span class="type">GtkScrolledWindow</span>.</td>
 
105
</tr>
 
106
<tr>
 
107
<td><p><span class="term"><em class="parameter"><code>user_table</code></em> :</span></p></td>
 
108
<td>The <a href="http://infinote.0x539.de/libinfinity/API/libinfinity/InfUserTable.html"><span class="type">InfUserTable</span></a> for the text session displayed in <em class="parameter"><code>viewport</code></em>.</td>
 
109
</tr>
 
110
<tr>
 
111
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
112
<td>A new <a class="link" href="InfTextGtkViewport.html" title="InfTextGtkViewport"><span class="type">InfTextGtkViewport</span></a>.</td>
 
113
</tr>
 
114
</tbody>
 
115
</table></div>
 
116
</div>
 
117
<hr>
 
118
<div class="refsect2">
 
119
<a name="inf-text-gtk-viewport-get-scrolled-window"></a><h3>inf_text_gtk_viewport_get_scrolled_window ()</h3>
 
120
<pre class="programlisting"><span class="returnvalue">GtkScrolledWindow</span> * inf_text_gtk_viewport_get_scrolled_window
 
121
                                                        (<em class="parameter"><code><a class="link" href="InfTextGtkViewport.html" title="InfTextGtkViewport"><span class="type">InfTextGtkViewport</span></a> *viewport</code></em>);</pre>
 
122
<p>
 
123
Returns the underlying <span class="type">GtkScrolledWindow</span>.
 
124
</p>
 
125
<div class="variablelist"><table border="0">
 
126
<col align="left" valign="top">
 
127
<tbody>
 
128
<tr>
 
129
<td><p><span class="term"><em class="parameter"><code>viewport</code></em> :</span></p></td>
 
130
<td>A <a class="link" href="InfTextGtkViewport.html" title="InfTextGtkViewport"><span class="type">InfTextGtkViewport</span></a>.</td>
 
131
</tr>
 
132
<tr>
 
133
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
134
<td>The <a class="link" href="InfTextGtkViewport.html" title="InfTextGtkViewport"><span class="type">InfTextGtkViewport</span></a>'s <span class="type">GtkScrolledWindow</span>.</td>
 
135
</tr>
 
136
</tbody>
 
137
</table></div>
 
138
</div>
 
139
<hr>
 
140
<div class="refsect2">
 
141
<a name="inf-text-gtk-viewport-get-user-table"></a><h3>inf_text_gtk_viewport_get_user_table ()</h3>
 
142
<pre class="programlisting"><a href="http://infinote.0x539.de/libinfinity/API/libinfinity/InfUserTable.html"><span class="returnvalue">InfUserTable</span></a> *      inf_text_gtk_viewport_get_user_table
 
143
                                                        (<em class="parameter"><code><a class="link" href="InfTextGtkViewport.html" title="InfTextGtkViewport"><span class="type">InfTextGtkViewport</span></a> *viewport</code></em>);</pre>
 
144
<p>
 
145
Returns the <a href="http://infinote.0x539.de/libinfinity/API/libinfinity/InfUserTable.html"><span class="type">InfUserTable</span></a> containing the users of the session the
 
146
<a class="link" href="InfTextGtkViewport.html" title="InfTextGtkViewport"><span class="type">InfTextGtkViewport</span></a>'s <span class="type">GtkScrolledWindow</span> is displaying.
 
147
</p>
 
148
<div class="variablelist"><table border="0">
 
149
<col align="left" valign="top">
 
150
<tbody>
 
151
<tr>
 
152
<td><p><span class="term"><em class="parameter"><code>viewport</code></em> :</span></p></td>
 
153
<td>A <a class="link" href="InfTextGtkViewport.html" title="InfTextGtkViewport"><span class="type">InfTextGtkViewport</span></a>.</td>
 
154
</tr>
 
155
<tr>
 
156
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
157
<td>The <span class="type">InfGtkTextViewport</span>'s <a href="http://infinote.0x539.de/libinfinity/API/libinfinity/InfUserTable.html"><span class="type">InfUserTable</span></a>.</td>
 
158
</tr>
 
159
</tbody>
 
160
</table></div>
 
161
</div>
 
162
<hr>
 
163
<div class="refsect2">
 
164
<a name="inf-text-gtk-viewport-set-active-user"></a><h3>inf_text_gtk_viewport_set_active_user ()</h3>
 
165
<pre class="programlisting"><span class="returnvalue">void</span>                inf_text_gtk_viewport_set_active_user
 
166
                                                        (<em class="parameter"><code><a class="link" href="InfTextGtkViewport.html" title="InfTextGtkViewport"><span class="type">InfTextGtkViewport</span></a> *viewport</code></em>,
 
167
                                                         <em class="parameter"><code><a href="http://infinote.0x539.de/libinfinity/API/libinftext/InfTextUser.html"><span class="type">InfTextUser</span></a> *user</code></em>);</pre>
 
168
<p>
 
169
Sets the user for which perspective to draw the viewport. The cursor
 
170
position for teh active user is not draws since it is assumed that the
 
171
viewport's "real" scrollbars match the active user's position.
 
172
</p>
 
173
<div class="variablelist"><table border="0">
 
174
<col align="left" valign="top">
 
175
<tbody>
 
176
<tr>
 
177
<td><p><span class="term"><em class="parameter"><code>viewport</code></em> :</span></p></td>
 
178
<td>A <a class="link" href="InfTextGtkViewport.html" title="InfTextGtkViewport"><span class="type">InfTextGtkViewport</span></a>.</td>
 
179
</tr>
 
180
<tr>
 
181
<td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
 
182
<td>A user from <em class="parameter"><code>viewport</code></em>'s user table, or <code class="literal">NULL</code>.</td>
 
183
</tr>
 
184
</tbody>
 
185
</table></div>
 
186
</div>
 
187
<hr>
 
188
<div class="refsect2">
 
189
<a name="inf-text-gtk-viewport-get-active-user"></a><h3>inf_text_gtk_viewport_get_active_user ()</h3>
 
190
<pre class="programlisting"><a href="http://infinote.0x539.de/libinfinity/API/libinftext/InfTextUser.html"><span class="returnvalue">InfTextUser</span></a> *       inf_text_gtk_viewport_get_active_user
 
191
                                                        (<em class="parameter"><code><a class="link" href="InfTextGtkViewport.html" title="InfTextGtkViewport"><span class="type">InfTextGtkViewport</span></a> *viewport</code></em>);</pre>
 
192
<p>
 
193
Returns the active user of <em class="parameter"><code>viewport</code></em>. See
 
194
<a class="link" href="InfTextGtkViewport.html#inf-text-gtk-viewport-set-active-user" title="inf_text_gtk_viewport_set_active_user ()"><code class="function">inf_text_gtk_viewport_set_active_user()</code></a>.
 
195
</p>
 
196
<div class="variablelist"><table border="0">
 
197
<col align="left" valign="top">
 
198
<tbody>
 
199
<tr>
 
200
<td><p><span class="term"><em class="parameter"><code>viewport</code></em> :</span></p></td>
 
201
<td>A <a class="link" href="InfTextGtkViewport.html" title="InfTextGtkViewport"><span class="type">InfTextGtkViewport</span></a>.</td>
 
202
</tr>
 
203
<tr>
 
204
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
205
<td>The active user of <em class="parameter"><code>viewport</code></em>.</td>
 
206
</tr>
 
207
</tbody>
 
208
</table></div>
 
209
</div>
 
210
<hr>
 
211
<div class="refsect2">
 
212
<a name="inf-text-gtk-viewport-set-show-user-markers"></a><h3>inf_text_gtk_viewport_set_show_user_markers ()</h3>
 
213
<pre class="programlisting"><span class="returnvalue">void</span>                inf_text_gtk_viewport_set_show_user_markers
 
214
                                                        (<em class="parameter"><code><a class="link" href="InfTextGtkViewport.html" title="InfTextGtkViewport"><span class="type">InfTextGtkViewport</span></a> *viewport</code></em>,
 
215
                                                         <em class="parameter"><code><span class="type">gboolean</span> show</code></em>);</pre>
 
216
<p>
 
217
If <em class="parameter"><code>show</code></em> is <code class="literal">TRUE</code> then draw a marker indicating the cursor position of all
 
218
non-local users with status <code class="literal">INF_USER_ACTIVE</code> in the scrollbar of the
 
219
scrolled window. If <em class="parameter"><code>show</code></em> is <code class="literal">FALSE</code> then do not draw user markers into the
 
220
scrollbar.
 
221
</p>
 
222
<div class="variablelist"><table border="0">
 
223
<col align="left" valign="top">
 
224
<tbody>
 
225
<tr>
 
226
<td><p><span class="term"><em class="parameter"><code>viewport</code></em> :</span></p></td>
 
227
<td>A <a class="link" href="InfTextGtkViewport.html" title="InfTextGtkViewport"><span class="type">InfTextGtkViewport</span></a>.</td>
 
228
</tr>
 
229
<tr>
 
230
<td><p><span class="term"><em class="parameter"><code>show</code></em> :</span></p></td>
 
231
<td>Whether to show the position of non-local users.</td>
 
232
</tr>
 
233
</tbody>
 
234
</table></div>
 
235
</div>
 
236
</div>
 
237
<div class="refsect1">
 
238
<a name="InfTextGtkViewport.property-details"></a><h2>Property Details</h2>
 
239
<div class="refsect2">
 
240
<a name="InfTextGtkViewport--active-user"></a><h3>The <code class="literal">"active-user"</code> property</h3>
 
241
<pre class="programlisting">  "active-user"              <a href="http://infinote.0x539.de/libinfinity/API/libinftext/InfTextUser.html"><span class="type">InfTextUser</span></a>*          : Read / Write</pre>
 
242
<p>The user for which to show the viewport.</p>
 
243
</div>
 
244
<hr>
 
245
<div class="refsect2">
 
246
<a name="InfTextGtkViewport--scrolled-window"></a><h3>The <code class="literal">"scrolled-window"</code> property</h3>
 
247
<pre class="programlisting">  "scrolled-window"          <span class="type">GtkScrolledWindow</span>*    : Read / Write / Construct Only</pre>
 
248
<p>The underlying GtkScrolledWindow.</p>
 
249
</div>
 
250
<hr>
 
251
<div class="refsect2">
 
252
<a name="InfTextGtkViewport--show-user-markers"></a><h3>The <code class="literal">"show-user-markers"</code> property</h3>
 
253
<pre class="programlisting">  "show-user-markers"        <span class="type">gboolean</span>              : Read / Write</pre>
 
254
<p>Whether to indicate the position of non-local user's cursors in the scrollbar.</p>
 
255
<p>Default value: TRUE</p>
 
256
</div>
 
257
<hr>
 
258
<div class="refsect2">
 
259
<a name="InfTextGtkViewport--user-table"></a><h3>The <code class="literal">"user-table"</code> property</h3>
 
260
<pre class="programlisting">  "user-table"               <a href="http://infinote.0x539.de/libinfinity/API/libinfinity/InfUserTable.html"><span class="type">InfUserTable</span></a>*         : Read / Write / Construct Only</pre>
 
261
<p>The user table containing the users of the session shown in the viewport.</p>
 
262
</div>
 
263
</div>
 
264
</div>
 
265
<div class="footer">
 
266
<hr>
 
267
          Generated by GTK-Doc V1.17</div>
 
268
</body>
 
269
</html>
 
 
b'\\ No newline at end of file'