/usr/share/qt5/doc/qtcontacts/contactsclasses.html is in qtpim5-doc-html 5.0~git20140515~29475884-0ubuntu20.
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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- contactsclasses.qdoc -->
<title>Qt Contacts C++ API | Qt 5.0 </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.0</li>
<li>Qt Contacts C++ API</li>
<li id="buildversion">Qt 5.0.0 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="#main-classes">Main Classes</a></li>
<li class="level1"><a href="#contact-details-leaf-classes">Contact Details Leaf Classes</a></li>
<li class="level1"><a href="#asynchronous-requests">Asynchronous Requests</a></li>
<li class="level1"><a href="#contact-selection">Contact Selection</a></li>
<li class="level1"><a href="#actions">Actions</a></li>
<li class="level1"><a href="#backends">Backends</a></li>
<li class="level1"><a href="#synchronization-and-serialization">Synchronization and Serialization</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Qt Contacts C++ API</h1>
<span class="subtitle"></span>
<!-- $$$contactsclasses.html-description -->
<div class="descr"> <a name="details"></a>
<a name="main-classes"></a>
<h2 id="main-classes">Main Classes</h2>
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="qcontact.html">QContact</a></p></td><td class="tblDescr"><p>Represents an addressbook contact</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qcontactabstractrequest.html">QContactAbstractRequest</a></p></td><td class="tblDescr"><p>Mechanism for asynchronous requests to be made of a manager if it supports them</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qcontactaction.html">QContactAction</a></p></td><td class="tblDescr"><p>Interface for performing an action on a QContact or QContactDetail</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qcontactdetail.html">QContactDetail</a></p></td><td class="tblDescr"><p>Represents a single, complete detail about a contact</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qcontactfilter.html">QContactFilter</a></p></td><td class="tblDescr"><p>Used to select contacts made available through a QContactManager</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qcontactmanager.html">QContactManager</a></p></td><td class="tblDescr"><p>Interface which allows clients with access to contact information stored in a particular backend</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qcontactobserver.html">QContactObserver</a></p></td><td class="tblDescr"><p>Simple class that emits a signal when a single particular contact is updated or deleted</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qcontactrelationship.html">QContactRelationship</a></p></td><td class="tblDescr"><p>Describes a one-to-one relationship between a locally-stored contact and another (possibly remote) contact</p></td></tr>
</table></div>
<a name="contact-details-leaf-classes"></a>
<h2 id="contact-details-leaf-classes">Contact Details Leaf Classes</h2>
<p>Several subclasses of <a href="qcontactdetail.html">QContactDetail</a> are provided as part of the Qt Contacts API. They are general in design but are intended to fulfill specific use-cases. Please note that certain backends may choose not to support one or more of these subclasses as they appear here; they may offer their own which provide similar functionality.</p>
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="qcontactaddress.html">QContactAddress</a></p></td><td class="tblDescr"><p>Contains an address of a contact</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qcontactdisplaylabel.html">QContactDisplayLabel</a></p></td><td class="tblDescr"><p>Contains a displayLabel of a contact</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qcontactemailaddress.html">QContactEmailAddress</a></p></td><td class="tblDescr"><p>Contains an email address of a contact</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qcontactfavorite.html">QContactFavorite</a></p></td><td class="tblDescr"><p>Indicates if a contact is a favorite contact as well as the position it should appear in an ordered list of favorites</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qcontactglobalpresence.html">QContactGlobalPresence</a></p></td><td class="tblDescr"><p>Aggregated presence information for a contact, synthesized or supplied by the backend</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qcontactname.html">QContactName</a></p></td><td class="tblDescr"><p>Contains a name of a contact</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qcontactphonenumber.html">QContactPhoneNumber</a></p></td><td class="tblDescr"><p>Phone number of a contact</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qcontacttag.html">QContactTag</a></p></td><td class="tblDescr"><p>Contains a tag associated with a contact</p></td></tr>
</table></div>
<p>Each of these subclasses provide access to information stored in fields which may have certain constraints, documented in each subclass documentation.</p>
<a name="asynchronous-requests"></a>
<h2 id="asynchronous-requests">Asynchronous Requests</h2>
<p>Clients may use either the <a href="contactssync.html">synchronous</a> or <a href="contactsasync.html">asynchronous</a> API to access functionality provided by a manager backend. The Qt Contacts Asynchronous API is offered through subclasses of the <a href="qcontactabstractrequest.html">QContactAbstractRequest</a> class:</p>
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="qcontactfetchbyidrequest.html">QContactFetchByIdRequest</a></p></td><td class="tblDescr"><p>Allows a client to asynchronously request contacts from a contacts store manager, given a list of contact IDs</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qcontactfetchrequest.html">QContactFetchRequest</a></p></td><td class="tblDescr"><p>Allows a client to asynchronously request contacts from a contacts store manager</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qcontactidfetchrequest.html">QContactIdFetchRequest</a></p></td><td class="tblDescr"><p>Allows a client to asynchronously request a list of contact ids from a contacts store manager</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qcontactrelationshipfetchrequest.html">QContactRelationshipFetchRequest</a></p></td><td class="tblDescr"><p>Allows a client to asynchronously request relationships from a contacts store manager</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qcontactrelationshipremoverequest.html">QContactRelationshipRemoveRequest</a></p></td><td class="tblDescr"><p>Allows a client to asynchronously request that certain relationships be removed from a contacts store</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qcontactrelationshipsaverequest.html">QContactRelationshipSaveRequest</a></p></td><td class="tblDescr"><p>Allows a client to asynchronously request that certain groups be saved to a contacts store</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qcontactremoverequest.html">QContactRemoveRequest</a></p></td><td class="tblDescr"><p>Allows a client to asynchronously request that certain contacts be removed from a contacts store</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qcontactsaverequest.html">QContactSaveRequest</a></p></td><td class="tblDescr"><p>Allows a client to asynchronously request that certain contacts be saved to a contacts store</p></td></tr>
</table></div>
<a name="contact-selection"></a>
<h2 id="contact-selection">Contact Selection</h2>
<p>Clients may select a contact by specifying a unique contact id, or by supplying a <a href="qcontactfilter.html">QContactFilter</a> which matches the contact or contacts they wish to select. The various derivatives of <a href="qcontactfilter.html">QContactFilter</a> allow for fine-grained and flexible selection of contacts according to various criteria:</p>
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="qcontactactionfilter.html">QContactActionFilter</a></p></td><td class="tblDescr"><p>Filter based around an action availability criterion</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qcontactchangelogfilter.html">QContactChangeLogFilter</a></p></td><td class="tblDescr"><p>Filter based around a contact timestamp criterion</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qcontactdetailfilter.html">QContactDetailFilter</a></p></td><td class="tblDescr"><p>Filter based around a detail value criterion</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qcontactdetailrangefilter.html">QContactDetailRangeFilter</a></p></td><td class="tblDescr"><p>Filter based around a detail value range criterion</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qcontactidfilter.html">QContactIdFilter</a></p></td><td class="tblDescr"><p>Filter based around a list of contact ids</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qcontactintersectionfilter.html">QContactIntersectionFilter</a></p></td><td class="tblDescr"><p>Filter which intersects the results of other filters</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qcontactinvalidfilter.html">QContactInvalidFilter</a></p></td><td class="tblDescr"><p>Matches no contacts</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qcontactrelationshipfilter.html">QContactRelationshipFilter</a></p></td><td class="tblDescr"><p>Filter based around relationship criteria</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qcontactunionfilter.html">QContactUnionFilter</a></p></td><td class="tblDescr"><p>Filter which unions the results of other filters</p></td></tr>
</table></div>
<p>A client can also request that the results of such a selection be sorted, by passing a <a href="qcontactsortorder.html">QContactSortOrder</a> (or list of sort orders) to the manager.</p>
<a name="actions"></a>
<h2 id="actions">Actions</h2>
<p>Actions are described by descriptors and are instantiated by factories.</p>
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="qcontactaction.html">QContactAction</a></p></td><td class="tblDescr"><p>Interface for performing an action on a QContact or QContactDetail</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qcontactactiondescriptor.html">QContactActionDescriptor</a></p></td><td class="tblDescr"><p>Information that uniquely identifies a specific implementation of an action</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qcontactactionfactory.html">QContactActionFactory</a></p></td><td class="tblDescr"><p>Interface for clients to retrieve instances of action implementations</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qcontactactiontarget.html">QContactActionTarget</a></p></td><td class="tblDescr"><p>Information about the target of an action. It may be either a contact, a contact and a detail of that contact, or a contact and a list of the details of the contact, which together should be used by the action</p></td></tr>
</table></div>
<a name="backends"></a>
<h2 id="backends">Backends</h2>
<p>A backend implementor must implement the following interfaces:</p>
<p>For more information, see <a href="contactsengines.html">Qt Contacts Manager Engines</a>.</p>
<a name="synchronization-and-serialization"></a>
<h2 id="synchronization-and-serialization">Synchronization and Serialization</h2>
<p>The Qt Contacts API is used by the Qt Versit module. It allows serialization of a <a href="qcontact.html">QContact</a> into a vCard document, and vice versa.</p>
</div>
<!-- @@@contactsclasses.html -->
</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>
|