/usr/share/gtk-doc/html/libgda-4.0/libgda-4.0-UI-plugins.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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>UI plugins</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="ch21.html" title="User interface API reference">
<link rel="prev" href="GdauiRtEditor.html" title="GdauiRtEditor">
<link rel="next" href="GdauiDataEntry.html" title="GdauiDataEntry">
<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="GdauiRtEditor.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch21.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="GdauiDataEntry.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgda-4.0-UI-plugins.synopsis" class="shortcut">Top</a>
|
<a href="#libgda-4.0-UI-plugins.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libgda-4.0-UI-plugins"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgda-4.0-UI-plugins.top_of_page"></a>UI plugins</span></h2>
<p>UI plugins</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgda-4.0-UI-plugins.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><a class="link" href="GdauiDataEntry.html" title="GdauiDataEntry"><span class="returnvalue">GdauiDataEntry</span></a> * (<a class="link" href="libgda-4.0-UI-plugins.html#GdauiEntryCreateFunc" title="GdauiEntryCreateFunc ()">*GdauiEntryCreateFunc</a>) (<em class="parameter"><code><a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="type">GdaDataHandler</span></a> *Param1</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> Param2</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> *Param3</code></em>);
<a href="http://library.gnome.org/devel/gtk3/GtkCellRenderer.html"><span class="returnvalue">GtkCellRenderer</span></a> * (<a class="link" href="libgda-4.0-UI-plugins.html#GdauiCellCreateFunc" title="GdauiCellCreateFunc ()">*GdauiCellCreateFunc</a>) (<em class="parameter"><code><a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="type">GdaDataHandler</span></a> *Param1</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> Param2</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> *Param3</code></em>);
<a class="link" href="libgda-4.0-UI-plugins.html#GdauiPlugin" title="GdauiPlugin">GdauiPlugin</a>;
<span class="returnvalue">void</span> <a class="link" href="libgda-4.0-UI-plugins.html#gdaui-plugin-declare" title="gdaui_plugin_declare ()">gdaui_plugin_declare</a> (<em class="parameter"><code>const <a class="link" href="libgda-4.0-UI-plugins.html#GdauiPlugin" title="GdauiPlugin"><span class="type">GdauiPlugin</span></a> *plugin</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgda-4.0-UI-plugins.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libgda-4.0-UI-plugins.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GdauiEntryCreateFunc"></a><h3>GdauiEntryCreateFunc ()</h3>
<pre class="programlisting"><a class="link" href="GdauiDataEntry.html" title="GdauiDataEntry"><span class="returnvalue">GdauiDataEntry</span></a> * (*GdauiEntryCreateFunc) (<em class="parameter"><code><a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="type">GdaDataHandler</span></a> *Param1</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> Param2</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> *Param3</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GdauiCellCreateFunc"></a><h3>GdauiCellCreateFunc ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk3/GtkCellRenderer.html"><span class="returnvalue">GtkCellRenderer</span></a> * (*GdauiCellCreateFunc) (<em class="parameter"><code><a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="type">GdaDataHandler</span></a> *Param1</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> Param2</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> *Param3</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GdauiPlugin"></a><h3>GdauiPlugin</h3>
<pre class="programlisting">typedef struct {
gchar *plugin_name;
gchar *plugin_descr;
gchar *plugin_file;
guint nb_g_types; /* 0 if all types are accepted */
GType *valid_g_types; /* not NULL if @nb_g_types is not 0 */
gchar *options_xml_spec; /* NULL if no option possible */
/* actual widget creation: one of them must be not NULL */
GdauiEntryCreateFunc entry_create_func;
GdauiCellCreateFunc cell_create_func;
} GdauiPlugin;
</pre>
<p>
Structure representing a plugin.
</p>
<p>
Note: <em class="parameter"><code>entry_create_func</code></em> and <em class="parameter"><code>cell_create_func</code></em> can't be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> at the same time
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GdauiPlugin.plugin-name"></a>plugin_name</code></em>;</span></p></td>
<td>the name of the plugin</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GdauiPlugin.plugin-descr"></a>plugin_descr</code></em>;</span></p></td>
<td>a description for the plugin, 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"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GdauiPlugin.plugin-file"></a>plugin_file</code></em>;</span></p></td>
<td>the shared object implementing the plugin, can be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for internal plugins</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GdauiPlugin.nb-g-types"></a>nb_g_types</code></em>;</span></p></td>
<td>number of types the plugin can handle, or <code class="literal">0</code> for any type</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> *<em class="structfield"><code><a name="GdauiPlugin.valid-g-types"></a>valid_g_types</code></em>;</span></p></td>
<td>an array of <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a>, containing the accepted types, its size is <em class="parameter"><code>nb_g_types</code></em>,
or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>nb_g_types</code></em> is <code class="literal">0</code>
</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GdauiPlugin.options-xml-spec"></a>options_xml_spec</code></em>;</span></p></td>
<td>a string describing the plugin's options, 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"><a class="link" href="libgda-4.0-UI-plugins.html#GdauiEntryCreateFunc" title="GdauiEntryCreateFunc ()"><span class="type">GdauiEntryCreateFunc</span></a> <em class="structfield"><code><a name="GdauiPlugin.entry-create-func"></a>entry_create_func</code></em>;</span></p></td>
<td>the function called to create a <a class="link" href="GdauiDataEntry.html" title="GdauiDataEntry"><span class="type">GdauiDataEntry</span></a>, 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"><a class="link" href="libgda-4.0-UI-plugins.html#GdauiCellCreateFunc" title="GdauiCellCreateFunc ()"><span class="type">GdauiCellCreateFunc</span></a> <em class="structfield"><code><a name="GdauiPlugin.cell-create-func"></a>cell_create_func</code></em>;</span></p></td>
<td>the function called to create a <a href="http://library.gnome.org/devel/gtk3/GtkCellRenderer.html"><span class="type">GtkCellRenderer</span></a>, 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="gdaui-plugin-declare"></a><h3>gdaui_plugin_declare ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gdaui_plugin_declare (<em class="parameter"><code>const <a class="link" href="libgda-4.0-UI-plugins.html#GdauiPlugin" title="GdauiPlugin"><span class="type">GdauiPlugin</span></a> *plugin</code></em>);</pre>
<p>
Adds a new plugin which will be used by the forms and grids. The new plugin, as
described by <em class="parameter"><code>plugin</code></em> can declare a custom widget to be used for forms, grids, or both.
</p>
<p>
If a plugin is already declared with the same name as the requested name, then
a warning is issued and the operation fails.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
<td>a pointer to a structure filled to describe the new plugin. All the contained information is copied.</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.17</div>
</body>
</html>
|