9f068396c2bcc4e9a7ef5b224c300612fd1d0f82
[empathy.git] / libempathy-gtk / empathy-live-search.h
1 /*
2  * Copyright (C) 2010 Collabora Ltd.
3  * Copyright (C) 2007-2010 Nokia Corporation.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
18  *
19  * Authors: Felix Kaser <felix.kaser@collabora.co.uk>
20  *          Xavier Claessens <xavier.claessens@collabora.co.uk>
21  *          Claudio Saavedra <csaavedra@igalia.com>
22  */
23
24 #ifndef __EMPATHY_LIVE_SEARCH_H__
25 #define __EMPATHY_LIVE_SEARCH_H__
26
27 #include <gtk/gtk.h>
28
29 #include "empathy-contact-list-store.h"
30
31 G_BEGIN_DECLS
32
33 #define EMPATHY_TYPE_LIVE_SEARCH         (empathy_live_search_get_type ())
34 #define EMPATHY_LIVE_SEARCH(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), EMPATHY_TYPE_LIVE_SEARCH, EmpathyLiveSearch))
35 #define EMPATHY_LIVE_SEARCH_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST ((k), EMPATHY_TYPE_LIVE_SEARCH, EmpathyLiveSearchClass))
36 #define EMPATHY_IS_LIVE_SEARCH(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), EMPATHY_TYPE_LIVE_SEARCH))
37 #define EMPATHY_IS_LIVE_SEARCH_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), EMPATHY_TYPE_LIVE_SEARCH))
38 #define EMPATHY_LIVE_SEARCH_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), EMPATHY_TYPE_LIVE_SEARCH, EmpathyLiveSearchClass))
39
40 typedef struct _EmpathyLiveSearch      EmpathyLiveSearch;
41 typedef struct _EmpathyLiveSearchClass EmpathyLiveSearchClass;
42
43 struct _EmpathyLiveSearch {
44   GtkHBox parent;
45
46   /*<private>*/
47   gpointer priv;
48 };
49
50 struct _EmpathyLiveSearchClass {
51   GtkHBoxClass parent_class;
52 };
53
54 GType empathy_live_search_get_type (void) G_GNUC_CONST;
55 GtkWidget *empathy_live_search_new (GtkWidget *hook);
56
57 GtkWidget *empathy_live_search_get_hook_widget (EmpathyLiveSearch *self);
58 void empathy_live_search_set_hook_widget (EmpathyLiveSearch *self,
59     GtkWidget *hook);
60
61 const gchar *empathy_live_search_get_text (EmpathyLiveSearch *self);
62 void empathy_live_search_set_text (EmpathyLiveSearch *self,
63     const gchar *text);
64
65 gboolean empathy_live_search_match (EmpathyLiveSearch *self,
66     const gchar *string);
67
68 GPtrArray * empathy_live_search_strip_utf8_string (const gchar *string);
69
70 gboolean empathy_live_search_match_words (const gchar *string,
71     GPtrArray *words);
72
73 GPtrArray * empathy_live_search_get_words (EmpathyLiveSearch *self);
74
75 /* Made public for unit tests */
76 gboolean empathy_live_search_match_string (const gchar *string,
77    const gchar *prefix);
78
79 G_END_DECLS
80
81 #endif /* __EMPATHY_LIVE_SEARCH_H__ */