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