~ubuntu-branches/ubuntu/natty/gedit/natty

« back to all changes in this revision

Viewing changes to docs/reference/html/GeditPlugin.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-06-21 15:14:19 UTC
  • mfrom: (1.1.80 upstream)
  • Revision ID: james.westby@ubuntu.com-20100621151419-j79nqokj12vpw9u3
Tags: 2.30.3-0ubuntu1
* New upstream version
  - Misc bugfixes
  - Handle empty input gracefully (lp: #586848)
  - Translations update

Show diffs side-by-side

added added

removed removed

Lines of Context:
48
48
                                                         <em class="parameter"><code><a class="link" href="gedit-gedit-window.html#GeditWindow"><span class="type">GeditWindow</span></a> *window</code></em>);
49
49
<span class="returnvalue">void</span>                <a class="link" href="GeditPlugin.html#gedit-plugin-update-ui" title="gedit_plugin_update_ui ()">gedit_plugin_update_ui</a>              (<em class="parameter"><code><a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a> *plugin</code></em>,
50
50
                                                         <em class="parameter"><code><a class="link" href="gedit-gedit-window.html#GeditWindow"><span class="type">GeditWindow</span></a> *window</code></em>);
51
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GeditPlugin.html#gedit-plugin-is-configurable" title="gedit_plugin_is_configurable ()">gedit_plugin_is_configurable</a>        (<em class="parameter"><code><a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a> *plugin</code></em>);
52
 
<a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="GeditPlugin.html#gedit-plugin-create-configure-dialog" title="gedit_plugin_create_configure_dialog ()">gedit_plugin_create_configure_dialog</a>
 
51
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GeditPlugin.html#gedit-plugin-is-configurable" title="gedit_plugin_is_configurable ()">gedit_plugin_is_configurable</a>        (<em class="parameter"><code><a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a> *plugin</code></em>);
 
52
<a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="GeditPlugin.html#gedit-plugin-create-configure-dialog" title="gedit_plugin_create_configure_dialog ()">gedit_plugin_create_configure_dialog</a>
53
53
                                                        (<em class="parameter"><code><a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a> *plugin</code></em>);
54
54
#define             <a class="link" href="GeditPlugin.html#GEDIT-PLUGIN-REGISTER-TYPE:CAPS" title="GEDIT_PLUGIN_REGISTER_TYPE()">GEDIT_PLUGIN_REGISTER_TYPE</a>          (PluginName,
55
55
                                                         plugin_name)
58
58
<div class="refsect1" title="Object Hierarchy">
59
59
<a name="GeditPlugin.object-hierarchy"></a><h2>Object Hierarchy</h2>
60
60
<pre class="synopsis">
61
 
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
61
  <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
62
62
   +----GeditPlugin
63
63
</pre>
64
64
</div>
65
65
<div class="refsect1" title="Properties">
66
66
<a name="GeditPlugin.properties"></a><h2>Properties</h2>
67
67
<pre class="synopsis">
68
 
  "<a class="link" href="GeditPlugin.html#GeditPlugin--data-dir" title='The "data-dir" property'>data-dir</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read
69
 
  "<a class="link" href="GeditPlugin.html#GeditPlugin--data-dir-name" title='The "data-dir-name" property'>data-dir-name</a>"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Write / Construct Only
70
 
  "<a class="link" href="GeditPlugin.html#GeditPlugin--install-dir" title='The "install-dir" property'>install-dir</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
 
68
  "<a class="link" href="GeditPlugin.html#GeditPlugin--data-dir" title='The "data-dir" property'>data-dir</a>"                 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read
 
69
  "<a class="link" href="GeditPlugin.html#GeditPlugin--data-dir-name" title='The "data-dir-name" property'>data-dir-name</a>"            <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Write / Construct Only
 
70
  "<a class="link" href="GeditPlugin.html#GeditPlugin--install-dir" title='The "install-dir" property'>install-dir</a>"              <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
71
71
</pre>
72
72
</div>
73
73
<div class="refsect1" title="Description">
74
74
<a name="GeditPlugin.description"></a><h2>Description</h2>
75
 
<p>
76
 
</p>
77
75
</div>
78
76
<div class="refsect1" title="Details">
79
77
<a name="GeditPlugin.details"></a><h2>Details</h2>
80
78
<div class="refsect2" title="GeditPlugin">
81
79
<a name="GeditPlugin-struct"></a><h3>GeditPlugin</h3>
82
80
<pre class="programlisting">typedef struct _GeditPlugin GeditPlugin;</pre>
83
 
<p>
84
 
</p>
85
81
</div>
86
82
<hr>
87
83
<div class="refsect2" title="gedit_plugin_activate ()">
159
155
<hr>
160
156
<div class="refsect2" title="gedit_plugin_is_configurable ()">
161
157
<a name="gedit-plugin-is-configurable"></a><h3>gedit_plugin_is_configurable ()</h3>
162
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gedit_plugin_is_configurable        (<em class="parameter"><code><a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a> *plugin</code></em>);</pre>
 
158
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gedit_plugin_is_configurable        (<em class="parameter"><code><a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a> *plugin</code></em>);</pre>
163
159
<p>
164
160
Whether the plugin is configurable.
165
161
</p>
182
178
<hr>
183
179
<div class="refsect2" title="gedit_plugin_create_configure_dialog ()">
184
180
<a name="gedit-plugin-create-configure-dialog"></a><h3>gedit_plugin_create_configure_dialog ()</h3>
185
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         gedit_plugin_create_configure_dialog
 
181
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         gedit_plugin_create_configure_dialog
186
182
                                                        (<em class="parameter"><code><a class="link" href="GeditPlugin.html" title="GeditPlugin"><span class="type">GeditPlugin</span></a> *plugin</code></em>);</pre>
187
183
<p>
188
184
Creates the configure dialog widget for the plugin.
207
203
<div class="refsect2" title="GEDIT_PLUGIN_REGISTER_TYPE()">
208
204
<a name="GEDIT-PLUGIN-REGISTER-TYPE:CAPS"></a><h3>GEDIT_PLUGIN_REGISTER_TYPE()</h3>
209
205
<pre class="programlisting">#define             GEDIT_PLUGIN_REGISTER_TYPE(PluginName, plugin_name)</pre>
210
 
<p>
211
 
</p>
212
 
<div class="variablelist"><table border="0">
213
 
<col align="left" valign="top">
214
 
<tbody>
215
 
<tr>
216
 
<td><p><span class="term"><em class="parameter"><code>PluginName</code></em> :</span></p></td>
217
 
<td>
218
 
</td>
219
 
</tr>
220
 
<tr>
221
 
<td><p><span class="term"><em class="parameter"><code>plugin_name</code></em> :</span></p></td>
222
 
<td>
223
 
</td>
224
 
</tr>
225
 
</tbody>
226
 
</table></div>
227
206
</div>
228
207
</div>
229
208
<div class="refsect1" title="Property Details">
230
209
<a name="GeditPlugin.property-details"></a><h2>Property Details</h2>
231
210
<div class="refsect2" title='The "data-dir" property'>
232
211
<a name="GeditPlugin--data-dir"></a><h3>The <code class="literal">"data-dir"</code> property</h3>
233
 
<pre class="programlisting">  "data-dir"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read</pre>
 
212
<pre class="programlisting">  "data-dir"                 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read</pre>
234
213
<p>The full path of the directory where the plugin should look for its data files.</p>
235
214
<p>Default value: NULL</p>
236
215
</div>
237
216
<hr>
238
217
<div class="refsect2" title='The "data-dir-name" property'>
239
218
<a name="GeditPlugin--data-dir-name"></a><h3>The <code class="literal">"data-dir-name"</code> property</h3>
240
 
<pre class="programlisting">  "data-dir-name"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Write / Construct Only</pre>
 
219
<pre class="programlisting">  "data-dir-name"            <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Write / Construct Only</pre>
241
220
<p>The basename of the directory where the plugin should look for its data files.</p>
242
221
<p>Default value: NULL</p>
243
222
</div>
244
223
<hr>
245
224
<div class="refsect2" title='The "install-dir" property'>
246
225
<a name="GeditPlugin--install-dir"></a><h3>The <code class="literal">"install-dir"</code> property</h3>
247
 
<pre class="programlisting">  "install-dir"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
 
226
<pre class="programlisting">  "install-dir"              <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
248
227
<p>The directory where the plugin is installed.</p>
249
228
<p>Default value: NULL</p>
250
229
</div>