File: qml-uicomponents-tabwidget.xml

package info (click to toggle)
qttools-opensource-src 5.15.17-2
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 58,636 kB
  • sloc: cpp: 204,308; xml: 3,621; ansic: 265; javascript: 120; perl: 118; makefile: 64; java: 32
file content (77 lines) | stat: -rw-r--r-- 3,397 bytes parent folder | download | duplicates (4) 
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
 
<?xml version="1.0" encoding="UTF-8"?>
<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.2" xml:lang="en">
<db:info>
<db:title>TabWidget QML Type</db:title>
<db:productname>Test</db:productname>
<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev>
<db:abstract>
<db:para>A widget that places its children as tabs.</db:para>
</db:abstract>
</db:info>
<db:variablelist>
<db:varlistentry>
<db:term>Import Statement</db:term>
<db:listitem>
<db:para>import UIComponents 1.0</db:para>
</db:listitem>
</db:varlistentry>
</db:variablelist>
<db:section xml:id="details">
<db:title>Detailed Description</db:title>
<db:para>A <db:link xlink:href="qml-uicomponents-tabwidget.xml">TabWidget</db:link> places its children as tabs in a view. Selecting a tab involves selecting the tab at the top.</db:para>
<db:para>The <db:link xlink:href="qml-uicomponents-tabwidget.xml">TabWidget</db:link> component is part of the <db:link xlink:href="uicomponents-qmlmodule.xml">UI Components</db:link> module.</db:para>
<db:para>This documentation is part of the <db:link xlink:href="test-componentset-example.xml">UIComponents</db:link> example.</db:para>
<db:section xml:id="adding-tabs">
<db:title>Adding Tabs</db:title>
<db:para>To add a tab, declare the tab as a child of the <db:link xlink:href="qml-uicomponents-tabwidget.xml">TabWidget</db:link>.</db:para>
<db:programlisting language="cpp">TabWidget {
    id: tabwidget

    Rectangle {
        id: tab1
        color: &lt;@string&gt;&amp;quot;red&amp;quot;&lt;/@string&gt;
        &lt;@comment&gt;//... omitted&lt;/@comment&gt;
    }
    Rectangle {
        id: tab2
        color: &lt;@string&gt;&amp;quot;blue&amp;quot;&lt;/@string&gt;
        &lt;@comment&gt;//... omitted&lt;/@comment&gt;
    }

}
</db:programlisting>
</db:section>
</db:section>
<db:section xml:id="property-documentation">
<db:title>Property Documentation</db:title>
<db:section xml:id="current-prop">
<db:title>current : int</db:title>
<db:fieldsynopsis>
<db:type>int</db:type>
<db:varname>current</db:varname>
<db:modifier>writable</db:modifier>
<db:synopsisinfo db:role="access">public</db:synopsisinfo>
<db:synopsisinfo db:role="status">active</db:synopsisinfo>
<db:synopsisinfo db:role="threadsafeness">unspecified</db:synopsisinfo>
</db:fieldsynopsis>
<db:para>The currently active tab in the <db:link xlink:href="qml-uicomponents-tabwidget.xml">TabWidget</db:link>.</db:para>
</db:section>
<db:section xml:id="sampleReadOnlyProperty-prop">
<db:title>[read-only] sampleReadOnlyProperty : int</db:title>
<db:fieldsynopsis>
<db:type>int</db:type>
<db:varname>sampleReadOnlyProperty</db:varname>
<db:modifier>[read-only]</db:modifier>

<db:synopsisinfo db:role="access">public</db:synopsisinfo>
<db:synopsisinfo db:role="status">active</db:synopsisinfo>
<db:synopsisinfo db:role="threadsafeness">unspecified</db:synopsisinfo>
</db:fieldsynopsis>
<db:para>A sample <db:code>read-only</db:code> property. A contrived property to demonstrate QDoc's ability to detect read-only properties.</db:para>
<db:para>The signature is:</db:para>
<db:programlisting language="cpp">readonly property &lt;@type&gt;int&lt;/@type&gt; sampleReadOnlyProperty: &lt;@number&gt;0&lt;/@number&gt;
</db:programlisting>
<db:para>Note that the property must be initialized to a value.</db:para>
</db:section>
</db:section>
</db:article>