1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
|
/**
* @file search.h
*
* purple
*
* Copyright (C) 2005 Bartosz Oler <bartosz@bzimage.us>
*
* 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 _PURPLE_GG_SEARCH_H
#define _PURPLE_GG_SEARCH_H
#include "connection.h"
#include <libgadu.h>
#include "gg.h"
typedef enum {
GGP_SEARCH_TYPE_INFO,
GGP_SEARCH_TYPE_FULL
} GGPSearchType;
typedef struct {
char *uin;
char *lastname;
char *firstname;
char *nickname;
char *city;
char *birthyear;
char *gender;
char *active;
char *offset;
char *last_uin;
GGPSearchType search_type;
guint32 seq;
void *user_data;
void *window;
} GGPSearchForm;
typedef GHashTable GGPSearches;
/**
* Create a new GGPSearchForm structure, and set the fields
* to the sane defaults.
*
* @return Newly allocated GGPSearchForm.
*/
GGPSearchForm *
ggp_search_form_new(GGPSearchType st);
/**
* Destroy a Search Form.
*
* @param form Search Form to destroy.
*/
void
ggp_search_form_destroy(GGPSearchForm *form);
/**
* Add a search to the list of searches.
*
* @param searches The list of searches.
* @param seq Search (form) ID number.
* @param form The search form to add.
*/
void
ggp_search_add(GGPSearches *searches, guint32 seq, GGPSearchForm *form);
/**
* Remove a search from the list.
*
* If you want to destory the search completely also call:
* ggp_search_form_destroy().
*
* @param searches The list of searches.
* @param seq ID number of the search.
*/
void
ggp_search_remove(GGPSearches *searches, guint32 seq);
/**
* Return the search with the specified ID.
*
* @param searches The list of searches.
* @param seq ID number of the search.
*/
GGPSearchForm *
ggp_search_get(GGPSearches *searches, guint32 seq);
/**
* Create a new GGPSearches structure.
*
* @return GGPSearches instance.
*/
GGPSearches *
ggp_search_new(void);
/**
* Destroy GGPSearches instance.
*
* @param searches GGPSearches instance.
*/
void
ggp_search_destroy(GGPSearches *searches);
/**
* Initiate a search in the public directory.
*
* @param gc PurpleConnection.
* @param form Filled in GGPSearchForm.
*
* @return Sequence number of a search or 0 if an error occurred.
*/
guint32
ggp_search_start(PurpleConnection *gc, GGPSearchForm *form);
/*
* Return converted to the UTF-8 value of the specified field.
*
* @param res Public directory look-up result.
* @param num Id of the record.
* @param fileld Name of the field.
*
* @return UTF-8 encoded value of the field.
*/
char *
ggp_search_get_result(gg_pubdir50_t res, int num, const char *field);
#endif /* _PURPLE_GG_SEARCH_H */
/* vim: set ts=8 sts=0 sw=8 noet: */
|