Mercurial > pidgin.yaz
view libpurple/protocols/msnp9/group.h @ 29038:cc391f752b05
These status strings are accessed from mxit_convert_presence_to_name() for the
Buddy List tooltip, so they cannot be NULL.
author | andrew.victor@mxit.com |
---|---|
date | Tue, 24 Nov 2009 15:12:42 +0000 |
parents | a07cfce78345 |
children |
line wrap: on
line source
/** * @file group.h Group functions * * purple * * Purple is the legal property of its developers, whose names are too numerous * to list here. Please refer to the COPYRIGHT file distributed with this * source distribution. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA */ #ifndef _MSN_GROUP_H_ #define _MSN_GROUP_H_ typedef struct _MsnGroup MsnGroup; #include <stdio.h> #include "session.h" #include "user.h" #include "userlist.h" /** * A group. */ struct _MsnGroup { MsnSession *session; /**< The MSN session. */ int id; /**< The group ID. */ char *name; /**< The name of the group. */ }; /**************************************************************************/ /** @name Group API */ /**************************************************************************/ /*@{*/ /** * Creates a new group structure. * * @param session The MSN session. * @param id The group ID. * @param name The name of the group. * * @return A new group structure. */ MsnGroup *msn_group_new(MsnUserList *userlist, int id, const char *name); /** * Destroys a group structure. * * @param group The group to destroy. */ void msn_group_destroy(MsnGroup *group); /** * Sets the ID for a group. * * @param group The group. * @param id The ID. */ void msn_group_set_id(MsnGroup *group, int id); /** * Sets the name for a group. * * @param group The group. * @param name The name. */ void msn_group_set_name(MsnGroup *group, const char *name); /** * Returns the ID for a group. * * @param group The group. * * @return The ID. */ int msn_group_get_id(const MsnGroup *group); /** * Returns the name for a group. * * @param group The group. * * @return The name. */ const char *msn_group_get_name(const MsnGroup *group); #endif /* _MSN_GROUP_H_ */