Galago - desktop presence framework

galago-avatar.h File Reference

Galago Avatar API. More...

#include <stdlib.h>
#include <libgalago/galago-account.h>
#include <libgalago/galago-image.h>

Go to the source code of this file.


Avatar API

GalagoObjectClassgalago_avatar_get_class (void)
 Returns the class for a GalagoAvatar.
GalagoAvatargalago_avatar_new (GalagoAccount *account, const unsigned char *data, size_t len)
 Creates a new avatar.
void galago_avatar_set_image_data (GalagoAvatar *avatar, const unsigned char *data, size_t len)
 Sets the avatar's image data.
GalagoAccountgalago_avatar_get_account (const GalagoAvatar *avatar)
 Returns an avatar's account.
void galago_avatar_get_image_data (const GalagoAvatar *avatar, unsigned char **ret_data, size_t *ret_len)
 Returns an avatar's image data.

Defines

#define GALAGO_CLASS_AVATAR   (galago_avatar_get_class())
#define GALAGO_DBUS_AVATAR_INTERFACE   "org.freedesktop.Galago.Avatar"
#define GALAGO_IS_AVATAR(obj)   (GALAGO_IS_OBJECT(obj) && galago_object_check_cast((obj), GALAGO_CLASS_AVATAR))

Typedefs

typedef _GalagoAvatar GalagoAvatar
typedef _GalagoAvatarClass GalagoAvatarClass
typedef _GalagoAvatarPrivate GalagoAvatarPrivate

Detailed Description

Galago Avatar API.

Copyright:
(C) 2004-2005 Christian Hammond
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library 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 Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

Definition in file galago-avatar.h.


Function Documentation

GalagoAccount* galago_avatar_get_account const GalagoAvatar avatar  ) 
 

Returns an avatar's account.

Parameters:
avatar The avatar.
Returns:
The account.

GalagoObjectClass* galago_avatar_get_class void   ) 
 

Returns the class for a GalagoAvatar.

Returns:
The GalagoAvatar class.

void galago_avatar_get_image_data const GalagoAvatar avatar,
unsigned char **  ret_data,
size_t *  ret_len
 

Returns an avatar's image data.

Parameters:
avatar The avatar.
ret_data The returned image data.
ret_len The returned image data length.

GalagoAvatar* galago_avatar_new GalagoAccount account,
const unsigned char *  data,
size_t  len
 

Creates a new avatar.

Parameters:
account The account the avatar is for.
data The image data.
len The image data length.
Returns:
The avatar.

void galago_avatar_set_image_data GalagoAvatar avatar,
const unsigned char *  data,
size_t  len
 

Sets the avatar's image data.

Parameters:
avatar The avatar.
data The image data.
len The image data length.