Mercurial > pidgin.yaz

comparison src/connection.h @ 6488:e5e8d21bd4d8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[gaim-migrate @ 7002] Some documentation updates. Really nothing great. committer: Tailor Script <tailor@pidgin.im>
author Christian Hammond <chipx86@chipx86.com>
date Mon, 18 Aug 2003 10:08:26 +0000
parents 70d5122bc3ff
children 0473a28ce807
comparison
equal deleted inserted replaced
6487:af83c7b6af00 6488:e5e8d21bd4d8
17 * GNU General Public License for more details. 17 * GNU General Public License for more details.
18 * 18 *
19 * You should have received a copy of the GNU General Public License 19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software 20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 *
23 * @signal signing-on (GaimConnection *gc)
24 * @signal signed-on (GaimConnection *gc)
25 * @signal signing-off (GaimConnection *gc)
26 * @signal signed-off (GaimConnection *gc)
22 */ 27 */
23 #ifndef _GAIM_CONNECTION_H_ 28 #ifndef _GAIM_CONNECTION_H_
24 #define _GAIM_CONNECTION_H_ 29 #define _GAIM_CONNECTION_H_
25 30
26 #include <stdlib.h> 31 #include <stdlib.h>
92 #endif 97 #endif
93 98
94 /**************************************************************************/ 99 /**************************************************************************/
95 /** @name Connection API */ 100 /** @name Connection API */
96 /**************************************************************************/ 101 /**************************************************************************/
102 /*@{*/
97 103
98 /** 104 /**
99 * Creates a connection to the specified account. 105 * Creates a connection to the specified account.
100 * 106 *
101 * @param account The account the connection should be connecting to. 107 * @param account The account the connection should be connecting to.
120 */ 126 */
121 void gaim_connection_connect(GaimConnection *gc); 127 void gaim_connection_connect(GaimConnection *gc);
122 128
123 /** 129 /**
124 * Signs a connection off. 130 * Signs a connection off.
125 * 131
126 * @param gc The connection to sign off. 132 * @param gc The connection to sign off.
127 * 133 *
128 * @see gaim_connection_connect() 134 * @see gaim_connection_connect()
129 */ 135 */
130 void gaim_connection_disconnect(GaimConnection *gc); 136 void gaim_connection_disconnect(GaimConnection *gc);
231 * 237 *
232 * @return A list of connecting connections. 238 * @return A list of connecting connections.
233 */ 239 */
234 GList *gaim_connections_get_connecting(void); 240 GList *gaim_connections_get_connecting(void);
235 241
242 /*@}*/
243
244 /**************************************************************************/
245 /** @name UI Operations API */
246 /**************************************************************************/
247 /*@{*/
248
249 /**
250 * Sets the UI operations structure to be used for connections.
251 *
252 * @param ops The UI operations structure.
253 */
254 void gaim_set_connection_ui_ops(GaimConnectionUiOps *ops);
255
256 /**
257 * Returns the UI operations structure used for connections.
258 *
259 * @return The UI operations structure in use.
260 */
261 GaimConnectionUiOps *gaim_get_connection_ui_ops(void);
262
263 /*@}*/
264
265 /**************************************************************************/
266 /** @name Connections Subsystem */
267 /**************************************************************************/
268 /*@{*/
269
236 /** 270 /**
237 * Initializes the connections subsystem. 271 * Initializes the connections subsystem.
238 */ 272 */
239 void gaim_connections_init(void); 273 void gaim_connections_init(void);
240 274
250 */ 284 */
251 void *gaim_connections_get_handle(void); 285 void *gaim_connections_get_handle(void);
252 286
253 /*@}*/ 287 /*@}*/
254 288
255 /**************************************************************************/
256 /** @name UI Operations API */
257 /**************************************************************************/
258 /*@{*/
259
260 /**
261 * Sets the UI operations structure to be used for connections.
262 *
263 * @param ops The UI operations structure.
264 */
265 void gaim_set_connection_ui_ops(GaimConnectionUiOps *ops);
266
267 /**
268 * Returns the UI operations structure used for connections.
269 *
270 * @return The UI operations structure in use.
271 */
272 GaimConnectionUiOps *gaim_get_connection_ui_ops(void);
273
274 /*@}*/
275 289
276 #ifdef __cplusplus 290 #ifdef __cplusplus
277 } 291 }
278 #endif 292 #endif
279 293