qtmultimedia5-doc-html 5.2.1-0ubuntu5 / usr / share / qt5 / doc / qtmultimediawidgets / qvideowidget.html

This file is indexed.

/usr/share/qt5/doc/qtmultimediawidgets/qvideowidget.html is in qtmultimedia5-doc-html 5.2.1-0ubuntu5.

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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qvideowidget.cpp -->
  <title>QVideoWidget Class | QtMultimediaWidgets 5.2</title>
  <link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
    <div class="main">
    <div class="main-rounded">
        <div class="navigationbar">
        <ul>
<li>Qt 5.2</li>
<li><a href="qtmultimediawidgets-index.html">Qt Multimedia Widgets</a></li>
<li><a href="qtmultimediawidgets-module.html">C++ Classes</a></li>
<li>QVideoWidget</li>
<li id="buildversion">
Qt 5.2.1 Reference Documentation</li>
    </ul>
    </div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#public-slots">Public Slots</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QVideoWidget Class</h1>
<!-- $$$QVideoWidget-brief -->
<p>The QVideoWidget class provides a widget which presents video produced by a media object. <a href="#details">More...</a></p>
<!-- @@@QVideoWidget -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include &lt;QVideoWidget&gt;</span>
</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> <tt>QT += multimediawidgets</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qcameraviewfinder.html">QCameraViewfinder</a>.</p>
</td></tr></table><ul>
<li><a href="qvideowidget-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2>Properties</h2>
<table class="propsummary">
<tr><td class="topAlign"><ul>
<li class="fn"><b><a href="qvideowidget.html#aspectRatioMode-prop">aspectRatioMode</a></b> : Qt::AspectRatioMode</li>
<li class="fn"><b><a href="qvideowidget.html#brightness-prop">brightness</a></b> : int</li>
<li class="fn"><b><a href="qvideowidget.html#contrast-prop">contrast</a></b> : int</li>
<li class="fn"><b><a href="qvideowidget.html#fullScreen-prop">fullScreen</a></b> : bool</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><b><a href="qvideowidget.html#hue-prop">hue</a></b> : int</li>
<li class="fn"><b><a href="qvideowidget.html#mediaObject-prop">mediaObject</a></b> : QMediaObject * const</li>
<li class="fn"><b><a href="qvideowidget.html#saturation-prop">saturation</a></b> : int</li>
</ul>
</td></tr>
</table>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qvideowidget.html#QVideoWidget">QVideoWidget</a></b>(QWidget *<i> parent</i> = 0)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qvideowidget.html#dtor.QVideoWidget">~QVideoWidget</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt::AspectRatioMode </td><td class="memItemRight bottomAlign"><b><a href="qvideowidget.html#aspectRatioMode-prop">aspectRatioMode</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qvideowidget.html#brightness-prop">brightness</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qvideowidget.html#contrast-prop">contrast</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qvideowidget.html#hue-prop">hue</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qvideowidget.html#fullScreen-prop">isFullScreen</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMediaObject * </td><td class="memItemRight bottomAlign"><b><a href="qvideowidget.html#mediaObject-prop">mediaObject</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qvideowidget.html#saturation-prop">saturation</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QSize </td><td class="memItemRight bottomAlign"><b><a href="qvideowidget.html#sizeHint">sizeHint</a></b>() const</td></tr>
</table>
<a name="public-slots"></a>
<h2>Public Slots</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvideowidget.html#aspectRatioMode-prop">setAspectRatioMode</a></b>(Qt::AspectRatioMode<i> mode</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvideowidget.html#brightness-prop">setBrightness</a></b>(int<i> brightness</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvideowidget.html#contrast-prop">setContrast</a></b>(int<i> contrast</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvideowidget.html#fullScreen-prop">setFullScreen</a></b>(bool<i> fullScreen</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvideowidget.html#hue-prop">setHue</a></b>(int<i> hue</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvideowidget.html#saturation-prop">setSaturation</a></b>(int<i> saturation</i>)</td></tr>
</table>
<a name="signals"></a>
<h2>Signals</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvideowidget.html#brightness-prop">brightnessChanged</a></b>(int<i> brightness</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvideowidget.html#contrast-prop">contrastChanged</a></b>(int<i> contrast</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvideowidget.html#fullScreen-prop">fullScreenChanged</a></b>(bool<i> fullScreen</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvideowidget.html#hue-prop">hueChanged</a></b>(int<i> hue</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvideowidget.html#saturation-prop">saturationChanged</a></b>(int<i> saturation</i>)</td></tr>
</table>
<a name="protected-functions"></a>
<h2>Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qvideowidget.html#event">event</a></b>(QEvent *<i> event</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvideowidget.html#hideEvent">hideEvent</a></b>(QHideEvent *<i> event</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvideowidget.html#moveEvent">moveEvent</a></b>(QMoveEvent *<i> event</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvideowidget.html#paintEvent">paintEvent</a></b>(QPaintEvent *<i> event</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvideowidget.html#resizeEvent">resizeEvent</a></b>(QResizeEvent *<i> event</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvideowidget.html#showEvent">showEvent</a></b>(QShowEvent *<i> event</i>)</td></tr>
</table>
<a name="details"></a>
<!-- $$$QVideoWidget-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QVideoWidget class provides a widget which presents video produced by a media object.</p>
<p>Attaching a QVideoWidget to a QMediaObject allows it to display the video or image output of that media object. A QVideoWidget is attached to media object by passing a pointer to the QMediaObject in its constructor, and detached by destroying the QVideoWidget.</p>
<pre class="cpp"></pre>
<p><b>Note</b>: Only a single display output can be attached to a media object at one time.</p>
</div>
<p><b>See also </b>QMediaObject, QMediaPlayer, and <a href="qgraphicsvideoitem.html">QGraphicsVideoItem</a>.</p>
<!-- @@@QVideoWidget -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$aspectRatioMode-prop$$$aspectRatioMode$$$setAspectRatioModeQt::AspectRatioMode -->
<h3 class="fn"><a name="aspectRatioMode-prop"></a><span class="name">aspectRatioMode</span> : <span class="type">Qt::AspectRatioMode</span></h3>
<p>This property holds how video is scaled with respect to its aspect ratio.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> Qt::AspectRatioMode </td><td class="memItemRight bottomAlign"><span class="name"><b>aspectRatioMode</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setAspectRatioMode</b></span>(Qt::AspectRatioMode<i> mode</i>)</td></tr>
</table>
<!-- @@@aspectRatioMode -->
<!-- $$$brightness-prop$$$brightness$$$setBrightnessint$$$brightnessChangedint -->
<h3 class="fn"><a name="brightness-prop"></a><span class="name">brightness</span> : <span class="type">int</span></h3>
<p>This property holds an adjustment to the brightness of displayed video.</p>
<p>Valid brightness values range between -100 and 100, the default is 0.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>brightness</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setBrightness</b></span>(int<i> brightness</i>)</td></tr>
</table>
<p><b>Notifier signal:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>brightnessChanged</b></span>(int<i> brightness</i>)</td></tr>
</table>
<!-- @@@brightness -->
<!-- $$$contrast-prop$$$contrast$$$setContrastint$$$contrastChangedint -->
<h3 class="fn"><a name="contrast-prop"></a><span class="name">contrast</span> : <span class="type">int</span></h3>
<p>This property holds an adjustment to the contrast of displayed video.</p>
<p>Valid contrast values range between -100 and 100, the default is 0.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>contrast</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setContrast</b></span>(int<i> contrast</i>)</td></tr>
</table>
<p><b>Notifier signal:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>contrastChanged</b></span>(int<i> contrast</i>)</td></tr>
</table>
<!-- @@@contrast -->
<!-- $$$fullScreen-prop$$$isFullScreen$$$setFullScreenbool$$$fullScreenChangedbool -->
<h3 class="fn"><a name="fullScreen-prop"></a><span class="name">fullScreen</span> : <span class="type">bool</span></h3>
<p>This property holds whether video display is confined to a window or is fullScreen.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>isFullScreen</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setFullScreen</b></span>(bool<i> fullScreen</i>)</td></tr>
</table>
<p><b>Notifier signal:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>fullScreenChanged</b></span>(bool<i> fullScreen</i>)</td></tr>
</table>
<!-- @@@fullScreen -->
<!-- $$$hue-prop$$$hue$$$setHueint$$$hueChangedint -->
<h3 class="fn"><a name="hue-prop"></a><span class="name">hue</span> : <span class="type">int</span></h3>
<p>This property holds an adjustment to the hue of displayed video.</p>
<p>Valid hue values range between -100 and 100, the default is 0.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>hue</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setHue</b></span>(int<i> hue</i>)</td></tr>
</table>
<p><b>Notifier signal:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>hueChanged</b></span>(int<i> hue</i>)</td></tr>
</table>
<!-- @@@hue -->
<!-- $$$mediaObject-prop$$$mediaObject -->
<h3 class="fn"><a name="mediaObject-prop"></a><span class="name">mediaObject</span> : <span class="type">QMediaObject</span> * const</h3>
<p>This property holds the media object which provides the video displayed by a widget.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QMediaObject * </td><td class="memItemRight bottomAlign"><span class="name"><b>mediaObject</b></span>() const</td></tr>
</table>
<!-- @@@mediaObject -->
<!-- $$$saturation-prop$$$saturation$$$setSaturationint$$$saturationChangedint -->
<h3 class="fn"><a name="saturation-prop"></a><span class="name">saturation</span> : <span class="type">int</span></h3>
<p>This property holds an adjustment to the saturation of displayed video.</p>
<p>Valid saturation values range between -100 and 100, the default is 0.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>saturation</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setSaturation</b></span>(int<i> saturation</i>)</td></tr>
</table>
<p><b>Notifier signal:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>saturationChanged</b></span>(int<i> saturation</i>)</td></tr>
</table>
<!-- @@@saturation -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QVideoWidget[overload1]$$$QVideoWidgetQWidget* -->
<h3 class="fn"><a name="QVideoWidget"></a>QVideoWidget::<span class="name">QVideoWidget</span>(<span class="type">QWidget</span> *<i> parent</i> = 0)</h3>
<p>Constructs a new video widget.</p>
<p>The <i>parent</i> is passed to QWidget.</p>
<!-- @@@QVideoWidget -->
<!-- $$$~QVideoWidget[overload1]$$$~QVideoWidget -->
<h3 class="fn"><a name="dtor.QVideoWidget"></a>QVideoWidget::<span class="name">~QVideoWidget</span>()</h3>
<p>Destroys a video widget.</p>
<!-- @@@~QVideoWidget -->
<!-- $$$event[overload1]$$$eventQEvent* -->
<h3 class="fn"><a name="event"></a><span class="type">bool</span> QVideoWidget::<span class="name">event</span>(<span class="type">QEvent</span> *<i> event</i>)<tt> [protected]</tt></h3>
<p>Current event <i>event</i>. Returns the value of the baseclass QWidget::event(QEvent *event) function.</p>
<!-- @@@event -->
<!-- $$$hideEvent[overload1]$$$hideEventQHideEvent* -->
<h3 class="fn"><a name="hideEvent"></a><span class="type">void</span> QVideoWidget::<span class="name">hideEvent</span>(<span class="type">QHideEvent</span> *<i> event</i>)<tt> [protected]</tt></h3>
<p>Handles the hide <i>event</i>.</p>
<!-- @@@hideEvent -->
<!-- $$$moveEvent[overload1]$$$moveEventQMoveEvent* -->
<h3 class="fn"><a name="moveEvent"></a><span class="type">void</span> QVideoWidget::<span class="name">moveEvent</span>(<span class="type">QMoveEvent</span> *<i> event</i>)<tt> [protected]</tt></h3>
<p>Handles the move <i>event</i>.</p>
<!-- @@@moveEvent -->
<!-- $$$paintEvent[overload1]$$$paintEventQPaintEvent* -->
<h3 class="fn"><a name="paintEvent"></a><span class="type">void</span> QVideoWidget::<span class="name">paintEvent</span>(<span class="type">QPaintEvent</span> *<i> event</i>)<tt> [protected]</tt></h3>
<p>Handles the paint <i>event</i>.</p>
<!-- @@@paintEvent -->
<!-- $$$resizeEvent[overload1]$$$resizeEventQResizeEvent* -->
<h3 class="fn"><a name="resizeEvent"></a><span class="type">void</span> QVideoWidget::<span class="name">resizeEvent</span>(<span class="type">QResizeEvent</span> *<i> event</i>)<tt> [protected]</tt></h3>
<p>Handles the resize <i>event</i>.</p>
<!-- @@@resizeEvent -->
<!-- $$$showEvent[overload1]$$$showEventQShowEvent* -->
<h3 class="fn"><a name="showEvent"></a><span class="type">void</span> QVideoWidget::<span class="name">showEvent</span>(<span class="type">QShowEvent</span> *<i> event</i>)<tt> [protected]</tt></h3>
<p>Handles the show <i>event</i>.</p>
<!-- @@@showEvent -->
<!-- $$$sizeHint[overload1]$$$sizeHint -->
<h3 class="fn"><a name="sizeHint"></a><span class="type">QSize</span> QVideoWidget::<span class="name">sizeHint</span>() const</h3>
<p>Returns the size hint for the current back end, if there is one, or else the size hint from QWidget.</p>
<!-- @@@sizeHint -->
</div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2013 Digia Plc and/or its
   subsidiaries. Documentation contributions included herein are the copyrights of
   their respective owners.<br>    The documentation provided herein is licensed under the terms of the    <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation    License version 1.3</a> as published by the Free Software Foundation.<br>    Digia, Qt and their respective logos are trademarks of Digia Plc     in Finland and/or other countries worldwide. All other trademarks are property
   of their respective owners. </p>
</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.