2007-06-29 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 #include "modest-mail-operation.h"
37
38 G_BEGIN_DECLS
39
40 /* Menu & toolbar actions */
41 void     modest_ui_actions_on_about         (GtkAction *action, ModestWindow *win);
42
43 void     modest_ui_actions_on_delete        (GtkAction *action, ModestWindow *win);
44
45 void     modest_ui_actions_on_quit          (GtkAction *action, ModestWindow *win);
46
47 void     modest_ui_actions_on_close_window  (GtkAction *action, ModestWindow *win);
48
49 void     modest_ui_actions_on_new_account      (GtkAction *action, ModestWindow *win);
50
51 void     modest_ui_actions_on_accounts      (GtkAction *action, ModestWindow *win);
52
53 void     modest_ui_actions_on_smtp_servers  (GtkAction *action, ModestWindow *win);
54
55 void     modest_ui_actions_on_add_to_contacts   (GtkAction *action, ModestWindow *win);
56
57 void     modest_ui_actions_on_select_contacts (GtkAction *action, ModestMsgEditWindow *win);
58
59 void     modest_ui_actions_on_open_addressbook (GtkAction *action, ModestWindow *win);
60
61 void     modest_ui_actions_on_check_names (GtkAction *action, ModestMsgEditWindow *win);
62
63 void     modest_ui_actions_on_new_msg       (GtkAction *action, ModestWindow *win);
64
65 void     modest_ui_actions_on_open           (GtkAction *action, ModestWindow *win);
66
67 void     modest_ui_actions_on_reply         (GtkAction *action, ModestWindow *win);
68
69 void     modest_ui_actions_on_forward       (GtkAction *action, ModestWindow *win);
70
71 void     modest_ui_actions_on_sort          (GtkAction *action, ModestWindow *window);
72
73 void     modest_ui_actions_on_reply_all     (GtkAction *action, ModestWindow *win);
74
75 void     modest_ui_actions_on_next          (GtkAction *action, ModestWindow *main_window);
76
77 void     modest_ui_actions_on_prev          (GtkAction *action, ModestWindow *main_window);
78
79 void     modest_ui_actions_on_details       (GtkAction *action, ModestWindow *win);
80
81 void     modest_ui_actions_on_move_to       (GtkAction *action, ModestWindow *win);
82
83 void     modest_ui_actions_on_settings      (GtkAction *action, ModestWindow *win);
84
85 /**
86  * modest_ui_actions_on_help:
87  * @action: a #GtkAction
88  * @win: a #ModestWindow
89  * 
90  * Shows the help dialog
91  **/
92 void     modest_ui_actions_on_help          (GtkAction *action, ModestWindow *win);
93
94 /**
95  * modest_ui_actions_toggle_folders_view:
96  * @action: the #GtkAction
97  * @main_window: the #ModestMainWindow
98  * 
99  * this action switches between split view (with a folders pane at the
100  * left) and simple view without the left pane with the folders and
101  * accounts. Maybe it's only useful for Maemo code, but as it uses
102  * generic code could be used also by the GNOME UI
103  **/
104 void     modest_ui_actions_toggle_folders_view       (GtkAction *action, 
105                                                       ModestMainWindow *main_window);
106
107 /**
108  * modest_ui_actions_toggle_folders_view:
109  * @action: the #GtkAction
110  * @main_window: the #ModestMainWindow
111  * 
112  * this action shows or hides the column titles of the header list
113  * view. It also enables the two lines rendering for the treeview rows
114  **/
115 void     modest_ui_actions_toggle_header_list_view    (GtkAction *action, 
116                                                        ModestMainWindow *main_window);
117
118 /* Widget actions */
119 void     modest_ui_actions_on_header_selected          (ModestHeaderView *folder_view, 
120                                                         TnyHeader *header,
121                                                         ModestMainWindow *main_window);
122 void     modest_ui_actions_on_header_activated         (ModestHeaderView *folder_view, 
123                                                          TnyHeader *header,
124                                                          ModestMainWindow *main_window);
125
126 void     modest_ui_actions_on_folder_selection_changed (ModestFolderView *folder_view,
127                                                          TnyFolderStore *folder_store, 
128                                                          gboolean selected,
129                                                          ModestMainWindow *main_window);
130
131 void     modest_ui_actions_on_item_not_found           (ModestHeaderView *header_view,
132                                                          ModestItemType type,
133                                                          ModestWindow *window);
134
135 void     modest_ui_actions_on_msg_link_hover           (ModestMsgView *msgview, const gchar* link,
136                                                         ModestWindow *win);
137
138 void     modest_ui_actions_on_msg_link_clicked         (ModestMsgView *msgview, const gchar* link,
139                                                         ModestWindow *win);
140
141 void     modest_ui_actions_on_msg_link_contextual      (ModestMsgView *msgview, const gchar* link,
142                                                         ModestWindow *win);
143
144 void     modest_ui_actions_on_msg_attachment_clicked   (ModestMsgView *msgview, TnyMimePart *mime_part,
145                                                         ModestWindow *win);
146
147 void     modest_ui_actions_on_msg_recpt_activated   (ModestMsgView *msgview, const gchar *address,
148                                                      ModestWindow *win);
149
150 void     modest_ui_actions_on_send                     (GtkWidget *widget,
151                                                         ModestMsgEditWindow *edit_window);
152 void     modest_ui_actions_on_save_to_drafts           (GtkWidget *widget, 
153                                                         ModestMsgEditWindow *edit_window);
154
155
156 void     modest_ui_actions_on_toggle_bold              (GtkToggleAction *action,
157                                                         ModestMsgEditWindow *window);
158
159 void     modest_ui_actions_on_toggle_italics           (GtkToggleAction *action,
160                                                         ModestMsgEditWindow *window);
161
162 void     modest_ui_actions_on_toggle_bullets           (GtkToggleAction *action,
163                                                         ModestMsgEditWindow *window);
164
165 void     modest_ui_actions_on_change_justify      (GtkRadioAction *action,
166                                                    GtkRadioAction *selected,
167                                                    ModestMsgEditWindow *window);
168
169 void     modest_ui_actions_on_select_editor_color      (GtkAction *action,
170                                                         ModestMsgEditWindow *window);
171
172 void     modest_ui_actions_on_select_editor_background_color      (GtkAction *action,
173                                                                    ModestMsgEditWindow *window);
174
175 void     modest_ui_actions_on_insert_image             (GtkAction *action,
176                                                         ModestMsgEditWindow *window);
177
178 void     modest_ui_actions_on_attach_file             (GtkAction *action,
179                                                        ModestMsgEditWindow *window);
180
181 void     modest_ui_actions_on_remove_attachments      (GtkAction *action,
182                                                        ModestMsgEditWindow *window);
183 void     modest_ui_actions_on_mark_as_read            (GtkAction *action,
184                                                        ModestWindow *window);
185
186 void     modest_ui_actions_on_mark_as_unread            (GtkAction *action,
187                                                          ModestWindow *window);
188
189 /**
190  * modest_ui_actions_do_send_receive_all:
191  * @win: the window that will be used as source of the refresh mail operation
192  * 
193  * Refreshes all the accounts
194  **/
195 void    modest_ui_actions_do_send_receive_all          (ModestWindow *win);
196
197 /**
198  * modest_ui_actions_do_send_receive:
199  * @account_name: the name of the Modest account or NULL
200  * @win: the window that will be used as source of the refresh mail operation
201  * 
202  * Refreshes the Modest account whose name is passed as argument. If
203  * NULL is passed as #account_name then this function refreses the
204  * active account, if no active account is defined then it picks the
205  * default account
206  **/
207 void    modest_ui_actions_do_send_receive              (const gchar *account_name,
208                                                         ModestWindow *win);
209
210 /**
211  * modest_ui_actions_on_send_receive:
212  * @action: a #GtkAction
213  * @win: the Window that contains the action
214  * 
215  * Handles the activation of the send receive action, for example
216  * clicks on Send&Receive button in the main toolbar
217  **/
218 void    modest_ui_actions_on_send_receive              (GtkAction *action, 
219                                                         ModestWindow *win);
220
221 void     modest_ui_actions_on_new_folder               (GtkAction *action,
222                                                         ModestMainWindow *main_window);
223
224 void     modest_ui_actions_on_rename_folder            (GtkAction *action,
225                                                         ModestMainWindow *main_window);
226
227 void     modest_ui_actions_on_delete_folder            (GtkAction *action,
228                                                          ModestMainWindow *main_window);
229
230 void     modest_ui_actions_on_move_folder_to_trash_folder     (GtkAction *action,
231                                                                ModestMainWindow *main_window);
232
233 /*
234 void     modest_ui_actions_on_connection_changed    (TnyDevice *device, gboolean online,
235                                                      ModestMainWindow *main_window);
236 */
237
238 void     modest_ui_actions_on_password_requested (TnyAccountStore *account_store,
239                                                   const gchar* server_account_name,
240                                                   gchar **username, gchar **password, gboolean *cancel, 
241                                                   gboolean *remember, ModestMainWindow *main_window);
242
243 void     modest_ui_actions_on_undo                     (GtkAction *action,
244                                                         ModestWindow *window);
245
246 void     modest_ui_actions_on_cut                      (GtkAction *action,
247                                                         ModestWindow *window);
248
249 void     modest_ui_actions_on_copy                     (GtkAction *action,
250                                                         ModestWindow *window);
251
252 void     modest_ui_actions_on_zoom_plus (GtkAction *action,
253                                          ModestWindow *window);
254
255 void     modest_ui_actions_on_zoom_minus (GtkAction *action,
256                                           ModestWindow *window);
257
258 void     modest_ui_actions_on_toggle_fullscreen    (GtkToggleAction *toggle,
259                                                     ModestWindow *window);
260
261 void     modest_ui_actions_on_change_fullscreen    (GtkAction *action,
262                                                     ModestWindow *window);
263
264 void     modest_ui_actions_on_paste                    (GtkAction *action,
265                                                         ModestWindow *window);
266
267 void     modest_ui_actions_on_select_all               (GtkAction *action,
268                                                         ModestWindow *window);
269
270 void     modest_ui_actions_on_toggle_show_cc (GtkToggleAction *toggle,
271                                               ModestMsgEditWindow *window);
272
273 void     modest_ui_actions_on_toggle_show_bcc (GtkToggleAction *toggle,
274                                               ModestMsgEditWindow *window);
275
276 void     modest_ui_actions_on_change_zoom              (GtkRadioAction *action,
277                                                         GtkRadioAction *selected,
278                                                         ModestWindow *window);
279
280 void     modest_ui_actions_msg_edit_on_change_priority (GtkRadioAction *action,
281                                                         GtkRadioAction *selected,
282                                                         ModestWindow *window);
283
284 void     modest_ui_actions_msg_edit_on_change_file_format (GtkRadioAction *action,
285                                                            GtkRadioAction *selected,
286                                                            ModestWindow *window);
287
288 void     modest_ui_actions_msg_edit_on_select_font (GtkAction *action,
289                                                     ModestMsgEditWindow *window);
290
291 /**
292  * modest_ui_actions_on_toggle_toolbar:
293  * @toggle: 
294  * @window: 
295  * 
296  * Hides/Shows the toolbars of the #ModestWindow instances
297  **/
298 void     modest_ui_actions_on_toggle_toolbar           (GtkToggleAction *toggle, 
299                                                         ModestWindow *window);
300
301 /**
302  * modest_ui_actions_on_folder_display_name_changed:
303  * @folder_view: a #ModestFolderView
304  * @display_name: the new window title
305  * @window: a #GtkWindow
306  * 
307  * Sets the title of the window to the value specified by
308  * display_name. This function is used typically as a callback to the
309  * "folder-display-name-changed" signal from the #ModestFolderView
310  **/
311 void     modest_ui_actions_on_folder_display_name_changed (ModestFolderView *folder_view,
312                                                            const gchar *display_name,
313                                                            GtkWindow *window);
314
315 void     modest_ui_actions_view_attachment                (GtkAction *action,
316                                                            ModestWindow *window);
317
318 void     modest_ui_actions_save_attachments               (GtkAction *action,
319                                                            ModestWindow *window);
320
321 void     modest_ui_actions_remove_attachments             (GtkAction *action,
322                                                            ModestWindow *window);
323
324 /**
325  * modest_ui_actions_on_retrieve_msg_contents:
326  * @action: the #GtkAction
327  * @window: the #ModestWindow that issues the action
328  * 
329  * Retrieve the contents of the selected messages in the header view
330  **/
331 void     modest_ui_actions_on_retrieve_msg_contents       (GtkAction *action,
332                                                            ModestWindow *window);
333
334 void
335 modest_ui_actions_on_email_menu_activated (GtkAction *action,
336                                           ModestWindow *window);
337
338 void
339 modest_ui_actions_on_edit_menu_activated (GtkAction *action,
340                                           ModestWindow *window);
341
342 void
343 modest_ui_actions_on_view_menu_activated (GtkAction *action,
344                                           ModestWindow *window);
345
346 void
347 modest_ui_actions_on_tools_menu_activated (GtkAction *action,
348                                           ModestWindow *window);
349
350 void
351 modest_ui_actions_on_attachment_menu_activated (GtkAction *action,
352                                                 ModestWindow *window);
353
354 void
355 modest_ui_actions_on_toolbar_csm_menu_activated (GtkAction *action,
356                                                  ModestWindow *window);
357
358 void
359 modest_ui_actions_on_folder_view_csm_menu_activated (GtkAction *action,
360                                                      ModestWindow *window);
361
362 void
363 modest_ui_actions_on_header_view_csm_menu_activated (GtkAction *action,
364                                                      ModestWindow *window);
365
366 void
367 modest_ui_actions_check_toolbar_dimming_rules (ModestWindow *window);
368
369 /**
370  * modest_ui_actions_move_folder_error_handler:
371  * @mail_op: a #ModestMailOperation
372  * @user_data: user data
373  * 
374  * manages an error in a mail operation that tries to move a folder
375  **/
376 void     modest_ui_actions_move_folder_error_handler      (ModestMailOperation *mail_op, 
377                                                            gpointer user_data);
378
379 /**
380  * modest_ui_actions_on_search_messages:
381  * @action: a #GtkAction
382  * @window: a #ModestWindow
383  *
384  * Shows the search messages dialog
385  **/
386 void     modest_ui_actions_on_search_messages             (GtkAction *action,
387                                                            ModestWindow *window);
388
389 /**
390  * modest_ui_actions_on_find_in_page:
391  * @action: a #GtkToggleAction
392  * @window: a #ModestWindow
393  *
394  * Toggles the visibility of the find in page toolbar
395  **/
396 void     modest_ui_actions_on_toggle_find_in_page             (GtkToggleAction *action,
397                                                                ModestWindow *window);
398
399 G_END_DECLS
400 #endif /* __MODEST_UI_ACTIONS_H__ */