libanjuta-dev 2:3.22.0-3 / usr / share / gtk-doc / html / libanjuta / writing-plugins.html

This file is indexed.

/usr/share/gtk-doc/html/libanjuta/writing-plugins.html is in libanjuta-dev 2:3.22.0-3.

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
 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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Anjuta Developers Reference Manual: Writing plugins</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Anjuta Developers Reference Manual">
<link rel="up" href="index.html" title="Anjuta Developers Reference Manual">
<link rel="prev" href="anjuta-architecture.html" title="Anjuta Architecture">
<link rel="next" href="writing-plugins-simple.html" title="Hello world plugin">
<meta name="generator" content="GTK-Doc V1.21 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts"></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><img src="up-insensitive.png" width="16" height="16" border="0"></td>
<td><a accesskey="p" href="anjuta-architecture.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="writing-plugins-simple.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="chapter">
<div class="titlepage"><div><div><h1 class="title">
<a name="writing-plugins"></a>Writing plugins</h1></div></div></div>
<div class="toc"><dl class="toc">
<dt><span class="sect1"><a href="writing-plugins.html#writing-plugins-description">Hello world plugin description, icon and UI files</a></span></dt>
<dt><span class="sect1"><a href="writing-plugins-simple.html">Hello world plugin</a></span></dt>
<dt><span class="sect1"><a href="writing-plugins-sources.html">Hello world advanced plugin</a></span></dt>
<dt><span class="sect1"><a href="writing-plugins-build-setup.html">Build setup</a></span></dt>
</dl></div>
<p>
		Before writing any Anjuta plugin, please read
		<a class="xref" href="anjuta-architecture.html" title="Anjuta Architecture"><i>Anjuta Architecture</i></a>
		to get a picture of how plugins interact with Anjuta shell and other
		plugins. Only a general overview is necessary for now. Eventually, as
		we proceed through this article, you can visit respective sections
		to read more.
		This is a tutorial style article and is never meant to be a cover-all
		document. You should read other relevent documents linked at respective
		places throughout this document to know further.
	</p>
<p>
		We are going to write the legacy <span class="emphasis"><em>Hello World</em></span> plugin.
		It really doesn't do anything other than displaying hello world. We
		will then continue with an advanced version of this plugin.
		Unlike the basic Hello world plugin, this advanced version
		will have much more. In addition to having
		a widget where <span class="emphasis"><em>Hello World</em></span> is displayed, it will also
		have a menu enty (UI) to display a dialog, implement a
		<a class="link" href="IAnjutaFile.html" title="IAnjutaFile"><span class="type">IAnjutaFile</span></a> interface
		and access other plugins using their interfaces.
	</p>
<div class="sect1">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="writing-plugins-description"></a>Hello world plugin description, icon and UI files</h2></div></div></div>
<p>
			We first begin by creating three helper files for our plugin. The
			first file is called <a class="xref" href="plugin-description-file.html" title="Plugin description file"><i>Plugin description file</i></a>. This file describes our plugin to Anjuta
			plugin loader. Various plugin meta information are store in this
			file, including its name and description. Before a plugin is loaded
			into memory, Anjuta will examine this file and accordingly decide to
			load it when required.
			</p>
<pre class="programlisting">
[Anjuta Plugin]
_Name=Hellow
_Description=An example hello world plugin.
Location=anjuta-hello-world:HelloWorldPlugin
Icon=anjuta-hello-world-plugin.png
			</pre>
<p>
			The first two fields are name and description field. They start
			with '_', because the fields are translatable. Location field
			tells where the plugin class is located. It is of the form
			library:class, where library is the shared library name without
			the 'lib' prefix and '.so' suffix. <span class="emphasis"><em>class</em></span> is
			the plugin class we define. Our plugin library is
			libanjuta-hello-world.so, so the plugin location would be
			<span class="emphasis"><em>anjuta-hello-world:HelloWorldPlugin</em></span>.
			More details in	<a class="xref" href="plugin-description-file.html" title="Plugin description file"><i>Plugin description file</i></a>.
			Next field 'Icon', gives the name of icon file for our
			hello world plugin.
		</p>
<p>
			Next file is the XML UI definition file. This file describes the UI
			structure of our plugin and how it should be connected to our action
			functions. More details in
			<a class="link" href="AnjutaUI.html" title="AnjutaUI"><span class="type">AnjutaUI</span></a>. The first
			hello world plugin doesn't use this file, but the second advanced
			one uses it.
			</p>
<pre class="programlisting">
&lt;!--*- xml -*--&gt;
&lt;ui&gt;
  &lt;menubar name="MenuMain"&gt;
    &lt;menu name="MenuFile" action="ActionMenuFile"&gt;
      &lt;placeholder name="PlaceholderFileMenus"&gt;
        &lt;menuitem name="HelloWorldAction" action="ActionFileHelloWorld" /&gt;
      &lt;/placeholder&gt;
    &lt;/menu&gt;
  &lt;/menubar&gt;
&lt;/ui&gt;
			</pre>
<p>			
		</p>
<p>
			The last file is the icon file in PNG format. All these three files
			are installed in different places. The prefix of their installation
			should match with that of Anjuta, otherwise Anjuta will not be able
			to find our plugin. See <a class="xref" href="writing-plugins-build-setup.html" title="Build setup">the section called “Build setup”</a> for installation of these files.
		</p>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.21</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.