* Changes in the autotools stuff affecting a lot of platform dependent
[modest] / src / widgets / modest-sort-criterium-view.h
1 /* Copyright (c) 2008, Nokia Corporation
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  * * Redistributions of source code must retain the above copyright
9  *   notice, this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright
11  *   notice, this list of conditions and the following disclaimer in the
12  *   documentation and/or other materials provided with the distribution.
13  * * Neither the name of the Nokia Corporation nor the names of its
14  *   contributors may be used to endorse or promote products derived from
15  *   this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #ifndef __MODEST_SORT_CRITERIUM_VIEW_H__
31 #define __MODEST_SORT_CRITERIUM_VIEW_H__
32
33 #include <glib-object.h>
34 #include <gtk/gtkenums.h>
35
36 G_BEGIN_DECLS
37
38 /* convenience macros */
39 #define MODEST_TYPE_SORT_CRITERIUM_VIEW             (modest_sort_criterium_view_get_type())
40 #define MODEST_SORT_CRITERIUM_VIEW(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_SORT_CRITERIUM_VIEW,ModestSortCriteriumView))
41 #define MODEST_IS_SORT_CRITERIUM_VIEW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_SORT_CRITERIUM_VIEW))
42 #define MODEST_SORT_CRITERIUM_VIEW_GET_IFACE(obj)   (G_TYPE_INSTANCE_GET_INTERFACE((obj),MODEST_TYPE_SORT_CRITERIUM_VIEW,ModestSortCriteriumViewIface))
43
44 typedef struct _ModestSortCriteriumView      ModestSortCriteriumView;
45 typedef struct _ModestSortCriteriumViewIface ModestSortCriteriumViewIface;
46
47 struct _ModestSortCriteriumViewIface {
48         GTypeInterface parent;
49
50         gint (*add_sort_key_func) (ModestSortCriteriumView *self, const gchar *sort_key);
51         void (*set_sort_key_func) (ModestSortCriteriumView *self, gint key);
52         void (*set_sort_order_func) (ModestSortCriteriumView *self, GtkSortType sort_type);
53         gint (*get_sort_key_func) (ModestSortCriteriumView *self);
54         GtkSortType (*get_sort_order_func) (ModestSortCriteriumView *self);
55 };
56
57
58 /**
59  *
60  * modest_sort_criterium_view_get_type
61  *
62  * get the GType for the this interface
63  *
64  * Returns: the GType for this interface
65  */
66 GType        modest_sort_criterium_view_get_type    (void) G_GNUC_CONST;
67
68
69 gint modest_sort_criterium_view_add_sort_key (ModestSortCriteriumView *self, const gchar *sort_key);
70 void modest_sort_criterium_view_set_sort_key (ModestSortCriteriumView *self, gint key);
71 void modest_sort_criterium_view_set_sort_order (ModestSortCriteriumView *self, GtkSortType sort_type);
72 gint modest_sort_criterium_view_get_sort_key (ModestSortCriteriumView *self);
73 GtkSortType modest_sort_criterium_view_get_sort_order (ModestSortCriteriumView *self);
74
75 G_END_DECLS
76
77 #endif /* __MODEST_SORT_CRITERIUM_VIEW_H__ */