1 /* Copyright (c) 2006, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
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.
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.
30 #ifndef __MODEST_UI_ACTIONS_H__
31 #define __MODEST_UI_ACTIONS_H__
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"
42 /* Menu & toolbar actions */
43 void modest_ui_actions_on_about (GtkAction *action, ModestWindow *win);
45 void modest_ui_actions_refresh_message_window_after_delete (ModestMsgViewWindow* win);
47 void modest_ui_actions_on_delete_message (GtkAction *action, ModestWindow *win);
49 gboolean modest_ui_actions_on_edit_mode_delete_message (ModestWindow *win);
51 gboolean modest_ui_actions_on_edit_mode_delete_folder (ModestWindow *win);
53 void modest_ui_actions_on_delete_message_or_folder (GtkAction *action, ModestWindow *win);
55 void modest_ui_actions_on_quit (GtkAction *action, ModestWindow *win);
57 void modest_ui_actions_on_close_window (GtkAction *action, ModestWindow *win);
59 void modest_ui_actions_on_new_account (GtkAction *action, ModestWindow *win);
61 void modest_ui_actions_on_accounts (GtkAction *action, ModestWindow *win);
63 void modest_ui_actions_on_smtp_servers (GtkAction *action, ModestWindow *win);
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);
68 void modest_ui_actions_on_select_contacts (GtkAction *action, ModestMsgEditWindow *win);
70 void modest_ui_actions_on_open_addressbook (GtkAction *action, ModestWindow *win);
72 void modest_ui_actions_on_check_names (GtkAction *action, ModestMsgEditWindow *win);
74 void modest_ui_actions_on_new_msg (GtkAction *action, ModestWindow *win);
76 void modest_ui_actions_on_new_msg_or_folder (GtkAction *action, ModestWindow *win);
78 void modest_ui_actions_on_open (GtkAction *action, ModestWindow *win);
80 void modest_ui_actions_on_reply (GtkAction *action, ModestWindow *win);
82 void modest_ui_actions_on_forward (GtkAction *action, ModestWindow *win);
84 void modest_ui_actions_on_sort (GtkAction *action, ModestWindow *window);
86 void modest_ui_actions_on_reply_all (GtkAction *action, ModestWindow *win);
88 void modest_ui_actions_on_next (GtkAction *action, ModestWindow *main_window);
90 void modest_ui_actions_on_prev (GtkAction *action, ModestWindow *main_window);
92 void modest_ui_actions_on_details (GtkAction *action, ModestWindow *win);
94 void modest_ui_actions_on_limit_error (GtkAction *action, ModestWindow *win);
96 gboolean modest_ui_actions_on_edit_mode_move_to (ModestWindow *win);
98 void modest_ui_actions_on_move_to (GtkAction *action, ModestWindow *win);
100 void modest_ui_actions_on_settings (GtkAction *action, ModestWindow *win);
103 * modest_ui_actions_on_help:
104 * @action: a #GtkAction
105 * @win: a #ModestWindow
107 * Shows the help dialog
109 void modest_ui_actions_on_help (GtkAction *action, GtkWindow *win);
113 * modest_ui_actions_on_csm_elp:
114 * @action: a #GtkAction
115 * @win: a #ModestWindow
117 * Shows the help dialog for folder view CSM. It shows the help ID
118 * which refers to the currently selected folder if any
120 void modest_ui_actions_on_csm_help (GtkAction *action, GtkWindow *win);
123 * modest_ui_actions_toggle_folders_view:
124 * @action: the #GtkAction
125 * @main_window: the #ModestMainWindow
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
132 void modest_ui_actions_toggle_folders_view (GtkAction *action,
133 ModestMainWindow *main_window);
136 * modest_ui_actions_toggle_folders_view:
137 * @action: the #GtkAction
138 * @main_window: the #ModestMainWindow
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
143 void modest_ui_actions_toggle_header_list_view (GtkAction *action,
144 ModestMainWindow *main_window);
147 void modest_ui_actions_on_header_selected (ModestHeaderView *folder_view,
149 ModestMainWindow *main_window);
150 void modest_ui_actions_on_header_activated (ModestHeaderView *folder_view,
153 ModestWindow *main_window);
155 void modest_ui_actions_on_folder_selection_changed (ModestFolderView *folder_view,
156 TnyFolderStore *folder_store,
158 ModestMainWindow *main_window);
160 void modest_ui_actions_on_item_not_found (ModestHeaderView *header_view,
162 ModestWindow *window);
164 void modest_ui_actions_on_msg_link_hover (ModestMsgView *msgview, const gchar* link,
167 void modest_ui_actions_on_msg_link_clicked (ModestMsgView *msgview, const gchar* link,
170 void modest_ui_actions_on_msg_link_contextual (ModestMsgView *msgview, const gchar* link,
173 void modest_ui_actions_on_msg_attachment_clicked (ModestMsgView *msgview, TnyMimePart *mime_part,
176 void modest_ui_actions_on_msg_recpt_activated (ModestMsgView *msgview, const gchar *address,
179 gboolean modest_ui_actions_on_send_msg (ModestWindow *window,
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);
188 void modest_ui_actions_on_toggle_bold (GtkToggleAction *action,
189 ModestMsgEditWindow *window);
191 void modest_ui_actions_on_toggle_italics (GtkToggleAction *action,
192 ModestMsgEditWindow *window);
194 void modest_ui_actions_on_toggle_bullets (GtkToggleAction *action,
195 ModestMsgEditWindow *window);
197 void modest_ui_actions_on_change_justify (GtkRadioAction *action,
198 GtkRadioAction *selected,
199 ModestMsgEditWindow *window);
201 void modest_ui_actions_on_select_editor_color (GtkAction *action,
202 ModestMsgEditWindow *window);
204 void modest_ui_actions_on_select_editor_background_color (GtkAction *action,
205 ModestMsgEditWindow *window);
207 void modest_ui_actions_on_insert_image (GObject *object,
208 ModestMsgEditWindow *window);
210 void modest_ui_actions_on_attach_file (GtkAction *action,
211 ModestMsgEditWindow *window);
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);
218 void modest_ui_actions_on_mark_as_unread (GtkAction *action,
219 ModestWindow *window);
221 void modest_ui_actions_cancel_send (GtkAction *action, ModestWindow *win);
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.
230 * Refreshes all the accounts
232 void modest_ui_actions_do_send_receive_all (ModestWindow *win,
233 gboolean force_connection,
234 gboolean poke_status,
235 gboolean interactive);
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
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
250 void modest_ui_actions_do_send_receive (const gchar *account_name,
251 gboolean force_connection,
252 gboolean poke_status,
253 gboolean interactive,
257 * modest_ui_actions_on_send_receive:
258 * @action: a #GtkAction
259 * @win: the Window that contains the action
261 * Handles the activation of the send receive action, for example
262 * clicks on Send&Receive button in the main toolbar
264 void modest_ui_actions_on_send_receive (GtkAction *action,
267 void modest_ui_actions_on_new_folder (GtkAction *action,
268 ModestWindow *main_window);
270 gboolean modest_ui_actions_on_edit_mode_rename_folder (ModestWindow *window);
272 void modest_ui_actions_on_rename_folder (GtkAction *action,
273 ModestWindow *window);
275 void modest_ui_actions_on_delete_folder (GtkAction *action,
276 ModestWindow *window);
278 void modest_ui_actions_on_move_folder_to_trash_folder (GtkAction *action,
279 ModestMainWindow *main_window);
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);
286 void modest_ui_actions_on_undo (GtkAction *action,
287 ModestWindow *window);
289 void modest_ui_actions_on_redo (GtkAction *action,
290 ModestWindow *window);
292 void modest_ui_actions_on_cut (GtkAction *action,
293 ModestWindow *window);
295 void modest_ui_actions_on_copy (GtkAction *action,
296 ModestWindow *window);
298 void modest_ui_actions_on_zoom_plus (GtkAction *action,
299 ModestWindow *window);
301 void modest_ui_actions_on_zoom_minus (GtkAction *action,
302 ModestWindow *window);
304 void modest_ui_actions_on_toggle_fullscreen (GtkToggleAction *toggle,
305 ModestWindow *window);
307 void modest_ui_actions_on_change_fullscreen (GtkAction *action,
308 ModestWindow *window);
310 void modest_ui_actions_on_paste (GtkAction *action,
311 ModestWindow *window);
313 void modest_ui_actions_on_select_all (GtkAction *action,
314 ModestWindow *window);
316 void modest_ui_actions_on_toggle_show_cc (GtkToggleAction *toggle,
317 ModestMsgEditWindow *window);
319 void modest_ui_actions_on_toggle_show_bcc (GtkToggleAction *toggle,
320 ModestMsgEditWindow *window);
322 void modest_ui_actions_on_change_zoom (GtkRadioAction *action,
323 GtkRadioAction *selected,
324 ModestWindow *window);
326 void modest_ui_actions_msg_edit_on_change_priority (GtkRadioAction *action,
327 GtkRadioAction *selected,
328 ModestWindow *window);
330 void modest_ui_actions_msg_edit_on_change_file_format (GtkRadioAction *action,
331 GtkRadioAction *selected,
332 ModestWindow *window);
334 void modest_ui_actions_msg_edit_on_select_font (GtkAction *action,
335 ModestMsgEditWindow *window);
338 * modest_ui_actions_on_toggle_toolbar:
342 * Hides/Shows the toolbars of the #ModestWindow instances
344 void modest_ui_actions_on_toggle_toolbar (GtkToggleAction *toggle,
345 ModestWindow *window);
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
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
357 void modest_ui_actions_on_folder_display_name_changed (ModestFolderView *folder_view,
358 const gchar *display_name,
361 void modest_ui_actions_view_attachment (GtkAction *action,
362 ModestWindow *window);
364 void modest_ui_actions_save_attachments (GtkAction *action,
365 ModestWindow *window);
367 void modest_ui_actions_remove_attachments (GtkAction *action,
368 ModestWindow *window);
371 * modest_ui_actions_on_retrieve_msg_contents:
372 * @action: the #GtkAction
373 * @window: the #ModestWindow that issues the action
375 * Retrieve the contents of the selected messages in the header view
377 void modest_ui_actions_on_retrieve_msg_contents (GtkAction *action,
378 ModestWindow *window);
381 modest_ui_actions_on_email_menu_activated (GtkAction *action,
382 ModestWindow *window);
385 modest_ui_actions_on_edit_menu_activated (GtkAction *action,
386 ModestWindow *window);
389 modest_ui_actions_on_format_menu_activated (GtkAction *action,
390 ModestWindow *window);
393 modest_ui_actions_on_view_menu_activated (GtkAction *action,
394 ModestWindow *window);
397 modest_ui_actions_on_tools_menu_activated (GtkAction *action,
398 ModestWindow *window);
401 modest_ui_actions_on_attachment_menu_activated (GtkAction *action,
402 ModestWindow *window);
405 modest_ui_actions_on_toolbar_csm_menu_activated (GtkAction *action,
406 ModestWindow *window);
409 modest_ui_actions_on_folder_view_csm_menu_activated (GtkAction *action,
410 ModestWindow *window);
413 modest_ui_actions_on_header_view_csm_menu_activated (GtkAction *action,
414 ModestWindow *window);
417 modest_ui_actions_check_toolbar_dimming_rules (ModestWindow *window);
420 modest_ui_actions_check_menu_dimming_rules (ModestWindow *window);
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"
428 * modest_ui_actions_move_folder_error_handler:
429 * @mail_op: a #ModestMailOperation
430 * @user_data: user data
432 * manages an error in a mail operation that tries to move a folder
434 void modest_ui_actions_move_folder_error_handler (ModestMailOperation *mail_op,
437 * modest_ui_actions_send-receive_error_handler:
438 * @mail_op: a #ModestMailOperation
439 * @user_data: user data
441 * manages an error in a mail operation that tries to execute
442 * a send&receive operation.
444 void modest_ui_actions_send_receive_error_handler (ModestMailOperation *mail_op,
448 * modest_ui_actions_on_search_messages:
449 * @action: a #GtkAction
450 * @window: a #ModestWindow
452 * Shows the search messages dialog
454 void modest_ui_actions_on_search_messages (GtkAction *action,
455 ModestWindow *window);
458 * modest_ui_actions_on_find_in_page:
459 * @action: a #GtkAction
460 * @window: a #ModestWindow
462 * Toggles the visibility of the find in page toolbar
464 void modest_ui_actions_on_toggle_find_in_page (GtkAction *action,
465 ModestWindow *window);
468 * modest_ui_actions_msg_retrieval_check
469 * @mail_op: a #ModestMailOperation
470 * @header: a #TnyHeader
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
478 * Returns: TRUE if the operation was OK, otherwise FALSE
480 gboolean modest_ui_actions_msg_retrieval_check (ModestMailOperation *mail_op,
486 * modest_ui_actions_disk_operations_error_handler
487 * @mail_op: a #ModestMailOperation
489 * Error handler for retrieval operations like
490 * modest_mail_operation_get_msg or
491 * modest_mail_operation_get_msgs_full
493 void modest_ui_actions_disk_operations_error_handler (ModestMailOperation *mail_op,
496 /* Show the account creation wizard dialog.
497 * returns: TRUE if an account was created. FALSE if the user cancelled.
499 gboolean modest_ui_actions_run_account_setup_wizard (ModestWindow *win);
501 gint modest_ui_actions_msgs_move_to_confirmation (ModestWindow *win,
502 TnyFolder *dest_folder,
507 * modest_ui_actions_on_send_queue_error_happened:
509 * Method for handling errors in send queues
511 void modest_ui_actions_on_send_queue_error_happened (TnySendQueue *self,
518 * modest_ui_actions_on_send_queue_status_changed:
520 * Method for handling changes in the status of the messages in the send queues
522 void modest_ui_actions_on_send_queue_status_changed (ModestTnySendQueue *send_queue,
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
538 * Opens a new message editor for composing
540 void modest_ui_actions_compose_msg (ModestWindow *win,
543 const gchar *bcc_str,
544 const gchar *subject_str,
545 const gchar *body_str,
547 gboolean set_as_modified);
549 void modest_ui_actions_on_account_connection_error (GtkWindow *parent_window,
550 TnyAccount *account);
552 gchar *modest_ui_actions_get_msg_already_deleted_error_msg (ModestWindow *win);
554 void modest_ui_actions_transfer_messages_helper (GtkWindow *win,
555 TnyFolder *src_folder,
557 TnyFolder *dst_folder);
559 void modest_ui_actions_on_fetch_images (GtkAction *action,
560 ModestWindow *window);
563 * modest_ui_actions_check_for_active_account:
564 * @win: a #ModestWindow
565 * @account_name: the account name of the account to check
567 * Check whether any connections are active, and cancel them if
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.
574 gboolean modest_ui_actions_check_for_active_account (ModestWindow *win,
575 const gchar* account_name);
578 #endif /* __MODEST_UI_ACTIONS_H__ */