/usr/share/qt5/doc/qtmultimedia/qcameraflashcontrol.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 | <?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" />
<!-- qcameraflashcontrol.cpp -->
<title>QCameraFlashControl Class | QtMultimedia 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="qtmultimedia-index.html">Qt Multimedia</a></li>
<li><a href="qtmultimedia-module.html">C++ Classes</a></li>
<li>QCameraFlashControl</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="#public-functions">Public Functions</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="#macros">Macros</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QCameraFlashControl Class</h1>
<!-- $$$QCameraFlashControl-brief -->
<p>The QCameraFlashControl class allows controlling a camera's flash. <a href="#details">More...</a></p>
<!-- @@@QCameraFlashControl -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <QCameraFlashControl></span>
</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> <tt>QT += multimedia</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qmediacontrol.html">QMediaControl</a>.</td></tr></table><ul>
<li><a href="qcameraflashcontrol-members.html">List of all members, including inherited members</a></li>
</ul>
<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="qcameraflashcontrol.html#dtor.QCameraFlashControl">~QCameraFlashControl</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QCameraExposure::FlashModes </td><td class="memItemRight bottomAlign"><b><a href="qcameraflashcontrol.html#flashMode">flashMode</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qcameraflashcontrol.html#isFlashModeSupported">isFlashModeSupported</a></b>(QCameraExposure::FlashModes<i> mode</i>) const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qcameraflashcontrol.html#isFlashReady">isFlashReady</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qcameraflashcontrol.html#setFlashMode">setFlashMode</a></b>(QCameraExposure::FlashModes<i> mode</i>) = 0</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="qcameraflashcontrol.html#flashReady">flashReady</a></b>(bool<i> ready</i>)</td></tr>
</table>
<a name="protected-functions"></a>
<h2>Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcameraflashcontrol.html#QCameraFlashControl">QCameraFlashControl</a></b>(QObject *<i> parent</i> = 0)</td></tr>
</table>
<a name="macros"></a>
<h2>Macros</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcameraflashcontrol.html#QCameraFlashControl_iid">QCameraFlashControl_iid</a></b></td></tr>
</table>
<a name="details"></a>
<!-- $$$QCameraFlashControl-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QCameraFlashControl class allows controlling a camera's flash.</p>
<p>You can set the type of flash effect used when an image is captured, and test to see if the flash hardware is ready to fire.</p>
<p>You can retrieve this control from the camera object in the usual way:</p>
<p>Some camera devices may not have flash hardware, or may not be configurable. In that case, there will be no QCameraFlashControl available.</p>
<p>The interface name of QCameraFlashControl is <tt>org.qt-project.qt.cameraflashcontrol/5.0</tt> as defined in <a href="qcameraflashcontrol.html#QCameraFlashControl_iid">QCameraFlashControl_iid</a>.</p>
</div>
<p><b>See also </b><a href="qcamera.html">QCamera</a>.</p>
<!-- @@@QCameraFlashControl -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QCameraFlashControl[overload1]$$$QCameraFlashControlQObject* -->
<h3 class="fn"><a name="QCameraFlashControl"></a>QCameraFlashControl::<span class="name">QCameraFlashControl</span>(<span class="type">QObject</span> *<i> parent</i> = 0)<tt> [protected]</tt></h3>
<p>Constructs a camera flash control object with <i>parent</i>.</p>
<!-- @@@QCameraFlashControl -->
<!-- $$$~QCameraFlashControl[overload1]$$$~QCameraFlashControl -->
<h3 class="fn"><a name="dtor.QCameraFlashControl"></a>QCameraFlashControl::<span class="name">~QCameraFlashControl</span>()</h3>
<p>Destroys the camera control object.</p>
<!-- @@@~QCameraFlashControl -->
<!-- $$$flashMode[overload1]$$$flashMode -->
<h3 class="fn"><a name="flashMode"></a><span class="type"><a href="qcameraexposure.html#FlashMode-enum">QCameraExposure::FlashModes</a></span> QCameraFlashControl::<span class="name">flashMode</span>() const<tt> [pure virtual]</tt></h3>
<p>Returns the current flash mode.</p>
<p><b>See also </b><a href="qcameraflashcontrol.html#setFlashMode">setFlashMode</a>().</p>
<!-- @@@flashMode -->
<!-- $$$flashReady[overload1]$$$flashReadybool -->
<h3 class="fn"><a name="flashReady"></a><span class="type">void</span> QCameraFlashControl::<span class="name">flashReady</span>(<span class="type">bool</span><i> ready</i>)<tt> [signal]</tt></h3>
<p>Signal emitted when flash state changes to <i>ready</i>.</p>
<!-- @@@flashReady -->
<!-- $$$isFlashModeSupported[overload1]$$$isFlashModeSupportedQCameraExposure::FlashModes -->
<h3 class="fn"><a name="isFlashModeSupported"></a><span class="type">bool</span> QCameraFlashControl::<span class="name">isFlashModeSupported</span>(<span class="type"><a href="qcameraexposure.html#FlashMode-enum">QCameraExposure::FlashModes</a></span><i> mode</i>) const<tt> [pure virtual]</tt></h3>
<p>Return true if the reqested flash <i>mode</i> is supported. Some <a href="qcameraexposure.html#FlashMode-enum">QCameraExposure::FlashMode</a> values can be combined, for example <a href="qcameraexposure.html#FlashMode-enum">QCameraExposure::FlashManual</a> | <a href="qcameraexposure.html#FlashMode-enum">QCameraExposure::FlashSlowSyncRearCurtain</a></p>
<!-- @@@isFlashModeSupported -->
<!-- $$$isFlashReady[overload1]$$$isFlashReady -->
<h3 class="fn"><a name="isFlashReady"></a><span class="type">bool</span> QCameraFlashControl::<span class="name">isFlashReady</span>() const<tt> [pure virtual]</tt></h3>
<p>Returns true if flash is charged.</p>
<!-- @@@isFlashReady -->
<!-- $$$setFlashMode[overload1]$$$setFlashModeQCameraExposure::FlashModes -->
<h3 class="fn"><a name="setFlashMode"></a><span class="type">void</span> QCameraFlashControl::<span class="name">setFlashMode</span>(<span class="type"><a href="qcameraexposure.html#FlashMode-enum">QCameraExposure::FlashModes</a></span><i> mode</i>)<tt> [pure virtual]</tt></h3>
<p>Set the current flash <i>mode</i>.</p>
<p>Usually a single <a href="qcameraexposure.html#FlashMode-enum">QCameraExposure::FlashMode</a> flag is used, but some non conflicting flags combination are also allowed, like <a href="qcameraexposure.html#FlashMode-enum">QCameraExposure::FlashManual</a> | <a href="qcameraexposure.html#FlashMode-enum">QCameraExposure::FlashSlowSyncRearCurtain</a>.</p>
<p><b>See also </b><a href="qcameraflashcontrol.html#flashMode">flashMode</a>().</p>
<!-- @@@setFlashMode -->
</div>
<div class="macros">
<h2>Macro Documentation</h2>
<!-- $$$QCameraFlashControl_iid[overload1]$$$QCameraFlashControl_iid -->
<h3 class="fn"><a name="QCameraFlashControl_iid"></a><span class="name">QCameraFlashControl_iid</span></h3>
<p><tt>org.qt-project.qt.cameraflashcontrol/5.0</tt></p>
<p>Defines the interface name of the <a href="qcameraflashcontrol.html">QCameraFlashControl</a> class.</p>
<!-- @@@QCameraFlashControl_iid -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</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>
|