2007-05-17 Murray Cumming <murrayc@murrayc.com>
[modest] / src / modest-ui-actions.h
1 /* Copyright (c) 2006, 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_UI_ACTIONS_H__
31 #define __MODEST_UI_ACTIONS_H__
32
33 #include <widgets/modest-main-window.h>
34 #include <widgets/modest-msg-edit-window.h>
35 #include <widgets/modest-recpt-view.h>
36
37 G_BEGIN_DECLS
38
39 /* Menu & toolbar actions */
40 void     modest_ui_actions_on_about         (GtkAction *action, ModestWindow *win);
41
42 void     modest_ui_actions_on_delete        (GtkAction *action, ModestWindow *win);
43
44 void     modest_ui_actions_on_quit          (GtkAction *action, ModestWindow *win);
45
46 void     modest_ui_actions_on_close_window  (GtkAction *action, ModestWindow *win);
47
48 void     modest_ui_actions_on_new_account      (GtkAction *action, ModestWindow *win);
49
50 void     modest_ui_actions_on_accounts      (GtkAction *action, ModestWindow *win);
51
52 void     modest_ui_actions_on_smtp_servers  (GtkAction *action, ModestWindow *win);
53
54 void     modest_ui_actions_on_add_to_contacts   (GtkAction *action, ModestWindow *win);
55
56 void     modest_ui_actions_on_select_contacts (GtkAction *action, ModestMsgEditWindow *win);
57
58 void     modest_ui_actions_on_check_names (GtkAction *action, ModestMsgEditWindow *win);
59
60 void     modest_ui_actions_on_new_msg       (GtkAction *action, ModestWindow *win);
61
62 void     modest_ui_actions_on_open           (GtkAction *action, ModestWindow *win);
63
64 void     modest_ui_actions_on_reply         (GtkAction *action, ModestWindow *win);
65
66 void     modest_ui_actions_on_forward       (GtkAction *action, ModestWindow *win);
67
68 void     modest_ui_actions_on_sort          (GtkAction *action, ModestWindow *window);
69
70 void     modest_ui_actions_on_reply_all     (GtkAction *action, ModestWindow *win);
71
72 void     modest_ui_actions_on_next          (GtkAction *action, ModestWindow *main_window);
73
74 void     modest_ui_actions_on_prev          (GtkAction *action, ModestWindow *main_window);
75
76 void     modest_ui_actions_on_details       (GtkAction *action, ModestWindow *win);
77
78 void     modest_ui_actions_on_move_to       (GtkAction *action, ModestWindow *win);
79
80 void     modest_ui_actions_on_settings      (GtkAction *action, ModestWindow *win);
81
82 /**
83  * modest_ui_actions_toggle_folders_view:
84  * @action: the #GtkAction
85  * @main_window: the #ModestMainWindow
86  * 
87  * this action switches between split view (with a folders pane at the
88  * left) and simple view without the left pane with the folders and
89  * accounts. Maybe it's only useful for Maemo code, but as it uses
90  * generic code could be used also by the GNOME UI
91  **/
92 void     modest_ui_actions_toggle_folders_view       (GtkAction *action, 
93                                                       ModestMainWindow *main_window);
94
95 /**
96  * modest_ui_actions_toggle_folders_view:
97  * @action: the #GtkAction
98  * @main_window: the #ModestMainWindow
99  * 
100  * this action shows or hides the column titles of the header list
101  * view. It also enables the two lines rendering for the treeview rows
102  **/
103 void     modest_ui_actions_toggle_header_list_view    (GtkAction *action, 
104                                                        ModestMainWindow *main_window);
105
106 /* Widget actions */
107 void     modest_ui_actions_on_header_selected          (ModestHeaderView *folder_view, 
108                                                         TnyHeader *header,
109                                                         ModestMainWindow *main_window);
110 void     modest_ui_actions_on_header_activated         (ModestHeaderView *folder_view, 
111                                                          TnyHeader *header,
112                                                          ModestMainWindow *main_window);
113
114 void     modest_ui_actions_on_folder_selection_changed (ModestFolderView *folder_view,
115                                                          TnyFolderStore *folder_store, 
116                                                          gboolean selected,
117                                                          ModestMainWindow *main_window);
118
119 void     modest_ui_actions_on_online_toggle_toggled    (GtkToggleButton *toggle,
120                                                          ModestMainWindow *main_window);
121
122 void     modest_ui_actions_on_item_not_found           (ModestHeaderView *header_view,
123                                                          ModestItemType type,
124                                                          ModestWindow *window);
125
126 void     modest_ui_actions_on_msg_link_hover           (ModestMsgView *msgview, const gchar* link,
127                                                         ModestWindow *win);
128
129 void     modest_ui_actions_on_msg_link_clicked         (ModestMsgView *msgview, const gchar* link,
130                                                         ModestWindow *win);
131
132 void     modest_ui_actions_on_msg_link_contextual      (ModestMsgView *msgview, const gchar* link,
133                                                         ModestWindow *win);
134
135 void     modest_ui_actions_on_msg_attachment_clicked   (ModestMsgView *msgview, TnyMimePart *mime_part,
136                                                         ModestWindow *win);
137
138 void     modest_ui_actions_on_msg_recpt_activated   (ModestMsgView *msgview, const gchar *address,
139                                                      ModestWindow *win);
140
141 void     modest_ui_actions_on_send                     (GtkWidget *widget,
142                                                         ModestMsgEditWindow *edit_window);
143 void     modest_ui_actions_on_save_to_drafts           (GtkWidget *widget, 
144                                                         ModestMsgEditWindow *edit_window);
145
146
147 void     modest_ui_actions_on_toggle_bold              (GtkToggleAction *action,
148                                                         ModestMsgEditWindow *window);
149
150 void     modest_ui_actions_on_toggle_italics           (GtkToggleAction *action,
151                                                         ModestMsgEditWindow *window);
152
153 void     modest_ui_actions_on_toggle_bullets           (GtkToggleAction *action,
154                                                         ModestMsgEditWindow *window);
155
156 void     modest_ui_actions_on_change_justify      (GtkRadioAction *action,
157                                                    GtkRadioAction *selected,
158                                                    ModestMsgEditWindow *window);
159
160 void     modest_ui_actions_on_select_editor_color      (GtkAction *action,
161                                                         ModestMsgEditWindow *window);
162
163 void     modest_ui_actions_on_select_editor_background_color      (GtkAction *action,
164                                                                    ModestMsgEditWindow *window);
165
166 void     modest_ui_actions_on_insert_image             (GtkAction *action,
167                                                         ModestMsgEditWindow *window);
168
169 void     modest_ui_actions_on_attach_file             (GtkAction *action,
170                                                        ModestMsgEditWindow *window);
171
172 void     modest_ui_actions_on_remove_attachments      (GtkAction *action,
173                                                        ModestMsgEditWindow *window);
174 void     modest_ui_actions_on_mark_as_read            (GtkAction *action,
175                                                        ModestWindow *window);
176
177 void     modest_ui_actions_on_mark_as_unread            (GtkAction *action,
178                                                          ModestWindow *window);
179
180 /**
181  * modest_ui_actions_do_send_receive_all:
182  * @win: the window that will be used as source of the refresh mail operation
183  * 
184  * Refreshes all the accounts
185  **/
186 void    modest_ui_actions_do_send_receive_all          (ModestWindow *win);
187
188 /**
189  * modest_ui_actions_do_send_receive:
190  * @account_name: the name of the Modest account or NULL
191  * @win: the window that will be used as source of the refresh mail operation
192  * 
193  * Refreshes the Modest account whose name is passed as argument. If
194  * NULL is passed as #account_name then this function refreses the
195  * active account, if no active account is defined then it picks the
196  * default account
197  **/
198 void    modest_ui_actions_do_send_receive              (const gchar *account_name,
199                                                         ModestWindow *win);
200
201 /**
202  * modest_ui_actions_on_send_receive:
203  * @action: a #GtkAction
204  * @win: the Window that contains the action
205  * 
206  * Handles the activation of the send receive action, for example
207  * clicks on Send&Receive button in the main toolbar
208  **/
209 void    modest_ui_actions_on_send_receive              (GtkAction *action, 
210                                                         ModestWindow *win);
211
212 void     modest_ui_actions_on_new_folder               (GtkAction *action,
213                                                         ModestMainWindow *main_window);
214
215 void     modest_ui_actions_on_rename_folder            (GtkAction *action,
216                                                         ModestMainWindow *main_window);
217
218 void     modest_ui_actions_on_delete_folder            (GtkAction *action,
219                                                          ModestMainWindow *main_window);
220
221 void     modest_ui_actions_on_move_folder_to_trash_folder     (GtkAction *action,
222                                                                ModestMainWindow *main_window);
223
224 void     modest_ui_actions_on_connection_changed    (TnyDevice *device, gboolean online,
225                                                      ModestMainWindow *main_window);
226
227 void     modest_ui_actions_on_password_requested (TnyAccountStore *account_store,
228                                                   const gchar* server_account_name,
229                                                   gchar **username, gchar **password, gboolean *cancel, 
230                                                   gboolean *remember, ModestMainWindow *main_window);
231
232 void     modest_ui_actions_on_undo                     (GtkAction *action,
233                                                         ModestWindow *window);
234
235 void     modest_ui_actions_on_cut                      (GtkAction *action,
236                                                         ModestWindow *window);
237
238 void     modest_ui_actions_on_copy                     (GtkAction *action,
239                                                         ModestWindow *window);
240
241 void     modest_ui_actions_on_zoom_plus (GtkAction *action,
242                                          ModestWindow *window);
243
244 void     modest_ui_actions_on_zoom_minus (GtkAction *action,
245                                           ModestWindow *window);
246
247 void     modest_ui_actions_on_toggle_fullscreen    (GtkToggleAction *toggle,
248                                                     ModestWindow *window);
249
250 void     modest_ui_actions_on_change_fullscreen    (GtkAction *action,
251                                                     ModestWindow *window);
252
253 void     modest_ui_actions_on_paste                    (GtkAction *action,
254                                                         ModestWindow *window);
255
256 void     modest_ui_actions_on_select_all               (GtkAction *action,
257                                                         ModestWindow *window);
258
259 void     modest_ui_actions_on_toggle_show_cc (GtkToggleAction *toggle,
260                                               ModestMsgEditWindow *window);
261
262 void     modest_ui_actions_on_toggle_show_bcc (GtkToggleAction *toggle,
263                                               ModestMsgEditWindow *window);
264
265 void     modest_ui_actions_on_change_zoom              (GtkRadioAction *action,
266                                                         GtkRadioAction *selected,
267                                                         ModestWindow *window);
268
269 void     modest_ui_actions_msg_edit_on_change_priority (GtkRadioAction *action,
270                                                         GtkRadioAction *selected,
271                                                         ModestWindow *window);
272
273 void     modest_ui_actions_msg_edit_on_change_file_format (GtkRadioAction *action,
274                                                            GtkRadioAction *selected,
275                                                            ModestWindow *window);
276
277 void     modest_ui_actions_msg_edit_on_select_font (GtkAction *action,
278                                                     ModestMsgEditWindow *window);
279
280 /**
281  * modest_ui_actions_on_toggle_toolbar:
282  * @toggle: 
283  * @window: 
284  * 
285  * Hides/Shows the toolbars of the #ModestWindow instances
286  **/
287 void     modest_ui_actions_on_toggle_toolbar           (GtkToggleAction *toggle, 
288                                                         ModestWindow *window);
289
290 /**
291  * modest_ui_actions_on_folder_display_name_changed:
292  * @folder_view: a #ModestFolderView
293  * @display_name: the new window title
294  * @window: a #GtkWindow
295  * 
296  * Sets the title of the window to the value specified by
297  * display_name. This function is used typically as a callback to the
298  * "folder-display-name-changed" signal from the #ModestFolderView
299  **/
300 void     modest_ui_actions_on_folder_display_name_changed (ModestFolderView *folder_view,
301                                                            const gchar *display_name,
302                                                            GtkWindow *window);
303
304 void modest_ui_actions_view_attachment (GtkAction *action,
305                                         ModestWindow *window);
306
307 void modest_ui_actions_save_attachments (GtkAction *action,
308                                          ModestWindow *window);
309
310 void modest_ui_actions_remove_attachments (GtkAction *action,
311                                            ModestWindow *window);
312
313                                         
314
315 G_END_DECLS
316 #endif /* __MODEST_UI_ACTIONS_H__ */