Removed MainWindow dependency from modest-ui-actions.c
[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 #include "modest-tny-send-queue.h"
38 #include "modest-plugin-ui-actions.h"
39
40 G_BEGIN_DECLS
41
42 /* Menu & toolbar actions */
43 void     modest_ui_actions_on_about         (GtkAction *action, ModestWindow *win);
44
45 void     modest_ui_actions_refresh_message_window_after_delete (ModestMsgViewWindow* win);
46
47 void     modest_ui_actions_on_delete_message     (GtkAction *action, ModestWindow *win);
48
49 gboolean modest_ui_actions_on_edit_mode_delete_message (ModestWindow *win);
50
51 gboolean modest_ui_actions_on_edit_mode_delete_folder (ModestWindow *win);
52
53 void     modest_ui_actions_on_delete_message_or_folder (GtkAction *action, ModestWindow *win);
54
55 void     modest_ui_actions_on_quit          (GtkAction *action, ModestWindow *win);
56
57 void     modest_ui_actions_on_close_window  (GtkAction *action, ModestWindow *win);
58
59 void     modest_ui_actions_on_new_account      (GtkAction *action, ModestWindow *win);
60
61 void     modest_ui_actions_on_accounts      (GtkAction *action, ModestWindow *win);
62
63 void     modest_ui_actions_on_smtp_servers  (GtkAction *action, ModestWindow *win);
64
65 void     modest_ui_actions_add_to_contacts   (GtkAction *action, ModestWindow *win);
66 void     modest_ui_actions_on_add_to_contacts   (GtkAction *action, ModestWindow *win);
67
68 void     modest_ui_actions_on_select_contacts (GtkAction *action, ModestMsgEditWindow *win);
69
70 void     modest_ui_actions_on_open_addressbook (GtkAction *action, ModestWindow *win);
71
72 void     modest_ui_actions_on_check_names (GtkAction *action, ModestMsgEditWindow *win);
73
74 void     modest_ui_actions_on_new_msg       (GtkAction *action, ModestWindow *win);
75
76 void     modest_ui_actions_on_new_msg_or_folder (GtkAction *action, ModestWindow *win);
77
78 void     modest_ui_actions_on_open           (GtkAction *action, ModestWindow *win);
79
80 void     modest_ui_actions_on_reply         (GtkAction *action, ModestWindow *win);
81
82 void     modest_ui_actions_on_forward       (GtkAction *action, ModestWindow *win);
83
84 void     modest_ui_actions_on_sort          (GtkAction *action, ModestWindow *window);
85
86 void     modest_ui_actions_on_reply_all     (GtkAction *action, ModestWindow *win);
87
88 void     modest_ui_actions_on_next          (GtkAction *action, ModestWindow *main_window);
89
90 void     modest_ui_actions_on_prev          (GtkAction *action, ModestWindow *main_window);
91
92 void     modest_ui_actions_on_details       (GtkAction *action, ModestWindow *win);
93
94 void     modest_ui_actions_on_limit_error   (GtkAction *action, ModestWindow *win);
95
96 gboolean     modest_ui_actions_on_edit_mode_move_to       (ModestWindow *win);
97
98 void     modest_ui_actions_on_move_to       (GtkAction *action, ModestWindow *win);
99
100 void     modest_ui_actions_on_settings      (GtkAction *action, ModestWindow *win);
101
102 /**
103  * modest_ui_actions_on_help:
104  * @action: a #GtkAction
105  * @win: a #ModestWindow
106  * 
107  * Shows the help dialog
108  **/
109 void     modest_ui_actions_on_help          (GtkAction *action, GtkWindow *win);
110
111
112 /**
113  * modest_ui_actions_on_csm_elp:
114  * @action: a #GtkAction
115  * @win: a #ModestWindow
116  * 
117  * Shows the help dialog for folder view CSM. It shows the help ID
118  * which refers to the currently selected folder if any
119  **/
120 void     modest_ui_actions_on_csm_help      (GtkAction *action, GtkWindow *win);
121
122 #ifndef MODEST_TOOLKIT_HILDON2
123 /**
124  * modest_ui_actions_toggle_folders_view:
125  * @action: the #GtkAction
126  * @main_window: the #ModestMainWindow
127  * 
128  * this action switches between split view (with a folders pane at the
129  * left) and simple view without the left pane with the folders and
130  * accounts. Maybe it's only useful for Maemo code, but as it uses
131  * generic code could be used also by the GNOME UI
132  **/
133 void     modest_ui_actions_toggle_folders_view       (GtkAction *action, 
134                                                       ModestMainWindow *main_window);
135
136 /**
137  * modest_ui_actions_toggle_folders_view:
138  * @action: the #GtkAction
139  * @main_window: the #ModestMainWindow
140  * 
141  * this action shows or hides the column titles of the header list
142  * view. It also enables the two lines rendering for the treeview rows
143  **/
144 void     modest_ui_actions_toggle_header_list_view    (GtkAction *action, 
145                                                        ModestMainWindow *main_window);
146
147 /* Widget actions */
148 void     modest_ui_actions_on_header_selected          (ModestHeaderView *folder_view, 
149                                                         TnyHeader *header,
150                                                         ModestMainWindow *main_window);
151 #endif
152 void     modest_ui_actions_on_header_activated         (ModestHeaderView *folder_view, 
153                                                         TnyHeader *header,
154                                                         GtkTreePath *path,
155                                                         ModestWindow *main_window);
156
157 #ifndef MODEST_TOOLKIT_HILDON2
158 void     modest_ui_actions_on_folder_selection_changed (ModestFolderView *folder_view,
159                                                          TnyFolderStore *folder_store, 
160                                                          gboolean selected,
161                                                          ModestMainWindow *main_window);
162 #endif
163
164 void     modest_ui_actions_on_item_not_found           (ModestHeaderView *header_view,
165                                                          ModestItemType type,
166                                                          ModestWindow *window);
167
168 void     modest_ui_actions_on_msg_link_hover           (ModestMsgView *msgview, const gchar* link,
169                                                         ModestWindow *win);
170
171 void     modest_ui_actions_on_msg_link_clicked         (ModestMsgView *msgview, const gchar* link,
172                                                         ModestWindow *win);
173
174 void     modest_ui_actions_on_msg_link_contextual      (ModestMsgView *msgview, const gchar* link,
175                                                         ModestWindow *win);
176
177 void     modest_ui_actions_on_msg_attachment_clicked   (ModestMsgView *msgview, TnyMimePart *mime_part,
178                                                         ModestWindow *win);
179
180 void     modest_ui_actions_on_msg_recpt_activated   (ModestMsgView *msgview, const gchar *address,
181                                                      ModestWindow *win);
182
183 gboolean modest_ui_actions_on_send                     (GtkWidget *widget,
184                                                         ModestMsgEditWindow *edit_window);
185 gboolean modest_ui_actions_on_save_to_drafts           (GtkWidget *widget, 
186                                                         ModestMsgEditWindow *edit_window);
187
188
189 void     modest_ui_actions_on_toggle_bold              (GtkToggleAction *action,
190                                                         ModestMsgEditWindow *window);
191
192 void     modest_ui_actions_on_toggle_italics           (GtkToggleAction *action,
193                                                         ModestMsgEditWindow *window);
194
195 void     modest_ui_actions_on_toggle_bullets           (GtkToggleAction *action,
196                                                         ModestMsgEditWindow *window);
197
198 void     modest_ui_actions_on_change_justify      (GtkRadioAction *action,
199                                                    GtkRadioAction *selected,
200                                                    ModestMsgEditWindow *window);
201
202 void     modest_ui_actions_on_select_editor_color      (GtkAction *action,
203                                                         ModestMsgEditWindow *window);
204
205 void     modest_ui_actions_on_select_editor_background_color      (GtkAction *action,
206                                                                    ModestMsgEditWindow *window);
207
208 void     modest_ui_actions_on_insert_image             (GObject *object,
209                                                         ModestMsgEditWindow *window);
210
211 void     modest_ui_actions_on_attach_file             (GtkAction *action,
212                                                        ModestMsgEditWindow *window);
213
214 void     modest_ui_actions_on_remove_attachments      (GtkAction *action,
215                                                        ModestMsgEditWindow *window);
216 void     modest_ui_actions_on_mark_as_read            (GtkAction *action,
217                                                        ModestWindow *window);
218
219 void     modest_ui_actions_on_mark_as_unread            (GtkAction *action,
220                                                          ModestWindow *window);
221
222 void     modest_ui_actions_cancel_send (GtkAction *action,  ModestWindow *win);
223
224 /**
225  * modest_ui_actions_do_send_receive_all:
226  * @win: the window that will be used as source of the refresh mail operation
227  * @force_connection: whether or not the code should try to force a new connection if we're offline
228  * @poke_status: wheter ot not we want to poke the status of all mail folders
229  * @interactive: is coming from an interactive send receive.
230  * 
231  * Refreshes all the accounts
232  **/
233 void    modest_ui_actions_do_send_receive_all          (ModestWindow *win,
234                                                         gboolean force_connection,
235                                                         gboolean poke_status,
236                                                         gboolean interactive);
237
238 /**
239  * modest_ui_actions_do_send_receive:
240  * @account_name: the name of the Modest account or NULL
241  * @force_connection: whether or not the code should try to force a new connection if we're offline
242  * @poke_status: wheter ot not we want to poke the status of all mail folders
243  * @interactive: is coming from an interactive send receive
244  * @win: the window that will be used as source of the refresh mail operation
245  * 
246  * Refreshes the Modest account whose name is passed as argument. If
247  * NULL is passed as #account_name then this function refreses the
248  * active account, if no active account is defined then it picks the
249  * default account
250  **/
251 void    modest_ui_actions_do_send_receive              (const gchar *account_name,
252                                                         gboolean force_connection,
253                                                         gboolean poke_status,
254                                                         gboolean interactive,
255                                                         ModestWindow *win);
256
257 /**
258  * modest_ui_actions_on_send_receive:
259  * @action: a #GtkAction
260  * @win: the Window that contains the action
261  * 
262  * Handles the activation of the send receive action, for example
263  * clicks on Send&Receive button in the main toolbar
264  **/
265 void    modest_ui_actions_on_send_receive              (GtkAction *action, 
266                                                         ModestWindow *win);
267
268 void     modest_ui_actions_on_new_folder               (GtkAction *action,
269                                                         ModestWindow *main_window);
270
271 gboolean     modest_ui_actions_on_edit_mode_rename_folder            (ModestWindow *window);
272
273 void     modest_ui_actions_on_rename_folder            (GtkAction *action,
274                                                         ModestWindow *window);
275
276 void     modest_ui_actions_on_delete_folder            (GtkAction *action,
277                                                         ModestWindow *window);
278
279 #ifndef MODEST_TOOLKIT_HILDON2
280 void     modest_ui_actions_on_move_folder_to_trash_folder     (GtkAction *action,
281                                                                ModestMainWindow *main_window);
282 #endif
283
284 void     modest_ui_actions_on_password_requested (TnyAccountStore *account_store,
285                                                   const gchar* server_account_name,
286                                                   gchar **username, gchar **password, gboolean *cancel, 
287                                                   gboolean *remember, ModestMainWindow *main_window);
288
289 void     modest_ui_actions_on_undo                     (GtkAction *action,
290                                                         ModestWindow *window);
291
292 void     modest_ui_actions_on_redo                     (GtkAction *action,
293                                                         ModestWindow *window);
294
295 void     modest_ui_actions_on_cut                      (GtkAction *action,
296                                                         ModestWindow *window);
297
298 void     modest_ui_actions_on_copy                     (GtkAction *action,
299                                                         ModestWindow *window);
300
301 void     modest_ui_actions_on_zoom_plus (GtkAction *action,
302                                          ModestWindow *window);
303
304 void     modest_ui_actions_on_zoom_minus (GtkAction *action,
305                                           ModestWindow *window);
306
307 void     modest_ui_actions_on_toggle_fullscreen    (GtkToggleAction *toggle,
308                                                     ModestWindow *window);
309
310 void     modest_ui_actions_on_change_fullscreen    (GtkAction *action,
311                                                     ModestWindow *window);
312
313 void     modest_ui_actions_on_paste                    (GtkAction *action,
314                                                         ModestWindow *window);
315
316 void     modest_ui_actions_on_select_all               (GtkAction *action,
317                                                         ModestWindow *window);
318
319 void     modest_ui_actions_on_toggle_show_cc (GtkToggleAction *toggle,
320                                               ModestMsgEditWindow *window);
321
322 void     modest_ui_actions_on_toggle_show_bcc (GtkToggleAction *toggle,
323                                               ModestMsgEditWindow *window);
324
325 void     modest_ui_actions_on_change_zoom              (GtkRadioAction *action,
326                                                         GtkRadioAction *selected,
327                                                         ModestWindow *window);
328
329 void     modest_ui_actions_msg_edit_on_change_priority (GtkRadioAction *action,
330                                                         GtkRadioAction *selected,
331                                                         ModestWindow *window);
332
333 void     modest_ui_actions_msg_edit_on_change_file_format (GtkRadioAction *action,
334                                                            GtkRadioAction *selected,
335                                                            ModestWindow *window);
336
337 void     modest_ui_actions_msg_edit_on_select_font (GtkAction *action,
338                                                     ModestMsgEditWindow *window);
339
340 /**
341  * modest_ui_actions_on_toggle_toolbar:
342  * @toggle: 
343  * @window: 
344  * 
345  * Hides/Shows the toolbars of the #ModestWindow instances
346  **/
347 void     modest_ui_actions_on_toggle_toolbar           (GtkToggleAction *toggle, 
348                                                         ModestWindow *window);
349
350 /**
351  * modest_ui_actions_on_folder_display_name_changed:
352  * @folder_view: a #ModestFolderView
353  * @display_name: the new window title
354  * @window: a #GtkWindow
355  * 
356  * Sets the title of the window to the value specified by
357  * display_name. This function is used typically as a callback to the
358  * "folder-display-name-changed" signal from the #ModestFolderView
359  **/
360 void     modest_ui_actions_on_folder_display_name_changed (ModestFolderView *folder_view,
361                                                            const gchar *display_name,
362                                                            GtkWindow *window);
363
364 void     modest_ui_actions_view_attachment                (GtkAction *action,
365                                                            ModestWindow *window);
366
367 void     modest_ui_actions_save_attachments               (GtkAction *action,
368                                                            ModestWindow *window);
369
370 void     modest_ui_actions_remove_attachments             (GtkAction *action,
371                                                            ModestWindow *window);
372
373 /**
374  * modest_ui_actions_on_retrieve_msg_contents:
375  * @action: the #GtkAction
376  * @window: the #ModestWindow that issues the action
377  * 
378  * Retrieve the contents of the selected messages in the header view
379  **/
380 void     modest_ui_actions_on_retrieve_msg_contents       (GtkAction *action,
381                                                            ModestWindow *window);
382
383 void
384 modest_ui_actions_on_email_menu_activated (GtkAction *action,
385                                           ModestWindow *window);
386
387 void
388 modest_ui_actions_on_edit_menu_activated (GtkAction *action,
389                                           ModestWindow *window);
390
391 void
392 modest_ui_actions_on_format_menu_activated (GtkAction *action,
393                                             ModestWindow *window);
394
395 void
396 modest_ui_actions_on_view_menu_activated (GtkAction *action,
397                                           ModestWindow *window);
398
399 void
400 modest_ui_actions_on_tools_menu_activated (GtkAction *action,
401                                           ModestWindow *window);
402
403 void
404 modest_ui_actions_on_attachment_menu_activated (GtkAction *action,
405                                                 ModestWindow *window);
406
407 void
408 modest_ui_actions_on_toolbar_csm_menu_activated (GtkAction *action,
409                                                  ModestWindow *window);
410
411 void
412 modest_ui_actions_on_folder_view_csm_menu_activated (GtkAction *action,
413                                                      ModestWindow *window);
414
415 void
416 modest_ui_actions_on_header_view_csm_menu_activated (GtkAction *action,
417                                                      ModestWindow *window);
418
419 void
420 modest_ui_actions_check_toolbar_dimming_rules (ModestWindow *window);
421
422 void
423 modest_ui_actions_check_menu_dimming_rules (ModestWindow *window);
424
425 /* Dimming rules groups */
426 #define MODEST_DIMMING_RULES_TOOLBAR "ModestToolbarDimmingRules"
427 #define MODEST_DIMMING_RULES_MENU "ModestMenuDimmingRules"
428 #define MODEST_DIMMING_RULES_CLIPBOARD "ModestClipboardDimmingRules"
429
430 /**
431  * modest_ui_actions_move_folder_error_handler:
432  * @mail_op: a #ModestMailOperation
433  * @user_data: user data
434  * 
435  * manages an error in a mail operation that tries to move a folder
436  **/
437 void     modest_ui_actions_move_folder_error_handler      (ModestMailOperation *mail_op, 
438                                                            gpointer user_data);
439 /**
440  * modest_ui_actions_send-receive_error_handler:
441  * @mail_op: a #ModestMailOperation
442  * @user_data: user data
443  * 
444  * manages an error in a mail operation that tries to execute
445  * a send&receive operation.
446  **/
447 void     modest_ui_actions_send_receive_error_handler      (ModestMailOperation *mail_op, 
448                                                             gpointer user_data);
449
450 /**
451  * modest_ui_actions_on_search_messages:
452  * @action: a #GtkAction
453  * @window: a #ModestWindow
454  *
455  * Shows the search messages dialog
456  **/
457 void     modest_ui_actions_on_search_messages             (GtkAction *action,
458                                                            ModestWindow *window);
459
460 /**
461  * modest_ui_actions_on_find_in_page:
462  * @action: a #GtkAction
463  * @window: a #ModestWindow
464  *
465  * Toggles the visibility of the find in page toolbar
466  **/
467 void     modest_ui_actions_on_toggle_find_in_page             (GtkAction *action,
468                                                                ModestWindow *window);
469
470 /**
471  * modest_ui_actions_msg_retrieval_check
472  * @mail_op: a #ModestMailOperation
473  * @header: a #TnyHeader
474  * @msg: a #TnyMsg
475  *
476  * This function checks that the message has been retrieved
477  * successfully. It it was not the case it unregisters the header from
478  * the window manager because it won't do it automatically unless the
479  * operation run fine
480  *
481  * Returns: TRUE if the operation was OK, otherwise FALSE
482  **/
483 gboolean modest_ui_actions_msg_retrieval_check                (ModestMailOperation *mail_op, 
484                                                                TnyHeader *header,
485                                                                TnyMsg *msg);
486
487
488 /**
489  * modest_ui_actions_disk_operations_error_handler
490  * @mail_op: a #ModestMailOperation
491  *
492  * Error handler for retrieval operations like
493  * modest_mail_operation_get_msg or
494  * modest_mail_operation_get_msgs_full
495  **/
496 void     modest_ui_actions_disk_operations_error_handler      (ModestMailOperation *mail_op,
497                                                                gpointer user_data);
498
499 /* Show the account creation wizard dialog.
500  * returns: TRUE if an account was created. FALSE if the user cancelled.
501  */
502 gboolean modest_ui_actions_run_account_setup_wizard (ModestWindow *win);
503
504 gint modest_ui_actions_msgs_move_to_confirmation (ModestWindow *win,
505                                                   TnyFolder *dest_folder,
506                                                   gboolean delete,
507                                                   TnyList *headers);
508
509 /*
510  * modest_ui_actions_on_send_queue_error_happened:
511  *
512  * Method for handling errors in send queues
513  */
514 void modest_ui_actions_on_send_queue_error_happened (TnySendQueue *self, 
515                                                      TnyHeader *header, 
516                                                      TnyMsg *msg, 
517                                                      GError *err, 
518                                                      gpointer user_data);
519
520 /*
521  * modest_ui_actions_on_send_queue_status_changed:
522  *
523  * Method for handling changes in the status of the messages in the send queues
524  */
525 void modest_ui_actions_on_send_queue_status_changed (ModestTnySendQueue *send_queue,
526                                                      gchar *msg_id, 
527                                                      guint status,
528                                                      gpointer user_data);
529
530 /**
531  * modest_ui_actions_compose_msg
532  * @win: Modest main window (can be NULL)
533  * @to_str: "To:" header, or NULL
534  * @cc_str: "Cc:" header, or NULL
535  * @bcc_str: "Bcc:" header, or NULL
536  * @subject_str: Subject of the message, or NULL
537  * @body_str: Body of the message (without signature), or NULL
538  * @attachments: attachments List of file URIs to attach
539  * @set_as_modified: wheter or not the message is set initially as modified or not
540  *
541  * Opens a new message editor for composing
542  */
543 void modest_ui_actions_compose_msg (ModestWindow *win,
544                                     const gchar *to_str,
545                                     const gchar *cc_str,
546                                     const gchar *bcc_str,
547                                     const gchar *subject_str,
548                                     const gchar *body_str,
549                                     GSList *attachments,
550                                     gboolean set_as_modified);
551
552 void modest_ui_actions_on_account_connection_error (GtkWindow *parent_window,
553                                                     TnyAccount *account);
554
555 gchar *modest_ui_actions_get_msg_already_deleted_error_msg (ModestWindow *win);
556
557 void modest_ui_actions_transfer_messages_helper (GtkWindow *win,
558                                                  TnyFolder *src_folder,
559                                                  TnyList *headers,
560                                                  TnyFolder *dst_folder);
561
562 void modest_ui_actions_on_fetch_images (GtkAction *action,
563                                         ModestWindow *window);
564
565 /**
566  * modest_ui_actions_check_for_active_account:
567  * @win: a #ModestWindow
568  * @account_name: the account name of the account to check
569  *
570  * Check whether any connections are active, and cancel them if
571  * the user wants.
572  *
573  * Returns: Returns TRUE if there was no problem, or if an operation
574  * was cancelled so we can continue. Returns FALSE if the user chose
575  * to cancel his request instead.
576  **/
577 gboolean modest_ui_actions_check_for_active_account (ModestWindow *win,
578                                                      const gchar* account_name);
579
580 G_END_DECLS
581 #endif /* __MODEST_UI_ACTIONS_H__ */