/usr/share/gtk-doc/html/grits/GritsCallback.html is in libgrits-doc 0.8.1-3.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GritsCallback</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
<link rel="home" href="index.html" title="Grits Reference Manual">
<link rel="up" href="ch03.html" title="Drawing Objects">
<link rel="prev" href="GritsMarker.html" title="GritsMarker">
<link rel="next" href="ch04.html" title="Plugins">
<meta name="generator" content="GTK-Doc V1.18 (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="GritsMarker.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch03.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">Grits Reference Manual</th>
<td><a accesskey="n" href="ch04.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GritsCallback.synopsis" class="shortcut">Top</a>
|
<a href="#GritsCallback.description" class="shortcut">Description</a>
|
<a href="#GritsCallback.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="GritsCallback"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GritsCallback.top_of_page"></a>GritsCallback</span></h2>
<p>GritsCallback — Custom callback objects</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GritsCallback.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="GritsCallback.html#GritsCallback-struct" title="struct GritsCallback">GritsCallback</a>;
struct <a class="link" href="GritsCallback.html#GritsCallbackClass" title="struct GritsCallbackClass">GritsCallbackClass</a>;
<span class="returnvalue">void</span> (<a class="link" href="GritsCallback.html#GritsCallbackFunc" title="GritsCallbackFunc ()">*GritsCallbackFunc</a>) (<em class="parameter"><code><a class="link" href="GritsCallback.html" title="GritsCallback"><span class="type">GritsCallback</span></a> *callback</code></em>,
<em class="parameter"><code><a class="link" href="GritsOpenGL.html" title="GritsOpenGL"><span class="type">GritsOpenGL</span></a> *opengl</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
<a class="link" href="GritsCallback.html" title="GritsCallback"><span class="returnvalue">GritsCallback</span></a> * <a class="link" href="GritsCallback.html#grits-callback-new" title="grits_callback_new ()">grits_callback_new</a> (<em class="parameter"><code><a class="link" href="GritsCallback.html#GritsCallbackFunc" title="GritsCallbackFunc ()"><span class="type">GritsCallbackFunc</span></a> draw_cb</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GritsCallback.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>
+----<a class="link" href="GritsObject.html" title="GritsObject">GritsObject</a>
+----GritsCallback
</pre>
</div>
<div class="refsect1">
<a name="GritsCallback.description"></a><h2>Description</h2>
<p>
<a class="link" href="GritsCallback.html" title="GritsCallback"><span class="type">GritsCallback</span></a> objects are used for custom drawing functions. A common example
of this would be to render something which does not easily fit into a normal
object. For instance, a Heads-Up-Display overlay.
</p>
<p>
Callbacks are an alternate to extending GritsObject with a new class and
should be used when only once instance of the object will be needed.
</p>
</div>
<div class="refsect1">
<a name="GritsCallback.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GritsCallback-struct"></a><h3>struct GritsCallback</h3>
<pre class="programlisting">struct GritsCallback;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GritsCallbackClass"></a><h3>struct GritsCallbackClass</h3>
<pre class="programlisting">struct GritsCallbackClass {
GritsObjectClass parent_class;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GritsCallbackFunc"></a><h3>GritsCallbackFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*GritsCallbackFunc) (<em class="parameter"><code><a class="link" href="GritsCallback.html" title="GritsCallback"><span class="type">GritsCallback</span></a> *callback</code></em>,
<em class="parameter"><code><a class="link" href="GritsOpenGL.html" title="GritsOpenGL"><span class="type">GritsOpenGL</span></a> *opengl</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>
A function to be called when the callback object is being rendered
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>the callback object to be drawn</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>the user data associated with the callback</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="grits-callback-new"></a><h3>grits_callback_new ()</h3>
<pre class="programlisting"><a class="link" href="GritsCallback.html" title="GritsCallback"><span class="returnvalue">GritsCallback</span></a> * grits_callback_new (<em class="parameter"><code><a class="link" href="GritsCallback.html#GritsCallbackFunc" title="GritsCallbackFunc ()"><span class="type">GritsCallbackFunc</span></a> draw_cb</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>
Create a <a class="link" href="GritsCallback.html" title="GritsCallback"><span class="type">GritsCallback</span></a> object with an associated function and user data.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data to pass to the drawing function</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the new <a class="link" href="GritsCallback.html" title="GritsCallback"><span class="type">GritsCallback</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|