← 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-network-manager.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sjoerd Simons
  • Date: 2008-03-10 16:39:07 UTC
  • mfrom: (1.1.13 upstream)
  • Revision ID: james.westby@ubuntu.com-20080310163907-tv41g2zmf0qqgi85
Tags: 0.22.0-1
New upstream release

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/libempathy/xml/empathy-irc-network-manager.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="EmpathyIrcNetworkManager">
 
7
<refmeta>
 
8
<refentrytitle role="top_of_page">EmpathyIrcNetworkManager</refentrytitle>
 
9
<manvolnum>3</manvolnum>
 
10
<refmiscinfo>LIBEMPATHY Library</refmiscinfo>
 
11
</refmeta>
 
12
 
 
13
<refnamediv>
 
14
<refname>EmpathyIrcNetworkManager</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="EmpathyIrcNetworkManager-struct">EmpathyIrcNetworkManager</link>;
 
27
<link linkend="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</link>* <link linkend="empathy-irc-network-manager-new">empathy_irc_network_manager_new</link>
 
28
                                                        (const <link linkend="gchar">gchar</link> *global_file,
 
29
                                                         const <link linkend="gchar">gchar</link> *user_file);
 
30
<link linkend="void">void</link>                <link linkend="empathy-irc-network-manager-add">empathy_irc_network_manager_add</link>     (<link linkend="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</link> *manager,
 
31
                                                         <link linkend="EmpathyIrcNetwork">EmpathyIrcNetwork</link> *network);
 
32
<link linkend="void">void</link>                <link linkend="empathy-irc-network-manager-remove">empathy_irc_network_manager_remove</link>  (<link linkend="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</link> *manager,
 
33
                                                         <link linkend="EmpathyIrcNetwork">EmpathyIrcNetwork</link> *network);
 
34
<link linkend="GSList">GSList</link>*             <link linkend="empathy-irc-network-manager-get-networks">empathy_irc_network_manager_get_networks</link>
 
35
                                                        (<link linkend="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</link> *manager);
 
36
<link linkend="EmpathyIrcNetwork">EmpathyIrcNetwork</link>*  <link linkend="empathy-irc-network-manager-find-network-by-address">empathy_irc_network_manager_find_network_by_address</link>
 
37
                                                        (<link linkend="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</link> *manager,
 
38
                                                         const <link linkend="gchar">gchar</link> *address);
 
39
 
 
40
</synopsis>
 
41
</refsynopsisdiv>
 
42
 
 
43
<refsect1 role="object_hierarchy">
 
44
<title role="object_hierarchy.title">Object Hierarchy</title>
 
45
<synopsis>
 
46
 
 
47
  <link linkend="GObject">GObject</link>
 
48
   +----EmpathyIrcNetworkManager
 
49
</synopsis>
 
50
 
 
51
</refsect1>
 
52
 
 
53
 
 
54
 
 
55
 
 
56
 
 
57
<refsect1 role="properties">
 
58
<title role="properties.title">Properties</title>
 
59
<synopsis>
 
60
 
 
61
  &quot;<link linkend="EmpathyIrcNetworkManager--global-file">global-file</link>&quot;              <link linkend="gchararray">gchararray</link>            : Read / Write / Construct Only
 
62
  &quot;<link linkend="EmpathyIrcNetworkManager--user-file">user-file</link>&quot;                <link linkend="gchararray">gchararray</link>            : Read / Write / Construct Only
 
63
</synopsis>
 
64
</refsect1>
 
65
 
 
66
 
 
67
 
 
68
<refsect1 role="desc">
 
69
<title role="desc.title">Description</title>
 
70
<para>
 
71
 
 
72
</para>
 
73
</refsect1>
 
74
 
 
75
<refsect1 role="details">
 
76
<title role="details.title">Details</title>
 
77
<refsect2>
 
78
<title><anchor id="EmpathyIrcNetworkManager-struct" role="struct"/>EmpathyIrcNetworkManager</title>
 
79
<indexterm><primary>EmpathyIrcNetworkManager</primary></indexterm><programlisting>typedef struct _EmpathyIrcNetworkManager EmpathyIrcNetworkManager;</programlisting>
 
80
<para>
 
81
 
 
82
</para></refsect2>
 
83
<refsect2>
 
84
<title><anchor id="empathy-irc-network-manager-new" role="function"/>empathy_irc_network_manager_new ()</title>
 
85
<indexterm><primary>empathy_irc_network_manager_new</primary></indexterm><programlisting><link linkend="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</link>* empathy_irc_network_manager_new
 
86
                                                        (const <link linkend="gchar">gchar</link> *global_file,
 
87
                                                         const <link linkend="gchar">gchar</link> *user_file);</programlisting>
 
88
<para>
 
89
Creates a new <link linkend="EmpathyIrcNetworkManager"><type>EmpathyIrcNetworkManager</type></link></para>
 
90
<para>
 
91
 
 
92
</para><variablelist role="params">
 
93
<varlistentry><term><parameter>global_file</parameter>&nbsp;:</term>
 
94
<listitem><simpara> the path of the global networks file, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
95
</simpara></listitem></varlistentry>
 
96
<varlistentry><term><parameter>user_file</parameter>&nbsp;:</term>
 
97
<listitem><simpara> the path of the user networks file, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
98
</simpara></listitem></varlistentry>
 
99
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="EmpathyIrcNetworkManager"><type>EmpathyIrcNetworkManager</type></link>
 
100
</simpara></listitem></varlistentry>
 
101
</variablelist></refsect2>
 
102
<refsect2>
 
103
<title><anchor id="empathy-irc-network-manager-add" role="function"/>empathy_irc_network_manager_add ()</title>
 
104
<indexterm><primary>empathy_irc_network_manager_add</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_irc_network_manager_add     (<link linkend="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</link> *manager,
 
105
                                                         <link linkend="EmpathyIrcNetwork">EmpathyIrcNetwork</link> *network);</programlisting>
 
106
<para>
 
107
Add an <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link> to the given <link linkend="EmpathyIrcNetworkManager"><type>EmpathyIrcNetworkManager</type></link>.</para>
 
108
<para>
 
109
 
 
110
</para><variablelist role="params">
 
111
<varlistentry><term><parameter>manager</parameter>&nbsp;:</term>
 
112
<listitem><simpara> an <link linkend="EmpathyIrcNetworkManager"><type>EmpathyIrcNetworkManager</type></link>
 
113
</simpara></listitem></varlistentry>
 
114
<varlistentry><term><parameter>network</parameter>&nbsp;:</term>
 
115
<listitem><simpara> the <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link> to add
 
116
</simpara></listitem></varlistentry>
 
117
</variablelist></refsect2>
 
118
<refsect2>
 
119
<title><anchor id="empathy-irc-network-manager-remove" role="function"/>empathy_irc_network_manager_remove ()</title>
 
120
<indexterm><primary>empathy_irc_network_manager_remove</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_irc_network_manager_remove  (<link linkend="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</link> *manager,
 
121
                                                         <link linkend="EmpathyIrcNetwork">EmpathyIrcNetwork</link> *network);</programlisting>
 
122
<para>
 
123
Remove an <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link> from the given <link linkend="EmpathyIrcNetworkManager"><type>EmpathyIrcNetworkManager</type></link>.</para>
 
124
<para>
 
125
 
 
126
</para><variablelist role="params">
 
127
<varlistentry><term><parameter>manager</parameter>&nbsp;:</term>
 
128
<listitem><simpara> an <link linkend="EmpathyIrcNetworkManager"><type>EmpathyIrcNetworkManager</type></link>
 
129
</simpara></listitem></varlistentry>
 
130
<varlistentry><term><parameter>network</parameter>&nbsp;:</term>
 
131
<listitem><simpara> the <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link> to remove
 
132
</simpara></listitem></varlistentry>
 
133
</variablelist></refsect2>
 
134
<refsect2>
 
135
<title><anchor id="empathy-irc-network-manager-get-networks" role="function"/>empathy_irc_network_manager_get_networks ()</title>
 
136
<indexterm><primary>empathy_irc_network_manager_get_networks</primary></indexterm><programlisting><link linkend="GSList">GSList</link>*             empathy_irc_network_manager_get_networks
 
137
                                                        (<link linkend="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</link> *manager);</programlisting>
 
138
<para>
 
139
Get the list of <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link> associated with the given
 
140
manager.</para>
 
141
<para>
 
142
 
 
143
</para><variablelist role="params">
 
144
<varlistentry><term><parameter>manager</parameter>&nbsp;:</term>
 
145
<listitem><simpara> an <link linkend="EmpathyIrcNetworkManager"><type>EmpathyIrcNetworkManager</type></link>
 
146
</simpara></listitem></varlistentry>
 
147
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GSList"><type>GSList</type></link> of refed <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link>
 
148
</simpara></listitem></varlistentry>
 
149
</variablelist></refsect2>
 
150
<refsect2>
 
151
<title><anchor id="empathy-irc-network-manager-find-network-by-address" role="function"/>empathy_irc_network_manager_find_network_by_address ()</title>
 
152
<indexterm><primary>empathy_irc_network_manager_find_network_by_address</primary></indexterm><programlisting><link linkend="EmpathyIrcNetwork">EmpathyIrcNetwork</link>*  empathy_irc_network_manager_find_network_by_address
 
153
                                                        (<link linkend="EmpathyIrcNetworkManager">EmpathyIrcNetworkManager</link> *manager,
 
154
                                                         const <link linkend="gchar">gchar</link> *address);</programlisting>
 
155
<para>
 
156
Find the <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link> which owns an <link linkend="EmpathyIrcServer"><type>EmpathyIrcServer</type></link>
 
157
that has the given address.</para>
 
158
<para>
 
159
 
 
160
</para><variablelist role="params">
 
161
<varlistentry><term><parameter>manager</parameter>&nbsp;:</term>
 
162
<listitem><simpara> an <link linkend="EmpathyIrcNetworkManager"><type>EmpathyIrcNetworkManager</type></link>
 
163
</simpara></listitem></varlistentry>
 
164
<varlistentry><term><parameter>address</parameter>&nbsp;:</term>
 
165
<listitem><simpara> the server address to look for
 
166
</simpara></listitem></varlistentry>
 
167
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the found <link linkend="EmpathyIrcNetwork"><type>EmpathyIrcNetwork</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if not found.
 
168
</simpara></listitem></varlistentry>
 
169
</variablelist></refsect2>
 
170
 
 
171
</refsect1>
 
172
<refsect1 role="property_details">
 
173
<title role="property_details.title">Property Details</title>
 
174
<refsect2><title><anchor id="EmpathyIrcNetworkManager--global-file"/>The <literal>&quot;global-file&quot;</literal> property</title>
 
175
<indexterm><primary>EmpathyIrcNetworkManager:global-file</primary></indexterm><programlisting>  &quot;global-file&quot;              <link linkend="gchararray">gchararray</link>            : Read / Write / Construct Only</programlisting>
 
176
<para>The path of the system-wide filename from which we have to load the networks list.</para><para>Default value: NULL</para>
 
177
</refsect2>
 
178
<refsect2><title><anchor id="EmpathyIrcNetworkManager--user-file"/>The <literal>&quot;user-file&quot;</literal> property</title>
 
179
<indexterm><primary>EmpathyIrcNetworkManager:user-file</primary></indexterm><programlisting>  &quot;user-file&quot;                <link linkend="gchararray">gchararray</link>            : Read / Write / Construct Only</programlisting>
 
180
<para>The path of user's  filename from which we have to load the networks list and to which we'll save his modifications.</para><para>Default value: NULL</para>
 
181
</refsect2>
 
182
 
 
183
</refsect1>
 
184
 
 
185
 
 
186
 
 
187
 
 
188
 
 
189
<refsect1><refsect2 /><refsect2 /></refsect1>
 
190
</refentry>