5261a1ec2dbfe0dbf5820b5710ce5e96ca3e8ba3
[modest] / src / modest-ui-actions.h
1 /* Copyright (c) 2006, Nokia Corporation
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
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.
16  *
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.
28  */
29
30 #ifndef __MODEST_UI_ACTIONS_H__
31 #define __MODEST_UI_ACTIONS_H__
32
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
38 G_BEGIN_DECLS
39
40 /* Menu & toolbar actions */
41 void     modest_ui_actions_on_about         (GtkAction *action, ModestWindow *win);
42
43 void     modest_ui_actions_on_delete        (GtkAction *action, ModestWindow *win);
44
45 void     modest_ui_actions_on_quit          (GtkAction *action, ModestWindow *win);
46
47 void     modest_ui_actions_on_close_window  (GtkAction *action, ModestWindow *win);
48
49 void     modest_ui_actions_on_new_account      (GtkAction *action, ModestWindow *win);
50
51 void     modest_ui_actions_on_accounts      (GtkAction *action, ModestWindow *win);
52
53 void     modest_ui_actions_on_smtp_servers  (GtkAction *action, ModestWindow *win);
54
55 void     modest_ui_actions_on_add_to_contacts   (GtkAction *action, ModestWindow *win);
56
57 void     modest_ui_actions_on_select_contacts (GtkAction *action, ModestMsgEditWindow *win);
58
59 void     modest_ui_actions_on_check_names (GtkAction *action, ModestMsgEditWindow *win);
60
61 void     modest_ui_actions_on_new_msg       (GtkAction *action, ModestWindow *win);
62
63 void     modest_ui_actions_on_open           (GtkAction *action, ModestWindow *win);
64
65 void     modest_ui_actions_on_reply         (GtkAction *action, ModestWindow *win);
66
67 void     modest_ui_actions_on_forward       (GtkAction *action, ModestWindow *win);
68
69 void     modest_ui_actions_on_sort          (GtkAction *action, ModestWindow *window);
70
71 void     modest_ui_actions_on_reply_all     (GtkAction *action, ModestWindow *win);
72
73 void     modest_ui_actions_on_next          (GtkAction *action, ModestWindow *main_window);
74
75 void     modest_ui_actions_on_prev          (GtkAction *action, ModestWindow *main_window);
76
77 void     modest_ui_actions_on_details       (GtkAction *action, ModestWindow *win);
78
79 void     modest_ui_actions_on_move_to       (GtkAction *action, ModestWindow *win);
80
81 void     modest_ui_actions_on_settings      (GtkAction *action, ModestWindow *win);
82
83 /**
84  * modest_ui_actions_on_help:
85  * @action: a #GtkAction
86  * @win: a #ModestWindow
87  * 
88  * Shows the help dialog
89  **/
90 void     modest_ui_actions_on_help          (GtkAction *action, ModestWindow *win);
91
92 /**
93  * modest_ui_actions_toggle_folders_view:
94  * @action: the #GtkAction
95  * @main_window: the #ModestMainWindow
96  * 
97  * this action switches between split view (with a folders pane at the
98  * left) and simple view without the left pane with the folders and
99  * accounts. Maybe it's only useful for Maemo code, but as it uses
100  * generic code could be used also by the GNOME UI
101  **/
102 void     modest_ui_actions_toggle_folders_view       (GtkAction *action, 
103                                                       ModestMainWindow *main_window);
104
105 /**
106  * modest_ui_actions_toggle_folders_view:
107  * @action: the #GtkAction
108  * @main_window: the #ModestMainWindow
109  * 
110  * this action shows or hides the column titles of the header list
111  * view. It also enables the two lines rendering for the treeview rows
112  **/
113 void     modest_ui_actions_toggle_header_list_view    (GtkAction *action, 
114                                                        ModestMainWindow *main_window);
115
116 /* Widget actions */
117 void     modest_ui_actions_on_header_selected          (ModestHeaderView *folder_view, 
118                                                         TnyHeader *header,
119                                                         ModestMainWindow *main_window);
120 void     modest_ui_actions_on_header_activated         (ModestHeaderView *folder_view, 
121                                                          TnyHeader *header,
122                                                          ModestMainWindow *main_window);
123
124 void     modest_ui_actions_on_folder_selection_changed (ModestFolderView *folder_view,
125                                                          TnyFolderStore *folder_store, 
126                                                          gboolean selected,
127                                                          ModestMainWindow *main_window);
128
129 void     modest_ui_actions_on_online_toggle_toggled    (GtkToggleButton *toggle,
130                                                          ModestMainWindow *main_window);
131
132 void     modest_ui_actions_on_item_not_found           (ModestHeaderView *header_view,
133                                                          ModestItemType type,
134                                                          ModestWindow *window);
135
136 void     modest_ui_actions_on_msg_link_hover           (ModestMsgView *msgview, const gchar* link,
137                                                         ModestWindow *win);
138
139 void     modest_ui_actions_on_msg_link_clicked         (ModestMsgView *msgview, const gchar* link,
140                                                         ModestWindow *win);
141
142 void     modest_ui_actions_on_msg_link_contextual      (ModestMsgView *msgview, const gchar* link,
143                                                         ModestWindow *win);
144
145 void     modest_ui_actions_on_msg_attachment_clicked   (ModestMsgView *msgview, TnyMimePart *mime_part,
146                                                         ModestWindow *win);
147
148 void     modest_ui_actions_on_msg_recpt_activated   (ModestMsgView *msgview, const gchar *address,
149                                                      ModestWindow *win);
150
151 void     modest_ui_actions_on_send                     (GtkWidget *widget,
152                                                         ModestMsgEditWindow *edit_window);
153 void     modest_ui_actions_on_save_to_drafts           (GtkWidget *widget, 
154                                                         ModestMsgEditWindow *edit_window);
155
156
157 void     modest_ui_actions_on_toggle_bold              (GtkToggleAction *action,
158                                                         ModestMsgEditWindow *window);
159
160 void     modest_ui_actions_on_toggle_italics           (GtkToggleAction *action,
161                                                         ModestMsgEditWindow *window);
162
163 void     modest_ui_actions_on_toggle_bullets           (GtkToggleAction *action,
164                                                         ModestMsgEditWindow *window);
165
166 void     modest_ui_actions_on_change_justify      (GtkRadioAction *action,
167                                                    GtkRadioAction *selected,
168                                                    ModestMsgEditWindow *window);
169
170 void     modest_ui_actions_on_select_editor_color      (GtkAction *action,
171                                                         ModestMsgEditWindow *window);
172
173 void     modest_ui_actions_on_select_editor_background_color      (GtkAction *action,
174                                                                    ModestMsgEditWindow *window);
175
176 void     modest_ui_actions_on_insert_image             (GtkAction *action,
177                                                         ModestMsgEditWindow *window);
178
179 void     modest_ui_actions_on_attach_file             (GtkAction *action,
180                                                        ModestMsgEditWindow *window);
181
182 void     modest_ui_actions_on_remove_attachments      (GtkAction *action,
183                                                        ModestMsgEditWindow *window);
184 void     modest_ui_actions_on_mark_as_read            (GtkAction *action,
185                                                        ModestWindow *window);
186
187 void     modest_ui_actions_on_mark_as_unread            (GtkAction *action,
188                                                          ModestWindow *window);
189
190 /**
191  * modest_ui_actions_do_send_receive_all:
192  * @win: the window that will be used as source of the refresh mail operation
193  * 
194  * Refreshes all the accounts
195  **/
196 void    modest_ui_actions_do_send_receive_all          (ModestWindow *win);
197
198 /**
199  * modest_ui_actions_do_send_receive:
200  * @account_name: the name of the Modest account or NULL
201  * @win: the window that will be used as source of the refresh mail operation
202  * 
203  * Refreshes the Modest account whose name is passed as argument. If
204  * NULL is passed as #account_name then this function refreses the
205  * active account, if no active account is defined then it picks the
206  * default account
207  **/
208 void    modest_ui_actions_do_send_receive              (const gchar *account_name,
209                                                         ModestWindow *win);
210
211 /**
212  * modest_ui_actions_on_send_receive:
213  * @action: a #GtkAction
214  * @win: the Window that contains the action
215  * 
216  * Handles the activation of the send receive action, for example
217  * clicks on Send&Receive button in the main toolbar
218  **/
219 void    modest_ui_actions_on_send_receive              (GtkAction *action, 
220                                                         ModestWindow *win);
221
222 void     modest_ui_actions_on_new_folder               (GtkAction *action,
223                                                         ModestMainWindow *main_window);
224
225 void     modest_ui_actions_on_rename_folder            (GtkAction *action,
226                                                         ModestMainWindow *main_window);
227
228 void     modest_ui_actions_on_delete_folder            (GtkAction *action,
229                                                          ModestMainWindow *main_window);
230
231 void     modest_ui_actions_on_move_folder_to_trash_folder     (GtkAction *action,
232                                                                ModestMainWindow *main_window);
233
234 /*
235 void     modest_ui_actions_on_connection_changed    (TnyDevice *device, gboolean online,
236                                                      ModestMainWindow *main_window);
237 */
238
239 void     modest_ui_actions_on_password_requested (TnyAccountStore *account_store,
240                                                   const gchar* server_account_name,
241                                                   gchar **username, gchar **password, gboolean *cancel, 
242                                                   gboolean *remember, ModestMainWindow *main_window);
243
244 void     modest_ui_actions_on_undo                     (GtkAction *action,
245                                                         ModestWindow *window);
246
247 void     modest_ui_actions_on_cut                      (GtkAction *action,
248                                                         ModestWindow *window);
249
250 void     modest_ui_actions_on_copy                     (GtkAction *action,
251                                                         ModestWindow *window);
252
253 void     modest_ui_actions_on_zoom_plus (GtkAction *action,
254                                          ModestWindow *window);
255
256 void     modest_ui_actions_on_zoom_minus (GtkAction *action,
257                                           ModestWindow *window);
258
259 void     modest_ui_actions_on_toggle_fullscreen    (GtkToggleAction *toggle,
260                                                     ModestWindow *window);
261
262 void     modest_ui_actions_on_change_fullscreen    (GtkAction *action,
263                                                     ModestWindow *window);
264
265 void     modest_ui_actions_on_paste                    (GtkAction *action,
266                                                         ModestWindow *window);
267
268 void     modest_ui_actions_on_select_all               (GtkAction *action,
269                                                         ModestWindow *window);
270
271 void     modest_ui_actions_on_toggle_show_cc (GtkToggleAction *toggle,
272                                               ModestMsgEditWindow *window);
273
274 void     modest_ui_actions_on_toggle_show_bcc (GtkToggleAction *toggle,
275                                               ModestMsgEditWindow *window);
276
277 void     modest_ui_actions_on_change_zoom              (GtkRadioAction *action,
278                                                         GtkRadioAction *selected,
279                                                         ModestWindow *window);
280
281 void     modest_ui_actions_msg_edit_on_change_priority (GtkRadioAction *action,
282                                                         GtkRadioAction *selected,
283                                                         ModestWindow *window);
284
285 void     modest_ui_actions_msg_edit_on_change_file_format (GtkRadioAction *action,
286                                                            GtkRadioAction *selected,
287                                                            ModestWindow *window);
288
289 void     modest_ui_actions_msg_edit_on_select_font (GtkAction *action,
290                                                     ModestMsgEditWindow *window);
291
292 /**
293  * modest_ui_actions_on_toggle_toolbar:
294  * @toggle: 
295  * @window: 
296  * 
297  * Hides/Shows the toolbars of the #ModestWindow instances
298  **/
299 void     modest_ui_actions_on_toggle_toolbar           (GtkToggleAction *toggle, 
300                                                         ModestWindow *window);
301
302 /**
303  * modest_ui_actions_on_folder_display_name_changed:
304  * @folder_view: a #ModestFolderView
305  * @display_name: the new window title
306  * @window: a #GtkWindow
307  * 
308  * Sets the title of the window to the value specified by
309  * display_name. This function is used typically as a callback to the
310  * "folder-display-name-changed" signal from the #ModestFolderView
311  **/
312 void     modest_ui_actions_on_folder_display_name_changed (ModestFolderView *folder_view,
313                                                            const gchar *display_name,
314                                                            GtkWindow *window);
315
316 void     modest_ui_actions_view_attachment                (GtkAction *action,
317                                                            ModestWindow *window);
318
319 void     modest_ui_actions_save_attachments               (GtkAction *action,
320                                                            ModestWindow *window);
321
322 void     modest_ui_actions_remove_attachments             (GtkAction *action,
323                                                            ModestWindow *window);
324
325 /**
326  * modest_ui_actions_on_retrieve_msg_contents:
327  * @action: the #GtkAction
328  * @window: the #ModestWindow that issues the action
329  * 
330  * Retrieve the contents of the selected messages in the header view
331  **/
332 void     modest_ui_actions_on_retrieve_msg_contents       (GtkAction *action,
333                                                            ModestWindow *window);
334
335 void
336 modest_ui_actions_on_email_menu_activated (GtkAction *action,
337                                           ModestWindow *window);
338
339 void
340 modest_ui_actions_on_edit_menu_activated (GtkAction *action,
341                                           ModestWindow *window);
342
343 void
344 modest_ui_actions_on_toolbar_csm_menu_activated (GtkAction *action,
345                                                  ModestWindow *window);
346
347 void
348 modest_ui_actions_on_folder_view_csm_menu_activated (GtkAction *action,
349                                                      ModestWindow *window);
350
351 void
352 modest_ui_actions_on_header_view_csm_menu_activated (GtkAction *action,
353                                                      ModestWindow *window);
354
355 void
356 modest_ui_actions_check_toolbar_dimming_rules (ModestWindow *window);
357
358 /**
359  * modest_ui_actions_move_folder_error_handler:
360  * @mail_op: a #ModestMailOperation
361  * @user_data: user data
362  * 
363  * manages an error in a mail operation that tries to move a folder
364  **/
365 void     modest_ui_actions_move_folder_error_handler      (ModestMailOperation *mail_op, 
366                                                            gpointer user_data);
367
368 /**
369  * modest_ui_actions_on_search_messages:
370  * @action: a #GtkAction
371  * @window: a #ModestWindow
372  *
373  * Shows the search messages dialog
374  **/
375 void     modest_ui_actions_on_search_messages             (GtkAction *action,
376                                                            ModestWindow *window);
377
378 /**
379  * modest_ui_actions_on_find_in_page:
380  * @action: a #GtkToggleAction
381  * @window: a #ModestWindow
382  *
383  * Toggles the visibility of the find in page toolbar
384  **/
385 void     modest_ui_actions_on_toggle_find_in_page             (GtkToggleAction *action,
386                                                                ModestWindow *window);
387
388 G_END_DECLS
389 #endif /* __MODEST_UI_ACTIONS_H__ */