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 <modest-shell-window.h>
38 #include <widgets/modest-window.h>
39 #include <widgets/modest-folder-view.h>
40 #include <tny-folder-store-query.h>
44 /* convenience macros */
45 #define MODEST_TYPE_FOLDER_WINDOW (modest_folder_window_get_type())
46 #define MODEST_FOLDER_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_FOLDER_WINDOW,ModestFolderWindow))
47 #define MODEST_FOLDER_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_FOLDER_WINDOW,ModestWindow))
49 #define MODEST_IS_FOLDER_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_FOLDER_WINDOW))
50 #define MODEST_IS_FOLDER_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_FOLDER_WINDOW))
51 #define MODEST_FOLDER_WINDOW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_FOLDER_WINDOW,ModestFolderWindowClass))
53 typedef struct _ModestFolderWindow ModestFolderWindow;
54 typedef struct _ModestFolderWindowClass ModestFolderWindowClass;
56 struct _ModestFolderWindow {
57 #ifdef MODEST_TOOLKIT_HILDON2
58 ModestHildon2Window parent;
60 ModestShellWindow parent;
64 struct _ModestFolderWindowClass {
65 #ifdef MODEST_TOOLKIT_HILDON2
66 ModestHildon2WindowClass parent_class;
68 ModestShellWindowClass parent_class;
73 * modest_folder_window_get_type:
75 * get the GType for the ModestFolderWindow class
77 * Returns: a GType for ModestFolderWindow
79 GType modest_folder_window_get_type (void) G_GNUC_CONST;
83 * modest_folder_window_new:
84 * @query: a #TnyFolderStoreQuery that specifies the folders to show
86 * instantiates a new ModestFolderWindow widget
88 * Returns: a new ModestFolderWindow, or NULL in case of error
90 ModestWindow* modest_folder_window_new (TnyFolderStoreQuery *query);
93 * modest_folder_window_get_folder_view:
94 * @self: a #ModestFolderWindow
96 * get the folder view inside the folder window
98 ModestFolderView *modest_folder_window_get_folder_view (ModestFolderWindow *self);
101 * modest_folder_window_set_account:
102 * @self: a #ModestFolderWindow
103 * @account_name: a string
105 * Sets the current active account in the folder window.
107 void modest_folder_window_set_account (ModestFolderWindow *self,
108 const gchar *account_name);
111 * modest_folder_window_set_mailbox:
112 * @self: a #ModestFolderWindow
115 * Sets the current mailbox in the folder window.
117 void modest_folder_window_set_mailbox (ModestFolderWindow *self,
118 const gchar *mailbox);
121 * modest_folder_Window_transfer_mode_enabled:
122 * @self: a #ModestFolderWindow
124 * if @self is in transfer mode (progress hint visible)
126 * Returns: %TRUE if progress hint should be visible
128 gboolean modest_folder_window_transfer_mode_enabled (ModestFolderWindow *self);