Revision 3243 PLUGIN.txt

View differences:

PLUGIN.txt
187 187
selected_text: string if a string is selected on the text view
188 188
msginfo: the MsgInfo message object displayed in the text view
189 189
-------------------------------------------------------------------------
190
gboolean (* compose_send)       (GObject        *obj,
191
                                 gpointer        compose,
192
                                 gint            compose_mode,
193
                                 gint            send_mode,
194
                                 const gchar    *msg_file,
195
                                 GSList         *to_list);
190 196

  
197
Emitted on a composed message is being sent.
198
If FALSE is returned, the message is sent normally.
199
If TRUE is returned, sending is cancelled.
200

  
201
compose: the Compose object
202
compose_mode: ComposeMode enum
203
send_mode: 0: send immediately 1: queue and send later
204
msg_file: path to the created message file
205
to_list: list of recipients
206
-------------------------------------------------------------------------
207
void (* messageview_show)       (GObject        *obj,
208
                                 gpointer        msgview,
209
                                 MsgInfo        *msginfo,
210
                                 gboolean        all_headers);
211

  
212
Emitted on displaying a message.
213

  
214
msgview: the MessageView object
215
msginfo: the MsgInfo message object displayed
216
all_headers: TRUE if all headers are displayed. FALSE if not.
217
-------------------------------------------------------------------------
218
void (* inc_mail_start)         (GObject        *obj,
219
                                 PrefsAccount   *account);
220

  
221
Emitted on the start of receiving.
222

  
223
account: receive target account (PrefsAccount)
224
-------------------------------------------------------------------------
225
void (* inc_mail_finished)      (GObject        *obj,
226
                                 gint            new_messages);
227

  
228
Emitted on the end of receiving.
229

  
230
new_messages: number of received messages
231
-------------------------------------------------------------------------
232
void (* prefs_common_open)      (GObject        *obj,
233
                                 GtkWidget      *window);
234

  
235
Emitted on opening common preferences dialog.
236

  
237
window: dialog window (GtkWindow)
238
-------------------------------------------------------------------------
239
void (* prefs_account_open)     (GObject        *obj,
240
                                 PrefsAccount   *account,
241
                                 GtkWidget      *window);
242

  
243
Emitted on opening account preferences dialog.
244

  
245
window: dialog window (GtkWindow)
246
-------------------------------------------------------------------------
247
void (* prefs_filter_open)      (GObject        *obj,
248
                                 GtkWidget      *window);
249

  
250
Emitted on opening filter rule preferences dialog.
251

  
252
window: dialog window (GtkWindow)
253
-------------------------------------------------------------------------
254
void (* prefs_filter_edit_open) (GObject        *obj,
255
                                 FilterRule     *rule,
256
                                 const gchar    *header,
257
                                 const gchar    *key,
258
                                 GtkWidget      *window);
259

  
260
Emitted on opening filter rule edit dialog.
261

  
262
window: dialog window (GtkWindow)
263
-------------------------------------------------------------------------
264
void (* prefs_template_open)    (GObject        *obj,
265
                                 GtkWidget      *window);
266

  
267
Emitted on opening template dialog.
268

  
269
window: dialog window (GtkWindow)
270
-------------------------------------------------------------------------
271
void (* plugin_manager_open)    (GObject        *obj,
272
                                 GtkWidget      *window);
273

  
274
Emitted on opening plug-in manager dialog.
275

  
276
window: dialog window (GtkWindow)
277
-------------------------------------------------------------------------
278

  
191 279
* libsylph-0
192 280

  
193 281
The following signals can be used by passing GObject obtained by

Also available in: Unified diff