Improve API docs for editor_insert_text_block().
[geany-mirror.git] / src / geanyobject.h
blob1bfc70f9c79f228e1c5578bd5c75ca1adc175d32
1 /*
2 * geanyobject.h - this file is part of Geany, a fast and lightweight IDE
4 * Copyright 2007-2010 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
5 * Copyright 2007-2010 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
20 * MA 02110-1301, USA.
22 * $Id$
26 #ifndef __GEANYOBJECT_H__
27 #define __GEANYOBJECT_H__
29 #include <glib-object.h>
31 G_BEGIN_DECLS
33 typedef enum
35 GCB_DOCUMENT_NEW,
36 GCB_DOCUMENT_OPEN,
37 GCB_DOCUMENT_BEFORE_SAVE,
38 GCB_DOCUMENT_SAVE,
39 GCB_DOCUMENT_FILETYPE_SET,
40 GCB_DOCUMENT_ACTIVATE,
41 GCB_DOCUMENT_CLOSE,
42 GCB_PROJECT_OPEN,
43 GCB_PROJECT_SAVE,
44 GCB_PROJECT_CLOSE,
45 GCB_UPDATE_EDITOR_MENU,
46 GCB_EDITOR_NOTIFY,
47 GCB_GEANY_STARTUP_COMPLETE,
48 GCB_SAVE_SETTINGS,
49 GCB_LOAD_SETTINGS,
50 GCB_MAX
52 GeanyCallbackId;
55 #define GEANY_OBJECT_TYPE (geany_object_get_type())
56 #define GEANY_OBJECT(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),\
57 GEANY_OBJECT_TYPE, GeanyObject))
58 #define GEANY_OBJECT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),\
59 GEANY_OBJECT_TYPE, GeanyObjectClass))
60 #define IS_GEANY_OBJECT(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),\
61 GEANY_OBJECT_TYPE))
62 #define IS_GEANY_OBJECT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),\
63 GEANY_OBJECT_TYPE))
65 typedef struct _GeanyObject GeanyObject;
66 typedef struct _GeanyObjectClass GeanyObjectClass;
68 struct _GeanyObject
70 GObject parent;
71 /* add your public declarations here */
74 struct SCNotification;
76 struct _GeanyObjectClass
78 GObjectClass parent_class;
80 void (*document_new)(GeanyDocument *doc);
81 void (*document_open)(GeanyDocument *doc);
82 void (*document_before_save)(GeanyDocument *doc);
83 void (*document_save)(GeanyDocument *doc);
84 void (*document_filetype_set)(GeanyDocument *doc, GeanyFiletype *filetype_old);
85 void (*document_activate)(GeanyDocument *doc);
86 void (*document_close)(GeanyDocument *doc);
87 void (*project_open)(GKeyFile *keyfile);
88 void (*project_save)(GKeyFile *keyfile);
89 void (*project_close)(void);
90 void (*update_editor_menu)(const gchar *word, gint click_pos, GeanyDocument *doc);
91 gboolean (*editor_notify)(GeanyEditor *editor, gpointer scnt);
92 void (*geany_startup_complete)(void);
93 void (*save_settings)(GKeyFile *keyfile);
94 void (*load_settings)(GKeyFile *keyfile);
97 GType geany_object_get_type (void);
98 GObject* geany_object_new (void);
100 G_END_DECLS
102 #endif /* __GEANYOBJECT_H__ */