1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/Frameworks/libpurple.framework/Versions/0.6.2/Headers/object.h Fri Aug 21 13:25:11 2009 -0700
1.3 @@ -0,0 +1,242 @@
1.4 +/**
1.5 + * @file object.h MSNObject API
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_OBJECT_H_
1.28 +#define _MSN_OBJECT_H_
1.29 +
1.30 +#include "imgstore.h"
1.31 +
1.32 +#include "internal.h"
1.33 +
1.34 +typedef enum
1.35 +{
1.36 + MSN_OBJECT_UNKNOWN = -1, /**< Unknown object */
1.37 + MSN_OBJECT_RESERVED1 = 1, /**< Reserved */
1.38 + MSN_OBJECT_EMOTICON = 2, /**< Custom Emoticon */
1.39 + MSN_OBJECT_USERTILE = 3, /**< UserTile (buddy icon) */
1.40 + MSN_OBJECT_RESERVED2 = 4, /**< Reserved */
1.41 + MSN_OBJECT_BACKGROUND = 5 /**< Background */
1.42 +
1.43 +} MsnObjectType;
1.44 +
1.45 +typedef struct
1.46 +{
1.47 + gboolean local;
1.48 +
1.49 + char *creator;
1.50 + int size;
1.51 + MsnObjectType type;
1.52 + PurpleStoredImage *img;
1.53 + char *location;
1.54 + char *friendly;
1.55 + char *sha1d;
1.56 + char *sha1c;
1.57 +
1.58 +} MsnObject;
1.59 +
1.60 +/**
1.61 + * Creates a MsnObject structure.
1.62 + *
1.63 + * @return A new MsnObject structure.
1.64 + */
1.65 +MsnObject *msn_object_new(void);
1.66 +
1.67 +/**
1.68 + * Creates a MsnObject structure from a string.
1.69 + *
1.70 + * @param str The string.
1.71 + *
1.72 + * @return The new MsnObject structure.
1.73 + */
1.74 +MsnObject *msn_object_new_from_string(const char *str);
1.75 +
1.76 +/**
1.77 + * Creates a MsnObject structure from a stored image
1.78 + *
1.79 + * @param img The image associated to object
1.80 + * @param location The object location as stored in MsnObject
1.81 + * @param creator The creator of the object
1.82 + * @param type The type of the object
1.83 + *
1.84 + * @return A new MsnObject structure
1.85 + */
1.86 +MsnObject *msn_object_new_from_image(PurpleStoredImage *img,
1.87 + const char *location, const char *creator, MsnObjectType type);
1.88 +
1.89 +/**
1.90 + * Destroys an MsnObject structure.
1.91 + *
1.92 + * @param obj The object structure.
1.93 + */
1.94 +void msn_object_destroy(MsnObject *obj);
1.95 +
1.96 +/**
1.97 + * Outputs a string representation of an MsnObject.
1.98 + *
1.99 + * @param obj The object.
1.100 + *
1.101 + * @return The string representation. This must be freed.
1.102 + */
1.103 +char *msn_object_to_string(const MsnObject *obj);
1.104 +
1.105 +/**
1.106 + * Sets the creator field in a MsnObject.
1.107 + *
1.108 + * @param creator The creator value.
1.109 + */
1.110 +void msn_object_set_creator(MsnObject *obj, const char *creator);
1.111 +
1.112 +/**
1.113 + * Sets the size field in a MsnObject.
1.114 + *
1.115 + * @param size The size value.
1.116 + */
1.117 +void msn_object_set_size(MsnObject *obj, int size);
1.118 +
1.119 +/**
1.120 + * Sets the type field in a MsnObject.
1.121 + *
1.122 + * @param type The type value.
1.123 + */
1.124 +void msn_object_set_type(MsnObject *obj, MsnObjectType type);
1.125 +
1.126 +/**
1.127 + * Sets the location field in a MsnObject.
1.128 + *
1.129 + * @param location The location value.
1.130 + */
1.131 +void msn_object_set_location(MsnObject *obj, const char *location);
1.132 +
1.133 +/**
1.134 + * Sets the friendly name field in a MsnObject.
1.135 + *
1.136 + * @param friendly The friendly name value.
1.137 + */
1.138 +void msn_object_set_friendly(MsnObject *obj, const char *friendly);
1.139 +
1.140 +/**
1.141 + * Sets the SHA1D field in a MsnObject.
1.142 + *
1.143 + * @param sha1d The sha1d value.
1.144 + */
1.145 +void msn_object_set_sha1d(MsnObject *obj, const char *sha1d);
1.146 +
1.147 +/**
1.148 + * Sets the SHA1C field in a MsnObject.
1.149 + *
1.150 + * @param sha1c The sha1c value.
1.151 + */
1.152 +void msn_object_set_sha1c(MsnObject *obj, const char *sha1c);
1.153 +
1.154 +/**
1.155 + * Associates an image with a MsnObject.
1.156 + *
1.157 + * @param obj The object.
1.158 + * @param img The image to associate.
1.159 + */
1.160 +void msn_object_set_image(MsnObject *obj, PurpleStoredImage *img);
1.161 +
1.162 +/**
1.163 + * Returns a MsnObject's creator value.
1.164 + *
1.165 + * @param obj The object.
1.166 + *
1.167 + * @return The creator value.
1.168 + */
1.169 +const char *msn_object_get_creator(const MsnObject *obj);
1.170 +
1.171 +/**
1.172 + * Returns a MsnObject's size value.
1.173 + *
1.174 + * @param obj The object.
1.175 + *
1.176 + * @return The size value.
1.177 + */
1.178 +int msn_object_get_size(const MsnObject *obj);
1.179 +
1.180 +/**
1.181 + * Returns a MsnObject's type.
1.182 + *
1.183 + * @param obj The object.
1.184 + *
1.185 + * @return The object type.
1.186 + */
1.187 +MsnObjectType msn_object_get_type(const MsnObject *obj);
1.188 +
1.189 +/**
1.190 + * Returns a MsnObject's location value.
1.191 + *
1.192 + * @param obj The object.
1.193 + *
1.194 + * @return The location value.
1.195 + */
1.196 +const char *msn_object_get_location(const MsnObject *obj);
1.197 +
1.198 +/**
1.199 + * Returns a MsnObject's friendly name value.
1.200 + *
1.201 + * @param obj The object.
1.202 + *
1.203 + * @return The friendly name value.
1.204 + */
1.205 +const char *msn_object_get_friendly(const MsnObject *obj);
1.206 +
1.207 +/**
1.208 + * Returns a MsnObject's SHA1D value.
1.209 + *
1.210 + * @param obj The object.
1.211 + *
1.212 + * @return The SHA1D value.
1.213 + */
1.214 +const char *msn_object_get_sha1d(const MsnObject *obj);
1.215 +
1.216 +/**
1.217 + * Returns a MsnObject's SHA1C value.
1.218 + *
1.219 + * @param obj The object.
1.220 + *
1.221 + * @return The SHA1C value.
1.222 + */
1.223 +const char *msn_object_get_sha1c(const MsnObject *obj);
1.224 +
1.225 +/**
1.226 + * Returns a MsnObject's SHA1C value if it exists, otherwise SHA1D.
1.227 + *
1.228 + * @param obj The object.
1.229 + *
1.230 + * @return The SHA1C value.
1.231 + */
1.232 +const char *msn_object_get_sha1(const MsnObject *obj);
1.233 +
1.234 +/**
1.235 + * Returns the image associated with the MsnObject.
1.236 + *
1.237 + * @param obj The object.
1.238 + *
1.239 + * @return The associated image.
1.240 + */
1.241 +PurpleStoredImage *msn_object_get_image(const MsnObject *obj);
1.242 +
1.243 +void msn_object_set_local(MsnObject *obj);
1.244 +
1.245 +#endif /* _MSN_OBJECT_H_ */