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"
41 /* Menu & toolbar actions */
42 void modest_ui_actions_on_about (GtkAction *action, ModestWindow *win);
44 void modest_ui_actions_refresh_message_window_after_delete (ModestMsgViewWindow* win);
46 void modest_ui_actions_on_delete_message (GtkAction *action, ModestWindow *win);
48 void modest_ui_actions_on_delete_message_or_folder (GtkAction *action, ModestWindow *win);
50 void modest_ui_actions_on_quit (GtkAction *action, ModestWindow *win);
52 void modest_ui_actions_on_close_window (GtkAction *action, ModestWindow *win);
54 void modest_ui_actions_on_new_account (GtkAction *action, ModestWindow *win);
56 void modest_ui_actions_on_accounts (GtkAction *action, ModestWindow *win);
58 void modest_ui_actions_on_smtp_servers (GtkAction *action, ModestWindow *win);
60 void modest_ui_actions_on_add_to_contacts (GtkAction *action, ModestWindow *win);
62 void modest_ui_actions_on_select_contacts (GtkAction *action, ModestMsgEditWindow *win);
64 void modest_ui_actions_on_open_addressbook (GtkAction *action, ModestWindow *win);
66 void modest_ui_actions_on_check_names (GtkAction *action, ModestMsgEditWindow *win);
68 void modest_ui_actions_on_new_msg (GtkAction *action, ModestWindow *win);
70 void modest_ui_actions_on_new_msg_or_folder (GtkAction *action, ModestWindow *win);
72 void modest_ui_actions_on_open (GtkAction *action, ModestWindow *win);
74 void modest_ui_actions_on_reply (GtkAction *action, ModestWindow *win);
76 void modest_ui_actions_on_forward (GtkAction *action, ModestWindow *win);
78 void modest_ui_actions_on_sort (GtkAction *action, ModestWindow *window);
80 void modest_ui_actions_on_reply_all (GtkAction *action, ModestWindow *win);
82 void modest_ui_actions_on_next (GtkAction *action, ModestWindow *main_window);
84 void modest_ui_actions_on_prev (GtkAction *action, ModestWindow *main_window);
86 void modest_ui_actions_on_details (GtkAction *action, ModestWindow *win);
88 void modest_ui_actions_on_move_to (GtkAction *action, ModestWindow *win);
90 void modest_ui_actions_on_settings (GtkAction *action, ModestWindow *win);
93 * modest_ui_actions_on_help:
94 * @action: a #GtkAction
95 * @win: a #ModestWindow
97 * Shows the help dialog
99 void modest_ui_actions_on_help (GtkAction *action, GtkWindow *win);
103 * modest_ui_actions_on_csm_elp:
104 * @action: a #GtkAction
105 * @win: a #ModestWindow
107 * Shows the help dialog for folder view CSM. It shows the help ID
108 * which refers to the currently selected folder if any
110 void modest_ui_actions_on_csm_help (GtkAction *action, GtkWindow *win);
113 * modest_ui_actions_toggle_folders_view:
114 * @action: the #GtkAction
115 * @main_window: the #ModestMainWindow
117 * this action switches between split view (with a folders pane at the
118 * left) and simple view without the left pane with the folders and
119 * accounts. Maybe it's only useful for Maemo code, but as it uses
120 * generic code could be used also by the GNOME UI
122 void modest_ui_actions_toggle_folders_view (GtkAction *action,
123 ModestMainWindow *main_window);
126 * modest_ui_actions_toggle_folders_view:
127 * @action: the #GtkAction
128 * @main_window: the #ModestMainWindow
130 * this action shows or hides the column titles of the header list
131 * view. It also enables the two lines rendering for the treeview rows
133 void modest_ui_actions_toggle_header_list_view (GtkAction *action,
134 ModestMainWindow *main_window);
137 void modest_ui_actions_on_header_selected (ModestHeaderView *folder_view,
139 ModestMainWindow *main_window);
140 void modest_ui_actions_on_header_activated (ModestHeaderView *folder_view,
142 ModestMainWindow *main_window);
144 void modest_ui_actions_on_folder_selection_changed (ModestFolderView *folder_view,
145 TnyFolderStore *folder_store,
147 ModestMainWindow *main_window);
149 void modest_ui_actions_on_item_not_found (ModestHeaderView *header_view,
151 ModestWindow *window);
153 void modest_ui_actions_on_msg_link_hover (ModestMsgView *msgview, const gchar* link,
156 void modest_ui_actions_on_msg_link_clicked (ModestMsgView *msgview, const gchar* link,
159 void modest_ui_actions_on_msg_link_contextual (ModestMsgView *msgview, const gchar* link,
162 void modest_ui_actions_on_msg_attachment_clicked (ModestMsgView *msgview, TnyMimePart *mime_part,
165 void modest_ui_actions_on_msg_recpt_activated (ModestMsgView *msgview, const gchar *address,
168 gboolean modest_ui_actions_on_send (GtkWidget *widget,
169 ModestMsgEditWindow *edit_window);
170 gboolean modest_ui_actions_on_save_to_drafts (GtkWidget *widget,
171 ModestMsgEditWindow *edit_window);
174 void modest_ui_actions_on_toggle_bold (GtkToggleAction *action,
175 ModestMsgEditWindow *window);
177 void modest_ui_actions_on_toggle_italics (GtkToggleAction *action,
178 ModestMsgEditWindow *window);
180 void modest_ui_actions_on_toggle_bullets (GtkToggleAction *action,
181 ModestMsgEditWindow *window);
183 void modest_ui_actions_on_change_justify (GtkRadioAction *action,
184 GtkRadioAction *selected,
185 ModestMsgEditWindow *window);
187 void modest_ui_actions_on_select_editor_color (GtkAction *action,
188 ModestMsgEditWindow *window);
190 void modest_ui_actions_on_select_editor_background_color (GtkAction *action,
191 ModestMsgEditWindow *window);
193 void modest_ui_actions_on_insert_image (GtkAction *action,
194 ModestMsgEditWindow *window);
196 void modest_ui_actions_on_attach_file (GtkAction *action,
197 ModestMsgEditWindow *window);
199 void modest_ui_actions_on_remove_attachments (GtkAction *action,
200 ModestMsgEditWindow *window);
201 void modest_ui_actions_on_mark_as_read (GtkAction *action,
202 ModestWindow *window);
204 void modest_ui_actions_on_mark_as_unread (GtkAction *action,
205 ModestWindow *window);
207 void modest_ui_actions_cancel_send (GtkAction *action, ModestWindow *win);
210 * modest_ui_actions_do_send_receive_all:
211 * @win: the window that will be used as source of the refresh mail operation
212 * @force_connection: whether or not the code should try to force a new connection if we're offline
213 * @poke_status: wheter ot not we want to poke the status of all mail folders
214 * @interactive: is coming from an interactive send receive.
216 * Refreshes all the accounts
218 void modest_ui_actions_do_send_receive_all (ModestWindow *win,
219 gboolean force_connection,
220 gboolean poke_status,
221 gboolean interactive);
224 * modest_ui_actions_do_send_receive:
225 * @account_name: the name of the Modest account or NULL
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 * @win: the window that will be used as source of the refresh mail operation
231 * Refreshes the Modest account whose name is passed as argument. If
232 * NULL is passed as #account_name then this function refreses the
233 * active account, if no active account is defined then it picks the
236 void modest_ui_actions_do_send_receive (const gchar *account_name,
237 gboolean force_connection,
238 gboolean poke_status,
239 gboolean interactive,
243 * modest_ui_actions_on_send_receive:
244 * @action: a #GtkAction
245 * @win: the Window that contains the action
247 * Handles the activation of the send receive action, for example
248 * clicks on Send&Receive button in the main toolbar
250 void modest_ui_actions_on_send_receive (GtkAction *action,
253 void modest_ui_actions_on_new_folder (GtkAction *action,
254 ModestMainWindow *main_window);
256 void modest_ui_actions_on_rename_folder (GtkAction *action,
257 ModestMainWindow *main_window);
259 void modest_ui_actions_on_delete_folder (GtkAction *action,
260 ModestMainWindow *main_window);
262 void modest_ui_actions_on_move_folder_to_trash_folder (GtkAction *action,
263 ModestMainWindow *main_window);
265 void modest_ui_actions_on_password_requested (TnyAccountStore *account_store,
266 const gchar* server_account_name,
267 gchar **username, gchar **password, gboolean *cancel,
268 gboolean *remember, ModestMainWindow *main_window);
270 void modest_ui_actions_on_undo (GtkAction *action,
271 ModestWindow *window);
273 void modest_ui_actions_on_redo (GtkAction *action,
274 ModestWindow *window);
276 void modest_ui_actions_on_cut (GtkAction *action,
277 ModestWindow *window);
279 void modest_ui_actions_on_copy (GtkAction *action,
280 ModestWindow *window);
282 void modest_ui_actions_on_zoom_plus (GtkAction *action,
283 ModestWindow *window);
285 void modest_ui_actions_on_zoom_minus (GtkAction *action,
286 ModestWindow *window);
288 void modest_ui_actions_on_toggle_fullscreen (GtkToggleAction *toggle,
289 ModestWindow *window);
291 void modest_ui_actions_on_change_fullscreen (GtkAction *action,
292 ModestWindow *window);
294 void modest_ui_actions_on_paste (GtkAction *action,
295 ModestWindow *window);
297 void modest_ui_actions_on_select_all (GtkAction *action,
298 ModestWindow *window);
300 void modest_ui_actions_on_toggle_show_cc (GtkToggleAction *toggle,
301 ModestMsgEditWindow *window);
303 void modest_ui_actions_on_toggle_show_bcc (GtkToggleAction *toggle,
304 ModestMsgEditWindow *window);
306 void modest_ui_actions_on_change_zoom (GtkRadioAction *action,
307 GtkRadioAction *selected,
308 ModestWindow *window);
310 void modest_ui_actions_msg_edit_on_change_priority (GtkRadioAction *action,
311 GtkRadioAction *selected,
312 ModestWindow *window);
314 void modest_ui_actions_msg_edit_on_change_file_format (GtkRadioAction *action,
315 GtkRadioAction *selected,
316 ModestWindow *window);
318 void modest_ui_actions_msg_edit_on_select_font (GtkAction *action,
319 ModestMsgEditWindow *window);
322 * modest_ui_actions_on_toggle_toolbar:
326 * Hides/Shows the toolbars of the #ModestWindow instances
328 void modest_ui_actions_on_toggle_toolbar (GtkToggleAction *toggle,
329 ModestWindow *window);
332 * modest_ui_actions_on_folder_display_name_changed:
333 * @folder_view: a #ModestFolderView
334 * @display_name: the new window title
335 * @window: a #GtkWindow
337 * Sets the title of the window to the value specified by
338 * display_name. This function is used typically as a callback to the
339 * "folder-display-name-changed" signal from the #ModestFolderView
341 void modest_ui_actions_on_folder_display_name_changed (ModestFolderView *folder_view,
342 const gchar *display_name,
345 void modest_ui_actions_view_attachment (GtkAction *action,
346 ModestWindow *window);
348 void modest_ui_actions_save_attachments (GtkAction *action,
349 ModestWindow *window);
351 void modest_ui_actions_remove_attachments (GtkAction *action,
352 ModestWindow *window);
355 * modest_ui_actions_on_retrieve_msg_contents:
356 * @action: the #GtkAction
357 * @window: the #ModestWindow that issues the action
359 * Retrieve the contents of the selected messages in the header view
361 void modest_ui_actions_on_retrieve_msg_contents (GtkAction *action,
362 ModestWindow *window);
365 modest_ui_actions_on_email_menu_activated (GtkAction *action,
366 ModestWindow *window);
369 modest_ui_actions_on_edit_menu_activated (GtkAction *action,
370 ModestWindow *window);
373 modest_ui_actions_on_format_menu_activated (GtkAction *action,
374 ModestWindow *window);
377 modest_ui_actions_on_view_menu_activated (GtkAction *action,
378 ModestWindow *window);
381 modest_ui_actions_on_tools_menu_activated (GtkAction *action,
382 ModestWindow *window);
385 modest_ui_actions_on_attachment_menu_activated (GtkAction *action,
386 ModestWindow *window);
389 modest_ui_actions_on_toolbar_csm_menu_activated (GtkAction *action,
390 ModestWindow *window);
393 modest_ui_actions_on_folder_view_csm_menu_activated (GtkAction *action,
394 ModestWindow *window);
397 modest_ui_actions_on_header_view_csm_menu_activated (GtkAction *action,
398 ModestWindow *window);
401 modest_ui_actions_check_toolbar_dimming_rules (ModestWindow *window);
404 modest_ui_actions_check_menu_dimming_rules (ModestWindow *window);
406 /* Dimming rules groups */
407 #define MODEST_DIMMING_RULES_TOOLBAR "ModestToolbarDimmingRules"
408 #define MODEST_DIMMING_RULES_MENU "ModestMenuDimmingRules"
409 #define MODEST_DIMMING_RULES_CLIPBOARD "ModestClipboardDimmingRules"
412 * modest_ui_actions_move_folder_error_handler:
413 * @mail_op: a #ModestMailOperation
414 * @user_data: user data
416 * manages an error in a mail operation that tries to move a folder
418 void modest_ui_actions_move_folder_error_handler (ModestMailOperation *mail_op,
421 * modest_ui_actions_send-receive_error_handler:
422 * @mail_op: a #ModestMailOperation
423 * @user_data: user data
425 * manages an error in a mail operation that tries to execute
426 * a send&receive operation.
428 void modest_ui_actions_send_receive_error_handler (ModestMailOperation *mail_op,
432 * modest_ui_actions_on_search_messages:
433 * @action: a #GtkAction
434 * @window: a #ModestWindow
436 * Shows the search messages dialog
438 void modest_ui_actions_on_search_messages (GtkAction *action,
439 ModestWindow *window);
442 * modest_ui_actions_on_find_in_page:
443 * @action: a #GtkToggleAction
444 * @window: a #ModestWindow
446 * Toggles the visibility of the find in page toolbar
448 void modest_ui_actions_on_toggle_find_in_page (GtkToggleAction *action,
449 ModestWindow *window);
452 * modest_ui_actions_msg_retrieval_check
453 * @mail_op: a #ModestMailOperation
454 * @header: a #TnyHeader
457 * This function checks that the message has been retrieved
458 * successfully. It it was not the case it unregisters the header from
459 * the window manager because it won't do it automatically unless the
462 * Returns: TRUE if the operation was OK, otherwise FALSE
464 gboolean modest_ui_actions_msg_retrieval_check (ModestMailOperation *mail_op,
470 * modest_ui_actions_disk_operations_error_handler
471 * @mail_op: a #ModestMailOperation
473 * Error handler for retrieval operations like
474 * modest_mail_operation_get_msg or
475 * modest_mail_operation_get_msgs_full
477 void modest_ui_actions_disk_operations_error_handler (ModestMailOperation *mail_op,
480 /* Show the account creation wizard dialog.
481 * returns: TRUE if an account was created. FALSE if the user cancelled.
483 gboolean modest_ui_actions_run_account_setup_wizard (ModestWindow *win);
485 gint modest_ui_actions_msgs_move_to_confirmation (ModestWindow *win,
486 TnyFolder *dest_folder,
491 * modest_ui_actions_on_send_queue_error_happened:
493 * Method for handling errors in send queues
495 void modest_ui_actions_on_send_queue_error_happened (TnySendQueue *self,
502 * modest_ui_actions_on_send_queue_status_changed:
504 * Method for handling changes in the status of the messages in the send queues
506 void modest_ui_actions_on_send_queue_status_changed (ModestTnySendQueue *send_queue,
512 * modest_ui_actions_compose_msg
513 * @win: Modest main window (can be NULL)
514 * @to_str: "To:" header, or NULL
515 * @cc_str: "Cc:" header, or NULL
516 * @bcc_str: "Bcc:" header, or NULL
517 * @subject_str: Subject of the message, or NULL
518 * @body_str: Body of the message (without signature), or NULL
519 * @attachments: attachments List of file URIs to attach
520 * @set_as_modified: wheter or not the message is set initially as modified or not
522 * Opens a new message editor for composing
524 void modest_ui_actions_compose_msg (ModestWindow *win,
527 const gchar *bcc_str,
528 const gchar *subject_str,
529 const gchar *body_str,
531 gboolean set_as_modified);
533 void modest_ui_actions_on_account_connection_error (GtkWindow *parent_window,
534 TnyAccount *account);
536 gchar *modest_ui_actions_get_msg_already_deleted_error_msg (ModestWindow *win);
538 void modest_ui_actions_transfer_messages_helper (GtkWindow *win,
539 TnyFolder *src_folder,
541 TnyFolder *dst_folder);
544 #endif /* __MODEST_UI_ACTIONS_H__ */