/usr/share/gtk-doc/html/libgda-4.0/GdaReportDocument.html is in libgda-4.0-doc 4.2.8-2build1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdaReportDocument</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="GNOME Data Access 4 manual">
<link rel="up" href="ch32.html" title="API reference">
<link rel="prev" href="GdaReportEngine.html" title="GdaReportEngine">
<link rel="next" href="GdaReportDocbookDocument.html" title="GdaReportDocbookDocument">
<meta name="generator" content="GTK-Doc V1.17 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="GdaReportEngine.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch32.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 Data Access 4 manual</th>
<td><a accesskey="n" href="GdaReportDocbookDocument.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GdaReportDocument.synopsis" class="shortcut">Top</a>
|
<a href="#GdaReportDocument.description" class="shortcut">Description</a>
|
<a href="#GdaReportDocument.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GdaReportDocument.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="GdaReportDocument"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GdaReportDocument.top_of_page"></a>GdaReportDocument</span></h2>
<p>GdaReportDocument — Report document</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GdaReportDocument.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="GdaReportDocument.html#GdaReportDocument-struct" title="struct GdaReportDocument">GdaReportDocument</a>;
<span class="returnvalue">void</span> <a class="link" href="GdaReportDocument.html#gda-report-document-set-template" title="gda_report_document_set_template ()">gda_report_document_set_template</a> (<em class="parameter"><code><a class="link" href="GdaReportDocument.html" title="GdaReportDocument"><span class="type">GdaReportDocument</span></a> *doc</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *file</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GdaReportDocument.html#gda-report-document-run-as-html" title="gda_report_document_run_as_html ()">gda_report_document_run_as_html</a> (<em class="parameter"><code><a class="link" href="GdaReportDocument.html" title="GdaReportDocument"><span class="type">GdaReportDocument</span></a> *doc</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GdaReportDocument.html#gda-report-document-run-as-pdf" title="gda_report_document_run_as_pdf ()">gda_report_document_run_as_pdf</a> (<em class="parameter"><code><a class="link" href="GdaReportDocument.html" title="GdaReportDocument"><span class="type">GdaReportDocument</span></a> *doc</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GdaReportDocument.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----GdaReportDocument
+----<a class="link" href="GdaReportRmlDocument.html" title="GdaReportRmlDocument">GdaReportRmlDocument</a>
+----<a class="link" href="GdaReportDocbookDocument.html" title="GdaReportDocbookDocument">GdaReportDocbookDocument</a>
</pre>
</div>
<div class="refsect1">
<a name="GdaReportDocument.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GdaReportDocument.html#GdaReportDocument--engine" title='The "engine" property'>engine</a>" <a class="link" href="GdaReportEngine.html" title="GdaReportEngine"><span class="type">GdaReportEngine</span></a>* : Read / Write
"<a class="link" href="GdaReportDocument.html#GdaReportDocument--template" title='The "template" property'>template</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Write
</pre>
</div>
<div class="refsect1">
<a name="GdaReportDocument.description"></a><h2>Description</h2>
<p>
The <a class="link" href="GdaReportDocument.html" title="GdaReportDocument"><span class="type">GdaReportDocument</span></a> wraps the usage of a <a class="link" href="GdaReportEngine.html" title="GdaReportEngine"><span class="type">GdaReportEngine</span></a> for specific HTML or PDF targets. This class is
abstract (no instance be created directly), and one of its subclasses has to be used.
</p>
</div>
<div class="refsect1">
<a name="GdaReportDocument.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GdaReportDocument-struct"></a><h3>struct GdaReportDocument</h3>
<pre class="programlisting">struct GdaReportDocument;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-report-document-set-template"></a><h3>gda_report_document_set_template ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gda_report_document_set_template (<em class="parameter"><code><a class="link" href="GdaReportDocument.html" title="GdaReportDocument"><span class="type">GdaReportDocument</span></a> *doc</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *file</code></em>);</pre>
<p>
Instructs <em class="parameter"><code>doc</code></em> to use the <em class="parameter"><code>file</code></em> RML file as a template
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>doc</code></em> :</span></p></td>
<td>a <a class="link" href="GdaReportDocument.html" title="GdaReportDocument"><span class="type">GdaReportDocument</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td>
<td>a RML file name, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-report-document-run-as-html"></a><h3>gda_report_document_run_as_html ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gda_report_document_run_as_html (<em class="parameter"><code><a class="link" href="GdaReportDocument.html" title="GdaReportDocument"><span class="type">GdaReportDocument</span></a> *doc</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Creates the report document and saves it as an HTML file into <em class="parameter"><code>filename</code></em>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>doc</code></em> :</span></p></td>
<td>a <a class="link" href="GdaReportDocument.html" title="GdaReportDocument"><span class="type">GdaReportDocument</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>the name of a filename to save to</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a place to store errors, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if no error occurred</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-report-document-run-as-pdf"></a><h3>gda_report_document_run_as_pdf ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gda_report_document_run_as_pdf (<em class="parameter"><code><a class="link" href="GdaReportDocument.html" title="GdaReportDocument"><span class="type">GdaReportDocument</span></a> *doc</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Creates the report document and saves it as a PDF file into <em class="parameter"><code>filename</code></em>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>doc</code></em> :</span></p></td>
<td>a <a class="link" href="GdaReportDocument.html" title="GdaReportDocument"><span class="type">GdaReportDocument</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>the name of a filename to save to</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a place to store errors, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if no error occurred</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="GdaReportDocument.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GdaReportDocument--engine"></a><h3>The <code class="literal">"engine"</code> property</h3>
<pre class="programlisting"> "engine" <a class="link" href="GdaReportEngine.html" title="GdaReportEngine"><span class="type">GdaReportEngine</span></a>* : Read / Write</pre>
<p></p>
</div>
<hr>
<div class="refsect2">
<a name="GdaReportDocument--template"></a><h3>The <code class="literal">"template"</code> property</h3>
<pre class="programlisting"> "template" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Write</pre>
<p></p>
<p>Default value: NULL</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.17</div>
</body>
</html>
|