/usr/share/gtk-doc/html/libpeony-extension/libpeony-extension-PeonyModule.html is in libpeony-extension-doc 1.1.1-0ubuntu2.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PeonyModule: Peony Extension Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Peony Extension Reference Manual">
<link rel="up" href="ch01.html" title="Extension Interfaces">
<link rel="prev" href="PeonyColumn.html" title="PeonyColumn">
<link rel="next" href="PeonyFileInfo.html" title="PeonyFileInfo">
<meta name="generator" content="GTK-Doc V1.27 (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="#libpeony-extension-PeonyModule.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#libpeony-extension-PeonyModule.object-hierarchy" class="shortcut">Object Hierarchy</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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="PeonyColumn.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="PeonyFileInfo.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libpeony-extension-PeonyModule"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libpeony-extension-PeonyModule.top_of_page"></a>PeonyModule</span></h2>
<p>PeonyModule — Initialize an extension</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libpeony-extension-PeonyModule.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" 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">GType</span>
</td>
<td class="function_name">
<a class="link" href="libpeony-extension-PeonyModule.html#peony-operation-result-get-type" title="peony_operation_result_get_type ()">peony_operation_result_get_type</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libpeony-extension-PeonyModule.html#peony-module-initialize" title="peony_module_initialize ()">peony_module_initialize</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libpeony-extension-PeonyModule.html#peony-module-shutdown" title="peony_module_shutdown ()">peony_module_shutdown</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libpeony-extension-PeonyModule.html#peony-module-list-types" title="peony_module_list_types ()">peony_module_list_types</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libpeony-extension-PeonyModule.html#peony-module-list-pyfiles" title="peony_module_list_pyfiles ()">peony_module_list_pyfiles</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libpeony-extension-PeonyModule.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libpeony-extension-PeonyModule.html#PEONY-TYPE-OPERATION-RESULT:CAPS" title="PEONY_TYPE_OPERATION_RESULT">PEONY_TYPE_OPERATION_RESULT</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="libpeony-extension-PeonyModule.html#PeonyOperationHandle" title="PeonyOperationHandle">PeonyOperationHandle</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="libpeony-extension-PeonyModule.html#PeonyOperationResult" title="enum PeonyOperationResult">PeonyOperationResult</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libpeony-extension-PeonyModule.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GEnum
<span class="lineart">╰──</span> PeonyOperationResult
</pre>
</div>
<div class="refsect1">
<a name="libpeony-extension-PeonyModule.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libpeony-extension/peony-extension-types.h>
</pre>
</div>
<div class="refsect1">
<a name="libpeony-extension-PeonyModule.description"></a><h2>Description</h2>
<p>Methods that each extension implements.</p>
</div>
<div class="refsect1">
<a name="libpeony-extension-PeonyModule.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="peony-operation-result-get-type"></a><h3>peony_operation_result_get_type ()</h3>
<pre class="programlisting"><span class="returnvalue">GType</span>
peony_operation_result_get_type (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="peony-module-initialize"></a><h3>peony_module_initialize ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
peony_module_initialize (<em class="parameter"><code><span class="type">GTypeModule</span> *module</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="peony-module-shutdown"></a><h3>peony_module_shutdown ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
peony_module_shutdown (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="peony-module-list-types"></a><h3>peony_module_list_types ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
peony_module_list_types (<em class="parameter"><code>const <span class="type">GType</span> **types</code></em>,
<em class="parameter"><code><span class="type">int</span> *num_types</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="peony-module-list-pyfiles"></a><h3>peony_module_list_pyfiles ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
peony_module_list_pyfiles (<em class="parameter"><code><span class="type">GList</span> **pyfiles</code></em>);</pre>
</div>
</div>
<div class="refsect1">
<a name="libpeony-extension-PeonyModule.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="PEONY-TYPE-OPERATION-RESULT:CAPS"></a><h3>PEONY_TYPE_OPERATION_RESULT</h3>
<pre class="programlisting">#define PEONY_TYPE_OPERATION_RESULT (peony_operation_result_get_type ())
</pre>
</div>
<hr>
<div class="refsect2">
<a name="PeonyOperationHandle"></a><h3>PeonyOperationHandle</h3>
<pre class="programlisting">typedef struct _PeonyOperationHandle PeonyOperationHandle;</pre>
<p>Handle for asynchronous interfaces. These are opaque handles that must
be unique within an extension object. These are returned by operations
that return PEONY_OPERATION_IN_PROGRESS.</p>
</div>
<hr>
<div class="refsect2">
<a name="PeonyOperationResult"></a><h3>enum PeonyOperationResult</h3>
<div class="refsect3">
<a name="PeonyOperationResult.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="PEONY-OPERATION-COMPLETE:CAPS"></a>PEONY_OPERATION_COMPLETE</p></td>
<td class="enum_member_description">
<p>the operation succeeded, and the extension
is done with the request.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="PEONY-OPERATION-FAILED:CAPS"></a>PEONY_OPERATION_FAILED</p></td>
<td class="enum_member_description">
<p>the operation failed.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="PEONY-OPERATION-IN-PROGRESS:CAPS"></a>PEONY_OPERATION_IN_PROGRESS</p></td>
<td class="enum_member_description">
<p>the extension has begin an async operation.
When this value is returned, the extension must set the handle parameter
and call the callback closure when the operation is complete.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|