1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/Frameworks/libpurple.framework/Versions/0.6.2/Headers/group.h	Fri Aug 21 13:25:11 2009 -0700
     1.3 @@ -0,0 +1,110 @@
     1.4 +/**
     1.5 + * @file group.h Group functions
     1.6 + *
     1.7 + * purple
     1.8 + *
     1.9 + * Purple is the legal property of its developers, whose names are too numerous
    1.10 + * to list here.  Please refer to the COPYRIGHT file distributed with this
    1.11 + * source distribution.
    1.12 + *
    1.13 + * This program is free software; you can redistribute it and/or modify
    1.14 + * it under the terms of the GNU General Public License as published by
    1.15 + * the Free Software Foundation; either version 2 of the License, or
    1.16 + * (at your option) any later version.
    1.17 + *
    1.18 + * This program is distributed in the hope that it will be useful,
    1.19 + * but WITHOUT ANY WARRANTY; without even the implied warranty of
    1.20 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    1.21 + * GNU General Public License for more details.
    1.22 + *
    1.23 + * You should have received a copy of the GNU General Public License
    1.24 + * along with this program; if not, write to the Free Software
    1.25 + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
    1.26 + */
    1.27 +#ifndef _MSN_GROUP_H_
    1.28 +#define _MSN_GROUP_H_
    1.29 +
    1.30 +typedef struct _MsnGroup  MsnGroup;
    1.31 +
    1.32 +#include <stdio.h>
    1.33 +
    1.34 +#include "session.h"
    1.35 +#include "user.h"
    1.36 +#include "userlist.h"
    1.37 +
    1.38 +#define MSN_INDIVIDUALS_GROUP_ID	"1983"
    1.39 +#define MSN_INDIVIDUALS_GROUP_NAME	_("Other Contacts")
    1.40 +
    1.41 +#define MSN_NON_IM_GROUP_ID		"email"
    1.42 +#define MSN_NON_IM_GROUP_NAME	_("Non-IM Contacts")
    1.43 +
    1.44 +/**
    1.45 + * A group.
    1.46 + */
    1.47 +struct _MsnGroup
    1.48 +{
    1.49 +	MsnSession *session;    /**< The MSN session.           */
    1.50 +
    1.51 +	char *id;                 /**< The group ID.              */
    1.52 +	char *name;             /**< The name of the group.     */
    1.53 +};
    1.54 +
    1.55 +/**************************************************************************
    1.56 + ** @name Group API                                                       *
    1.57 + **************************************************************************/
    1.58 +/*@{*/
    1.59 +
    1.60 +/**
    1.61 + * Creates a new group structure.
    1.62 + *
    1.63 + * @param session The MSN session.
    1.64 + * @param id      The group ID.
    1.65 + * @param name    The name of the group.
    1.66 + *
    1.67 + * @return A new group structure.
    1.68 + */
    1.69 +MsnGroup *msn_group_new(MsnUserList *userlist, const char *id, const char *name);
    1.70 +
    1.71 +/**
    1.72 + * Destroys a group structure.
    1.73 + *
    1.74 + * @param group The group to destroy.
    1.75 + */
    1.76 +void msn_group_destroy(MsnGroup *group);
    1.77 +
    1.78 +/**
    1.79 + * Sets the ID for a group.
    1.80 + *
    1.81 + * @param group The group.
    1.82 + * @param id    The ID.
    1.83 + */
    1.84 +void msn_group_set_id(MsnGroup *group, const char *id);
    1.85 +
    1.86 +/**
    1.87 + * Sets the name for a group.
    1.88 + *
    1.89 + * @param group The group.
    1.90 + * @param name  The name.
    1.91 + */
    1.92 +void msn_group_set_name(MsnGroup *group, const char *name);
    1.93 +
    1.94 +/**
    1.95 + * Returns the ID for a group.
    1.96 + *
    1.97 + * @param group The group.
    1.98 + *
    1.99 + * @return The ID.
   1.100 + */
   1.101 +char* msn_group_get_id(const MsnGroup *group);
   1.102 +
   1.103 +/**
   1.104 + * Returns the name for a group.
   1.105 + *
   1.106 + * @param group The group.
   1.107 + *
   1.108 + * @return The name.
   1.109 + */
   1.110 +const char *msn_group_get_name(const MsnGroup *group);
   1.111 +
   1.112 +#endif /* _MSN_GROUP_H_ */
   1.113 +