|
14192
|
1 /**
|
|
|
2 * @file group.h Group functions
|
|
|
3 *
|
|
|
4 * gaim
|
|
|
5 *
|
|
|
6 * Gaim is the legal property of its developers, whose names are too numerous
|
|
|
7 * to list here. Please refer to the COPYRIGHT file distributed with this
|
|
|
8 * source distribution.
|
|
|
9 *
|
|
|
10 * This program is free software; you can redistribute it and/or modify
|
|
|
11 * it under the terms of the GNU General Public License as published by
|
|
|
12 * the Free Software Foundation; either version 2 of the License, or
|
|
|
13 * (at your option) any later version.
|
|
|
14 *
|
|
|
15 * This program is distributed in the hope that it will be useful,
|
|
|
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
18 * GNU General Public License for more details.
|
|
|
19 *
|
|
|
20 * You should have received a copy of the GNU General Public License
|
|
|
21 * along with this program; if not, write to the Free Software
|
|
|
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
|
23 */
|
|
|
24 #ifndef _MSN_GROUP_H_
|
|
|
25 #define _MSN_GROUP_H_
|
|
|
26
|
|
|
27 typedef struct _MsnGroup MsnGroup;
|
|
|
28
|
|
|
29 #include <stdio.h>
|
|
|
30
|
|
|
31 #include "session.h"
|
|
|
32 #include "user.h"
|
|
|
33
|
|
|
34 #include "userlist.h"
|
|
|
35
|
|
|
36 /**
|
|
|
37 * A group.
|
|
|
38 */
|
|
|
39 struct _MsnGroup
|
|
|
40 {
|
|
|
41 MsnSession *session; /**< The MSN session. */
|
|
|
42
|
|
|
43 int id; /**< The group ID. */
|
|
|
44 char *name; /**< The name of the group. */
|
|
|
45 };
|
|
|
46
|
|
|
47 /**************************************************************************/
|
|
|
48 /** @name Group API */
|
|
|
49 /**************************************************************************/
|
|
|
50 /*@{*/
|
|
|
51
|
|
|
52 /**
|
|
|
53 * Creates a new group structure.
|
|
|
54 *
|
|
|
55 * @param session The MSN session.
|
|
|
56 * @param id The group ID.
|
|
|
57 * @param name The name of the group.
|
|
|
58 *
|
|
|
59 * @return A new group structure.
|
|
|
60 */
|
|
|
61 MsnGroup *msn_group_new(MsnUserList *userlist, int id, const char *name);
|
|
|
62
|
|
|
63 /**
|
|
|
64 * Destroys a group structure.
|
|
|
65 *
|
|
|
66 * @param group The group to destroy.
|
|
|
67 */
|
|
|
68 void msn_group_destroy(MsnGroup *group);
|
|
|
69
|
|
|
70 /**
|
|
|
71 * Sets the ID for a group.
|
|
|
72 *
|
|
|
73 * @param group The group.
|
|
|
74 * @param id The ID.
|
|
|
75 */
|
|
|
76 void msn_group_set_id(MsnGroup *group, int id);
|
|
|
77
|
|
|
78 /**
|
|
|
79 * Sets the name for a group.
|
|
|
80 *
|
|
|
81 * @param group The group.
|
|
|
82 * @param name The name.
|
|
|
83 */
|
|
|
84 void msn_group_set_name(MsnGroup *group, const char *name);
|
|
|
85
|
|
|
86 /**
|
|
|
87 * Returns the ID for a group.
|
|
|
88 *
|
|
|
89 * @param group The group.
|
|
|
90 *
|
|
|
91 * @return The ID.
|
|
|
92 */
|
|
|
93 int msn_group_get_id(const MsnGroup *group);
|
|
|
94
|
|
|
95 /**
|
|
|
96 * Returns the name for a group.
|
|
|
97 *
|
|
|
98 * @param group The group.
|
|
|
99 *
|
|
|
100 * @return The name.
|
|
|
101 */
|
|
|
102 const char *msn_group_get_name(const MsnGroup *group);
|
|
|
103 #endif /* _MSN_GROUP_H_ */
|
