/usr/share/gtk-doc/html/caja-python/caja-python-overview.html is in python-caja-common 1.20.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>Overview</title><link rel="stylesheet" type="text/css" href="style.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="caja-python Reference Manual"><link rel="up" href="index.html" title="caja-python Reference Manual"><link rel="prev" href="index.html" title="caja-python Reference Manual"><link rel="next" href="caja-python-overview-example.html" title="A Simple Extension"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Overview</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="caja-python-overview-example.html">Next</a></td></tr></table><hr></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="caja-python-overview"></a>Overview</h1></div></div></div><p>Writing a Caja-Python extension is a fairly straight-forward process.
One simply imports the Caja module from the gobject introspection repository and creates a class which is derived from a gobject.GObject and
one of the Caja module's classes. When an extension derives a class, it becomes a "provider",
telling Caja to ask it for information. There are several types of providers
available for extensions to use: there is MenuProvider, LocationWidgetProvider,
ColumnProvider, PropertyPageProvider, and InfoProvider, all of which will be explained
in more detail below. Your class can be derived from multiple providers.</p><p>Here are the basic steps:</p><p>1. A script is written and installed to the standard caja-python extension install path</p><p>2. Caja is (re)started and loads the caja-python C extension, which in turn loads all python extensions it can find</p><p>3. Any python script in the standard caja-python extension install path that imports the Caja module from the gobject introspection repository and derives
the main class from a Caja module class will be loaded</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">A note about the standard python extensions install path</h3><p>As of caja-python 0.7.0 (and continued in 1.0+), caja-python looks in ~/.local/share/caja-python/extensions
for local extensions and $PREFIX/share/caja-python/extensions for global extensions.</p></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">A note about compatibility issues for caja-python 1.0</h3><p>1. We no longer support the "import caja" command that previous versions used. This is because
caja-python now directly uses Caja's annotations, which must be imported by the "from gi.repository import Caja" command.</p><p>2. The extension class must now derive itself from a gobject.GObject in addition to the standard Caja classes.</p><p>3. For now, some Caja class constructors require passing named arguments instead of a standard argument list. This requirement may go away at some point.</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="caja-python-overview-example.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">caja-python Reference Manual </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> A Simple Extension</td></tr></table></div></body></html>
|