mw_srvc_dir.h

Go to the documentation of this file.

/*
  Meanwhile - Unofficial Lotus Sametime Community Client Library
  Copyright (C) 2004  Christopher (siege) O'Brien
  
  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Library General Public
  License as published by the Free Software Foundation; either
  version 2 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
  Library General Public License for more details.
  
  You should have received a copy of the GNU Library General Public
  License along with this library; if not, write to the Free
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef _MW_SRVC_DIR_H
#define _MW_SERV_DIR_H


#include <glib.h>


#ifdef __cplusplus
extern "C" {
#endif


struct mwSession;


#define SERVICE_DIRECTORY  0x0000001a


struct mwServiceDirectory;


struct mwAddressBook;


struct mwDirectory;


enum mwDirectoryState {
  mwDirectory_NEW,      
  mwDirectory_PENDING,  
  mwDirectory_OPEN,     
  mwDirectory_ERROR,    
  mwDirectory_UNKNOWN,  
};


#define DIR_SEARCH_ERROR  0x00000000


#define MW_DIRECTORY_IS_STATE(dir, state) \
  (mwDirectory_getState(dir) == (state))

#define MW_DIRECTORY_IS_NEW(dir) \
  MW_DIRECTORY_IS_STATE((dir), mwDirectory_NEW)

#define MW_DIRECTORY_IS_PENDING(dir) \
  MW_DIRECTORY_IS_STATE((dir), mwDirectory_PENDING)

#define MW_DIRECTORY_IS_OPEN(dir) \
  MW_DIRECTORY_IS_STATE((dir), mwDirectory_OPEN)


enum mwDirectoryMemberType {
  mwDirectoryMember_USER   = 0x0000,
  mwDirectoryMember_GROUP  = 0x0001,
};


struct mwDirectoryMember {
  guint16 type;      
  char *id;          
  char *long_name;   
  char *short_name;  
  guint16 foo;       
};


typedef void (*mwSearchHandler)
     (struct mwDirectory *dir,
      guint32 code, guint32 offset, GList *members);


struct mwDirectoryHandler {

  void (*on_book_list)(struct mwServiceDirectory *srvc, GList *books);

  void (*dir_opened)(struct mwDirectory *dir);

  void (*dir_closed)(struct mwDirectory *dir, guint32 reason);

  void (*clear)(struct mwServiceDirectory *srvc);
};


struct mwServiceDirectory *
mwServiceDirectory_new(struct mwSession *session,
                       struct mwDirectoryHandler *handler);


struct mwDirectoryHandler *
mwServiceDirectory_getHandler(struct mwServiceDirectory *srvc);


GList *mwServiceDirectory_getAddressBooks(struct mwServiceDirectory *srvc);


int mwServiceDirectory_refreshAddressBooks(struct mwServiceDirectory *srvc);


GList *mwServiceDirectory_getDirectories(struct mwServiceDirectory *srvc);


GList *mwAddressBook_getDirectories(struct mwAddressBook *book);


const char *mwAddressBook_getName(struct mwAddressBook *book);


struct mwDirectory *mwDirectory_new(struct mwAddressBook *book);


enum mwDirectoryState mwDirectory_getState(struct mwDirectory *dir);


void mwDirectory_setClientData(struct mwDirectory *dir,
                               gpointer data, GDestroyNotify clear);


gpointer mwDirectory_getClientData(struct mwDirectory *dir);


void mwDirectory_removeClientData(struct mwDirectory *dir);


struct mwServiceDirectory *mwDirectory_getService(struct mwDirectory *dir);


struct mwAddressBook *mwDirectory_getAddressBook(struct mwDirectory *dir);


int mwDirectory_open(struct mwDirectory *dir, mwSearchHandler cb);


int mwDirectory_next(struct mwDirectory *dir);


int mwDirectory_previous(struct mwDirectory *dir);


int mwDirectory_search(struct mwDirectory *dir, const char *query);


int mwDirectory_destroy(struct mwDirectory *dir);


#ifdef __cplusplus
}
#endif


#endif /* _MW_SRVC_DIR_H */