← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/libempathy/xml/empathy-irc-server.xml

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/xml/empathy-irc-server.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
<!ENTITY version SYSTEM "version.xml">
 
5
]>
 
6
<refentry id="EmpathyIrcServer">
 
7
<refmeta>
 
8
<refentrytitle role="top_of_page">EmpathyIrcServer</refentrytitle>
 
9
<manvolnum>3</manvolnum>
 
10
<refmiscinfo>LIBEMPATHY Library</refmiscinfo>
 
11
</refmeta>
 
12
 
 
13
<refnamediv>
 
14
<refname>EmpathyIrcServer</refname>
 
15
<refpurpose></refpurpose>
 
16
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
 
17
</refnamediv>
 
18
 
 
19
<refsynopsisdiv role="synopsis">
 
20
<title role="synopsis.title">Synopsis</title>
 
21
 
 
22
<synopsis>
 
23
 
 
24
 
 
25
 
 
26
                    <link linkend="EmpathyIrcServer-struct">EmpathyIrcServer</link>;
 
27
<link linkend="EmpathyIrcServer">EmpathyIrcServer</link>*   <link linkend="empathy-irc-server-new">empathy_irc_server_new</link>              (const <link linkend="gchar">gchar</link> *address,
 
28
                                                         <link linkend="guint">guint</link> port,
 
29
                                                         <link linkend="gboolean">gboolean</link> ssl);
 
30
 
 
31
</synopsis>
 
32
</refsynopsisdiv>
 
33
 
 
34
<refsect1 role="object_hierarchy">
 
35
<title role="object_hierarchy.title">Object Hierarchy</title>
 
36
<synopsis>
 
37
 
 
38
  <link linkend="GObject">GObject</link>
 
39
   +----EmpathyIrcServer
 
40
</synopsis>
 
41
 
 
42
</refsect1>
 
43
 
 
44
 
 
45
 
 
46
 
 
47
 
 
48
<refsect1 role="properties">
 
49
<title role="properties.title">Properties</title>
 
50
<synopsis>
 
51
 
 
52
  &quot;<link linkend="EmpathyIrcServer--address">address</link>&quot;                  <link linkend="gchararray">gchararray</link>            : Read / Write
 
53
  &quot;<link linkend="EmpathyIrcServer--port">port</link>&quot;                     <link linkend="guint">guint</link>                 : Read / Write
 
54
  &quot;<link linkend="EmpathyIrcServer--ssl">ssl</link>&quot;                      <link linkend="gboolean">gboolean</link>              : Read / Write
 
55
</synopsis>
 
56
</refsect1>
 
57
 
 
58
<refsect1 role="signal_proto">
 
59
<title role="signal_proto.title">Signals</title>
 
60
<synopsis>
 
61
 
 
62
  &quot;<link linkend="EmpathyIrcServer-modified">modified</link>&quot;                                       : Run Last / Has Details
 
63
</synopsis>
 
64
</refsect1>
 
65
 
 
66
 
 
67
<refsect1 role="desc">
 
68
<title role="desc.title">Description</title>
 
69
<para>
 
70
 
 
71
</para>
 
72
</refsect1>
 
73
 
 
74
<refsect1 role="details">
 
75
<title role="details.title">Details</title>
 
76
<refsect2>
 
77
<title><anchor id="EmpathyIrcServer-struct" role="struct"/>EmpathyIrcServer</title>
 
78
<indexterm><primary>EmpathyIrcServer</primary></indexterm><programlisting>typedef struct _EmpathyIrcServer EmpathyIrcServer;</programlisting>
 
79
<para>
 
80
 
 
81
</para></refsect2>
 
82
<refsect2>
 
83
<title><anchor id="empathy-irc-server-new" role="function"/>empathy_irc_server_new ()</title>
 
84
<indexterm><primary>empathy_irc_server_new</primary></indexterm><programlisting><link linkend="EmpathyIrcServer">EmpathyIrcServer</link>*   empathy_irc_server_new              (const <link linkend="gchar">gchar</link> *address,
 
85
                                                         <link linkend="guint">guint</link> port,
 
86
                                                         <link linkend="gboolean">gboolean</link> ssl);</programlisting>
 
87
<para>
 
88
Creates a new <link linkend="EmpathyIrcServer"><type>EmpathyIrcServer</type></link></para>
 
89
<para>
 
90
 
 
91
</para><variablelist role="params">
 
92
<varlistentry><term><parameter>address</parameter>&nbsp;:</term>
 
93
<listitem><simpara> the address
 
94
</simpara></listitem></varlistentry>
 
95
<varlistentry><term><parameter>port</parameter>&nbsp;:</term>
 
96
<listitem><simpara> the port
 
97
</simpara></listitem></varlistentry>
 
98
<varlistentry><term><parameter>ssl</parameter>&nbsp;:</term>
 
99
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the server needs a SSL connection
 
100
</simpara></listitem></varlistentry>
 
101
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="EmpathyIrcServer"><type>EmpathyIrcServer</type></link>
 
102
</simpara></listitem></varlistentry>
 
103
</variablelist></refsect2>
 
104
 
 
105
</refsect1>
 
106
<refsect1 role="property_details">
 
107
<title role="property_details.title">Property Details</title>
 
108
<refsect2><title><anchor id="EmpathyIrcServer--address"/>The <literal>&quot;address&quot;</literal> property</title>
 
109
<indexterm><primary>EmpathyIrcServer:address</primary></indexterm><programlisting>  &quot;address&quot;                  <link linkend="gchararray">gchararray</link>            : Read / Write</programlisting>
 
110
<para>The address of this server.</para><para>Default value: NULL</para>
 
111
</refsect2>
 
112
<refsect2><title><anchor id="EmpathyIrcServer--port"/>The <literal>&quot;port&quot;</literal> property</title>
 
113
<indexterm><primary>EmpathyIrcServer:port</primary></indexterm><programlisting>  &quot;port&quot;                     <link linkend="guint">guint</link>                 : Read / Write</programlisting>
 
114
<para>The port to use to connect on this server.</para><para>Allowed values: [1,65535]</para>
 
115
<para>Default value: 6667</para>
 
116
</refsect2>
 
117
<refsect2><title><anchor id="EmpathyIrcServer--ssl"/>The <literal>&quot;ssl&quot;</literal> property</title>
 
118
<indexterm><primary>EmpathyIrcServer:ssl</primary></indexterm><programlisting>  &quot;ssl&quot;                      <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
 
119
<para>If this server needs SSL connection.</para><para>Default value: FALSE</para>
 
120
</refsect2>
 
121
 
 
122
</refsect1>
 
123
 
 
124
<refsect1 role="signals">
 
125
<title role="signals.title">Signal Details</title>
 
126
<refsect2><title><anchor id="EmpathyIrcServer-modified"/>The <literal>&quot;modified&quot;</literal> signal</title>
 
127
<indexterm><primary>EmpathyIrcServer::modified</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EmpathyIrcServer">EmpathyIrcServer</link> *server,
 
128
                                                        <link linkend="gpointer">gpointer</link>          user_data)      : Run Last / Has Details</programlisting>
 
129
<para>
 
130
Emitted when a property of the server is modified.</para>
 
131
<para>
 
132
 
 
133
</para><variablelist role="params">
 
134
<varlistentry><term><parameter>server</parameter>&nbsp;:</term>
 
135
<listitem><simpara> the object that received the signal
 
136
</simpara></listitem></varlistentry>
 
137
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
138
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
139
</variablelist></refsect2>
 
140
</refsect1>
 
141
 
 
142
 
 
143
 
 
144
 
 
145
<refsect1><refsect2 /><refsect2 /></refsect1>
 
146
</refentry>