1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/Frameworks/libpurple.framework/Versions/0.6.2/Headers/search.h Fri Aug 21 13:25:11 2009 -0700
1.3 @@ -0,0 +1,153 @@
1.4 +/**
1.5 + * @file search.h
1.6 + *
1.7 + * purple
1.8 + *
1.9 + * Copyright (C) 2005 Bartosz Oler <bartosz@bzimage.us>
1.10 + *
1.11 + * This program is free software; you can redistribute it and/or modify
1.12 + * it under the terms of the GNU General Public License as published by
1.13 + * the Free Software Foundation; either version 2 of the License, or
1.14 + * (at your option) any later version.
1.15 + *
1.16 + * This program is distributed in the hope that it will be useful,
1.17 + * but WITHOUT ANY WARRANTY; without even the implied warranty of
1.18 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1.19 + * GNU General Public License for more details.
1.20 + *
1.21 + * You should have received a copy of the GNU General Public License
1.22 + * along with this program; if not, write to the Free Software
1.23 + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
1.24 + */
1.25 +
1.26 +
1.27 +#ifndef _PURPLE_GG_SEARCH_H
1.28 +#define _PURPLE_GG_SEARCH_H
1.29 +
1.30 +#include "connection.h"
1.31 +
1.32 +#include <libgadu.h>
1.33 +#include "gg.h"
1.34 +
1.35 +
1.36 +typedef enum {
1.37 + GGP_SEARCH_TYPE_INFO,
1.38 + GGP_SEARCH_TYPE_FULL
1.39 +
1.40 +} GGPSearchType;
1.41 +
1.42 +typedef struct {
1.43 +
1.44 + char *uin;
1.45 + char *lastname;
1.46 + char *firstname;
1.47 + char *nickname;
1.48 + char *city;
1.49 + char *birthyear;
1.50 + char *gender;
1.51 + char *active;
1.52 + char *offset;
1.53 +
1.54 + char *last_uin;
1.55 +
1.56 + GGPSearchType search_type;
1.57 + guint32 seq;
1.58 +
1.59 + void *user_data;
1.60 + void *window;
1.61 +} GGPSearchForm;
1.62 +
1.63 +typedef GHashTable GGPSearches;
1.64 +
1.65 +
1.66 +/**
1.67 + * Create a new GGPSearchForm structure, and set the fields
1.68 + * to the sane defaults.
1.69 + *
1.70 + * @return Newly allocated GGPSearchForm.
1.71 + */
1.72 +GGPSearchForm *
1.73 +ggp_search_form_new(GGPSearchType st);
1.74 +
1.75 +/**
1.76 + * Destroy a Search Form.
1.77 + *
1.78 + * @param form Search Form to destroy.
1.79 + */
1.80 +void
1.81 +ggp_search_form_destroy(GGPSearchForm *form);
1.82 +
1.83 +/**
1.84 + * Add a search to the list of searches.
1.85 + *
1.86 + * @param searches The list of searches.
1.87 + * @param seq Search (form) ID number.
1.88 + * @param form The search form to add.
1.89 + */
1.90 +void
1.91 +ggp_search_add(GGPSearches *searches, guint32 seq, GGPSearchForm *form);
1.92 +
1.93 +/**
1.94 + * Remove a search from the list.
1.95 + *
1.96 + * If you want to destory the search completely also call:
1.97 + * ggp_search_form_destroy().
1.98 + *
1.99 + * @param searches The list of searches.
1.100 + * @param seq ID number of the search.
1.101 + */
1.102 +void
1.103 +ggp_search_remove(GGPSearches *searches, guint32 seq);
1.104 +
1.105 +/**
1.106 + * Return the search with the specified ID.
1.107 + *
1.108 + * @param searches The list of searches.
1.109 + * @param seq ID number of the search.
1.110 + */
1.111 +GGPSearchForm *
1.112 +ggp_search_get(GGPSearches *searches, guint32 seq);
1.113 +
1.114 +/**
1.115 + * Create a new GGPSearches structure.
1.116 + *
1.117 + * @return GGPSearches instance.
1.118 + */
1.119 +GGPSearches *
1.120 +ggp_search_new(void);
1.121 +
1.122 +/**
1.123 + * Destroy GGPSearches instance.
1.124 + *
1.125 + * @param searches GGPSearches instance.
1.126 + */
1.127 +void
1.128 +ggp_search_destroy(GGPSearches *searches);
1.129 +
1.130 +/**
1.131 + * Initiate a search in the public directory.
1.132 + *
1.133 + * @param gc PurpleConnection.
1.134 + * @param form Filled in GGPSearchForm.
1.135 + *
1.136 + * @return Sequence number of a search or 0 if an error occurred.
1.137 + */
1.138 +guint32
1.139 +ggp_search_start(PurpleConnection *gc, GGPSearchForm *form);
1.140 +
1.141 +/*
1.142 + * Return converted to the UTF-8 value of the specified field.
1.143 + *
1.144 + * @param res Public directory look-up result.
1.145 + * @param num Id of the record.
1.146 + * @param fileld Name of the field.
1.147 + *
1.148 + * @return UTF-8 encoded value of the field.
1.149 + */
1.150 +char *
1.151 +ggp_search_get_result(gg_pubdir50_t res, int num, const char *field);
1.152 +
1.153 +
1.154 +#endif /* _PURPLE_GG_SEARCH_H */
1.155 +
1.156 +/* vim: set ts=8 sts=0 sw=8 noet: */