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_add_to_contacts (GtkAction *action, ModestWindow *win);
62 void modest_ui_actions_on_add_to_contacts (GtkAction *action, ModestWindow *win);
64 void modest_ui_actions_on_select_contacts (GtkAction *action, ModestMsgEditWindow *win);
66 void modest_ui_actions_on_open_addressbook (GtkAction *action, ModestWindow *win);
68 void modest_ui_actions_on_check_names (GtkAction *action, ModestMsgEditWindow *win);
70 void modest_ui_actions_on_new_msg (GtkAction *action, ModestWindow *win);
72 void modest_ui_actions_on_new_msg_or_folder (GtkAction *action, ModestWindow *win);
74 void modest_ui_actions_on_open (GtkAction *action, ModestWindow *win);
76 void modest_ui_actions_on_reply (GtkAction *action, ModestWindow *win);
78 void modest_ui_actions_on_forward (GtkAction *action, ModestWindow *win);
80 void modest_ui_actions_on_sort (GtkAction *action, ModestWindow *window);
82 void modest_ui_actions_on_reply_all (GtkAction *action, ModestWindow *win);
84 void modest_ui_actions_on_next (GtkAction *action, ModestWindow *main_window);
86 void modest_ui_actions_on_prev (GtkAction *action, ModestWindow *main_window);
88 void modest_ui_actions_on_details (GtkAction *action, ModestWindow *win);
90 void modest_ui_actions_on_move_to (GtkAction *action, ModestWindow *win);
92 void modest_ui_actions_on_settings (GtkAction *action, ModestWindow *win);
95 * modest_ui_actions_on_help:
96 * @action: a #GtkAction
97 * @win: a #ModestWindow
99 * Shows the help dialog
101 void modest_ui_actions_on_help (GtkAction *action, GtkWindow *win);
105 * modest_ui_actions_on_csm_elp:
106 * @action: a #GtkAction
107 * @win: a #ModestWindow
109 * Shows the help dialog for folder view CSM. It shows the help ID
110 * which refers to the currently selected folder if any
112 void modest_ui_actions_on_csm_help (GtkAction *action, GtkWindow *win);
115 * modest_ui_actions_toggle_folders_view:
116 * @action: the #GtkAction
117 * @main_window: the #ModestMainWindow
119 * this action switches between split view (with a folders pane at the
120 * left) and simple view without the left pane with the folders and
121 * accounts. Maybe it's only useful for Maemo code, but as it uses
122 * generic code could be used also by the GNOME UI
124 void modest_ui_actions_toggle_folders_view (GtkAction *action,
125 ModestMainWindow *main_window);
128 * modest_ui_actions_toggle_folders_view:
129 * @action: the #GtkAction
130 * @main_window: the #ModestMainWindow
132 * this action shows or hides the column titles of the header list
133 * view. It also enables the two lines rendering for the treeview rows
135 void modest_ui_actions_toggle_header_list_view (GtkAction *action,
136 ModestMainWindow *main_window);
139 void modest_ui_actions_on_header_selected (ModestHeaderView *folder_view,
141 ModestMainWindow *main_window);
142 void modest_ui_actions_on_header_activated (ModestHeaderView *folder_view,
145 ModestWindow *main_window);
147 void modest_ui_actions_on_folder_selection_changed (ModestFolderView *folder_view,
148 TnyFolderStore *folder_store,
150 ModestMainWindow *main_window);
152 void modest_ui_actions_on_item_not_found (ModestHeaderView *header_view,
154 ModestWindow *window);
156 void modest_ui_actions_on_msg_link_hover (ModestMsgView *msgview, const gchar* link,
159 void modest_ui_actions_on_msg_link_clicked (ModestMsgView *msgview, const gchar* link,
162 void modest_ui_actions_on_msg_link_contextual (ModestMsgView *msgview, const gchar* link,
165 void modest_ui_actions_on_msg_attachment_clicked (ModestMsgView *msgview, TnyMimePart *mime_part,
168 void modest_ui_actions_on_msg_recpt_activated (ModestMsgView *msgview, const gchar *address,
171 gboolean modest_ui_actions_on_send (GtkWidget *widget,
172 ModestMsgEditWindow *edit_window);
173 gboolean modest_ui_actions_on_save_to_drafts (GtkWidget *widget,
174 ModestMsgEditWindow *edit_window);
177 void modest_ui_actions_on_toggle_bold (GtkToggleAction *action,
178 ModestMsgEditWindow *window);
180 void modest_ui_actions_on_toggle_italics (GtkToggleAction *action,
181 ModestMsgEditWindow *window);
183 void modest_ui_actions_on_toggle_bullets (GtkToggleAction *action,
184 ModestMsgEditWindow *window);
186 void modest_ui_actions_on_change_justify (GtkRadioAction *action,
187 GtkRadioAction *selected,
188 ModestMsgEditWindow *window);
190 void modest_ui_actions_on_select_editor_color (GtkAction *action,
191 ModestMsgEditWindow *window);
193 void modest_ui_actions_on_select_editor_background_color (GtkAction *action,
194 ModestMsgEditWindow *window);
196 void modest_ui_actions_on_insert_image (GtkAction *action,
197 ModestMsgEditWindow *window);
199 void modest_ui_actions_on_attach_file (GtkAction *action,
200 ModestMsgEditWindow *window);
202 void modest_ui_actions_on_remove_attachments (GtkAction *action,
203 ModestMsgEditWindow *window);
204 void modest_ui_actions_on_mark_as_read (GtkAction *action,
205 ModestWindow *window);
207 void modest_ui_actions_on_mark_as_unread (GtkAction *action,
208 ModestWindow *window);
210 void modest_ui_actions_cancel_send (GtkAction *action, ModestWindow *win);
213 * modest_ui_actions_do_send_receive_all:
214 * @win: the window that will be used as source of the refresh mail operation
215 * @force_connection: whether or not the code should try to force a new connection if we're offline
216 * @poke_status: wheter ot not we want to poke the status of all mail folders
217 * @interactive: is coming from an interactive send receive.
219 * Refreshes all the accounts
221 void modest_ui_actions_do_send_receive_all (ModestWindow *win,
222 gboolean force_connection,
223 gboolean poke_status,
224 gboolean interactive);
227 * modest_ui_actions_do_send_receive:
228 * @account_name: the name of the Modest account or NULL
229 * @force_connection: whether or not the code should try to force a new connection if we're offline
230 * @poke_status: wheter ot not we want to poke the status of all mail folders
231 * @interactive: is coming from an interactive send receive
232 * @win: the window that will be used as source of the refresh mail operation
234 * Refreshes the Modest account whose name is passed as argument. If
235 * NULL is passed as #account_name then this function refreses the
236 * active account, if no active account is defined then it picks the
239 void modest_ui_actions_do_send_receive (const gchar *account_name,
240 gboolean force_connection,
241 gboolean poke_status,
242 gboolean interactive,
246 * modest_ui_actions_on_send_receive:
247 * @action: a #GtkAction
248 * @win: the Window that contains the action
250 * Handles the activation of the send receive action, for example
251 * clicks on Send&Receive button in the main toolbar
253 void modest_ui_actions_on_send_receive (GtkAction *action,
256 void modest_ui_actions_on_new_folder (GtkAction *action,
257 ModestMainWindow *main_window);
259 void modest_ui_actions_on_rename_folder (GtkAction *action,
260 ModestMainWindow *main_window);
262 void modest_ui_actions_on_delete_folder (GtkAction *action,
263 ModestMainWindow *main_window);
265 void modest_ui_actions_on_move_folder_to_trash_folder (GtkAction *action,
266 ModestMainWindow *main_window);
268 void modest_ui_actions_on_password_requested (TnyAccountStore *account_store,
269 const gchar* server_account_name,
270 gchar **username, gchar **password, gboolean *cancel,
271 gboolean *remember, ModestMainWindow *main_window);
273 void modest_ui_actions_on_undo (GtkAction *action,
274 ModestWindow *window);
276 void modest_ui_actions_on_redo (GtkAction *action,
277 ModestWindow *window);
279 void modest_ui_actions_on_cut (GtkAction *action,
280 ModestWindow *window);
282 void modest_ui_actions_on_copy (GtkAction *action,
283 ModestWindow *window);
285 void modest_ui_actions_on_zoom_plus (GtkAction *action,
286 ModestWindow *window);
288 void modest_ui_actions_on_zoom_minus (GtkAction *action,
289 ModestWindow *window);
291 void modest_ui_actions_on_toggle_fullscreen (GtkToggleAction *toggle,
292 ModestWindow *window);
294 void modest_ui_actions_on_change_fullscreen (GtkAction *action,
295 ModestWindow *window);
297 void modest_ui_actions_on_paste (GtkAction *action,
298 ModestWindow *window);
300 void modest_ui_actions_on_select_all (GtkAction *action,
301 ModestWindow *window);
303 void modest_ui_actions_on_toggle_show_cc (GtkToggleAction *toggle,
304 ModestMsgEditWindow *window);
306 void modest_ui_actions_on_toggle_show_bcc (GtkToggleAction *toggle,
307 ModestMsgEditWindow *window);
309 void modest_ui_actions_on_change_zoom (GtkRadioAction *action,
310 GtkRadioAction *selected,
311 ModestWindow *window);
313 void modest_ui_actions_msg_edit_on_change_priority (GtkRadioAction *action,
314 GtkRadioAction *selected,
315 ModestWindow *window);
317 void modest_ui_actions_msg_edit_on_change_file_format (GtkRadioAction *action,
318 GtkRadioAction *selected,
319 ModestWindow *window);
321 void modest_ui_actions_msg_edit_on_select_font (GtkAction *action,
322 ModestMsgEditWindow *window);
325 * modest_ui_actions_on_toggle_toolbar:
329 * Hides/Shows the toolbars of the #ModestWindow instances
331 void modest_ui_actions_on_toggle_toolbar (GtkToggleAction *toggle,
332 ModestWindow *window);
335 * modest_ui_actions_on_folder_display_name_changed:
336 * @folder_view: a #ModestFolderView
337 * @display_name: the new window title
338 * @window: a #GtkWindow
340 * Sets the title of the window to the value specified by
341 * display_name. This function is used typically as a callback to the
342 * "folder-display-name-changed" signal from the #ModestFolderView
344 void modest_ui_actions_on_folder_display_name_changed (ModestFolderView *folder_view,
345 const gchar *display_name,
348 void modest_ui_actions_view_attachment (GtkAction *action,
349 ModestWindow *window);
351 void modest_ui_actions_save_attachments (GtkAction *action,
352 ModestWindow *window);
354 void modest_ui_actions_remove_attachments (GtkAction *action,
355 ModestWindow *window);
358 * modest_ui_actions_on_retrieve_msg_contents:
359 * @action: the #GtkAction
360 * @window: the #ModestWindow that issues the action
362 * Retrieve the contents of the selected messages in the header view
364 void modest_ui_actions_on_retrieve_msg_contents (GtkAction *action,
365 ModestWindow *window);
368 modest_ui_actions_on_email_menu_activated (GtkAction *action,
369 ModestWindow *window);
372 modest_ui_actions_on_edit_menu_activated (GtkAction *action,
373 ModestWindow *window);
376 modest_ui_actions_on_format_menu_activated (GtkAction *action,
377 ModestWindow *window);
380 modest_ui_actions_on_view_menu_activated (GtkAction *action,
381 ModestWindow *window);
384 modest_ui_actions_on_tools_menu_activated (GtkAction *action,
385 ModestWindow *window);
388 modest_ui_actions_on_attachment_menu_activated (GtkAction *action,
389 ModestWindow *window);
392 modest_ui_actions_on_toolbar_csm_menu_activated (GtkAction *action,
393 ModestWindow *window);
396 modest_ui_actions_on_folder_view_csm_menu_activated (GtkAction *action,
397 ModestWindow *window);
400 modest_ui_actions_on_header_view_csm_menu_activated (GtkAction *action,
401 ModestWindow *window);
404 modest_ui_actions_check_toolbar_dimming_rules (ModestWindow *window);
407 modest_ui_actions_check_menu_dimming_rules (ModestWindow *window);
409 /* Dimming rules groups */
410 #define MODEST_DIMMING_RULES_TOOLBAR "ModestToolbarDimmingRules"
411 #define MODEST_DIMMING_RULES_MENU "ModestMenuDimmingRules"
412 #define MODEST_DIMMING_RULES_CLIPBOARD "ModestClipboardDimmingRules"
415 * modest_ui_actions_move_folder_error_handler:
416 * @mail_op: a #ModestMailOperation
417 * @user_data: user data
419 * manages an error in a mail operation that tries to move a folder
421 void modest_ui_actions_move_folder_error_handler (ModestMailOperation *mail_op,
424 * modest_ui_actions_send-receive_error_handler:
425 * @mail_op: a #ModestMailOperation
426 * @user_data: user data
428 * manages an error in a mail operation that tries to execute
429 * a send&receive operation.
431 void modest_ui_actions_send_receive_error_handler (ModestMailOperation *mail_op,
435 * modest_ui_actions_on_search_messages:
436 * @action: a #GtkAction
437 * @window: a #ModestWindow
439 * Shows the search messages dialog
441 void modest_ui_actions_on_search_messages (GtkAction *action,
442 ModestWindow *window);
445 * modest_ui_actions_on_find_in_page:
446 * @action: a #GtkToggleAction
447 * @window: a #ModestWindow
449 * Toggles the visibility of the find in page toolbar
451 void modest_ui_actions_on_toggle_find_in_page (GtkToggleAction *action,
452 ModestWindow *window);
455 * modest_ui_actions_msg_retrieval_check
456 * @mail_op: a #ModestMailOperation
457 * @header: a #TnyHeader
460 * This function checks that the message has been retrieved
461 * successfully. It it was not the case it unregisters the header from
462 * the window manager because it won't do it automatically unless the
465 * Returns: TRUE if the operation was OK, otherwise FALSE
467 gboolean modest_ui_actions_msg_retrieval_check (ModestMailOperation *mail_op,
473 * modest_ui_actions_disk_operations_error_handler
474 * @mail_op: a #ModestMailOperation
476 * Error handler for retrieval operations like
477 * modest_mail_operation_get_msg or
478 * modest_mail_operation_get_msgs_full
480 void modest_ui_actions_disk_operations_error_handler (ModestMailOperation *mail_op,
483 /* Show the account creation wizard dialog.
484 * returns: TRUE if an account was created. FALSE if the user cancelled.
486 gboolean modest_ui_actions_run_account_setup_wizard (ModestWindow *win);
488 gint modest_ui_actions_msgs_move_to_confirmation (ModestWindow *win,
489 TnyFolder *dest_folder,
494 * modest_ui_actions_on_send_queue_error_happened:
496 * Method for handling errors in send queues
498 void modest_ui_actions_on_send_queue_error_happened (TnySendQueue *self,
505 * modest_ui_actions_on_send_queue_status_changed:
507 * Method for handling changes in the status of the messages in the send queues
509 void modest_ui_actions_on_send_queue_status_changed (ModestTnySendQueue *send_queue,
515 * modest_ui_actions_compose_msg
516 * @win: Modest main window (can be NULL)
517 * @to_str: "To:" header, or NULL
518 * @cc_str: "Cc:" header, or NULL
519 * @bcc_str: "Bcc:" header, or NULL
520 * @subject_str: Subject of the message, or NULL
521 * @body_str: Body of the message (without signature), or NULL
522 * @attachments: attachments List of file URIs to attach
523 * @set_as_modified: wheter or not the message is set initially as modified or not
525 * Opens a new message editor for composing
527 void modest_ui_actions_compose_msg (ModestWindow *win,
530 const gchar *bcc_str,
531 const gchar *subject_str,
532 const gchar *body_str,
534 gboolean set_as_modified);
536 void modest_ui_actions_on_account_connection_error (GtkWindow *parent_window,
537 TnyAccount *account);
539 gchar *modest_ui_actions_get_msg_already_deleted_error_msg (ModestWindow *win);
541 void modest_ui_actions_transfer_messages_helper (GtkWindow *win,
542 TnyFolder *src_folder,
544 TnyFolder *dst_folder);
548 #endif /* __MODEST_UI_ACTIONS_H__ */