1 /* Copyright (c) 2008 Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
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.
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.
30 #ifndef __MODEST_FOLDER_WINDOW_H__
31 #define __MODEST_FOLDER_WINDOW_H__
33 #ifdef MODEST_TOOLKIT_HILDON2
34 #include <modest-hildon2-window.h>
36 #include <widgets/modest-window.h>
37 #include <widgets/modest-folder-view.h>
38 #include <tny-folder-store-query.h>
42 /* convenience macros */
43 #define MODEST_TYPE_FOLDER_WINDOW (modest_folder_window_get_type())
44 #define MODEST_FOLDER_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_FOLDER_WINDOW,ModestFolderWindow))
45 #define MODEST_FOLDER_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_FOLDER_WINDOW,ModestWindow))
47 #define MODEST_IS_FOLDER_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_FOLDER_WINDOW))
48 #define MODEST_IS_FOLDER_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_FOLDER_WINDOW))
49 #define MODEST_FOLDER_WINDOW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_FOLDER_WINDOW,ModestFolderWindowClass))
51 typedef struct _ModestFolderWindow ModestFolderWindow;
52 typedef struct _ModestFolderWindowClass ModestFolderWindowClass;
54 struct _ModestFolderWindow {
55 #ifdef MODEST_TOOLKIT_HILDON2
56 ModestHildon2Window parent;
62 struct _ModestFolderWindowClass {
63 #ifdef MODEST_TOOLKIT_HILDON2
64 ModestHildon2WindowClass parent_class;
66 ModestWindowClass parent_class;
71 * modest_folder_window_get_type:
73 * get the GType for the ModestFolderWindow class
75 * Returns: a GType for ModestFolderWindow
77 GType modest_folder_window_get_type (void) G_GNUC_CONST;
81 * modest_folder_window_new:
82 * @query: a #TnyFolderStoreQuery that specifies the folders to show
84 * instantiates a new ModestFolderWindow widget
86 * Returns: a new ModestFolderWindow, or NULL in case of error
88 ModestWindow* modest_folder_window_new (TnyFolderStoreQuery *query);
91 * modest_folder_window_get_folder_view:
92 * @self: a #ModestFolderWindow
94 * get the folder view inside the folder window
96 ModestFolderView *modest_folder_window_get_folder_view (ModestFolderWindow *self);
99 * modest_folder_window_set_account:
100 * @self: a #ModestFolderWindow
101 * @account_name: a string
103 * Sets the current active account in the folder window.
105 void modest_folder_window_set_account (ModestFolderWindow *self,
106 const gchar *account_name);
109 * modest_folder_window_set_mailbox:
110 * @self: a #ModestFolderWindow
113 * Sets the current mailbox in the folder window.
115 void modest_folder_window_set_mailbox (ModestFolderWindow *self,
116 const gchar *mailbox);
119 * modest_folder_Window_transfer_mode_enabled:
120 * @self: a #ModestFolderWindow
122 * if @self is in transfer mode (progress hint visible)
124 * Returns: %TRUE if progress hint should be visible
126 gboolean modest_folder_window_transfer_mode_enabled (ModestFolderWindow *self);