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