/usr/share/u1db-qt/doc/html/qml-u1db-document.html is in libu1db-qt5-doc 0.1.5+15.10.20150826.1-0ubuntu1.
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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- document.cpp -->
<title>Document QML Type | U1Db-Qt </title>
<link rel="stylesheet" type="text/css" href="style/css.css">
<link rel="stylesheet" type="text/css" href="style/css_002.css">
<link rel="stylesheet" type="text/css" href="style/reset.css">
<link rel="stylesheet" type="text/css" href="style/qtquick.css">
<link rel="stylesheet" type="text/css" href="style/base.css">
<link rel="stylesheet" type="text/css" href="style/scratch.css">
<link rel="stylesheet" type="text/css" href="style/base.css" /></head>
<body>
<div class="wrapper">
<div class="main-content">
<div class="sidebar">
<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="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Document QML Type</h1>
<span class="subtitle"></span>
<!-- $$$Document-brief -->
<p>Document proxies a single document stored in the Database. <a href="#details">More...</a></p>
<!-- @@@Document -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import U1db .</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiates:</td><td class="memItemRight bottomAlign"> <a href="qml-u1db-document.html"><a href="document.html">Document</a></td></tr></table></div><ul>
<li><a href="qml-u1db-document-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-u1db-document.html#content-prop">content</a></b></b> : Variant</li>
<li class="fn"><b><b><a href="qml-u1db-document.html#contents-prop">contents</a></b></b> : Variant</li>
<li class="fn"><b><b><a href="qml-u1db-document.html#create-prop">create</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-u1db-document.html#docId-prop">docId</a></b></b> : string</li>
</ul>
<!-- $$$Document-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p>This is the declarative API equivalent of <a href="qml-u1db-database.html#putDoc-method">Database::putDoc()</a> and <a href="qml-u1db-database.html#getDoc-method">Database::getDoc()</a>.</p>
<pre class="qml"><span class="type"><a href="qml-u1db-document.html">Document</a></span> {
<span class="name">docId</span>: <span class="string">'myId'</span>
<span class="name">defaults</span>: {
<span class="name">color</span>: <span class="string">'blue'</span>
}
<span class="name">create</span>: <span class="number">true</span>
}</pre>
<p><b>See also </b><a href="qml-u1db-database.html">Database</a>.</p>
<!-- @@@Document -->
<h2>Property Documentation</h2>
<!-- $$$content -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="content-prop"><td class="tblQmlPropNode"><p><a name="content-prop"></a><span class="name">content</span> : <span class="type">Variant</span></p></td></tr></table></div></div><div class="qmldoc"><p>The default contents of the document, which are used only if create is true, <a href="qml-u1db-document.html#docId-prop">docId</a> is not empty and no document with the same <a href="qml-u1db-document.html#docId-prop">docId</a> exists in the database yet. If the <i>defaults</i> change, it's up to the API user to handle it.</p>
</div></div><!-- @@@content -->
<br/>
<!-- $$$contents -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="contents-prop"><td class="tblQmlPropNode"><p><a name="contents-prop"></a><span class="name">contents</span> : <span class="type">Variant</span></p></td></tr></table></div></div><div class="qmldoc"><p>Updates the <i>contents</i> of the document. A valid <a href="qml-u1db-document.html#docId-prop">docId</a> must be set.</p>
</div></div><!-- @@@contents -->
<br/>
<!-- $$$create -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="create-prop"><td class="tblQmlPropNode"><p><a name="create-prop"></a><span class="name">create</span> : <span class="type">bool</span></p></td></tr></table></div></div><div class="qmldoc"><p>If <i>create</i> is true, <a href="qml-u1db-document.html#docId-prop">docId</a> is not empty and no document with the same <a href="qml-u1db-document.html#docId-prop">docId</a> exists, defaults will be used to store the document.</p>
</div></div><!-- @@@create -->
<br/>
<!-- $$$docId -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="docId-prop"><td class="tblQmlPropNode"><p><a name="docId-prop"></a><span class="name">docId</span> : <span class="type">string</span></p></td></tr></table></div></div><div class="qmldoc"><p>The docId can be that of an existing document in the database and will determine what getContents() returns. If no such documents exists, setDefaults() can be used to supply a preset.</p>
</div></div><!-- @@@docId -->
<br/>
</div>
</div>
</body>
</html>
|