~ubuntu-branches/debian/jessie/cheese/jessie

« back to all changes in this revision

Viewing changes to docs/reference/html/CheeseWidget.html

  • Committer: Bazaar Package Importer
  • Author(s): Michael Biebl
  • Date: 2010-05-04 17:37:18 UTC
  • mfrom: (1.1.13 upstream)
  • Revision ID: james.westby@ubuntu.com-20100504173718-k2rx3nryi4vd0xyx
Tags: 2.30.1-1
* New upstream release.
  - HAL dependency has been dropped. Use (g)udev for v4l capability probing
    on Linux. Closes: #573774
  - Split code into separate libraries.
* debian/control.in
  - Drop Build-Depends on libhal-dev.
  - Drop Build-Depends on libebook1.2-dev.
  - Bump Build-Depends on libgtk2.0-dev to (>= 2.19.1).
  - Bump Build-Depends on libgstreamer*-dev to (>= 0.10.23).
  - Add Build-Depends on libcanberra-gtk-dev.
  - Add Build-Depends on libxtst-dev.
  - Add Build-Depends on libgudev-1.0-dev on Linux.
  - Bump Standards-Version to 3.8.4. No further changes.
* Switch to source format 3.0 (quilt)
  - Add debian/source/format.
* debian/rules
  - Drop lpia specific configure flags, lpia is dead.
* Update package layout (based on work by Ubuntu)
  - Move data files into new cheese-common package.
  - Keep binary along with its desktop and dbus service file in the cheese
    package.
  - Add libcheese-gtk18 and libcheese-gtk-dev package for the new
    libcheese-gtk library. Use a symbols file for improved shlibs
    dependencies.
  - Add Conflicts/Replaces to cheese-common to ensure proper upgrades from
    previous versions.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>CheeseWidget</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
7
<link rel="home" href="index.html" title="cheese Reference Manual">
 
8
<link rel="up" href="ch01.html" title="[Insert title here]">
 
9
<link rel="prev" href="CheeseCameraDeviceMonitor.html" title="CheeseCameraDeviceMonitor">
 
10
<link rel="next" href="object-tree.html" title="Object Hierarchy">
 
11
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="CheeseCameraDeviceMonitor.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">cheese Reference Manual</th>
 
21
<td><a accesskey="n" href="object-tree.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#CheeseWidget.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#CheeseWidget.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#CheeseWidget.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
                   | 
 
30
                  <a href="#CheeseWidget.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 
31
                   | 
 
32
                  <a href="#CheeseWidget.properties" class="shortcut">Properties</a>
 
33
</td></tr>
 
34
</table>
 
35
<div class="refentry" title="CheeseWidget">
 
36
<a name="CheeseWidget"></a><div class="titlepage"></div>
 
37
<div class="refnamediv"><table width="100%"><tr>
 
38
<td valign="top">
 
39
<h2><span class="refentrytitle"><a name="CheeseWidget.top_of_page"></a>CheeseWidget</span></h2>
 
40
<p>CheeseWidget</p>
 
41
</td>
 
42
<td valign="top" align="right"></td>
 
43
</tr></table></div>
 
44
<div class="refsynopsisdiv" title="Synopsis">
 
45
<a name="CheeseWidget.synopsis"></a><h2>Synopsis</h2>
 
46
<pre class="synopsis">                    <a class="link" href="CheeseWidget.html#CheeseWidgetClass" title="CheeseWidgetClass">CheeseWidgetClass</a>;
 
47
                    <a class="link" href="CheeseWidget.html#CheeseWidget-struct" title="CheeseWidget">CheeseWidget</a>;
 
48
<a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="CheeseWidget.html#cheese-widget-new" title="cheese_widget_new ()">cheese_widget_new</a>                   (<em class="parameter"><code><span class="type">void</span></code></em>);
 
49
<span class="returnvalue">void</span>                <a class="link" href="CheeseWidget.html#cheese-widget-get-error" title="cheese_widget_get_error ()">cheese_widget_get_error</a>             (<em class="parameter"><code><a class="link" href="CheeseWidget.html" title="CheeseWidget"><span class="type">CheeseWidget</span></a> *widget</code></em>,
 
50
                                                         <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>);
 
51
enum                <a class="link" href="CheeseWidget.html#CheeseWidgetState" title="enum CheeseWidgetState">CheeseWidgetState</a>;
 
52
</pre>
 
53
</div>
 
54
<div class="refsect1" title="Object Hierarchy">
 
55
<a name="CheeseWidget.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
56
<pre class="synopsis">
 
57
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
58
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
 
59
         +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkObject.html">GtkObject</a>
 
60
               +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html">GtkWidget</a>
 
61
                     +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkContainer.html">GtkContainer</a>
 
62
                           +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkNotebook.html">GtkNotebook</a>
 
63
                                 +----CheeseWidget
 
64
</pre>
 
65
</div>
 
66
<div class="refsect1" title="Implemented Interfaces">
 
67
<a name="CheeseWidget.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
 
68
<p>
 
69
CheeseWidget implements
 
70
 AtkImplementorIface and  <a href="http://library.gnome.org/devel/gtk/unstable/gtk-gtkbuildable.html#GtkBuildable">GtkBuildable</a>.</p>
 
71
</div>
 
72
<div class="refsect1" title="Properties">
 
73
<a name="CheeseWidget.properties"></a><h2>Properties</h2>
 
74
<pre class="synopsis">
 
75
  "<a class="link" href="CheeseWidget.html#CheeseWidget--state" title='The "state" property'>state</a>"                    <a class="link" href="CheeseWidget.html#CheeseWidgetState" title="enum CheeseWidgetState"><span class="type">CheeseWidgetState</span></a>     : Read
 
76
</pre>
 
77
</div>
 
78
<div class="refsect1" title="Description">
 
79
<a name="CheeseWidget.description"></a><h2>Description</h2>
 
80
<p>
 
81
</p>
 
82
</div>
 
83
<div class="refsect1" title="Details">
 
84
<a name="CheeseWidget.details"></a><h2>Details</h2>
 
85
<div class="refsect2" title="CheeseWidgetClass">
 
86
<a name="CheeseWidgetClass"></a><h3>CheeseWidgetClass</h3>
 
87
<pre class="programlisting">typedef struct {
 
88
  GtkNotebookClass parent_class;
 
89
} CheeseWidgetClass;
 
90
</pre>
 
91
<p>
 
92
</p>
 
93
</div>
 
94
<hr>
 
95
<div class="refsect2" title="CheeseWidget">
 
96
<a name="CheeseWidget-struct"></a><h3>CheeseWidget</h3>
 
97
<pre class="programlisting">typedef struct _CheeseWidget CheeseWidget;</pre>
 
98
<p>
 
99
</p>
 
100
</div>
 
101
<hr>
 
102
<div class="refsect2" title="cheese_widget_new ()">
 
103
<a name="cheese-widget-new"></a><h3>cheese_widget_new ()</h3>
 
104
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         cheese_widget_new                   (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
105
<p>
 
106
Returns a new <a class="link" href="CheeseWidget.html" title="CheeseWidget"><span class="type">CheeseWidget</span></a> widget.
 
107
</p>
 
108
<div class="variablelist"><table border="0">
 
109
<col align="left" valign="top">
 
110
<tbody><tr>
 
111
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
112
<td> a <a class="link" href="CheeseWidget.html" title="CheeseWidget"><span class="type">CheeseWidget</span></a> widget.
 
113
</td>
 
114
</tr></tbody>
 
115
</table></div>
 
116
</div>
 
117
<hr>
 
118
<div class="refsect2" title="cheese_widget_get_error ()">
 
119
<a name="cheese-widget-get-error"></a><h3>cheese_widget_get_error ()</h3>
 
120
<pre class="programlisting"><span class="returnvalue">void</span>                cheese_widget_get_error             (<em class="parameter"><code><a class="link" href="CheeseWidget.html" title="CheeseWidget"><span class="type">CheeseWidget</span></a> *widget</code></em>,
 
121
                                                         <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>
 
122
<p>
 
123
Listen for notify::state signals and call this when the current state is <a class="link" href="CheeseWidget.html#CHEESE-WIDGET-STATE-ERROR:CAPS"><code class="literal">CHEESE_WIDGET_STATE_ERROR</code></a>.
 
124
</p>
 
125
<p>
 
126
The returned <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> will contain more details on what went wrong.
 
127
</p>
 
128
<div class="variablelist"><table border="0">
 
129
<col align="left" valign="top">
 
130
<tbody>
 
131
<tr>
 
132
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
 
133
<td>a <a class="link" href="CheeseWidget.html" title="CheeseWidget"><span class="type">CheeseWidget</span></a>
 
134
</td>
 
135
</tr>
 
136
<tr>
 
137
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
138
<td>return location for the error
 
139
</td>
 
140
</tr>
 
141
</tbody>
 
142
</table></div>
 
143
</div>
 
144
<hr>
 
145
<div class="refsect2" title="enum CheeseWidgetState">
 
146
<a name="CheeseWidgetState"></a><h3>enum CheeseWidgetState</h3>
 
147
<pre class="programlisting">typedef enum
 
148
{
 
149
  CHEESE_WIDGET_STATE_NONE,
 
150
  CHEESE_WIDGET_STATE_READY,
 
151
  CHEESE_WIDGET_STATE_ERROR
 
152
} CheeseWidgetState;
 
153
</pre>
 
154
<p>
 
155
Current <a class="link" href="CheeseWidget.html" title="CheeseWidget"><span class="type">CheeseWidget</span></a> state.
 
156
</p>
 
157
<div class="variablelist"><table border="0">
 
158
<col align="left" valign="top">
 
159
<tbody>
 
160
<tr>
 
161
<td><p><a name="CHEESE-WIDGET-STATE-NONE:CAPS"></a><span class="term"><code class="literal">CHEESE_WIDGET_STATE_NONE</code></span></p></td>
 
162
<td>Default state, camera uninitialized
 
163
</td>
 
164
</tr>
 
165
<tr>
 
166
<td><p><a name="CHEESE-WIDGET-STATE-READY:CAPS"></a><span class="term"><code class="literal">CHEESE_WIDGET_STATE_READY</code></span></p></td>
 
167
<td>The camera should be ready and the widget should be displaying the preview
 
168
</td>
 
169
</tr>
 
170
<tr>
 
171
<td><p><a name="CHEESE-WIDGET-STATE-ERROR:CAPS"></a><span class="term"><code class="literal">CHEESE_WIDGET_STATE_ERROR</code></span></p></td>
 
172
<td>An error occurred while setting up the camera, check what went wrong with <a class="link" href="CheeseWidget.html#cheese-widget-get-error" title="cheese_widget_get_error ()"><code class="function">cheese_widget_get_error()</code></a>
 
173
</td>
 
174
</tr>
 
175
</tbody>
 
176
</table></div>
 
177
</div>
 
178
</div>
 
179
<div class="refsect1" title="Property Details">
 
180
<a name="CheeseWidget.property-details"></a><h2>Property Details</h2>
 
181
<div class="refsect2" title='The "state" property'>
 
182
<a name="CheeseWidget--state"></a><h3>The <code class="literal">"state"</code> property</h3>
 
183
<pre class="programlisting">  "state"                    <a class="link" href="CheeseWidget.html#CheeseWidgetState" title="enum CheeseWidgetState"><span class="type">CheeseWidgetState</span></a>     : Read</pre>
 
184
<p>
 
185
Current state of the widget.
 
186
</p>
 
187
<p>
 
188
Connect to notify::state signal to get notified about state
 
189
changes. Useful to update other widgets sensitiveness when the
 
190
camera is ready or to handle errors if camera setup fails.
 
191
</p>
 
192
<p>Default value: CHEESE_WIDGET_STATE_NONE</p>
 
193
</div>
 
194
</div>
 
195
</div>
 
196
<div class="footer">
 
197
<hr>
 
198
          Generated by GTK-Doc V1.14</div>
 
199
</body>
 
200
</html>
 
 
b'\\ No newline at end of file'