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, GtkWindow *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_ui_actions_on_send_receive:
219 * @action: a #GtkAction
220 * @win: the Window that contains the action
222 * Handles the activation of the send receive action, for example
223 * clicks on Send&Receive button in the main toolbar
225 void modest_ui_actions_on_send_receive (GtkAction *action,
228 void modest_ui_actions_on_new_folder (GtkAction *action,
229 ModestMainWindow *main_window);
231 void modest_ui_actions_on_rename_folder (GtkAction *action,
232 ModestMainWindow *main_window);
234 void modest_ui_actions_on_delete_folder (GtkAction *action,
235 ModestMainWindow *main_window);
237 void modest_ui_actions_on_move_folder_to_trash_folder (GtkAction *action,
238 ModestMainWindow *main_window);
240 void modest_ui_actions_on_password_requested (TnyAccountStore *account_store,
241 const gchar* server_account_name,
242 gchar **username, gchar **password, gboolean *cancel,
243 gboolean *remember, ModestMainWindow *main_window);
245 void modest_ui_actions_on_undo (GtkAction *action,
246 ModestWindow *window);
248 void modest_ui_actions_on_redo (GtkAction *action,
249 ModestWindow *window);
251 void modest_ui_actions_on_cut (GtkAction *action,
252 ModestWindow *window);
254 void modest_ui_actions_on_copy (GtkAction *action,
255 ModestWindow *window);
257 void modest_ui_actions_on_zoom_plus (GtkAction *action,
258 ModestWindow *window);
260 void modest_ui_actions_on_zoom_minus (GtkAction *action,
261 ModestWindow *window);
263 void modest_ui_actions_on_toggle_fullscreen (GtkToggleAction *toggle,
264 ModestWindow *window);
266 void modest_ui_actions_on_change_fullscreen (GtkAction *action,
267 ModestWindow *window);
269 void modest_ui_actions_on_paste (GtkAction *action,
270 ModestWindow *window);
272 void modest_ui_actions_on_select_all (GtkAction *action,
273 ModestWindow *window);
275 void modest_ui_actions_on_toggle_show_cc (GtkToggleAction *toggle,
276 ModestMsgEditWindow *window);
278 void modest_ui_actions_on_toggle_show_bcc (GtkToggleAction *toggle,
279 ModestMsgEditWindow *window);
281 void modest_ui_actions_on_change_zoom (GtkRadioAction *action,
282 GtkRadioAction *selected,
283 ModestWindow *window);
285 void modest_ui_actions_msg_edit_on_change_priority (GtkRadioAction *action,
286 GtkRadioAction *selected,
287 ModestWindow *window);
289 void modest_ui_actions_msg_edit_on_change_file_format (GtkRadioAction *action,
290 GtkRadioAction *selected,
291 ModestWindow *window);
293 void modest_ui_actions_msg_edit_on_select_font (GtkAction *action,
294 ModestMsgEditWindow *window);
297 * modest_ui_actions_on_toggle_toolbar:
301 * Hides/Shows the toolbars of the #ModestWindow instances
303 void modest_ui_actions_on_toggle_toolbar (GtkToggleAction *toggle,
304 ModestWindow *window);
307 * modest_ui_actions_on_folder_display_name_changed:
308 * @folder_view: a #ModestFolderView
309 * @display_name: the new window title
310 * @window: a #GtkWindow
312 * Sets the title of the window to the value specified by
313 * display_name. This function is used typically as a callback to the
314 * "folder-display-name-changed" signal from the #ModestFolderView
316 void modest_ui_actions_on_folder_display_name_changed (ModestFolderView *folder_view,
317 const gchar *display_name,
320 void modest_ui_actions_view_attachment (GtkAction *action,
321 ModestWindow *window);
323 void modest_ui_actions_save_attachments (GtkAction *action,
324 ModestWindow *window);
326 void modest_ui_actions_remove_attachments (GtkAction *action,
327 ModestWindow *window);
330 * modest_ui_actions_on_retrieve_msg_contents:
331 * @action: the #GtkAction
332 * @window: the #ModestWindow that issues the action
334 * Retrieve the contents of the selected messages in the header view
336 void modest_ui_actions_on_retrieve_msg_contents (GtkAction *action,
337 ModestWindow *window);
340 modest_ui_actions_on_email_menu_activated (GtkAction *action,
341 ModestWindow *window);
344 modest_ui_actions_on_edit_menu_activated (GtkAction *action,
345 ModestWindow *window);
348 modest_ui_actions_on_format_menu_activated (GtkAction *action,
349 ModestWindow *window);
352 modest_ui_actions_on_view_menu_activated (GtkAction *action,
353 ModestWindow *window);
356 modest_ui_actions_on_tools_menu_activated (GtkAction *action,
357 ModestWindow *window);
360 modest_ui_actions_on_attachment_menu_activated (GtkAction *action,
361 ModestWindow *window);
364 modest_ui_actions_on_toolbar_csm_menu_activated (GtkAction *action,
365 ModestWindow *window);
368 modest_ui_actions_on_folder_view_csm_menu_activated (GtkAction *action,
369 ModestWindow *window);
372 modest_ui_actions_on_header_view_csm_menu_activated (GtkAction *action,
373 ModestWindow *window);
376 modest_ui_actions_check_toolbar_dimming_rules (ModestWindow *window);
379 * modest_ui_actions_move_folder_error_handler:
380 * @mail_op: a #ModestMailOperation
381 * @user_data: user data
383 * manages an error in a mail operation that tries to move a folder
385 void modest_ui_actions_move_folder_error_handler (ModestMailOperation *mail_op,
388 * modest_ui_actions_send-receive_error_handler:
389 * @mail_op: a #ModestMailOperation
390 * @user_data: user data
392 * manages an error in a mail operation that tries to execute
393 * a send&receive operation.
395 void modest_ui_actions_send_receive_error_handler (ModestMailOperation *mail_op,
399 * modest_ui_actions_on_search_messages:
400 * @action: a #GtkAction
401 * @window: a #ModestWindow
403 * Shows the search messages dialog
405 void modest_ui_actions_on_search_messages (GtkAction *action,
406 ModestWindow *window);
409 * modest_ui_actions_on_find_in_page:
410 * @action: a #GtkToggleAction
411 * @window: a #ModestWindow
413 * Toggles the visibility of the find in page toolbar
415 void modest_ui_actions_on_toggle_find_in_page (GtkToggleAction *action,
416 ModestWindow *window);
419 * modest_ui_actions_msg_retrieval_check
420 * @mail_op: a #ModestMailOperation
421 * @header: a #TnyHeader
424 * This function checks that the message has been retrieved
425 * successfully. It it was not the case it unregisters the header from
426 * the window manager because it won't do it automatically unless the
429 * Returns: TRUE if the operation was OK, otherwise FALSE
431 gboolean modest_ui_actions_msg_retrieval_check (ModestMailOperation *mail_op,
437 * modest_ui_actions_get_msgs_full_error_handler
438 * @mail_op: a #ModestMailOperation
440 * Error handler for message retrieval operations like
441 * modest_mail_operation_get_msg or
442 * modest_mail_operation_get_msgs_full
444 void modest_ui_actions_get_msgs_full_error_handler (ModestMailOperation *mail_op,
447 /* Show the account creation wizard dialog.
448 * returns: TRUE if an account was created. FALSE if the user cancelled.
450 gboolean modest_ui_actions_run_account_setup_wizard (ModestWindow *win);
452 gint modest_ui_actions_msgs_move_to_confirmation (ModestWindow *win,
453 TnyFolder *dest_folder,
458 * modest_ui_actions_on_send_queue_error_happened:
460 * Method for handling errors in send queues
462 void modest_ui_actions_on_send_queue_error_happened (TnySendQueue *self,
469 * modest_ui_actions_on_send_queue_status_changed:
471 * Method for handling changes in the status of the messages in the send queues
473 void modest_ui_actions_on_send_queue_status_changed (ModestTnySendQueue *send_queue,
479 * Opens a new message editor for composing
480 * @param win Modest main window (can be NULL)
481 * @param to_str "To:" header, or NULL
482 * @param cc_str "Cc:" header, or NULL
483 * @param bcc_str "Bcc:" header, or NULL
484 * @param subject_str Subject of the message, or NULL
485 * @param body_str Body of the message (without signature), or NULL
486 * @param attachments List of file URIs to attach
488 void modest_ui_actions_compose_msg (ModestWindow *win,
491 const gchar *bcc_str,
492 const gchar *subject_str,
493 const gchar *body_str,
494 GSList *attachments);
496 void modest_ui_actions_on_account_connection_error (GtkWindow *parent_window,
497 TnyAccount *account);
500 #endif /* __MODEST_UI_ACTIONS_H__ */