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 void modest_ui_actions_on_delete_message_or_folder (GtkAction *action, ModestWindow *win);
51 void modest_ui_actions_on_quit (GtkAction *action, ModestWindow *win);
53 void modest_ui_actions_on_close_window (GtkAction *action, ModestWindow *win);
55 void modest_ui_actions_on_new_account (GtkAction *action, ModestWindow *win);
57 void modest_ui_actions_on_accounts (GtkAction *action, ModestWindow *win);
59 void modest_ui_actions_on_smtp_servers (GtkAction *action, ModestWindow *win);
61 void modest_ui_actions_on_add_to_contacts (GtkAction *action, ModestWindow *win);
63 void modest_ui_actions_on_select_contacts (GtkAction *action, ModestMsgEditWindow *win);
65 void modest_ui_actions_on_open_addressbook (GtkAction *action, ModestWindow *win);
67 void modest_ui_actions_on_check_names (GtkAction *action, ModestMsgEditWindow *win);
69 void modest_ui_actions_on_new_msg (GtkAction *action, ModestWindow *win);
71 void modest_ui_actions_on_new_msg_or_folder (GtkAction *action, ModestWindow *win);
73 void modest_ui_actions_on_open (GtkAction *action, ModestWindow *win);
75 void modest_ui_actions_on_reply (GtkAction *action, ModestWindow *win);
77 void modest_ui_actions_on_forward (GtkAction *action, ModestWindow *win);
79 void modest_ui_actions_on_sort (GtkAction *action, ModestWindow *window);
81 void modest_ui_actions_on_reply_all (GtkAction *action, ModestWindow *win);
83 void modest_ui_actions_on_next (GtkAction *action, ModestWindow *main_window);
85 void modest_ui_actions_on_prev (GtkAction *action, ModestWindow *main_window);
87 void modest_ui_actions_on_details (GtkAction *action, ModestWindow *win);
89 void modest_ui_actions_on_move_to (GtkAction *action, ModestWindow *win);
91 void modest_ui_actions_on_settings (GtkAction *action, ModestWindow *win);
94 * modest_ui_actions_on_help:
95 * @action: a #GtkAction
96 * @win: a #ModestWindow
98 * Shows the help dialog
100 void modest_ui_actions_on_help (GtkAction *action, GtkWindow *win);
104 * modest_ui_actions_on_csm_elp:
105 * @action: a #GtkAction
106 * @win: a #ModestWindow
108 * Shows the help dialog for folder view CSM. It shows the help ID
109 * which refers to the currently selected folder if any
111 void modest_ui_actions_on_csm_help (GtkAction *action, GtkWindow *win);
114 * modest_ui_actions_toggle_folders_view:
115 * @action: the #GtkAction
116 * @main_window: the #ModestMainWindow
118 * this action switches between split view (with a folders pane at the
119 * left) and simple view without the left pane with the folders and
120 * accounts. Maybe it's only useful for Maemo code, but as it uses
121 * generic code could be used also by the GNOME UI
123 void modest_ui_actions_toggle_folders_view (GtkAction *action,
124 ModestMainWindow *main_window);
127 * modest_ui_actions_toggle_folders_view:
128 * @action: the #GtkAction
129 * @main_window: the #ModestMainWindow
131 * this action shows or hides the column titles of the header list
132 * view. It also enables the two lines rendering for the treeview rows
134 void modest_ui_actions_toggle_header_list_view (GtkAction *action,
135 ModestMainWindow *main_window);
138 void modest_ui_actions_on_header_selected (ModestHeaderView *folder_view,
140 ModestMainWindow *main_window);
141 void modest_ui_actions_on_header_activated (ModestHeaderView *folder_view,
143 ModestMainWindow *main_window);
145 void modest_ui_actions_on_folder_selection_changed (ModestFolderView *folder_view,
146 TnyFolderStore *folder_store,
148 ModestMainWindow *main_window);
150 void modest_ui_actions_on_item_not_found (ModestHeaderView *header_view,
152 ModestWindow *window);
154 void modest_ui_actions_on_msg_link_hover (ModestMsgView *msgview, const gchar* link,
157 void modest_ui_actions_on_msg_link_clicked (ModestMsgView *msgview, const gchar* link,
160 void modest_ui_actions_on_msg_link_contextual (ModestMsgView *msgview, const gchar* link,
163 void modest_ui_actions_on_msg_attachment_clicked (ModestMsgView *msgview, TnyMimePart *mime_part,
166 void modest_ui_actions_on_msg_recpt_activated (ModestMsgView *msgview, const gchar *address,
169 gboolean modest_ui_actions_on_send (GtkWidget *widget,
170 ModestMsgEditWindow *edit_window);
171 gboolean modest_ui_actions_on_save_to_drafts (GtkWidget *widget,
172 ModestMsgEditWindow *edit_window);
175 void modest_ui_actions_on_toggle_bold (GtkToggleAction *action,
176 ModestMsgEditWindow *window);
178 void modest_ui_actions_on_toggle_italics (GtkToggleAction *action,
179 ModestMsgEditWindow *window);
181 void modest_ui_actions_on_toggle_bullets (GtkToggleAction *action,
182 ModestMsgEditWindow *window);
184 void modest_ui_actions_on_change_justify (GtkRadioAction *action,
185 GtkRadioAction *selected,
186 ModestMsgEditWindow *window);
188 void modest_ui_actions_on_select_editor_color (GtkAction *action,
189 ModestMsgEditWindow *window);
191 void modest_ui_actions_on_select_editor_background_color (GtkAction *action,
192 ModestMsgEditWindow *window);
194 void modest_ui_actions_on_insert_image (GtkAction *action,
195 ModestMsgEditWindow *window);
197 void modest_ui_actions_on_attach_file (GtkAction *action,
198 ModestMsgEditWindow *window);
200 void modest_ui_actions_on_remove_attachments (GtkAction *action,
201 ModestMsgEditWindow *window);
202 void modest_ui_actions_on_mark_as_read (GtkAction *action,
203 ModestWindow *window);
205 void modest_ui_actions_on_mark_as_unread (GtkAction *action,
206 ModestWindow *window);
208 void modest_ui_actions_cancel_send (GtkAction *action, ModestWindow *win);
211 * modest_ui_actions_do_send_receive_all:
212 * @win: the window that will be used as source of the refresh mail operation
213 * @force_connection: whether or not the code should try to force a new connection if we're offline
214 * @poke_status: wheter ot not we want to poke the status of all mail folders
215 * @interactive: is coming from an interactive send receive.
217 * Refreshes all the accounts
219 void modest_ui_actions_do_send_receive_all (ModestWindow *win,
220 gboolean force_connection,
221 gboolean poke_status,
222 gboolean interactive);
225 * modest_ui_actions_do_send_receive:
226 * @account_name: the name of the Modest account or NULL
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 * @win: the window that will be used as source of the refresh mail operation
232 * Refreshes the Modest account whose name is passed as argument. If
233 * NULL is passed as #account_name then this function refreses the
234 * active account, if no active account is defined then it picks the
237 void modest_ui_actions_do_send_receive (const gchar *account_name,
238 gboolean force_connection,
239 gboolean poke_status,
240 gboolean interactive,
244 * modest_ui_actions_on_send_receive:
245 * @action: a #GtkAction
246 * @win: the Window that contains the action
248 * Handles the activation of the send receive action, for example
249 * clicks on Send&Receive button in the main toolbar
251 void modest_ui_actions_on_send_receive (GtkAction *action,
254 void modest_ui_actions_on_new_folder (GtkAction *action,
255 ModestMainWindow *main_window);
257 void modest_ui_actions_on_rename_folder (GtkAction *action,
258 ModestMainWindow *main_window);
260 void modest_ui_actions_on_delete_folder (GtkAction *action,
261 ModestMainWindow *main_window);
263 void modest_ui_actions_on_move_folder_to_trash_folder (GtkAction *action,
264 ModestMainWindow *main_window);
266 void modest_ui_actions_on_password_requested (TnyAccountStore *account_store,
267 const gchar* server_account_name,
268 gchar **username, gchar **password, gboolean *cancel,
269 gboolean *remember, ModestMainWindow *main_window);
271 void modest_ui_actions_on_undo (GtkAction *action,
272 ModestWindow *window);
274 void modest_ui_actions_on_redo (GtkAction *action,
275 ModestWindow *window);
277 void modest_ui_actions_on_cut (GtkAction *action,
278 ModestWindow *window);
280 void modest_ui_actions_on_copy (GtkAction *action,
281 ModestWindow *window);
283 void modest_ui_actions_on_zoom_plus (GtkAction *action,
284 ModestWindow *window);
286 void modest_ui_actions_on_zoom_minus (GtkAction *action,
287 ModestWindow *window);
289 void modest_ui_actions_on_toggle_fullscreen (GtkToggleAction *toggle,
290 ModestWindow *window);
292 void modest_ui_actions_on_change_fullscreen (GtkAction *action,
293 ModestWindow *window);
295 void modest_ui_actions_on_paste (GtkAction *action,
296 ModestWindow *window);
298 void modest_ui_actions_on_select_all (GtkAction *action,
299 ModestWindow *window);
301 void modest_ui_actions_on_toggle_show_cc (GtkToggleAction *toggle,
302 ModestMsgEditWindow *window);
304 void modest_ui_actions_on_toggle_show_bcc (GtkToggleAction *toggle,
305 ModestMsgEditWindow *window);
307 void modest_ui_actions_on_change_zoom (GtkRadioAction *action,
308 GtkRadioAction *selected,
309 ModestWindow *window);
311 void modest_ui_actions_msg_edit_on_change_priority (GtkRadioAction *action,
312 GtkRadioAction *selected,
313 ModestWindow *window);
315 void modest_ui_actions_msg_edit_on_change_file_format (GtkRadioAction *action,
316 GtkRadioAction *selected,
317 ModestWindow *window);
319 void modest_ui_actions_msg_edit_on_select_font (GtkAction *action,
320 ModestMsgEditWindow *window);
323 * modest_ui_actions_on_toggle_toolbar:
327 * Hides/Shows the toolbars of the #ModestWindow instances
329 void modest_ui_actions_on_toggle_toolbar (GtkToggleAction *toggle,
330 ModestWindow *window);
333 * modest_ui_actions_on_folder_display_name_changed:
334 * @folder_view: a #ModestFolderView
335 * @display_name: the new window title
336 * @window: a #GtkWindow
338 * Sets the title of the window to the value specified by
339 * display_name. This function is used typically as a callback to the
340 * "folder-display-name-changed" signal from the #ModestFolderView
342 void modest_ui_actions_on_folder_display_name_changed (ModestFolderView *folder_view,
343 const gchar *display_name,
346 void modest_ui_actions_view_attachment (GtkAction *action,
347 ModestWindow *window);
349 void modest_ui_actions_save_attachments (GtkAction *action,
350 ModestWindow *window);
352 void modest_ui_actions_remove_attachments (GtkAction *action,
353 ModestWindow *window);
356 * modest_ui_actions_on_retrieve_msg_contents:
357 * @action: the #GtkAction
358 * @window: the #ModestWindow that issues the action
360 * Retrieve the contents of the selected messages in the header view
362 void modest_ui_actions_on_retrieve_msg_contents (GtkAction *action,
363 ModestWindow *window);
366 modest_ui_actions_on_email_menu_activated (GtkAction *action,
367 ModestWindow *window);
370 modest_ui_actions_on_edit_menu_activated (GtkAction *action,
371 ModestWindow *window);
374 modest_ui_actions_on_format_menu_activated (GtkAction *action,
375 ModestWindow *window);
378 modest_ui_actions_on_view_menu_activated (GtkAction *action,
379 ModestWindow *window);
382 modest_ui_actions_on_tools_menu_activated (GtkAction *action,
383 ModestWindow *window);
386 modest_ui_actions_on_attachment_menu_activated (GtkAction *action,
387 ModestWindow *window);
390 modest_ui_actions_on_toolbar_csm_menu_activated (GtkAction *action,
391 ModestWindow *window);
394 modest_ui_actions_on_folder_view_csm_menu_activated (GtkAction *action,
395 ModestWindow *window);
398 modest_ui_actions_on_header_view_csm_menu_activated (GtkAction *action,
399 ModestWindow *window);
402 modest_ui_actions_check_toolbar_dimming_rules (ModestWindow *window);
405 modest_ui_actions_check_menu_dimming_rules (ModestWindow *window);
407 /* Dimming rules groups */
408 #define MODEST_DIMMING_RULES_TOOLBAR "ModestToolbarDimmingRules"
409 #define MODEST_DIMMING_RULES_MENU "ModestMenuDimmingRules"
410 #define MODEST_DIMMING_RULES_CLIPBOARD "ModestClipboardDimmingRules"
413 * modest_ui_actions_move_folder_error_handler:
414 * @mail_op: a #ModestMailOperation
415 * @user_data: user data
417 * manages an error in a mail operation that tries to move a folder
419 void modest_ui_actions_move_folder_error_handler (ModestMailOperation *mail_op,
422 * modest_ui_actions_send-receive_error_handler:
423 * @mail_op: a #ModestMailOperation
424 * @user_data: user data
426 * manages an error in a mail operation that tries to execute
427 * a send&receive operation.
429 void modest_ui_actions_send_receive_error_handler (ModestMailOperation *mail_op,
433 * modest_ui_actions_on_search_messages:
434 * @action: a #GtkAction
435 * @window: a #ModestWindow
437 * Shows the search messages dialog
439 void modest_ui_actions_on_search_messages (GtkAction *action,
440 ModestWindow *window);
443 * modest_ui_actions_on_find_in_page:
444 * @action: a #GtkToggleAction
445 * @window: a #ModestWindow
447 * Toggles the visibility of the find in page toolbar
449 void modest_ui_actions_on_toggle_find_in_page (GtkToggleAction *action,
450 ModestWindow *window);
453 * modest_ui_actions_msg_retrieval_check
454 * @mail_op: a #ModestMailOperation
455 * @header: a #TnyHeader
458 * This function checks that the message has been retrieved
459 * successfully. It it was not the case it unregisters the header from
460 * the window manager because it won't do it automatically unless the
463 * Returns: TRUE if the operation was OK, otherwise FALSE
465 gboolean modest_ui_actions_msg_retrieval_check (ModestMailOperation *mail_op,
471 * modest_ui_actions_disk_operations_error_handler
472 * @mail_op: a #ModestMailOperation
474 * Error handler for retrieval operations like
475 * modest_mail_operation_get_msg or
476 * modest_mail_operation_get_msgs_full
478 void modest_ui_actions_disk_operations_error_handler (ModestMailOperation *mail_op,
481 /* Show the account creation wizard dialog.
482 * returns: TRUE if an account was created. FALSE if the user cancelled.
484 gboolean modest_ui_actions_run_account_setup_wizard (ModestWindow *win);
486 gint modest_ui_actions_msgs_move_to_confirmation (ModestWindow *win,
487 TnyFolder *dest_folder,
492 * modest_ui_actions_on_send_queue_error_happened:
494 * Method for handling errors in send queues
496 void modest_ui_actions_on_send_queue_error_happened (TnySendQueue *self,
503 * modest_ui_actions_on_send_queue_status_changed:
505 * Method for handling changes in the status of the messages in the send queues
507 void modest_ui_actions_on_send_queue_status_changed (ModestTnySendQueue *send_queue,
513 * modest_ui_actions_compose_msg
514 * @win: Modest main window (can be NULL)
515 * @to_str: "To:" header, or NULL
516 * @cc_str: "Cc:" header, or NULL
517 * @bcc_str: "Bcc:" header, or NULL
518 * @subject_str: Subject of the message, or NULL
519 * @body_str: Body of the message (without signature), or NULL
520 * @attachments: attachments List of file URIs to attach
521 * @set_as_modified: wheter or not the message is set initially as modified or not
523 * Opens a new message editor for composing
525 void modest_ui_actions_compose_msg (ModestWindow *win,
528 const gchar *bcc_str,
529 const gchar *subject_str,
530 const gchar *body_str,
532 gboolean set_as_modified);
534 void modest_ui_actions_on_account_connection_error (GtkWindow *parent_window,
535 TnyAccount *account);
537 gchar *modest_ui_actions_get_msg_already_deleted_error_msg (ModestWindow *win);
539 void modest_ui_actions_transfer_messages_helper (GtkWindow *win,
540 TnyFolder *src_folder,
542 TnyFolder *dst_folder);
546 #endif /* __MODEST_UI_ACTIONS_H__ */