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);
244 void modest_ui_actions_on_connection_changed (TnyDevice *device, gboolean online,
245 ModestMainWindow *main_window);
248 void modest_ui_actions_on_password_requested (TnyAccountStore *account_store,
249 const gchar* server_account_name,
250 gchar **username, gchar **password, gboolean *cancel,
251 gboolean *remember, ModestMainWindow *main_window);
253 void modest_ui_actions_on_undo (GtkAction *action,
254 ModestWindow *window);
256 void modest_ui_actions_on_redo (GtkAction *action,
257 ModestWindow *window);
259 void modest_ui_actions_on_cut (GtkAction *action,
260 ModestWindow *window);
262 void modest_ui_actions_on_copy (GtkAction *action,
263 ModestWindow *window);
265 void modest_ui_actions_on_zoom_plus (GtkAction *action,
266 ModestWindow *window);
268 void modest_ui_actions_on_zoom_minus (GtkAction *action,
269 ModestWindow *window);
271 void modest_ui_actions_on_toggle_fullscreen (GtkToggleAction *toggle,
272 ModestWindow *window);
274 void modest_ui_actions_on_change_fullscreen (GtkAction *action,
275 ModestWindow *window);
277 void modest_ui_actions_on_paste (GtkAction *action,
278 ModestWindow *window);
280 void modest_ui_actions_on_select_all (GtkAction *action,
281 ModestWindow *window);
283 void modest_ui_actions_on_toggle_show_cc (GtkToggleAction *toggle,
284 ModestMsgEditWindow *window);
286 void modest_ui_actions_on_toggle_show_bcc (GtkToggleAction *toggle,
287 ModestMsgEditWindow *window);
289 void modest_ui_actions_on_change_zoom (GtkRadioAction *action,
290 GtkRadioAction *selected,
291 ModestWindow *window);
293 void modest_ui_actions_msg_edit_on_change_priority (GtkRadioAction *action,
294 GtkRadioAction *selected,
295 ModestWindow *window);
297 void modest_ui_actions_msg_edit_on_change_file_format (GtkRadioAction *action,
298 GtkRadioAction *selected,
299 ModestWindow *window);
301 void modest_ui_actions_msg_edit_on_select_font (GtkAction *action,
302 ModestMsgEditWindow *window);
305 * modest_ui_actions_on_toggle_toolbar:
309 * Hides/Shows the toolbars of the #ModestWindow instances
311 void modest_ui_actions_on_toggle_toolbar (GtkToggleAction *toggle,
312 ModestWindow *window);
315 * modest_ui_actions_on_folder_display_name_changed:
316 * @folder_view: a #ModestFolderView
317 * @display_name: the new window title
318 * @window: a #GtkWindow
320 * Sets the title of the window to the value specified by
321 * display_name. This function is used typically as a callback to the
322 * "folder-display-name-changed" signal from the #ModestFolderView
324 void modest_ui_actions_on_folder_display_name_changed (ModestFolderView *folder_view,
325 const gchar *display_name,
328 void modest_ui_actions_view_attachment (GtkAction *action,
329 ModestWindow *window);
331 void modest_ui_actions_save_attachments (GtkAction *action,
332 ModestWindow *window);
334 void modest_ui_actions_remove_attachments (GtkAction *action,
335 ModestWindow *window);
338 * modest_ui_actions_on_retrieve_msg_contents:
339 * @action: the #GtkAction
340 * @window: the #ModestWindow that issues the action
342 * Retrieve the contents of the selected messages in the header view
344 void modest_ui_actions_on_retrieve_msg_contents (GtkAction *action,
345 ModestWindow *window);
348 modest_ui_actions_on_email_menu_activated (GtkAction *action,
349 ModestWindow *window);
352 modest_ui_actions_on_edit_menu_activated (GtkAction *action,
353 ModestWindow *window);
356 modest_ui_actions_on_format_menu_activated (GtkAction *action,
357 ModestWindow *window);
360 modest_ui_actions_on_view_menu_activated (GtkAction *action,
361 ModestWindow *window);
364 modest_ui_actions_on_tools_menu_activated (GtkAction *action,
365 ModestWindow *window);
368 modest_ui_actions_on_attachment_menu_activated (GtkAction *action,
369 ModestWindow *window);
372 modest_ui_actions_on_toolbar_csm_menu_activated (GtkAction *action,
373 ModestWindow *window);
376 modest_ui_actions_on_folder_view_csm_menu_activated (GtkAction *action,
377 ModestWindow *window);
380 modest_ui_actions_on_header_view_csm_menu_activated (GtkAction *action,
381 ModestWindow *window);
384 modest_ui_actions_check_toolbar_dimming_rules (ModestWindow *window);
387 * modest_ui_actions_move_folder_error_handler:
388 * @mail_op: a #ModestMailOperation
389 * @user_data: user data
391 * manages an error in a mail operation that tries to move a folder
393 void modest_ui_actions_move_folder_error_handler (ModestMailOperation *mail_op,
396 * modest_ui_actions_send-receive_error_handler:
397 * @mail_op: a #ModestMailOperation
398 * @user_data: user data
400 * manages an error in a mail operation that tries to execute
401 * a send&receive operation.
403 void modest_ui_actions_send_receive_error_handler (ModestMailOperation *mail_op,
407 * modest_ui_actions_on_search_messages:
408 * @action: a #GtkAction
409 * @window: a #ModestWindow
411 * Shows the search messages dialog
413 void modest_ui_actions_on_search_messages (GtkAction *action,
414 ModestWindow *window);
417 * modest_ui_actions_on_find_in_page:
418 * @action: a #GtkToggleAction
419 * @window: a #ModestWindow
421 * Toggles the visibility of the find in page toolbar
423 void modest_ui_actions_on_toggle_find_in_page (GtkToggleAction *action,
424 ModestWindow *window);
427 * modest_ui_actions_msg_retrieval_check
428 * @mail_op: a #ModestMailOperation
429 * @header: a #TnyHeader
432 * This function checks that the message has been retrieved
433 * successfully. It it was not the case it unregisters the header from
434 * the window manager because it won't do it automatically unless the
437 * Returns: TRUE if the operation was OK, otherwise FALSE
439 gboolean modest_ui_actions_msg_retrieval_check (ModestMailOperation *mail_op,
445 * modest_ui_actions_get_msgs_full_error_handler
446 * @mail_op: a #ModestMailOperation
448 * Error handler for message retrieval operations like
449 * modest_mail_operation_get_msg or
450 * modest_mail_operation_get_msgs_full
452 void modest_ui_actions_get_msgs_full_error_handler (ModestMailOperation *mail_op,
455 /** A convenience method, because deleting a message is
456 * otherwise complicated, and it's best to change it in one place
459 void modest_do_message_delete (TnyHeader *header, ModestWindow *win);
461 /** A convenience method, because deleting a message is
462 * otherwise complicated, and it's best to change it in one place
465 void modest_do_messages_delete (TnyList *headers, ModestWindow *win);
467 /* Show the account creation wizard dialog.
468 * returns: TRUE if an account was created. FALSE if the user cancelled.
470 gboolean modest_run_account_setup_wizard (ModestWindow *win);
472 gint modest_ui_actions_msgs_move_to_confirmation (GtkWindow *win,
473 TnyFolder *dest_folder,
478 * modest_ui_actions_on_send_queue_error_happened:
480 * Method for handling errors in send queues
482 void modest_ui_actions_on_send_queue_error_happened (TnySendQueue *self,
489 * modest_ui_actions_on_send_queue_status_changed:
491 * Method for handling changes in the status of the messages in the send queues
493 void modest_ui_actions_on_send_queue_status_changed (ModestTnySendQueue *send_queue,
499 #endif /* __MODEST_UI_ACTIONS_H__ */