/usr/share/qt5/doc/qtqml/qqmlimageproviderbase.html is in qtdeclarative5-doc-html 5.5.1-2ubuntu6.
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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qqmlengine.cpp -->
<title>QQmlImageProviderBase Class | Qt QML 5.5</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.5</li>
<li><a href="qtqml-index.html">Qt QML</a></li>
<li><a href="qtqml-module.html">C++ Classes</a></li>
<li>QQmlImageProviderBase</li>
<li id="buildversion">Qt 5.5.1 Reference Documentation</li>
</ul>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QQmlImageProviderBase Class</h1>
<!-- $$$QQmlImageProviderBase-brief -->
<p>The <a href="qqmlimageproviderbase.html">QQmlImageProviderBase</a> class is used to register image providers in the QML engine. <a href="#details">More...</a></p>
<!-- @@@QQmlImageProviderBase -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QQmlImageProviderBase></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += qml</td></tr></table></div><ul>
<li><a href="qqmlimageproviderbase-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2 id="public-types">Public Types</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qqmlimageproviderbase.html#Flag-enum">Flag</a></b> { ForceAsynchronousImageLoading }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> flags </td><td class="memItemRight bottomAlign"><b><a href="qqmlimageproviderbase.html#Flag-enum">Flags</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qqmlimageproviderbase.html#ImageType-enum">ImageType</a></b> { Image, Pixmap, Texture, ImageResponse }</td></tr>
</table></div>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual Flags </td><td class="memItemRight bottomAlign"><b><a href="qqmlimageproviderbase.html#flags">flags</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual ImageType </td><td class="memItemRight bottomAlign"><b><a href="qqmlimageproviderbase.html#imageType">imageType</a></b>() const = 0</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QQmlImageProviderBase-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qqmlimageproviderbase.html">QQmlImageProviderBase</a> class is used to register image providers in the QML engine.</p>
<p>Image providers must be registered with the QML engine. The only information the QML engine knows about image providers is the type of image data they provide. To use an image provider to acquire image data, you must cast the <a href="qqmlimageproviderbase.html">QQmlImageProviderBase</a> pointer to a QQuickImageProvider pointer.</p>
</div>
<p><b>See also </b>QQuickImageProvider and QQuickTextureFactory.</p>
<!-- @@@QQmlImageProviderBase -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$Flag$$$ForceAsynchronousImageLoading -->
<h3 class="flags" id="Flag-enum"><a name="Flag-enum"></a>enum QQmlImageProviderBase::<span class="name">Flag</span><br/>flags QQmlImageProviderBase::<span class="name">Flags</span></h3>
<p>Defines specific requirements or features of this image provider.</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QQmlImageProviderBase::ForceAsynchronousImageLoading</code></td><td class="topAlign"><code>0x01</code></td><td class="topAlign">Ensures that image requests to the provider are run in a separate thread, which allows the provider to spend as much time as needed on producing the image without blocking the main thread.</td></tr>
</table></div>
<p>The Flags type is a typedef for <a href="">QFlags</a><Flag>. It stores an OR combination of Flag values.</p>
<!-- @@@Flag -->
<!-- $$$ImageType$$$Image$$$Pixmap$$$Texture$$$Invalid$$$ImageResponse -->
<h3 class="fn" id="ImageType-enum"><a name="ImageType-enum"></a>enum QQmlImageProviderBase::<span class="name">ImageType</span></h3>
<p>Defines the type of image supported by this image provider.</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QQmlImageProviderBase::Image</code></td><td class="topAlign"><code>0</code></td><td class="topAlign">The Image Provider provides QImage images. The QQuickImageProvider::requestImage() method will be called for all image requests.</td></tr>
<tr><td class="topAlign"><code>QQmlImageProviderBase::Pixmap</code></td><td class="topAlign"><code>1</code></td><td class="topAlign">The Image Provider provides QPixmap images. The QQuickImageProvider::requestPixmap() method will be called for all image requests.</td></tr>
<tr><td class="topAlign"><code>QQmlImageProviderBase::Texture</code></td><td class="topAlign"><code>2</code></td><td class="topAlign">The Image Provider provides QSGTextureProvider based images. The QQuickImageProvider::requestTexture() method will be called for all image requests.</td></tr>
<tr><td class="topAlign"><code>QQmlImageProviderBase::ImageResponse</code></td><td class="topAlign"><code>4</code></td><td class="topAlign">The Image provider provides QQuickTextureFactory based images. Should only be used in QQuickAsyncImageProvider or its subclasses. The QQuickAsyncImageProvider::requestImageResponse() method will be called for all image requests. Since Qt 5.6</td></tr>
</table></div>
<!-- @@@ImageType -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$flags[overload1]$$$flags -->
<h3 class="fn" id="flags"><a name="flags"></a><code>[pure virtual] </code><span class="type"><a href="qqmlimageproviderbase.html#Flag-enum">Flags</a></span> QQmlImageProviderBase::<span class="name">flags</span>() const</h3>
<p>Implement this to return the properties of this image provider.</p>
<!-- @@@flags -->
<!-- $$$imageType[overload1]$$$imageType -->
<h3 class="fn" id="imageType"><a name="imageType"></a><code>[pure virtual] </code><span class="type"><a href="qqmlimageproviderbase.html#ImageType-enum">ImageType</a></span> QQmlImageProviderBase::<span class="name">imageType</span>() const</h3>
<p>Implement this method to return the image type supported by this image provider.</p>
<!-- @@@imageType -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd.
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> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|