/usr/share/gtk-doc/html/gnome-scan-1.0/GnomeScanModule.html is in libgnomescan-dev 0.6.2-1.1ubuntu4.
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 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GnomeScanModule</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="Gnome Scan Reference Manual">
<link rel="up" href="backend.html" title="Writing Backend">
<link rel="prev" href="backend.html" title="Writing Backend">
<link rel="next" href="GnomeScanBackend.html" title="GnomeScanBackend">
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="core.html" title="Part I. Gnome Scan Core Reference">
<link rel="chapter" href="setup.html" title="Using Gnome Scan">
<link rel="chapter" href="extends.html" title="Extending For Application">
<link rel="part" href="internals.html" title="Part II. Gnome Scan Internals">
<link rel="chapter" href="backend.html" title="Writing Backend">
<link rel="index" href="symbols.html" title="Index">
<link rel="index" href="hierarchy.html" title="Object Hierarchy">
<link rel="index" href="gallery.html" title="Widget Gallery">
</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="2">
<tr valign="middle">
<td><a accesskey="p" href="backend.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="backend.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Gnome Scan Reference Manual</th>
<td><a accesskey="n" href="GnomeScanBackend.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#GnomeScanModule.synopsis" class="shortcut">Top</a>
|
<a href="#GnomeScanModule.description" class="shortcut">Description</a>
|
<a href="#GnomeScanModule.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GnomeScanModule.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#GnomeScanModule.properties" class="shortcut">Properties</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GnomeScanModule"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GnomeScanModule.top_of_page"></a>GnomeScanModule</span></h2>
<p>GnomeScanModule — Module loading and initialization</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GnomeScanModule.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#define <a class="link" href="GnomeScanModule.html#GS-DEFINE-MODULE-TYPE:CAPS" title="GS_DEFINE_MODULE_TYPE()">GS_DEFINE_MODULE_TYPE</a> (TN, t_n, T_P)
<a class="link" href="GnomeScanModule.html#GnomeScanModule-struct" title="GnomeScanModule">GnomeScanModule</a>;
<a class="link" href="GnomeScanModule.html" title="GnomeScanModule">GnomeScanModule</a>* <a class="link" href="GnomeScanModule.html#gnome-scan-module-new" title="gnome_scan_module_new ()">gnome_scan_module_new</a> (<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *filename);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GnomeScanModule.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="/usr/share/gtk-doc/html/gobject/GTypeModule.html"
>GTypeModule</a>
+----GnomeScanModule
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GnomeScanModule.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GnomeScanModule implements
<a
href="/usr/share/gtk-doc/html/gobject/GTypePlugin.html"
>GTypePlugin</a>.</p>
</div>
<div class="refsect1" lang="en">
<a name="GnomeScanModule.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GnomeScanModule.html#GnomeScanModule--filename" title='The "filename" property'>filename</a>" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GnomeScanModule.description"></a><h2>Description</h2>
<p>
A module represent the library opened with <a
href="/usr/share/gtk-doc/html/glib/glib-Dynamic-Loading-of-Modules.html#GModule"
><span class="type">GModule</span></a> where are
stored a list of <span class="type">GObjects</span>.</p>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="GnomeScanModule.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="GS-DEFINE-MODULE-TYPE:CAPS"></a><h3>GS_DEFINE_MODULE_TYPE()</h3>
<pre class="programlisting">#define GS_DEFINE_MODULE_TYPE(TN, t_n, T_P)</pre>
<p>
Convenient macro used to declare a dynamicly registered type.
</p>
<p>
For example:
</p>
<pre class="programlisting">
GS_DEFINE_MODULE_TYPE (FooBar, foo_bar, G_TYPE_OBJECT)
</pre>
<p>
</p>
<p>
expands to:
</p>
<p>
</p>
<pre class="programlisting">
static void foo_bar_init (FooBar *self);
static void foo_bar_class_init (FooBarClass *klass);
static GType foo_bar_type = 0;
GType
foo_bar_get_type ()
{ return foo_bar_type; }
void
foo_bar_register_type (GTypeModule *module)
{
if (!foo_bar_type)
{
static const GTypeInfo type_info =
{
sizeof (FooBarClass),
(GBaseInitFunc) NULL,
(GBaseFinalizeFunc) NULL,
(GClassInitFunc) foo_bar_class_init,
NULL,
NULL,
sizeof (FooBar),
0,
(GInstanceInitFunc) foo_bar_init
};
foo_bar_type =
g_type_module_register_type (module, G_TYPE_OBJECT,
g_intern_static_string ("FooBar"), &type_info, 0);
}
}
</pre>
<p>
</p>
<p>
See: G_DEFINE_TYPE</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>TN</code></em> :</span></p></td>
<td> Capitalized type name
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>t_n</code></em> :</span></p></td>
<td> Type function prefix
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>T_P</code></em> :</span></p></td>
<td> Parent GType macro
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GnomeScanModule-struct"></a><h3>GnomeScanModule</h3>
<pre class="programlisting">typedef struct {
void (* init) (GnomeScanModule *module);
void (* finalize) (GnomeScanModule *module);
} GnomeScanModule;
</pre>
<p>
A <a class="link" href="GnomeScanModule.html" title="GnomeScanModule"><span class="type">GnomeScanModule</span></a> handle the loading, initialization, finalization
and unloading of a module. If you want to extends Gnome Scan, you
must implement two function, one for <em class="parameter"><code>init</code></em> and one for <em class="parameter"><code>finalize</code></em>,
called <code class="function">gnome_scan_module_init()</code> and
<code class="function">gnome_scan_module_finalize()</code>. You should prefix function prototypes
with <a
href="/usr/share/gtk-doc/html/glib/glib-Dynamic-Loading-of-Modules.html#G-MODULE-EXPORT:CAPS"
><span class="type">G_MODULE_EXPORT</span></a>.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gnome-scan-module-new"></a><h3>gnome_scan_module_new ()</h3>
<pre class="programlisting"><a class="link" href="GnomeScanModule.html" title="GnomeScanModule">GnomeScanModule</a>* gnome_scan_module_new (<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *filename);</pre>
<p>
Open and initialize a new module. This function should be used only
by <span class="type">GnomeScanModuleManager</span>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td> The path to shared object
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a new <a class="link" href="GnomeScanModule.html" title="GnomeScanModule"><span class="type">GnomeScanModule</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="GnomeScanModule.property-details"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="GnomeScanModule--filename"></a><h3>The <code class="literal">"filename"</code> property</h3>
<pre class="programlisting"> "filename" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* : Read / Write / Construct Only</pre>
<p>
The path to the shared object.</p>
<p>
</p>
<p>Default value: NULL</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.10</div>
</body>
</html>
|