/usr/share/gtk-doc/html/libgwydgets/Gwy3DWindow.html is in libgwyddion20-doc 2.34-3ubuntu1.
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 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Gwyddion Widgets Library Reference Manual: Gwy3DWindow</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Gwyddion Widgets Library Reference Manual">
<link rel="up" href="Widgets3D.html" title="3D Widgets">
<link rel="prev" href="Gwy3DView.html" title="Gwy3DView">
<link rel="next" href="Gwy3DSetup.html" title="Gwy3DSetup">
<meta name="generator" content="GTK-Doc V1.19 (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="10"><tr valign="middle">
<td width="100%" align="left">
<a href="#" class="shortcut">Top</a>
|
<a href="#Gwy3DWindow.description" class="shortcut">Description</a>
|
<a href="#Gwy3DWindow.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#Gwy3DWindow.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
</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="Widgets3D.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="Gwy3DView.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="Gwy3DSetup.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="Gwy3DWindow"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="Gwy3DWindow.top_of_page"></a>Gwy3DWindow</span></h2>
<p>Gwy3DWindow — 3D data display window</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="Gwy3DWindow.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libgwydgets/gwydgets.h>
struct <a class="link" href="Gwy3DWindow.html#Gwy3DWindow-struct" title="struct Gwy3DWindow">Gwy3DWindow</a>;
struct <a class="link" href="Gwy3DWindow.html#Gwy3DWindowClass" title="struct Gwy3DWindowClass">Gwy3DWindowClass</a>;
<a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="Gwy3DWindow.html#gwy-3d-window-new" title="gwy_3d_window_new ()">gwy_3d_window_new</a> (<em class="parameter"><code><a class="link" href="Gwy3DView.html" title="Gwy3DView"><span class="type">Gwy3DView</span></a> *gwy3dview</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="Gwy3DWindow.html#gwy-3d-window-get-3d-view" title="gwy_3d_window_get_3d_view ()">gwy_3d_window_get_3d_view</a> (<em class="parameter"><code><a class="link" href="Gwy3DWindow.html" title="Gwy3DWindow"><span class="type">Gwy3DWindow</span></a> *gwy3dwindow</code></em>);
<span class="returnvalue">void</span> <a class="link" href="Gwy3DWindow.html#gwy-3d-window-add-action-widget" title="gwy_3d_window_add_action_widget ()">gwy_3d_window_add_action_widget</a> (<em class="parameter"><code><a class="link" href="Gwy3DWindow.html" title="Gwy3DWindow"><span class="type">Gwy3DWindow</span></a> *gwy3dwindow</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>);
<span class="returnvalue">void</span> <a class="link" href="Gwy3DWindow.html#gwy-3d-window-add-small-toolbar-button" title="gwy_3d_window_add_small_toolbar_button ()">gwy_3d_window_add_small_toolbar_button</a>
(<em class="parameter"><code><a class="link" href="Gwy3DWindow.html" title="Gwy3DWindow"><span class="type">Gwy3DWindow</span></a> *gwy3dwindow</code></em>,
<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *stock_id</code></em>,
<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tooltip</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-Closures.html#GCallback"><span class="type">GCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> cbdata</code></em>);
<span class="returnvalue">void</span> <a class="link" href="Gwy3DWindow.html#gwy-3d-window-set-overlay-chooser" title="gwy_3d_window_set_overlay_chooser ()">gwy_3d_window_set_overlay_chooser</a> (<em class="parameter"><code><a class="link" href="Gwy3DWindow.html" title="Gwy3DWindow"><span class="type">Gwy3DWindow</span></a> *gwy3dwindow</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *chooser</code></em>);
<span class="returnvalue">void</span> <a class="link" href="Gwy3DWindow.html#gwy-3d-window-class-set-tooltips" title="gwy_3d_window_class_set_tooltips ()">gwy_3d_window_class_set_tooltips</a> (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkTooltips.html"><span class="type">GtkTooltips</span></a> *tips</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkTooltips.html"><span class="returnvalue">GtkTooltips</span></a> * <a class="link" href="Gwy3DWindow.html#gwy-3d-window-class-get-tooltips" title="gwy_3d_window_class_get_tooltips ()">gwy_3d_window_class_get_tooltips</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
</pre>
</div>
<div class="refsect1">
<a name="Gwy3DWindow.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
+----<a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkObject.html">GtkObject</a>
+----<a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkWidget.html">GtkWidget</a>
+----<a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkContainer.html">GtkContainer</a>
+----<a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkBin.html">GtkBin</a>
+----<a href="/usr/share/gtk-doc/html/gtk3/GtkWindow.html">GtkWindow</a>
+----Gwy3DWindow
</pre>
</div>
<div class="refsect1">
<a name="Gwy3DWindow.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
Gwy3DWindow implements
AtkImplementorIface and <a href="/usr/share/gtk-doc/html/gtk3/GtkBuildable.html">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="Gwy3DWindow.description"></a><h2>Description</h2>
<p>
<a class="link" href="Gwy3DWindow.html" title="Gwy3DWindow"><span class="type">Gwy3DWindow</span></a> encapsulates a <a class="link" href="Gwy3DView.html" title="Gwy3DView"><span class="type">Gwy3DView</span></a> together with appropriate controls.
You can create a 3D window for a 3D view with <a class="link" href="Gwy3DWindow.html#gwy-3d-window-new" title="gwy_3d_window_new ()"><code class="function">gwy_3d_window_new()</code></a>. It has an
`action area' below the controls where additional widgets can be packed with
<a class="link" href="Gwy3DWindow.html#gwy-3d-window-add-action-widget" title="gwy_3d_window_add_action_widget ()"><code class="function">gwy_3d_window_add_action_widget()</code></a>.
</p>
</div>
<div class="refsect1">
<a name="Gwy3DWindow.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="Gwy3DWindow-struct"></a><h3>struct Gwy3DWindow</h3>
<pre class="programlisting">struct Gwy3DWindow;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="Gwy3DWindowClass"></a><h3>struct Gwy3DWindowClass</h3>
<pre class="programlisting">struct Gwy3DWindowClass {
GtkWindowClass parent_class;
void (*reserved1)(void);
void (*reserved2)(void);
void (*reserved3)(void);
void (*reserved4)(void);
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-3d-window-new"></a><h3>gwy_3d_window_new ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * gwy_3d_window_new (<em class="parameter"><code><a class="link" href="Gwy3DView.html" title="Gwy3DView"><span class="type">Gwy3DView</span></a> *gwy3dview</code></em>);</pre>
<p>
Creates a new OpenGL 3D data displaying window.
</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>gwy3dview</code></em> :</span></p></td>
<td>A <a class="link" href="Gwy3DView.html" title="Gwy3DView"><span class="type">Gwy3DView</span></a> containing the data-displaying widget to show.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A newly created widget, as <a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-3d-window-get-3d-view"></a><h3>gwy_3d_window_get_3d_view ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * gwy_3d_window_get_3d_view (<em class="parameter"><code><a class="link" href="Gwy3DWindow.html" title="Gwy3DWindow"><span class="type">Gwy3DWindow</span></a> *gwy3dwindow</code></em>);</pre>
<p>
Returns the <a class="link" href="Gwy3DView.html" title="Gwy3DView"><span class="type">Gwy3DView</span></a> widget this 3D window currently shows.
</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>gwy3dwindow</code></em> :</span></p></td>
<td>A 3D data view window.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The currently shown <a class="link" href="GwyDataView.html" title="GwyDataView"><span class="type">GwyDataView</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-3d-window-add-action-widget"></a><h3>gwy_3d_window_add_action_widget ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_3d_window_add_action_widget (<em class="parameter"><code><a class="link" href="Gwy3DWindow.html" title="Gwy3DWindow"><span class="type">Gwy3DWindow</span></a> *gwy3dwindow</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>);</pre>
<p>
Adds a widget (usually a button) to 3D window action area.
</p>
<p>
The action area is located under the parameter notebook.
</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>gwy3dwindow</code></em> :</span></p></td>
<td>A 3D data view window.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
<td>A widget to pack into the action area.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-3d-window-add-small-toolbar-button"></a><h3>gwy_3d_window_add_small_toolbar_button ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_3d_window_add_small_toolbar_button
(<em class="parameter"><code><a class="link" href="Gwy3DWindow.html" title="Gwy3DWindow"><span class="type">Gwy3DWindow</span></a> *gwy3dwindow</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *stock_id</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tooltip</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GCallback"><span class="type">GCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> cbdata</code></em>);</pre>
<p>
Adds a button to small <em class="parameter"><code>gwy3dwindow</code></em> toolbar.
</p>
<p>
The small toolbar is those visible when full controls are hidden. Due to
space constraints the button must be contain only a pixmap.
</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>gwy3dwindow</code></em> :</span></p></td>
<td>A 3D data view window.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>stock_id</code></em> :</span></p></td>
<td>Button pixmap stock id, like <a href="/usr/share/gtk-doc/html/gtk3/gtk3-Stock-Items.html#GTK-STOCK-SAVE:CAPS"><span class="type">GTK_STOCK_SAVE</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tooltip</code></em> :</span></p></td>
<td>Button tooltip.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>Callback action for "clicked" signal. It is connected swapped,
that is it gets <em class="parameter"><code>cbdata</code></em> as its first argument, the clicked button
as the last.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cbdata</code></em> :</span></p></td>
<td>Data to pass to <em class="parameter"><code>callback</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-3d-window-set-overlay-chooser"></a><h3>gwy_3d_window_set_overlay_chooser ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_3d_window_set_overlay_chooser (<em class="parameter"><code><a class="link" href="Gwy3DWindow.html" title="Gwy3DWindow"><span class="type">Gwy3DWindow</span></a> *gwy3dwindow</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> *chooser</code></em>);</pre>
<p>
Sets the overlay chooser widget of a 3D window.
</p>
<p>
Once set, the overlay chooser widget cannot be changed.
</p>
<p>
The 3D window does not use the provided widget in any way, it just places
it in an appropriate place in the user interface. It is expected that the
caller will perform <code class="function">gwy_app_3d_window_set_data2()</code> upon selection of data
in the chooser.
</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>gwy3dwindow</code></em> :</span></p></td>
<td>A 3D data view window.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>chooser</code></em> :</span></p></td>
<td>Overlay chooser widget.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-3d-window-class-set-tooltips"></a><h3>gwy_3d_window_class_set_tooltips ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_3d_window_class_set_tooltips (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk2/GtkTooltips.html"><span class="type">GtkTooltips</span></a> *tips</code></em>);</pre>
<p>
Sets the tooltips object to use for adding tooltips to 3D window parts.
</p>
<p>
This is a class method. It affects only newly cerated 3D windows, existing
3D windows will continue to use the tooltips they were constructed with.
</p>
<p>
If no class tooltips object is set before first <a class="link" href="Gwy3DWindow.html" title="Gwy3DWindow"><span class="type">Gwy3DWindow</span></a> is created,
the class instantiates one on its own. You can normally obtain it with
<a class="link" href="Gwy3DWindow.html#gwy-3d-window-class-get-tooltips" title="gwy_3d_window_class_get_tooltips ()"><code class="function">gwy_3d_window_class_get_tooltips()</code></a> then. The class takes a reference on
the tooltips in either case.
</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>tips</code></em> :</span></p></td>
<td>Tooltips object <a class="link" href="Gwy3DWindow.html" title="Gwy3DWindow"><span class="type">Gwy3DWindow</span></a>'s should use for setting tooltips.
A <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> value disables tooltips altogether.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-3d-window-class-get-tooltips"></a><h3>gwy_3d_window_class_get_tooltips ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk2/GtkTooltips.html"><span class="returnvalue">GtkTooltips</span></a> * gwy_3d_window_class_get_tooltips (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Gets the tooltips object used for adding tooltips to 3D window parts.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The <a href="/usr/share/gtk-doc/html/gtk2/GtkTooltips.html"><span class="type">GtkTooltips</span></a> object.</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="Gwy3DWindow.see-also"></a><h2>See Also</h2>
<a class="link" href="Gwy3DView.html" title="Gwy3DView"><span class="type">Gwy3DView</span></a> -- the basic 3D data display widget
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|