This is going to be a very quick run-through of writing a “gedit” plugin using Python. This method allows you to rapidly produce plugins that require a minimum of code. Depending on what you want to do, only a few lines might be required. Look at a simple plugin such as FocusAutoSave, for an example.
A gedit plugin is comprised of extensions, where each extension represents functionality that you’re adding at the application-level, window-level, or view-level (where “view” often refers to a particular document).
A plugin has access to the full might of PyGTK. Regardless of which type of extension(s) you need to implement, each base class requires that a do_activate() and do_deactivate() method be implemented. It is from these methods that you either a) configure signals to be handled, or b) schedule a timer to invoke a callback.
To make gedit see your plugin, you have to store two files in ~/.local/share/gedit/plugins: abc.py, and abc.plugin . The latter file is an INI-type file that tells gedit about your plugin, and how to import it. Note that the plugins/ directory must have a __init__.py file in it (as all Python package directories must). Though the “Module” value in the plugin-info file must agree with the name of your Python module, the actual class names within it can have arbitrary names (they automatically wire themselves into GTK). To make an installer, just use “invoke“, make, etc..
[Plugin] Loader=python Module=dustin IAge=3 Name=Dustin's Plugin Description=A Python plugin example Authors=Dustin Oprea Copyright=Copyright © 2013 Dustin Oprea Website=http://www.myplugin.com
The practical purpose of this code is questionable. It’s really just provided as an example of a few different things. Note that the print()’s will be displayed in the console, which means that you should start gedit from the console if you wish to see them.
from gi.repository import GObject, Gedit, Gio SETTINGS_KEY = "org.gnome.gedit.preferences.editor" gedit_settings = Gio.Settings(SETTINGS_KEY) class DustinPluginWindowExtension(GObject.Object, Gedit.WindowActivatable): "Our extension to the window's behavior." __gtype_name__ = "DustinPluginWindowExtension" window = GObject.property(type=Gedit.Window) def __init__(self): GObject.Object.__init__(self) def do_activate(self): "Called when the when is loaded." # To get a list of all unsaved documents: # self.window.get_unsaved_documents() # To list all available config options configured in the "preferences" window: # gedit_settings.keys() # The get_boolean() call seems like it can be used to either get a boolean # value, or determine if a configurable is even present (for backwards- # compatibility). if gedit_settings.get_boolean("auto-save") is True: print(gedit_settings.get_uint("auto-save-interval")) # Schedule a callback to trigger in five seconds. self.timer_id = GObject.timeout_add_seconds(5, self.__window_callback) def __window_callback(self): print("Trigger.") # Return True to automatically schedule again. return True def do_deactivate(self): "We're being unloaded. Clean-up." # Clean-up our timer. GObject.source_remove(self.timer_id) self.timer_id = None class DustinPluginViewExtension(GObject.Object, Gedit.ViewActivatable): "Our extension to the document's behavior." __gtype_name__ = "DustinPluginViewExtension" view = GObject.property(type=Gedit.View) def __init__(self): GObject.Object.__init__(self) def do_activate(self): # Get the document. self.__doc = self.view.get_buffer() # To get the name of the document as shown in the tab: # self.__doc.get_short_name_for_display() # To insert something at the current cursor position. self.__doc.insert_at_cursor("Hello World.\n") # Get the text of the document. This works using start/stop iterators # (pointers to the left and right sides of the content to grab). # text = self.__doc.get_text(self.__doc.get_start_iter(), # self.__doc.get_end_iter(), True) # Wire a handler to the "saved" signal. self.__sig_saved = self.__doc.connect("saved", self.__on_saved) def do_deactivate(self): self.__doc.disconnect(self.__sig_saved) del self.__sig_saved def __on_saved(self, widget, *args, **kwargs): print("Saved.")
To enable debug logging, just set the log-level at the top of your Python module. Logging should be printed out to the console.
When I was first looking at writing a gedit plugin, I had no direction for 1) how to retrieve the text, 2) how to properly schedule timers (which is a general GTK task), and 3) how to get values from gedit’s configuration. Hopefully this helps.
Additional resources that might be of some help:
Writing Plugins for gedit 3 with Python
Python Plugin How To for gedit 3
gedit Reference Manual (great reference for signals)