File: EntangleApplication.html

package info (click to toggle)
entangle 0.6.0-2
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 7,836 kB
  • ctags: 3,171
  • sloc: ansic: 18,933; sh: 11,305; makefile: 448; xml: 227; python: 221
file content (227 lines) | stat: -rw-r--r-- 14,107 bytes parent folder | download
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EntangleApplication</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Entangle Reference Manual">
<link rel="up" href="ch02.html" title="Entangle Frontend">
<link rel="prev" href="ch02.html" title="Entangle Frontend">
<link rel="next" href="EntangleCameraManager.html" title="EntangleCameraManager">
<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="2">
<tr valign="middle">
<td><a accesskey="p" href="ch02.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.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">Entangle Reference Manual</th>
<td><a accesskey="n" href="EntangleCameraManager.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#EntangleApplication.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#EntangleApplication.description" class="shortcut">Description</a>
                   | 
                  <a href="#EntangleApplication.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#EntangleApplication.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#EntangleApplication.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="EntangleApplication"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="EntangleApplication.top_of_page"></a>EntangleApplication</span></h2>
<p>EntangleApplication — Global application state base class</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="EntangleApplication.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct              <a class="link" href="EntangleApplication.html#EntangleApplication-struct" title="struct EntangleApplication">EntangleApplication</a>;
struct              <a class="link" href="EntangleApplication.html#EntangleApplicationClass" title="struct EntangleApplicationClass">EntangleApplicationClass</a>;
<a class="link" href="EntangleApplication.html" title="EntangleApplication"><span class="returnvalue">EntangleApplication</span></a> * <a class="link" href="EntangleApplication.html#entangle-application-new" title="entangle_application_new ()">entangle_application_new</a>          (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="EntangleCameraList.html" title="EntangleCameraList"><span class="returnvalue">EntangleCameraList</span></a> * <a class="link" href="EntangleApplication.html#entangle-application-get-active-cameras" title="entangle_application_get_active_cameras ()">entangle_application_get_active_cameras</a>
                                                        (<em class="parameter"><code><a class="link" href="EntangleApplication.html" title="EntangleApplication"><span class="type">EntangleApplication</span></a> *application</code></em>);
<a class="link" href="EntangleCameraList.html" title="EntangleCameraList"><span class="returnvalue">EntangleCameraList</span></a> * <a class="link" href="EntangleApplication.html#entangle-application-get-supported-cameras" title="entangle_application_get_supported_cameras ()">entangle_application_get_supported_cameras</a>
                                                        (<em class="parameter"><code><a class="link" href="EntangleApplication.html" title="EntangleApplication"><span class="type">EntangleApplication</span></a> *application</code></em>);
<a class="link" href="EntanglePreferences.html" title="EntanglePreferences"><span class="returnvalue">EntanglePreferences</span></a> * <a class="link" href="EntangleApplication.html#entangle-application-get-preferences" title="entangle_application_get_preferences ()">entangle_application_get_preferences</a>
                                                        (<em class="parameter"><code><a class="link" href="EntangleApplication.html" title="EntangleApplication"><span class="type">EntangleApplication</span></a> *application</code></em>);
<a href="/usr/share/gtk-doc/html/libpeas/PeasEngine.html"><span class="returnvalue">PeasEngine</span></a> *        <a class="link" href="EntangleApplication.html#entangle-application-get-plugin-engine" title="entangle_application_get_plugin_engine ()">entangle_application_get_plugin_engine</a>
                                                        (<em class="parameter"><code><a class="link" href="EntangleApplication.html" title="EntangleApplication"><span class="type">EntangleApplication</span></a> *application</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="EntangleApplication.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 href="http://library.gnome.org/devel/gio/unstable/GApplication.html">GApplication</a>
         +----<a href="http://developer.gnome.org/gtk2/GtkApplication.html">GtkApplication</a>
               +----EntangleApplication
</pre>
</div>
<div class="refsect1">
<a name="EntangleApplication.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
EntangleApplication implements
 <a href="http://library.gnome.org/devel/gio/unstable/GActionGroup.html">GActionGroup</a> and  <a href="http://library.gnome.org/devel/gio/unstable/GActionMap.html">GActionMap</a>.</p>
</div>
<div class="refsect1">
<a name="EntangleApplication.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="EntangleApplication.html#EntangleApplication--active-cameras" title='The "active-cameras" property'>active-cameras</a>"           <a class="link" href="EntangleCameraList.html" title="EntangleCameraList"><span class="type">EntangleCameraList</span></a>*   : Read
  "<a class="link" href="EntangleApplication.html#EntangleApplication--preferences" title='The "preferences" property'>preferences</a>"              <a class="link" href="EntanglePreferences.html" title="EntanglePreferences"><span class="type">EntanglePreferences</span></a>*  : Read
  "<a class="link" href="EntangleApplication.html#EntangleApplication--supported-cameras" title='The "supported-cameras" property'>supported-cameras</a>"        <a class="link" href="EntangleCameraList.html" title="EntangleCameraList"><span class="type">EntangleCameraList</span></a>*   : Read
</pre>
</div>
<div class="refsect1">
<a name="EntangleApplication.description"></a><h2>Description</h2>
<p>
</p>
<p>
EntangleApplication maintains some global application state. At this time,
the list of currently attached cameras, the application preferences
and the plugin manager.
</p>
<p>
</p>
<p>
</p>
<p>
This class will normally be sub-classed when creating a Entangle based
application, typically in order to add in UI state.
</p>
<p>
</p>
</div>
<div class="refsect1">
<a name="EntangleApplication.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="EntangleApplication-struct"></a><h3>struct EntangleApplication</h3>
<pre class="programlisting">struct EntangleApplication;</pre>
</div>
<hr>
<div class="refsect2">
<a name="EntangleApplicationClass"></a><h3>struct EntangleApplicationClass</h3>
<pre class="programlisting">struct EntangleApplicationClass {
    GtkApplicationClass parent_class;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="entangle-application-new"></a><h3>entangle_application_new ()</h3>
<pre class="programlisting"><a class="link" href="EntangleApplication.html" title="EntangleApplication"><span class="returnvalue">EntangleApplication</span></a> * entangle_application_new          (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="entangle-application-get-active-cameras"></a><h3>entangle_application_get_active_cameras ()</h3>
<pre class="programlisting"><a class="link" href="EntangleCameraList.html" title="EntangleCameraList"><span class="returnvalue">EntangleCameraList</span></a> * entangle_application_get_active_cameras
                                                        (<em class="parameter"><code><a class="link" href="EntangleApplication.html" title="EntangleApplication"><span class="type">EntangleApplication</span></a> *application</code></em>);</pre>
<p>
Retrieve the active camera list
</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 camera list. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="entangle-application-get-supported-cameras"></a><h3>entangle_application_get_supported_cameras ()</h3>
<pre class="programlisting"><a class="link" href="EntangleCameraList.html" title="EntangleCameraList"><span class="returnvalue">EntangleCameraList</span></a> * entangle_application_get_supported_cameras
                                                        (<em class="parameter"><code><a class="link" href="EntangleApplication.html" title="EntangleApplication"><span class="type">EntangleApplication</span></a> *application</code></em>);</pre>
<p>
Retrieve the supported camera list
</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 camera list. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="entangle-application-get-preferences"></a><h3>entangle_application_get_preferences ()</h3>
<pre class="programlisting"><a class="link" href="EntanglePreferences.html" title="EntanglePreferences"><span class="returnvalue">EntanglePreferences</span></a> * entangle_application_get_preferences
                                                        (<em class="parameter"><code><a class="link" href="EntangleApplication.html" title="EntangleApplication"><span class="type">EntangleApplication</span></a> *application</code></em>);</pre>
<p>
Retrieve the application preferences object
</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 application preferences. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="entangle-application-get-plugin-engine"></a><h3>entangle_application_get_plugin_engine ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/libpeas/PeasEngine.html"><span class="returnvalue">PeasEngine</span></a> *        entangle_application_get_plugin_engine
                                                        (<em class="parameter"><code><a class="link" href="EntangleApplication.html" title="EntangleApplication"><span class="type">EntangleApplication</span></a> *application</code></em>);</pre>
<p>
Retrieve the plugin manager
</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 plugin engine. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="EntangleApplication.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="EntangleApplication--active-cameras"></a><h3>The <code class="literal">"active-cameras"</code> property</h3>
<pre class="programlisting">  "active-cameras"           <a class="link" href="EntangleCameraList.html" title="EntangleCameraList"><span class="type">EntangleCameraList</span></a>*   : Read</pre>
<p>List of active cameras.</p>
</div>
<hr>
<div class="refsect2">
<a name="EntangleApplication--preferences"></a><h3>The <code class="literal">"preferences"</code> property</h3>
<pre class="programlisting">  "preferences"              <a class="link" href="EntanglePreferences.html" title="EntanglePreferences"><span class="type">EntanglePreferences</span></a>*  : Read</pre>
<p>Application preferences.</p>
</div>
<hr>
<div class="refsect2">
<a name="EntangleApplication--supported-cameras"></a><h3>The <code class="literal">"supported-cameras"</code> property</h3>
<pre class="programlisting">  "supported-cameras"        <a class="link" href="EntangleCameraList.html" title="EntangleCameraList"><span class="type">EntangleCameraList</span></a>*   : Read</pre>
<p>List of supported cameras.</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.19</div>
</body>
</html>