<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.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" />
<!-- qorganizeritemfetchhint.cpp -->
<title>Qt Mobility 1.2: QOrganizerItemFetchHint Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="content">
<a href="index.html" class="qtref"><span>QtMobility Reference Documentation</span></a>
</div>
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtorganizer.html">QtOrganizer</a></li>
<li>QOrganizerItemFetchHint</li>
</ul>
</div>
</div>
<div class="content mainContent">
<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>
<h1 class="title">QOrganizerItemFetchHint Class Reference</h1>
<!-- $$$QOrganizerItemFetchHint-brief -->
<p>The QOrganizerItemFetchHint class provides hints to the manager about which organizer item information needs to be retrieved in an asynchronous fetch request or a synchronous function call. <a href="#details">More...</a></p>
<!-- @@@QOrganizerItemFetchHint -->
<pre class="cpp"> <span class="preprocessor">#include <QOrganizerItemFetchHint></span></pre><p>This class was introduced in Qt Mobility 1.1.</p>
<ul>
<li><a href="qorganizeritemfetchhint-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemfetchhint.html#OptimizationHint-enum">OptimizationHint</a></b> { AllRequired, NoBinaryBlobs }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> flags </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemfetchhint.html#OptimizationHint-enum">OptimizationHints</a></b></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="qorganizeritemfetchhint.html#QOrganizerItemFetchHint">QOrganizerItemFetchHint</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemfetchhint.html#QOrganizerItemFetchHint-2">QOrganizerItemFetchHint</a></b> ( const QOrganizerItemFetchHint & <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemfetchhint.html#dtor.QOrganizerItemFetchHint">~QOrganizerItemFetchHint</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QStringList </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemfetchhint.html#detailDefinitionsHint">detailDefinitionsHint</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> OptimizationHints </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemfetchhint.html#optimizationHints">optimizationHints</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemfetchhint.html#setDetailDefinitionsHint">setDetailDefinitionsHint</a></b> ( const QStringList & <i>definitionNames</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemfetchhint.html#setOptimizationHints">setOptimizationHints</a></b> ( OptimizationHints <i>hints</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QOrganizerItemFetchHint & </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemfetchhint.html#operator-eq">operator=</a></b> ( const QOrganizerItemFetchHint & <i>other</i> )</td></tr>
</table>
<a name="details"></a>
<!-- $$$QOrganizerItemFetchHint-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QOrganizerItemFetchHint class provides hints to the manager about which organizer item information needs to be retrieved in an asynchronous fetch request or a synchronous function call.</p>
<p>All of the hints may be ignored at the discretion of the manager, however if a manager is able to optimize retrieval of organizer items due to hints, it may do so. If a manager ignores a hint, it must retrieve the full set of data that the hint refers to.</p>
<p>The fetch hint contains:</p>
<ul>
<li>a list of detail definition names which the client is interested in (empty if interested in all detail definitions)</li>
<li>some optimization flags which allow the client to tell the backend if they are not interested in binary blobs (images etc).</li>
</ul>
<p>Important note: a client should not make changes to an organizer item which has been retrieved using a fetch hint other than the default fetch hint. Doing so will result in information loss when saving the organizer item back to the manager (as the "new" restricted organizer item will replace the previously saved organizer item in the backend).</p>
</div>
<!-- @@@QOrganizerItemFetchHint -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$OptimizationHint$$$AllRequired$$$NoActionPreferences$$$NoBinaryBlobs -->
<h3 class="flags"><a name="OptimizationHint-enum"></a>enum QOrganizerItemFetchHint::<span class="name">OptimizationHint</span><br/>flags QOrganizerItemFetchHint::<span class="name">OptimizationHints</span></h3>
<p>This enum defines flags which may be set to inform the backend that the client does not require certain information. The backend may safely ignore the hint, but then must return the full set of information relating to the optimization hint.</p>
<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"><tt>QOrganizerItemFetchHint::AllRequired</tt></td><td class="topAlign"><tt>0x0</tt></td><td class="topAlign">Tells the backend that all information is required Tells the backend that the client does not require retrieved organizer items to include a cache of action preferences</td></tr>
<tr><td class="topAlign"><tt>QOrganizerItemFetchHint::NoBinaryBlobs</tt></td><td class="topAlign"><tt>0x4</tt></td><td class="topAlign">Tells the backend that the client does not require retrieved organizer items to include binary blobs such as thumbnail images</td></tr>
</table>
<p>The OptimizationHints type is a typedef for <a href="qflags.html">QFlags</a><OptimizationHint>. It stores an OR combination of OptimizationHint values.</p>
<!-- @@@OptimizationHint -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QOrganizerItemFetchHint[overload1]$$$QOrganizerItemFetchHint -->
<h3 class="fn"><a name="QOrganizerItemFetchHint"></a>QOrganizerItemFetchHint::<span class="name">QOrganizerItemFetchHint</span> ()</h3>
<p>Constructs a new organizer item fetch hint which requests that the backend fetch all information</p>
<!-- @@@QOrganizerItemFetchHint -->
<!-- $$$QOrganizerItemFetchHint$$$QOrganizerItemFetchHintconstQOrganizerItemFetchHint& -->
<h3 class="fn"><a name="QOrganizerItemFetchHint-2"></a>QOrganizerItemFetchHint::<span class="name">QOrganizerItemFetchHint</span> ( const <span class="type">QOrganizerItemFetchHint</span> & <i>other</i> )</h3>
<p>Constructs a new organizer item fetch hint as a copy of <i>other</i></p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@QOrganizerItemFetchHint -->
<!-- $$$~QOrganizerItemFetchHint[overload1]$$$~QOrganizerItemFetchHint -->
<h3 class="fn"><a name="dtor.QOrganizerItemFetchHint"></a>QOrganizerItemFetchHint::<span class="name">~QOrganizerItemFetchHint</span> ()</h3>
<p>Frees any memory in use by the fetch hint</p>
<!-- @@@~QOrganizerItemFetchHint -->
<!-- $$$detailDefinitionsHint[overload1]$$$detailDefinitionsHint -->
<h3 class="fn"><a name="detailDefinitionsHint"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstringlist.html">QStringList</a></span> QOrganizerItemFetchHint::<span class="name">detailDefinitionsHint</span> () const</h3>
<p>Returns the list of definition names that identify detail definitions of which details the manager should (at a minimum) retrieve when fetching organizer items. This hint may be ignored by the backend, in which case it will return the full set of details for each organizer item retrieved.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qorganizeritemfetchhint.html#setDetailDefinitionsHint">setDetailDefinitionsHint</a>().</p>
<!-- @@@detailDefinitionsHint -->
<!-- $$$optimizationHints[overload1]$$$optimizationHints -->
<h3 class="fn"><a name="optimizationHints"></a><span class="type"><a href="qorganizeritemfetchhint.html#OptimizationHint-enum">OptimizationHints</a></span> QOrganizerItemFetchHint::<span class="name">optimizationHints</span> () const</h3>
<p>Returns the optimization hint flags specified by the client. These hints may be ignored by the backend, in which case it will return the full set of information accessible in an organizer item.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qorganizeritemfetchhint.html#setOptimizationHints">setOptimizationHints</a>().</p>
<!-- @@@optimizationHints -->
<!-- $$$setDetailDefinitionsHint[overload1]$$$setDetailDefinitionsHintconstQStringList& -->
<h3 class="fn"><a name="setDetailDefinitionsHint"></a><span class="type">void</span> QOrganizerItemFetchHint::<span class="name">setDetailDefinitionsHint</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstringlist.html">QStringList</a></span> & <i>definitionNames</i> )</h3>
<p>Sets the list of definition names that identify detail definitions of which details the manager should (at a minimum) retrieve when fetching organizer items to <i>definitionNames</i>. This hint may be ignored by the backend, in which case it will return the full set of details for each organizer item retrieved.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qorganizeritemfetchhint.html#detailDefinitionsHint">detailDefinitionsHint</a>().</p>
<!-- @@@setDetailDefinitionsHint -->
<!-- $$$setOptimizationHints[overload1]$$$setOptimizationHintsOptimizationHints -->
<h3 class="fn"><a name="setOptimizationHints"></a><span class="type">void</span> QOrganizerItemFetchHint::<span class="name">setOptimizationHints</span> ( <span class="type"><a href="qorganizeritemfetchhint.html#OptimizationHint-enum">OptimizationHints</a></span> <i>hints</i> )</h3>
<p>Sets the optimization hint flags specified by the client to <i>hints</i>. These hints may be ignored by the backend, in which case it will return the full set of information accessible in an organizer item.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qorganizeritemfetchhint.html#optimizationHints">optimizationHints</a>().</p>
<!-- @@@setOptimizationHints -->
<!-- $$$operator=[overload1]$$$operator=constQOrganizerItemFetchHint& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QOrganizerItemFetchHint</span> & QOrganizerItemFetchHint::<span class="name">operator=</span> ( const <span class="type">QOrganizerItemFetchHint</span> & <i>other</i> )</h3>
<p>Assigns this fetch hint to be equal to the <i>other</i> fetch hint</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@operator= -->
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2008-2011 Nokia Corporation and/or its
subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation
in Finland and/or other countries worldwide.</p>
<p>
All other trademarks are property of their respective owners. <a title="Privacy Policy"
href="http://qt.nokia.com/about/privacy-policy">Privacy Policy</a></p>
<br />
<p>
Licensees holding valid Qt Commercial licenses may use this document in accordance with the Qt Commercial License Agreement provided with the Software or, alternatively, in accordance with the terms contained in a written agreement between you and Nokia.</p>
<p>
Alternatively, this document may be used 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.</p>
</div>
</body>
</html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
50facae208d4a6f280e44a513b104320
>
files
>
1574
