← Back to branch summary

~ubuntu-branches/ubuntu/utopic/geany/utopic

« back to all changes in this revision

Viewing changes to doc/pluginsignals.c

  • Committer: Package Import Robot
  • Author(s): Chow Loong Jin
  • Date: 2011-12-10 07:43:26 UTC
  • mfrom: (3.3.7 sid)
  • Revision ID: package-import@ubuntu.com-20111210074326-s8yqbew5i20h33tf
Tags: 0.21-1ubuntu1
* Merge from Debian Unstable, remaining changes:
  - debian/patches/20_use_evince_viewer.patch:
     + use evince as viewer for pdf and dvi files
  - debian/patches/20_use_x_terminal_emulator.patch:
     + use x-terminal-emulator as terminal
  - debian/control
     + Add breaks on geany-plugins-common << 0.20
* Also fixes bugs:
  - Filter for MATLAB/Octave files filters everythign (LP: 885505)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/pluginsignals.c
1
1
/*
2
2
 *      pluginsignals.c - this file is part of Geany, a fast and lightweight IDE
3
3
 *
4
 
 *      Copyright 2008-2010 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
5
 
 *      Copyright 2008-2010 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
 
4
 *      Copyright 2008-2011 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
 
5
 *      Copyright 2008-2011 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
6
6
 *
7
7
 *      This program is free software; you can redistribute it and/or modify
8
8
 *      it under the terms of the GNU General Public License as published by
19
19
 *      Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
20
20
 *      MA 02110-1301, USA.
21
21
 *
22
 
 * $Id: pluginsignals.c 5235 2010-09-16 15:14:09Z ntrel $
 
22
 * $Id: pluginsignals.c 5710 2011-04-11 14:40:27Z ntrel $
23
23
 */
24
24
 
25
25
/* Note: this file is for Doxygen only. */
64
64
 
65
65
/** Sent when a new document is created.
66
66
 *
67
 
 *  You need to include "document.h" for the declaration of GeanyDocument.
68
 
 *
69
67
 *  @param obj a GeanyObject instance, should be ignored.
70
68
 *  @param doc the new document.
71
69
 *  @param user_data user data.
74
72
 
75
73
/** Sent when a new document is opened.
76
74
 *
77
 
 *  You need to include "document.h" for the declaration of GeanyDocument.
78
 
 *
79
75
 *  @param obj a GeanyObject instance, should be ignored.
80
76
 *  @param doc the opened document.
81
77
 *  @param user_data user data.
82
78
 */
83
79
signal void (*document_open)(GObject *obj, GeanyDocument *doc, gpointer user_data);
84
80
 
 
81
/** Sent when an existing document is reloaded.
 
82
 *
 
83
 *  @param obj a GeanyObject instance, should be ignored.
 
84
 *  @param doc the re-opened document.
 
85
 *  @param user_data user data.
 
86
 *
 
87
 *  @since 0.21
 
88
 */
 
89
signal void (*document_reload)(GObject *obj, GeanyDocument *doc, gpointer user_data);
 
90
 
85
91
/** Sent before a document is saved.
86
92
 *
87
 
 *  You need to include "document.h" for the declaration of GeanyDocument.
88
 
 *
89
93
 *  @param obj a GeanyObject instance, should be ignored.
90
94
 *  @param doc the document to be saved.
91
95
 *  @param user_data user data.
94
98
 
95
99
/** Sent when a new document is saved.
96
100
 *
97
 
 *  You need to include "document.h" for the declaration of GeanyDocument.
98
 
 *
99
101
 *  @param obj a GeanyObject instance, should be ignored.
100
102
 *  @param doc the saved document.
101
103
 *  @param user_data user data.
118
120
 
119
121
/** Sent when switching notebook pages.
120
122
 *
121
 
 *  You need to include "document.h" for the declaration of GeanyDocument.
122
 
 *
123
123
 *  @param obj a GeanyObject instance, should be ignored.
124
124
 *  @param doc the current document.
125
125
 *  @param user_data user data.
128
128
 
129
129
/** Sent before closing a document.
130
130
 *
131
 
 *  You need to include "document.h" for the declaration of GeanyDocument.
132
 
 *
133
131
 *  @param obj a GeanyObject instance, should be ignored.
134
132
 *  @param doc the document about to be closed.
135
133
 *  @param user_data user data.
203
201
 *  @note You can add menu items from @c plugin_init() using @c geany->main_widgets->editor_menu,
204
202
 *  remembering to destroy them in @c plugin_cleanup().
205
203
 *
206
 
 *  You need to include "document.h" for the declaration of GeanyDocument.
207
 
 *
208
204
 *  @param obj a GeanyObject instance, should be ignored.
209
205
 *  @param word the current word (in UTF-8 encoding) below the cursor position
210
206
                   where the popup menu will be opened.
238
234
 *           care about the return value; make sure to return TRUE only if it is necessary
239
235
 *           and in the correct situations.
240
236
 *
241
 
 *  You need to include "editor.h" for the declaration of GeanyEditor and "Scintilla.h" for
242
 
 *  SCNotification.
243
 
 *
244
237
 *  @param obj a GeanyObject instance, should be ignored.
245
238
 *  @param editor The current GeanyEditor.
246
239
 *  @param nt A pointer to the SCNotification struct which holds additional information for