summaryrefslogtreecommitdiff
path: root/tools/plugin_template/pluma-plugin.c
blob: 26422a4e45af9f1104ea164967c48ecf5a446ed9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
/*
 * ##(FILENAME) - ##(DESCRIPTION)
 *
 * Copyright (C) ##(DATE_YEAR) - ##(AUTHOR_FULLNAME)
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <glib/gi18n-lib.h>
#include <pluma/pluma-window.h>
#include <pluma/pluma-window-activatable.h>
#include <pluma/pluma-debug.h>
##ifdef WITH_CONFIGURE_DIALOG
#include <libpeas-gtk/peas-gtk-configurable.h>
##endif

#include "##(PLUGIN_MODULE)-plugin.h"

static void pluma_window_activatable_iface_init (PlumaWindowActivatableInterface *iface);

struct _##(PLUGIN_ID.camel)PluginPrivate
{
	PlumaWindow        *window;

	GtkActionGroup   *action_group;
	guint             ui_id;
};

enum {
	PROP_0,
	PROP_OBJECT
};

G_DEFINE_DYNAMIC_TYPE_EXTENDED (##(PLUGIN_ID.camel)Plugin,
                                ##(PLUGIN_ID.lower)_plugin,
                                PEAS_TYPE_EXTENSION_BASE,
                                0,
                                G_ADD_PRIVATE_DYNAMIC (##(PLUGIN_ID.camel)Plugin)
                                G_IMPLEMENT_INTERFACE_DYNAMIC (PLUMA_TYPE_WINDOW_ACTIVATABLE,
                                                               pluma_window_activatable_iface_init))
##ifdef WITH_MENU
/* UI string. See pluma-ui.xml for reference */
const gchar submenu[] =
"<ui>"
"  <menubar name='MenuBar'>"
"    <!-- Put your menu entries here -->"
"  </menubar>"
"</ui>";

/* UI actions */
static const GtkActionEntry action_entries[] =
	{
		/* Put your actions here */
	};
##endif

static void
##(PLUGIN_ID.lower)_plugin_init (##(PLUGIN_ID.camel)Plugin *plugin)
{

	plugin->priv = ##(PLUGIN_ID.lower)_plugin_get_instance_private (plugin);

	pluma_debug_message (DEBUG_PLUGINS, "##(PLUGIN_ID.camel)Plugin initializing");
}

static void
##(PLUGIN_ID.lower)_plugin_finalize (GObject *object)
{
	pluma_debug_message (DEBUG_PLUGINS, "##(PLUGIN_ID.camel)Plugin finalizing");

	G_OBJECT_CLASS (##(PLUGIN_ID.lower)_plugin_parent_class)->finalize (object);
}

static void
##(PLUGIN_ID.lower)_plugin_dispose (GObject *object)
{
	##(PLUGIN_ID.camel)Plugin *plugin = ##(PLUGIN_ID.upper)_PLUGIN (object);

	pluma_debug_message (DEBUG_PLUGINS, "##(PLUGIN_ID.camel)Plugin disposing");

	if (plugin->priv->window != NULL)
	{
		g_object_unref (plugin->priv->window);
		plugin->priv->window = NULL;
	}

	if (plugin->priv->action_group)
	{
		g_object_unref (plugin->priv->action_group);
		plugin->priv->action_group = NULL;
	}

	G_OBJECT_CLASS (##(PLUGIN_ID.lower)_plugin_parent_class)->dispose (object);
}

static void
update_ui (##(PLUGIN_ID.camel)PluginPrivate *data)
{
##ifdef WITH_MENU
	PlumaWindow *window;
	PlumaView *view;
	GtkAction *action;
##endif

	pluma_debug (DEBUG_PLUGINS);

##ifdef WITH_MENU
	window = PLUMA_WINDOW (data->window);
	view = pluma_window_get_active_view (window);

	pluma_debug_message (DEBUG_PLUGINS, "View: %p", view);

	action = gtk_action_group_get_action (data->action_group,
                                              "##(PLUGIN_ID.camel)PluginActions");
	gtk_action_set_sensitive (action,
                                  (view != NULL) &&
                                  gtk_text_view_get_editable (GTK_TEXT_VIEW (view)));
##endif
}


static void
##(PLUGIN_ID.lower)_plugin_activate (PlumaWindowActivatable *activatable)
{
##ifdef WITH_MENU
	##(PLUGIN_ID.camel)PluginPrivate *data;
	PlumaWindow *window;
	GtkUIManager *manager;
	GError *error = NULL;
##endif

	pluma_debug (DEBUG_PLUGINS);

##ifdef WITH_MENU
	data = ##(PLUGIN_ID.upper)_PLUGIN (activatable)->priv;
	window = PLUMA_WINDOW (data->window);

	manager = pluma_window_get_ui_manager (window);

	data->action_group = gtk_action_group_new ("##(PLUGIN_ID.camel)PluginActions");
	gtk_action_group_set_translation_domain (data->action_group,
                                                 GETTEXT_PACKAGE);
	gtk_action_group_add_actions (data->action_group,
                                      action_entries,
                                      G_N_ELEMENTS (action_entries),
                                      window);

	gtk_ui_manager_insert_action_group (manager, data->action_group, -1);

	data->ui_id = gtk_ui_manager_add_ui_from_string (manager,
                                                         submenu,
                                                         -1,
                                                         &error);
	if (data->ui_id == 0)
	{
		g_warning ("%s", error->message);
		return;
	}
	update_ui (data);
##endif
}

static void
##(PLUGIN_ID.lower)_plugin_deactivate (PlumaWindowActivatable *activatable)
{
##ifdef WITH_MENU
	##(PLUGIN_ID.camel)PluginPrivate *data;
	PlumaWindow *window;
	GtkUIManager *manager;
##endif

	pluma_debug (DEBUG_PLUGINS);

##ifdef WITH_MENU
	data = ##(PLUGIN_ID.upper)_PLUGIN (activatable)->priv;
	window = PLUMA_WINDOW (data->window);

	manager = pluma_window_get_ui_manager (window);

	gtk_ui_manager_remove_ui (manager, data->ui_id);
	gtk_ui_manager_remove_action_group (manager, data->action_group);
##endif
}

static void
##(PLUGIN_ID.lower)_plugin_update_state (PlumaWindowActivatable *activatable)
{
	pluma_debug (DEBUG_PLUGINS);

	update_ui (##(PLUGIN_ID.upper)_PLUGIN (activatable)->priv);
}

##ifdef WITH_CONFIGURE_DIALOG
static GtkWidget *
##(PLUGIN_ID.lower)_plugin_create_configure_widget (PeasGtkConfigurable *configurable)
{
	pluma_debug (DEBUG_PLUGINS);
}
##endif

static void
##(PLUGIN_ID.lower)_plugin_set_property (GObject      *object,
                                         guint         prop_id,
                                         const GValue *value,
                                         GParamSpec   *pspec)
{
	##(PLUGIN_ID.camel)Plugin *plugin = ##(PLUGIN_ID.upper)_PLUGIN (object);

	switch (prop_id)
	{
		case PROP_OBJECT:
			plugin->priv->window = PLUMA_WINDOW (g_value_dup_object (value));
			break;

		default:
			G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
			break;
	}
}

static void
##(PLUGIN_ID.lower)_plugin_get_property (GObject    *object,
                                         guint       prop_id,
                                         GValue     *value,
                                         GParamSpec *pspec)
{
	##(PLUGIN_ID.camel)Plugin *plugin = ##(PLUGIN_ID.upper)_PLUGIN (object);

	switch (prop_id)
	{
		case PROP_OBJECT:
			g_value_set_object (value, plugin->priv->window);
			break;

		default:
			G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
			break;
	}
}

static void
##(PLUGIN_ID.lower)_plugin_class_init (##(PLUGIN_ID.camel)PluginClass *klass)
{
	GObjectClass *object_class = G_OBJECT_CLASS (klass);

	object_class->finalize = ##(PLUGIN_ID.lower)_plugin_finalize;
	object_class->dispose = ##(PLUGIN_ID.lower)_plugin_dispose;
	object_class->set_property = ##(PLUGIN_ID.lower)_plugin_set_property;
	object_class->get_property = ##(PLUGIN_ID.lower)_plugin_get_property;

	g_object_class_override_property (object_class, PROP_OBJECT, "object");
}

static void
##(PLUGIN_ID.lower)_plugin_class_finalize (##(PLUGIN_ID.camel)PluginClass *klass)
{
	/* dummy function - used by G_DEFINE_DYNAMIC_TYPE_EXTENDED */
}

static void
pluma_window_activatable_iface_init (PlumaWindowActivatableInterface *iface)
{
	iface->activate = ##(PLUGIN_ID.lower)_plugin_activate;
	iface->deactivate = ##(PLUGIN_ID.lower)_plugin_deactivate;
	iface->update_state = ##(PLUGIN_ID.lower)_plugin_update_state;
}

##ifdef WITH_CONFIGURE_DIALOG
static void
peas_gtk_configurable_iface_init (PeasGtkConfigurableInterface *iface)
{
	iface->create_configure_widget = ##(PLUGIN_ID.lower)_plugin_create_configure_widget;
}
##endif

G_MODULE_EXPORT void
peas_register_types (PeasObjectModule *module)
{
	##(PLUGIN_ID.lower)_plugin_register_type (G_TYPE_MODULE (module));

	peas_object_module_register_extension_type (module,
                                                    PLUMA_TYPE_WINDOW_ACTIVATABLE,
                                                    TYPE_##(PLUGIN_ID.upper)_PLUGIN);

##ifdef WITH_CONFIGURE_DIALOG
	peas_object_module_register_extension_type (module,
                                                    PEAS_GTK_TYPE_CONFIGURABLE,
                                                    TYPE_##(PLUGIN_ID.upper)_PLUGIN);
##endif
}