libpeas-doc 1.12.1-2 / usr / share / gtk-doc / html / libpeas / PeasGtkConfigurable.html

This file is indexed.

/usr/share/gtk-doc/html/libpeas/PeasGtkConfigurable.html is in libpeas-doc 1.12.1-2.

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
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Peas Reference Manual: PeasGtkConfigurable</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Peas Reference Manual">
<link rel="up" href="ch03.html" title="Built-in Extension Interfaces">
<link rel="prev" href="PeasActivatable.html" title="PeasActivatable">
<link rel="next" href="api-index-full.html" title="API Index">
<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">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#PeasGtkConfigurable.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#PeasGtkConfigurable.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites">  <span class="dim">|</span> 
                  <a href="#PeasGtkConfigurable.prerequisites" class="shortcut">Prerequisites</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="PeasActivatable.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="api-index-full.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="PeasGtkConfigurable"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="PeasGtkConfigurable.top_of_page"></a>PeasGtkConfigurable</span></h2>
<p>PeasGtkConfigurable — Interface for providing a plugin configuration UI.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="PeasGtkConfigurable.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody><tr>
<td class="function_type">
<span class="returnvalue">GtkWidget</span> *
</td>
<td class="function_name">
<a class="link" href="PeasGtkConfigurable.html#peas-gtk-configurable-create-configure-widget" title="peas_gtk_configurable_create_configure_widget ()">peas_gtk_configurable_create_configure_widget</a> <span class="c_punctuation">()</span>
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="PeasGtkConfigurable.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="PeasGtkConfigurable.html#PeasGtkConfigurable-struct" title="PeasGtkConfigurable">PeasGtkConfigurable</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="PeasGtkConfigurable.html#PeasGtkConfigurableInterface" title="struct PeasGtkConfigurableInterface">PeasGtkConfigurableInterface</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="PeasGtkConfigurable.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GInterface
    <span class="lineart">╰──</span> PeasGtkConfigurable
</pre>
</div>
<div class="refsect1">
<a name="PeasGtkConfigurable.prerequisites"></a><h2>Prerequisites</h2>
<p>
PeasGtkConfigurable requires
 GObject.</p>
</div>
<div class="refsect1">
<a name="PeasGtkConfigurable.description"></a><h2>Description</h2>
<p>The <a class="link" href="PeasGtkConfigurable.html" title="PeasGtkConfigurable"><span class="type">PeasGtkConfigurable</span></a> interface will allow a plugin to provide a
graphical interface for the user to configure the plugin through the
<a class="link" href="PeasGtkPluginManager.html" title="PeasGtkPluginManager"><span class="type">PeasGtkPluginManager</span></a>: the <a class="link" href="PeasGtkPluginManager.html" title="PeasGtkPluginManager"><span class="type">PeasGtkPluginManager</span></a> will make its
“Configure Plugin” button active when the selected plugin implements
the <a class="link" href="PeasGtkConfigurable.html" title="PeasGtkConfigurable"><span class="type">PeasGtkConfigurable</span></a> interface.</p>
<p>To allow plugin configuration from the <a class="link" href="PeasGtkPluginManager.html" title="PeasGtkPluginManager"><span class="type">PeasGtkPluginManager</span></a>, the
plugin writer will just need to implement the
PeasGtkConfigurableInterface.create_configure_widget() method.</p>
</div>
<div class="refsect1">
<a name="PeasGtkConfigurable.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="peas-gtk-configurable-create-configure-widget"></a><h3>peas_gtk_configurable_create_configure_widget ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> *
peas_gtk_configurable_create_configure_widget
                               (<em class="parameter"><code><a class="link" href="PeasGtkConfigurable.html" title="PeasGtkConfigurable"><span class="type">PeasGtkConfigurable</span></a> *configurable</code></em>);</pre>
<p>Creates the configure widget for the plugin. The returned widget
should allow configuring all the relevant aspects of the plugin, and should
allow instant-apply, as promoted by the Gnome Human Interface Guidelines.</p>
<p><a class="link" href="PeasGtkPluginManager.html" title="PeasGtkPluginManager"><span class="type">PeasGtkPluginManager</span></a> will embed the returned widget into a dialog box,
but you shouldn't take this behaviour for granted as other implementations
of a plugin manager UI might do otherwise.</p>
<p>This method should always return a valid <span class="type">GtkWidget</span> instance, never <code class="literal">NULL</code>.</p>
<div class="refsect3">
<a name="id-1.2.4.3.8.2.7"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>configurable</p></td>
<td class="parameter_description"><p>A <a class="link" href="PeasGtkConfigurable.html" title="PeasGtkConfigurable"><span class="type">PeasGtkConfigurable</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.4.3.8.2.8"></a><h4>Returns</h4>
<p> A <span class="type">GtkWidget</span> used for configuration. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="PeasGtkConfigurable.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="PeasGtkConfigurable-struct"></a><h3>PeasGtkConfigurable</h3>
<pre class="programlisting">typedef struct _PeasGtkConfigurable PeasGtkConfigurable;</pre>
<p>Interface for configurable plugins.</p>
</div>
<hr>
<div class="refsect2">
<a name="PeasGtkConfigurableInterface"></a><h3>struct PeasGtkConfigurableInterface</h3>
<pre class="programlisting">struct PeasGtkConfigurableInterface {
  GTypeInterface g_iface;

  GtkWidget  *(*create_configure_widget)  (PeasGtkConfigurable  *configurable);
};
</pre>
<p>Provides an interface for configurable plugins.</p>
<div class="refsect3">
<a name="id-1.2.4.3.9.3.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><span class="type">GTypeInterface</span> <em class="structfield"><code><a name="PeasGtkConfigurableInterface.g-iface"></a>g_iface</code></em>;</p></td>
<td class="struct_member_description"><p>The parent interface.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="PeasGtkConfigurableInterface.create-configure-widget"></a>create_configure_widget</code></em> ()</p></td>
<td class="struct_member_description"><p>Creates the configure widget for the plugin.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.21</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.