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 void modest_ui_actions_on_delete_message_or_folder (GtkAction *action, ModestWindow *win);
53 void modest_ui_actions_on_quit (GtkAction *action, ModestWindow *win);
55 void modest_ui_actions_on_close_window (GtkAction *action, ModestWindow *win);
57 void modest_ui_actions_on_new_account (GtkAction *action, ModestWindow *win);
59 void modest_ui_actions_on_accounts (GtkAction *action, ModestWindow *win);
61 void modest_ui_actions_on_smtp_servers (GtkAction *action, ModestWindow *win);
63 void modest_ui_actions_add_to_contacts (GtkAction *action, ModestWindow *win);
64 void modest_ui_actions_on_add_to_contacts (GtkAction *action, ModestWindow *win);
66 void modest_ui_actions_on_select_contacts (GtkAction *action, ModestMsgEditWindow *win);
68 void modest_ui_actions_on_open_addressbook (GtkAction *action, ModestWindow *win);
70 void modest_ui_actions_on_check_names (GtkAction *action, ModestMsgEditWindow *win);
72 void modest_ui_actions_on_new_msg (GtkAction *action, ModestWindow *win);
74 void modest_ui_actions_on_new_msg_or_folder (GtkAction *action, ModestWindow *win);
76 void modest_ui_actions_on_open (GtkAction *action, ModestWindow *win);
78 void modest_ui_actions_on_reply (GtkAction *action, ModestWindow *win);
80 void modest_ui_actions_on_forward (GtkAction *action, ModestWindow *win);
82 void modest_ui_actions_on_sort (GtkAction *action, ModestWindow *window);
84 void modest_ui_actions_on_reply_all (GtkAction *action, ModestWindow *win);
86 void modest_ui_actions_on_next (GtkAction *action, ModestWindow *main_window);
88 void modest_ui_actions_on_prev (GtkAction *action, ModestWindow *main_window);
90 void modest_ui_actions_on_details (GtkAction *action, ModestWindow *win);
92 void modest_ui_actions_on_move_to (GtkAction *action, ModestWindow *win);
94 void modest_ui_actions_on_settings (GtkAction *action, ModestWindow *win);
97 * modest_ui_actions_on_help:
98 * @action: a #GtkAction
99 * @win: a #ModestWindow
101 * Shows the help dialog
103 void modest_ui_actions_on_help (GtkAction *action, GtkWindow *win);
107 * modest_ui_actions_on_csm_elp:
108 * @action: a #GtkAction
109 * @win: a #ModestWindow
111 * Shows the help dialog for folder view CSM. It shows the help ID
112 * which refers to the currently selected folder if any
114 void modest_ui_actions_on_csm_help (GtkAction *action, GtkWindow *win);
117 * modest_ui_actions_toggle_folders_view:
118 * @action: the #GtkAction
119 * @main_window: the #ModestMainWindow
121 * this action switches between split view (with a folders pane at the
122 * left) and simple view without the left pane with the folders and
123 * accounts. Maybe it's only useful for Maemo code, but as it uses
124 * generic code could be used also by the GNOME UI
126 void modest_ui_actions_toggle_folders_view (GtkAction *action,
127 ModestMainWindow *main_window);
130 * modest_ui_actions_toggle_folders_view:
131 * @action: the #GtkAction
132 * @main_window: the #ModestMainWindow
134 * this action shows or hides the column titles of the header list
135 * view. It also enables the two lines rendering for the treeview rows
137 void modest_ui_actions_toggle_header_list_view (GtkAction *action,
138 ModestMainWindow *main_window);
141 void modest_ui_actions_on_header_selected (ModestHeaderView *folder_view,
143 ModestMainWindow *main_window);
144 void modest_ui_actions_on_header_activated (ModestHeaderView *folder_view,
147 ModestWindow *main_window);
149 void modest_ui_actions_on_folder_selection_changed (ModestFolderView *folder_view,
150 TnyFolderStore *folder_store,
152 ModestMainWindow *main_window);
154 void modest_ui_actions_on_item_not_found (ModestHeaderView *header_view,
156 ModestWindow *window);
158 void modest_ui_actions_on_msg_link_hover (ModestMsgView *msgview, const gchar* link,
161 void modest_ui_actions_on_msg_link_clicked (ModestMsgView *msgview, const gchar* link,
164 void modest_ui_actions_on_msg_link_contextual (ModestMsgView *msgview, const gchar* link,
167 void modest_ui_actions_on_msg_attachment_clicked (ModestMsgView *msgview, TnyMimePart *mime_part,
170 void modest_ui_actions_on_msg_recpt_activated (ModestMsgView *msgview, const gchar *address,
173 gboolean modest_ui_actions_on_send (GtkWidget *widget,
174 ModestMsgEditWindow *edit_window);
175 gboolean modest_ui_actions_on_save_to_drafts (GtkWidget *widget,
176 ModestMsgEditWindow *edit_window);
179 void modest_ui_actions_on_toggle_bold (GtkToggleAction *action,
180 ModestMsgEditWindow *window);
182 void modest_ui_actions_on_toggle_italics (GtkToggleAction *action,
183 ModestMsgEditWindow *window);
185 void modest_ui_actions_on_toggle_bullets (GtkToggleAction *action,
186 ModestMsgEditWindow *window);
188 void modest_ui_actions_on_change_justify (GtkRadioAction *action,
189 GtkRadioAction *selected,
190 ModestMsgEditWindow *window);
192 void modest_ui_actions_on_select_editor_color (GtkAction *action,
193 ModestMsgEditWindow *window);
195 void modest_ui_actions_on_select_editor_background_color (GtkAction *action,
196 ModestMsgEditWindow *window);
198 void modest_ui_actions_on_insert_image (GtkAction *action,
199 ModestMsgEditWindow *window);
201 void modest_ui_actions_on_attach_file (GtkAction *action,
202 ModestMsgEditWindow *window);
204 void modest_ui_actions_on_remove_attachments (GtkAction *action,
205 ModestMsgEditWindow *window);
206 void modest_ui_actions_on_mark_as_read (GtkAction *action,
207 ModestWindow *window);
209 void modest_ui_actions_on_mark_as_unread (GtkAction *action,
210 ModestWindow *window);
212 void modest_ui_actions_cancel_send (GtkAction *action, ModestWindow *win);
215 * modest_ui_actions_do_send_receive_all:
216 * @win: the window that will be used as source of the refresh mail operation
217 * @force_connection: whether or not the code should try to force a new connection if we're offline
218 * @poke_status: wheter ot not we want to poke the status of all mail folders
219 * @interactive: is coming from an interactive send receive.
221 * Refreshes all the accounts
223 void modest_ui_actions_do_send_receive_all (ModestWindow *win,
224 gboolean force_connection,
225 gboolean poke_status,
226 gboolean interactive);
229 * modest_ui_actions_do_send_receive:
230 * @account_name: the name of the Modest account or NULL
231 * @force_connection: whether or not the code should try to force a new connection if we're offline
232 * @poke_status: wheter ot not we want to poke the status of all mail folders
233 * @interactive: is coming from an interactive send receive
234 * @win: the window that will be used as source of the refresh mail operation
236 * Refreshes the Modest account whose name is passed as argument. If
237 * NULL is passed as #account_name then this function refreses the
238 * active account, if no active account is defined then it picks the
241 void modest_ui_actions_do_send_receive (const gchar *account_name,
242 gboolean force_connection,
243 gboolean poke_status,
244 gboolean interactive,
248 * modest_ui_actions_on_send_receive:
249 * @action: a #GtkAction
250 * @win: the Window that contains the action
252 * Handles the activation of the send receive action, for example
253 * clicks on Send&Receive button in the main toolbar
255 void modest_ui_actions_on_send_receive (GtkAction *action,
258 void modest_ui_actions_on_new_folder (GtkAction *action,
259 ModestMainWindow *main_window);
261 void modest_ui_actions_on_rename_folder (GtkAction *action,
262 ModestMainWindow *main_window);
264 void modest_ui_actions_on_delete_folder (GtkAction *action,
265 ModestMainWindow *main_window);
267 void modest_ui_actions_on_move_folder_to_trash_folder (GtkAction *action,
268 ModestMainWindow *main_window);
270 void modest_ui_actions_on_password_requested (TnyAccountStore *account_store,
271 const gchar* server_account_name,
272 gchar **username, gchar **password, gboolean *cancel,
273 gboolean *remember, ModestMainWindow *main_window);
275 void modest_ui_actions_on_undo (GtkAction *action,
276 ModestWindow *window);
278 void modest_ui_actions_on_redo (GtkAction *action,
279 ModestWindow *window);
281 void modest_ui_actions_on_cut (GtkAction *action,
282 ModestWindow *window);
284 void modest_ui_actions_on_copy (GtkAction *action,
285 ModestWindow *window);
287 void modest_ui_actions_on_zoom_plus (GtkAction *action,
288 ModestWindow *window);
290 void modest_ui_actions_on_zoom_minus (GtkAction *action,
291 ModestWindow *window);
293 void modest_ui_actions_on_toggle_fullscreen (GtkToggleAction *toggle,
294 ModestWindow *window);
296 void modest_ui_actions_on_change_fullscreen (GtkAction *action,
297 ModestWindow *window);
299 void modest_ui_actions_on_paste (GtkAction *action,
300 ModestWindow *window);
302 void modest_ui_actions_on_select_all (GtkAction *action,
303 ModestWindow *window);
305 void modest_ui_actions_on_toggle_show_cc (GtkToggleAction *toggle,
306 ModestMsgEditWindow *window);
308 void modest_ui_actions_on_toggle_show_bcc (GtkToggleAction *toggle,
309 ModestMsgEditWindow *window);
311 void modest_ui_actions_on_change_zoom (GtkRadioAction *action,
312 GtkRadioAction *selected,
313 ModestWindow *window);
315 void modest_ui_actions_msg_edit_on_change_priority (GtkRadioAction *action,
316 GtkRadioAction *selected,
317 ModestWindow *window);
319 void modest_ui_actions_msg_edit_on_change_file_format (GtkRadioAction *action,
320 GtkRadioAction *selected,
321 ModestWindow *window);
323 void modest_ui_actions_msg_edit_on_select_font (GtkAction *action,
324 ModestMsgEditWindow *window);
327 * modest_ui_actions_on_toggle_toolbar:
331 * Hides/Shows the toolbars of the #ModestWindow instances
333 void modest_ui_actions_on_toggle_toolbar (GtkToggleAction *toggle,
334 ModestWindow *window);
337 * modest_ui_actions_on_folder_display_name_changed:
338 * @folder_view: a #ModestFolderView
339 * @display_name: the new window title
340 * @window: a #GtkWindow
342 * Sets the title of the window to the value specified by
343 * display_name. This function is used typically as a callback to the
344 * "folder-display-name-changed" signal from the #ModestFolderView
346 void modest_ui_actions_on_folder_display_name_changed (ModestFolderView *folder_view,
347 const gchar *display_name,
350 void modest_ui_actions_view_attachment (GtkAction *action,
351 ModestWindow *window);
353 void modest_ui_actions_save_attachments (GtkAction *action,
354 ModestWindow *window);
356 void modest_ui_actions_remove_attachments (GtkAction *action,
357 ModestWindow *window);
360 * modest_ui_actions_on_retrieve_msg_contents:
361 * @action: the #GtkAction
362 * @window: the #ModestWindow that issues the action
364 * Retrieve the contents of the selected messages in the header view
366 void modest_ui_actions_on_retrieve_msg_contents (GtkAction *action,
367 ModestWindow *window);
370 modest_ui_actions_on_email_menu_activated (GtkAction *action,
371 ModestWindow *window);
374 modest_ui_actions_on_edit_menu_activated (GtkAction *action,
375 ModestWindow *window);
378 modest_ui_actions_on_format_menu_activated (GtkAction *action,
379 ModestWindow *window);
382 modest_ui_actions_on_view_menu_activated (GtkAction *action,
383 ModestWindow *window);
386 modest_ui_actions_on_tools_menu_activated (GtkAction *action,
387 ModestWindow *window);
390 modest_ui_actions_on_attachment_menu_activated (GtkAction *action,
391 ModestWindow *window);
394 modest_ui_actions_on_toolbar_csm_menu_activated (GtkAction *action,
395 ModestWindow *window);
398 modest_ui_actions_on_folder_view_csm_menu_activated (GtkAction *action,
399 ModestWindow *window);
402 modest_ui_actions_on_header_view_csm_menu_activated (GtkAction *action,
403 ModestWindow *window);
406 modest_ui_actions_check_toolbar_dimming_rules (ModestWindow *window);
409 modest_ui_actions_check_menu_dimming_rules (ModestWindow *window);
411 /* Dimming rules groups */
412 #define MODEST_DIMMING_RULES_TOOLBAR "ModestToolbarDimmingRules"
413 #define MODEST_DIMMING_RULES_MENU "ModestMenuDimmingRules"
414 #define MODEST_DIMMING_RULES_CLIPBOARD "ModestClipboardDimmingRules"
417 * modest_ui_actions_move_folder_error_handler:
418 * @mail_op: a #ModestMailOperation
419 * @user_data: user data
421 * manages an error in a mail operation that tries to move a folder
423 void modest_ui_actions_move_folder_error_handler (ModestMailOperation *mail_op,
426 * modest_ui_actions_send-receive_error_handler:
427 * @mail_op: a #ModestMailOperation
428 * @user_data: user data
430 * manages an error in a mail operation that tries to execute
431 * a send&receive operation.
433 void modest_ui_actions_send_receive_error_handler (ModestMailOperation *mail_op,
437 * modest_ui_actions_on_search_messages:
438 * @action: a #GtkAction
439 * @window: a #ModestWindow
441 * Shows the search messages dialog
443 void modest_ui_actions_on_search_messages (GtkAction *action,
444 ModestWindow *window);
447 * modest_ui_actions_on_find_in_page:
448 * @action: a #GtkToggleAction
449 * @window: a #ModestWindow
451 * Toggles the visibility of the find in page toolbar
453 void modest_ui_actions_on_toggle_find_in_page (GtkToggleAction *action,
454 ModestWindow *window);
457 * modest_ui_actions_msg_retrieval_check
458 * @mail_op: a #ModestMailOperation
459 * @header: a #TnyHeader
462 * This function checks that the message has been retrieved
463 * successfully. It it was not the case it unregisters the header from
464 * the window manager because it won't do it automatically unless the
467 * Returns: TRUE if the operation was OK, otherwise FALSE
469 gboolean modest_ui_actions_msg_retrieval_check (ModestMailOperation *mail_op,
475 * modest_ui_actions_disk_operations_error_handler
476 * @mail_op: a #ModestMailOperation
478 * Error handler for retrieval operations like
479 * modest_mail_operation_get_msg or
480 * modest_mail_operation_get_msgs_full
482 void modest_ui_actions_disk_operations_error_handler (ModestMailOperation *mail_op,
485 /* Show the account creation wizard dialog.
486 * returns: TRUE if an account was created. FALSE if the user cancelled.
488 gboolean modest_ui_actions_run_account_setup_wizard (ModestWindow *win);
490 gint modest_ui_actions_msgs_move_to_confirmation (ModestWindow *win,
491 TnyFolder *dest_folder,
496 * modest_ui_actions_on_send_queue_error_happened:
498 * Method for handling errors in send queues
500 void modest_ui_actions_on_send_queue_error_happened (TnySendQueue *self,
507 * modest_ui_actions_on_send_queue_status_changed:
509 * Method for handling changes in the status of the messages in the send queues
511 void modest_ui_actions_on_send_queue_status_changed (ModestTnySendQueue *send_queue,
517 * modest_ui_actions_compose_msg
518 * @win: Modest main window (can be NULL)
519 * @to_str: "To:" header, or NULL
520 * @cc_str: "Cc:" header, or NULL
521 * @bcc_str: "Bcc:" header, or NULL
522 * @subject_str: Subject of the message, or NULL
523 * @body_str: Body of the message (without signature), or NULL
524 * @attachments: attachments List of file URIs to attach
525 * @set_as_modified: wheter or not the message is set initially as modified or not
527 * Opens a new message editor for composing
529 void modest_ui_actions_compose_msg (ModestWindow *win,
532 const gchar *bcc_str,
533 const gchar *subject_str,
534 const gchar *body_str,
536 gboolean set_as_modified);
538 void modest_ui_actions_on_account_connection_error (GtkWindow *parent_window,
539 TnyAccount *account);
541 gchar *modest_ui_actions_get_msg_already_deleted_error_msg (ModestWindow *win);
543 void modest_ui_actions_transfer_messages_helper (GtkWindow *win,
544 TnyFolder *src_folder,
546 TnyFolder *dst_folder);
550 #endif /* __MODEST_UI_ACTIONS_H__ */