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_open (GtkAction *action, ModestWindow *win);
72 void modest_ui_actions_on_reply (GtkAction *action, ModestWindow *win);
74 void modest_ui_actions_on_forward (GtkAction *action, ModestWindow *win);
76 void modest_ui_actions_on_sort (GtkAction *action, ModestWindow *window);
78 void modest_ui_actions_on_reply_all (GtkAction *action, ModestWindow *win);
80 void modest_ui_actions_on_next (GtkAction *action, ModestWindow *main_window);
82 void modest_ui_actions_on_prev (GtkAction *action, ModestWindow *main_window);
84 void modest_ui_actions_on_details (GtkAction *action, ModestWindow *win);
86 void modest_ui_actions_on_move_to (GtkAction *action, ModestWindow *win);
88 void modest_ui_actions_on_settings (GtkAction *action, ModestWindow *win);
91 * modest_ui_actions_on_help:
92 * @action: a #GtkAction
93 * @win: a #ModestWindow
95 * Shows the help dialog
97 void modest_ui_actions_on_help (GtkAction *action, ModestWindow *win);
100 * modest_ui_actions_toggle_folders_view:
101 * @action: the #GtkAction
102 * @main_window: the #ModestMainWindow
104 * this action switches between split view (with a folders pane at the
105 * left) and simple view without the left pane with the folders and
106 * accounts. Maybe it's only useful for Maemo code, but as it uses
107 * generic code could be used also by the GNOME UI
109 void modest_ui_actions_toggle_folders_view (GtkAction *action,
110 ModestMainWindow *main_window);
113 * modest_ui_actions_toggle_folders_view:
114 * @action: the #GtkAction
115 * @main_window: the #ModestMainWindow
117 * this action shows or hides the column titles of the header list
118 * view. It also enables the two lines rendering for the treeview rows
120 void modest_ui_actions_toggle_header_list_view (GtkAction *action,
121 ModestMainWindow *main_window);
124 void modest_ui_actions_on_header_selected (ModestHeaderView *folder_view,
126 ModestMainWindow *main_window);
127 void modest_ui_actions_on_header_activated (ModestHeaderView *folder_view,
129 ModestMainWindow *main_window);
131 void modest_ui_actions_on_folder_selection_changed (ModestFolderView *folder_view,
132 TnyFolderStore *folder_store,
134 ModestMainWindow *main_window);
136 void modest_ui_actions_on_item_not_found (ModestHeaderView *header_view,
138 ModestWindow *window);
140 void modest_ui_actions_on_msg_link_hover (ModestMsgView *msgview, const gchar* link,
143 void modest_ui_actions_on_msg_link_clicked (ModestMsgView *msgview, const gchar* link,
146 void modest_ui_actions_on_msg_link_contextual (ModestMsgView *msgview, const gchar* link,
149 void modest_ui_actions_on_msg_attachment_clicked (ModestMsgView *msgview, TnyMimePart *mime_part,
152 void modest_ui_actions_on_msg_recpt_activated (ModestMsgView *msgview, const gchar *address,
155 void modest_ui_actions_on_send (GtkWidget *widget,
156 ModestMsgEditWindow *edit_window);
157 void modest_ui_actions_on_save_to_drafts (GtkWidget *widget,
158 ModestMsgEditWindow *edit_window);
161 void modest_ui_actions_on_toggle_bold (GtkToggleAction *action,
162 ModestMsgEditWindow *window);
164 void modest_ui_actions_on_toggle_italics (GtkToggleAction *action,
165 ModestMsgEditWindow *window);
167 void modest_ui_actions_on_toggle_bullets (GtkToggleAction *action,
168 ModestMsgEditWindow *window);
170 void modest_ui_actions_on_change_justify (GtkRadioAction *action,
171 GtkRadioAction *selected,
172 ModestMsgEditWindow *window);
174 void modest_ui_actions_on_select_editor_color (GtkAction *action,
175 ModestMsgEditWindow *window);
177 void modest_ui_actions_on_select_editor_background_color (GtkAction *action,
178 ModestMsgEditWindow *window);
180 void modest_ui_actions_on_insert_image (GtkAction *action,
181 ModestMsgEditWindow *window);
183 void modest_ui_actions_on_attach_file (GtkAction *action,
184 ModestMsgEditWindow *window);
186 void modest_ui_actions_on_remove_attachments (GtkAction *action,
187 ModestMsgEditWindow *window);
188 void modest_ui_actions_on_mark_as_read (GtkAction *action,
189 ModestWindow *window);
191 void modest_ui_actions_on_mark_as_unread (GtkAction *action,
192 ModestWindow *window);
194 void modest_ui_actions_cancel_send (GtkAction *action, ModestWindow *win);
197 * modest_ui_actions_do_send_receive_all:
198 * @win: the window that will be used as source of the refresh mail operation
200 * Refreshes all the accounts
202 void modest_ui_actions_do_send_receive_all (ModestWindow *win);
205 * modest_ui_actions_do_send_receive:
206 * @account_name: the name of the Modest account or NULL
207 * @win: the window that will be used as source of the refresh mail operation
209 * Refreshes the Modest account whose name is passed as argument. If
210 * NULL is passed as #account_name then this function refreses the
211 * active account, if no active account is defined then it picks the
214 void modest_ui_actions_do_send_receive (const gchar *account_name,
218 modest_do_refresh_current_folder(ModestWindow *win);
221 * modest_ui_actions_on_send_receive:
222 * @action: a #GtkAction
223 * @win: the Window that contains the action
225 * Handles the activation of the send receive action, for example
226 * clicks on Send&Receive button in the main toolbar
228 void modest_ui_actions_on_send_receive (GtkAction *action,
231 void modest_ui_actions_on_new_folder (GtkAction *action,
232 ModestMainWindow *main_window);
234 void modest_ui_actions_on_rename_folder (GtkAction *action,
235 ModestMainWindow *main_window);
237 void modest_ui_actions_on_delete_folder (GtkAction *action,
238 ModestMainWindow *main_window);
240 void modest_ui_actions_on_move_folder_to_trash_folder (GtkAction *action,
241 ModestMainWindow *main_window);
243 void modest_ui_actions_on_password_requested (TnyAccountStore *account_store,
244 const gchar* server_account_name,
245 gchar **username, gchar **password, gboolean *cancel,
246 gboolean *remember, ModestMainWindow *main_window);
248 void modest_ui_actions_on_undo (GtkAction *action,
249 ModestWindow *window);
251 void modest_ui_actions_on_redo (GtkAction *action,
252 ModestWindow *window);
254 void modest_ui_actions_on_cut (GtkAction *action,
255 ModestWindow *window);
257 void modest_ui_actions_on_copy (GtkAction *action,
258 ModestWindow *window);
260 void modest_ui_actions_on_zoom_plus (GtkAction *action,
261 ModestWindow *window);
263 void modest_ui_actions_on_zoom_minus (GtkAction *action,
264 ModestWindow *window);
266 void modest_ui_actions_on_toggle_fullscreen (GtkToggleAction *toggle,
267 ModestWindow *window);
269 void modest_ui_actions_on_change_fullscreen (GtkAction *action,
270 ModestWindow *window);
272 void modest_ui_actions_on_paste (GtkAction *action,
273 ModestWindow *window);
275 void modest_ui_actions_on_select_all (GtkAction *action,
276 ModestWindow *window);
278 void modest_ui_actions_on_toggle_show_cc (GtkToggleAction *toggle,
279 ModestMsgEditWindow *window);
281 void modest_ui_actions_on_toggle_show_bcc (GtkToggleAction *toggle,
282 ModestMsgEditWindow *window);
284 void modest_ui_actions_on_change_zoom (GtkRadioAction *action,
285 GtkRadioAction *selected,
286 ModestWindow *window);
288 void modest_ui_actions_msg_edit_on_change_priority (GtkRadioAction *action,
289 GtkRadioAction *selected,
290 ModestWindow *window);
292 void modest_ui_actions_msg_edit_on_change_file_format (GtkRadioAction *action,
293 GtkRadioAction *selected,
294 ModestWindow *window);
296 void modest_ui_actions_msg_edit_on_select_font (GtkAction *action,
297 ModestMsgEditWindow *window);
300 * modest_ui_actions_on_toggle_toolbar:
304 * Hides/Shows the toolbars of the #ModestWindow instances
306 void modest_ui_actions_on_toggle_toolbar (GtkToggleAction *toggle,
307 ModestWindow *window);
310 * modest_ui_actions_on_folder_display_name_changed:
311 * @folder_view: a #ModestFolderView
312 * @display_name: the new window title
313 * @window: a #GtkWindow
315 * Sets the title of the window to the value specified by
316 * display_name. This function is used typically as a callback to the
317 * "folder-display-name-changed" signal from the #ModestFolderView
319 void modest_ui_actions_on_folder_display_name_changed (ModestFolderView *folder_view,
320 const gchar *display_name,
323 void modest_ui_actions_view_attachment (GtkAction *action,
324 ModestWindow *window);
326 void modest_ui_actions_save_attachments (GtkAction *action,
327 ModestWindow *window);
329 void modest_ui_actions_remove_attachments (GtkAction *action,
330 ModestWindow *window);
333 * modest_ui_actions_on_retrieve_msg_contents:
334 * @action: the #GtkAction
335 * @window: the #ModestWindow that issues the action
337 * Retrieve the contents of the selected messages in the header view
339 void modest_ui_actions_on_retrieve_msg_contents (GtkAction *action,
340 ModestWindow *window);
343 modest_ui_actions_on_email_menu_activated (GtkAction *action,
344 ModestWindow *window);
347 modest_ui_actions_on_edit_menu_activated (GtkAction *action,
348 ModestWindow *window);
351 modest_ui_actions_on_format_menu_activated (GtkAction *action,
352 ModestWindow *window);
355 modest_ui_actions_on_view_menu_activated (GtkAction *action,
356 ModestWindow *window);
359 modest_ui_actions_on_tools_menu_activated (GtkAction *action,
360 ModestWindow *window);
363 modest_ui_actions_on_attachment_menu_activated (GtkAction *action,
364 ModestWindow *window);
367 modest_ui_actions_on_toolbar_csm_menu_activated (GtkAction *action,
368 ModestWindow *window);
371 modest_ui_actions_on_folder_view_csm_menu_activated (GtkAction *action,
372 ModestWindow *window);
375 modest_ui_actions_on_header_view_csm_menu_activated (GtkAction *action,
376 ModestWindow *window);
379 modest_ui_actions_check_toolbar_dimming_rules (ModestWindow *window);
382 * modest_ui_actions_move_folder_error_handler:
383 * @mail_op: a #ModestMailOperation
384 * @user_data: user data
386 * manages an error in a mail operation that tries to move a folder
388 void modest_ui_actions_move_folder_error_handler (ModestMailOperation *mail_op,
391 * modest_ui_actions_send-receive_error_handler:
392 * @mail_op: a #ModestMailOperation
393 * @user_data: user data
395 * manages an error in a mail operation that tries to execute
396 * a send&receive operation.
398 void modest_ui_actions_send_receive_error_handler (ModestMailOperation *mail_op,
402 * modest_ui_actions_on_search_messages:
403 * @action: a #GtkAction
404 * @window: a #ModestWindow
406 * Shows the search messages dialog
408 void modest_ui_actions_on_search_messages (GtkAction *action,
409 ModestWindow *window);
412 * modest_ui_actions_on_find_in_page:
413 * @action: a #GtkToggleAction
414 * @window: a #ModestWindow
416 * Toggles the visibility of the find in page toolbar
418 void modest_ui_actions_on_toggle_find_in_page (GtkToggleAction *action,
419 ModestWindow *window);
422 * modest_ui_actions_msg_retrieval_check
423 * @mail_op: a #ModestMailOperation
424 * @header: a #TnyHeader
427 * This function checks that the message has been retrieved
428 * successfully. It it was not the case it unregisters the header from
429 * the window manager because it won't do it automatically unless the
432 * Returns: TRUE if the operation was OK, otherwise FALSE
434 gboolean modest_ui_actions_msg_retrieval_check (ModestMailOperation *mail_op,
440 * modest_ui_actions_get_msgs_full_error_handler
441 * @mail_op: a #ModestMailOperation
443 * Error handler for message retrieval operations like
444 * modest_mail_operation_get_msg or
445 * modest_mail_operation_get_msgs_full
447 void modest_ui_actions_get_msgs_full_error_handler (ModestMailOperation *mail_op,
450 /** A convenience method, because deleting a message is
451 * otherwise complicated, and it's best to change it in one place
454 void modest_do_message_delete (TnyHeader *header, ModestWindow *win);
456 /** A convenience method, because deleting a message is
457 * otherwise complicated, and it's best to change it in one place
460 void modest_do_messages_delete (TnyList *headers, ModestWindow *win);
462 /* Show the account creation wizard dialog.
463 * returns: TRUE if an account was created. FALSE if the user cancelled.
465 gboolean modest_ui_actions_run_account_setup_wizard (ModestWindow *win);
467 gint modest_ui_actions_msgs_move_to_confirmation (ModestWindow *win,
468 TnyFolder *dest_folder,
473 * modest_ui_actions_on_send_queue_error_happened:
475 * Method for handling errors in send queues
477 void modest_ui_actions_on_send_queue_error_happened (TnySendQueue *self,
484 * modest_ui_actions_on_send_queue_status_changed:
486 * Method for handling changes in the status of the messages in the send queues
488 void modest_ui_actions_on_send_queue_status_changed (ModestTnySendQueue *send_queue,
494 #endif /* __MODEST_UI_ACTIONS_H__ */