← Back to branch summary

~ubuntu-branches/ubuntu/natty/empathy/natty-updates

« back to all changes in this revision

Viewing changes to docs/libempathy/html/EmpathyIrcServer.html

Tags: upstream-0.22.0
Import upstream version 0.22.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/libempathy/html/EmpathyIrcServer.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=US-ASCII">
 
5
<title>EmpathyIrcServer</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
 
7
<link rel="start" href="index.html" title="libempathy Reference Manual">
 
8
<link rel="up" href="libempathy_api.html" title="libempathy API reference">
 
9
<link rel="prev" href="EmpathyIdle.html" title="EmpathyIdle">
 
10
<link rel="next" href="EmpathyIrcNetwork.html" title="EmpathyIrcNetwork">
 
11
<meta name="generator" content="GTK-Doc V1.9 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
<link rel="part" href="pt01.html" title="Part&#160;I.&#160;libempathy Overview">
 
14
<link rel="part" href="pt02.html" title="Part&#160;II.&#160;API Reference">
 
15
<link rel="chapter" href="libempathy_api.html" title="libempathy API reference">
 
16
<link rel="chapter" href="libempathy-hierarchy.html" title="Object Hierarchy">
 
17
<link rel="index" href="ix01.html" title="Index">
 
18
</head>
 
19
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
20
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
21
<tr valign="middle">
 
22
<td><a accesskey="p" href="EmpathyIdle.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
23
<td><a accesskey="u" href="libempathy_api.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
24
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
25
<th width="100%" align="center">libempathy Reference Manual</th>
 
26
<td><a accesskey="n" href="EmpathyIrcNetwork.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
27
</tr>
 
28
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id351581" class="shortcut">Top</a>
 
29
                  &#160;|&#160;
 
30
                  <a href="#id376451" class="shortcut">Description</a>
 
31
                  &#160;|&#160;
 
32
                  <a href="#id356190" class="shortcut">Object Hierarchy</a>
 
33
                  &#160;|&#160;
 
34
                  <a href="#id367886" class="shortcut">Properties</a>
 
35
                  &#160;|&#160;
 
36
                  <a href="#id367939" class="shortcut">Signals</a></nobr></td></tr>
 
37
</table>
 
38
<div class="refentry" lang="en">
 
39
<a name="EmpathyIrcServer"></a><div class="titlepage"></div>
 
40
<div class="refnamediv"><table width="100%"><tr>
 
41
<td valign="top">
 
42
<h2>
 
43
<a name="id351581"></a><span class="refentrytitle">EmpathyIrcServer</span>
 
44
</h2>
 
45
<p>EmpathyIrcServer</p>
 
46
</td>
 
47
<td valign="top" align="right"></td>
 
48
</tr></table></div>
 
49
<div class="refsynopsisdiv">
 
50
<h2>Synopsis</h2>
 
51
<pre class="synopsis">
 
52
 
 
53
 
 
54
 
 
55
                    <a class="link" href="EmpathyIrcServer.html#EmpathyIrcServer-struct">EmpathyIrcServer</a>;
 
56
<a class="link" href="EmpathyIrcServer.html" title="EmpathyIrcServer">EmpathyIrcServer</a>*   <a class="link" href="EmpathyIrcServer.html#empathy-irc-server-new">empathy_irc_server_new</a>              (const gchar *address,
 
57
                                                         guint port,
 
58
                                                         gboolean ssl);
 
59
 
 
60
</pre>
 
61
</div>
 
62
<div class="refsect1" lang="en">
 
63
<a name="id356190"></a><h2>Object Hierarchy</h2>
 
64
<pre class="synopsis">
 
65
 
 
66
  GObject
 
67
   +----EmpathyIrcServer
 
68
</pre>
 
69
</div>
 
70
<div class="refsect1" lang="en">
 
71
<a name="id367886"></a><h2>Properties</h2>
 
72
<pre class="synopsis">
 
73
 
 
74
  "<a class="link" href="EmpathyIrcServer.html#EmpathyIrcServer--address">address</a>"                  gchararray            : Read / Write
 
75
  "<a class="link" href="EmpathyIrcServer.html#EmpathyIrcServer--port">port</a>"                     guint                 : Read / Write
 
76
  "<a class="link" href="EmpathyIrcServer.html#EmpathyIrcServer--ssl">ssl</a>"                      gboolean              : Read / Write
 
77
</pre>
 
78
</div>
 
79
<div class="refsect1" lang="en">
 
80
<a name="id367939"></a><h2>Signals</h2>
 
81
<pre class="synopsis">
 
82
 
 
83
  "<a class="link" href="EmpathyIrcServer.html#EmpathyIrcServer-modified">modified</a>"                                       : Run Last / Has Details
 
84
</pre>
 
85
</div>
 
86
<div class="refsect1" lang="en">
 
87
<a name="id376451"></a><h2>Description</h2>
 
88
<p>
 
89
 
 
90
</p>
 
91
</div>
 
92
<div class="refsect1" lang="en">
 
93
<a name="id376467"></a><h2>Details</h2>
 
94
<div class="refsect2" lang="en">
 
95
<a name="id376477"></a><h3>
 
96
<a name="EmpathyIrcServer-struct"></a>EmpathyIrcServer</h3>
 
97
<a class="indexterm" name="id376489"></a><pre class="programlisting">typedef struct _EmpathyIrcServer EmpathyIrcServer;</pre>
 
98
<p>
 
99
 
 
100
</p>
 
101
</div>
 
102
<hr>
 
103
<div class="refsect2" lang="en">
 
104
<a name="id376505"></a><h3>
 
105
<a name="empathy-irc-server-new"></a>empathy_irc_server_new ()</h3>
 
106
<a class="indexterm" name="id376517"></a><pre class="programlisting"><a class="link" href="EmpathyIrcServer.html" title="EmpathyIrcServer">EmpathyIrcServer</a>*   empathy_irc_server_new              (const gchar *address,
 
107
                                                         guint port,
 
108
                                                         gboolean ssl);</pre>
 
109
<p>
 
110
Creates a new <a class="link" href="EmpathyIrcServer.html" title="EmpathyIrcServer"><span class="type">EmpathyIrcServer</span></a></p>
 
111
<p>
 
112
 
 
113
</p>
 
114
<div class="variablelist"><table border="0">
 
115
<col align="left" valign="top">
 
116
<tbody>
 
117
<tr>
 
118
<td><p><span class="term"><em class="parameter"><code>address</code></em>&#160;:</span></p></td>
 
119
<td> the address
 
120
</td>
 
121
</tr>
 
122
<tr>
 
123
<td><p><span class="term"><em class="parameter"><code>port</code></em>&#160;:</span></p></td>
 
124
<td> the port
 
125
</td>
 
126
</tr>
 
127
<tr>
 
128
<td><p><span class="term"><em class="parameter"><code>ssl</code></em>&#160;:</span></p></td>
 
129
<td> <code class="literal">TRUE</code> if the server needs a SSL connection
 
130
</td>
 
131
</tr>
 
132
<tr>
 
133
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
134
<td> a new <a class="link" href="EmpathyIrcServer.html" title="EmpathyIrcServer"><span class="type">EmpathyIrcServer</span></a>
 
135
</td>
 
136
</tr>
 
137
</tbody>
 
138
</table></div>
 
139
</div>
 
140
</div>
 
141
<div class="refsect1" lang="en">
 
142
<a name="id384389"></a><h2>Property Details</h2>
 
143
<div class="refsect2" lang="en">
 
144
<a name="id384399"></a><h3>
 
145
<a name="EmpathyIrcServer--address"></a>The <code class="literal">"address"</code> property</h3>
 
146
<a class="indexterm" name="id390843"></a><pre class="programlisting">  "address"                  gchararray            : Read / Write</pre>
 
147
<p>The address of this server.</p>
 
148
<p>Default value: NULL</p>
 
149
</div>
 
150
<hr>
 
151
<div class="refsect2" lang="en">
 
152
<a name="id390868"></a><h3>
 
153
<a name="EmpathyIrcServer--port"></a>The <code class="literal">"port"</code> property</h3>
 
154
<a class="indexterm" name="id390882"></a><pre class="programlisting">  "port"                     guint                 : Read / Write</pre>
 
155
<p>The port to use to connect on this server.</p>
 
156
<p>Allowed values: [1,65535]</p>
 
157
<p>Default value: 6667</p>
 
158
</div>
 
159
<hr>
 
160
<div class="refsect2" lang="en">
 
161
<a name="id390911"></a><h3>
 
162
<a name="EmpathyIrcServer--ssl"></a>The <code class="literal">"ssl"</code> property</h3>
 
163
<a class="indexterm" name="id390926"></a><pre class="programlisting">  "ssl"                      gboolean              : Read / Write</pre>
 
164
<p>If this server needs SSL connection.</p>
 
165
<p>Default value: FALSE</p>
 
166
</div>
 
167
</div>
 
168
<div class="refsect1" lang="en">
 
169
<a name="id390953"></a><h2>Signal Details</h2>
 
170
<div class="refsect2" lang="en">
 
171
<a name="id390963"></a><h3>
 
172
<a name="EmpathyIrcServer-modified"></a>The <code class="literal">"modified"</code> signal</h3>
 
173
<a class="indexterm" name="id390978"></a><pre class="programlisting">void                user_function                      (<a class="link" href="EmpathyIrcServer.html" title="EmpathyIrcServer">EmpathyIrcServer</a> *server,
 
174
                                                        gpointer          user_data)      : Run Last / Has Details</pre>
 
175
<p>
 
176
Emitted when a property of the server is modified.</p>
 
177
<p>
 
178
 
 
179
</p>
 
180
<div class="variablelist"><table border="0">
 
181
<col align="left" valign="top">
 
182
<tbody>
 
183
<tr>
 
184
<td><p><span class="term"><em class="parameter"><code>server</code></em>&#160;:</span></p></td>
 
185
<td> the object that received the signal
 
186
</td>
 
187
</tr>
 
188
<tr>
 
189
<td><p><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></p></td>
 
190
<td>user data set when the signal handler was connected.</td>
 
191
</tr>
 
192
</tbody>
 
193
</table></div>
 
194
</div>
 
195
</div>
 
196
<div class="refsect1" lang="en">
 
197
<a name="id391047"></a><div class="refsect2" lang="en"><a name="id391048"></a></div>
 
198
<hr>
 
199
<div class="refsect2" lang="en"><a name="id391050"></a></div>
 
200
</div>
 
201
</div>
 
202
</body>
 
203
</html>