← Back to branch summary

~oif-team/ubuntu/natty/qt4-x11/xi2.1

« back to all changes in this revision

Viewing changes to doc/html/qhelpcontentmodel.html

  • Committer: Bazaar Package Importer
  • Author(s): Alessandro Ghersi
  • Date: 2009-11-02 18:30:08 UTC
  • mfrom: (1.2.2 upstream)
  • mto: (15.2.5 experimental)
  • mto: This revision was merged to the branch mainline in revision 88.
  • Revision ID: james.westby@ubuntu.com-20091102183008-b6a4gcs128mvfb3m
Tags: upstream-4.6.0~beta1
Import upstream version 4.6.0~beta1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/qhelpcontentmodel.html
2
2
<!DOCTYPE html
3
3
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
4
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
 
<!-- /fasttmp/mkdist-qt-4.5.2-1245473805/qt-x11-opensource-src-4.5.2/tools/assistant/lib/qhelpcontentwidget.cpp -->
 
5
<!-- qhelpcontentwidget.cpp -->
6
6
<head>
7
 
  <title>Qt 4.5: QHelpContentModel Class Reference</title>
 
7
  <title>Qt 4.6: QHelpContentModel Class Reference</title>
8
8
  <link href="classic.css" rel="stylesheet" type="text/css" />
9
9
</head>
10
10
<body>
 
11
<a name="//apple_ref/cpp/cl//QHelpContentModel" />
11
12
<table border="0" cellpadding="0" cellspacing="0" width="100%">
12
13
<tr>
13
 
<td align="left" valign="top" width="32"><a href="http://qtsoftware.com/products/qt"><img src="images/qt-logo.png" align="left" border="0" /></a></td>
14
 
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="namespaces.html"><font color="#004faf">All&nbsp;Namespaces</font></a>&nbsp;&middot; <a href="classes.html"><font color="#004faf">All&nbsp;Classes</font></a>&nbsp;&middot; <a href="mainclasses.html"><font color="#004faf">Main&nbsp;Classes</font></a>&nbsp;&middot; <a href="groups.html"><font color="#004faf">Grouped&nbsp;Classes</font></a>&nbsp;&middot; <a href="modules.html"><font color="#004faf">Modules</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">Functions</font></a></td>
15
 
<td align="right" valign="top" width="230"></td></tr></table><h1 class="title">QHelpContentModel Class Reference<br /><span class="small-subtitle">[<a href="qthelp.html">QtHelp</a> module]</span>
 
14
<td align="left" valign="top" width="32"><a href="http://qt.nokia.com/"><img src="images/qt-logo.png" align="left" border="0" /></a></td>
 
15
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="classes.html"><font color="#004faf">All&nbsp;Classes</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">All&nbsp;Functions</font></a>&nbsp;&middot; <a href="overviews.html"><font color="#004faf">Overviews</font></a></td><td class="searchBar" align="right" valign="center"><form action="http://www.google.com/cse" id="cse-search-box"><div><input type="hidden" name="cx" value="000136343326384750312:dhbxnqlakyu" /><input type="hidden" name="ie" value="UTF-8" /><input type="text" name="q" size="31" /><input type="submit" name="sa" value="Search" /></div></form></td>
 
16
</tr></table><h1 class="title">QHelpContentModel Class Reference<br /><span class="small-subtitle">[<a href="qthelp.html">QtHelp</a> module]</span>
16
17
</h1>
17
18
<p>The QHelpContentModel class provides a model that supplies content to views. <a href="#details">More...</a></p>
18
 
<pre> #include &lt;QHelpContentModel&gt;</pre><p>Inherits <a href="qabstractitemmodel.html">QAbstractItemModel</a>.</p>
 
19
<pre> #include &lt;QHelpContentModel&gt;</pre><p><b>This class is not part of the Qt GUI Framework Edition.</b></p>
 
20
<p>Inherits <a href="qabstractitemmodel.html">QAbstractItemModel</a>.</p>
19
21
<p>This class was introduced in Qt 4.4.</p>
20
22
<ul>
21
23
<li><a href="qhelpcontentmodel-members.html">List of all members, including inherited members</a></li>
22
24
</ul>
 
25
<hr />
23
26
<a name="public-functions"></a>
24
 
<h3>Public Functions</h3>
25
 
<ul>
26
 
<li><div class="fn"></div><b><a href="qhelpcontentmodel.html#dtor.QHelpContentModel">~QHelpContentModel</a></b> ()</li>
27
 
<li><div class="fn"></div>virtual int <b><a href="qhelpcontentmodel.html#columnCount">columnCount</a></b> ( const QModelIndex &amp; <i>parent</i> = QModelIndex() ) const</li>
28
 
<li><div class="fn"></div>QHelpContentItem * <b><a href="qhelpcontentmodel.html#contentItemAt">contentItemAt</a></b> ( const QModelIndex &amp; <i>index</i> ) const</li>
29
 
<li><div class="fn"></div>void <b><a href="qhelpcontentmodel.html#createContents">createContents</a></b> ( const QString &amp; <i>customFilterName</i> )</li>
30
 
<li><div class="fn"></div>virtual QVariant <b><a href="qhelpcontentmodel.html#data">data</a></b> ( const QModelIndex &amp; <i>index</i>, int <i>role</i> ) const</li>
31
 
<li><div class="fn"></div>virtual QModelIndex <b><a href="qhelpcontentmodel.html#index">index</a></b> ( int <i>row</i>, int <i>column</i>, const QModelIndex &amp; <i>parent</i> = QModelIndex() ) const</li>
32
 
<li><div class="fn"></div>bool <b><a href="qhelpcontentmodel.html#isCreatingContents">isCreatingContents</a></b> () const</li>
33
 
<li><div class="fn"></div>virtual QModelIndex <b><a href="qhelpcontentmodel.html#parent">parent</a></b> ( const QModelIndex &amp; <i>index</i> ) const</li>
34
 
<li><div class="fn"></div>virtual int <b><a href="qhelpcontentmodel.html#rowCount">rowCount</a></b> ( const QModelIndex &amp; <i>parent</i> = QModelIndex() ) const</li>
35
 
</ul>
36
 
<ul>
37
 
<li><div class="fn"></div>34 public functions inherited from <a href="qabstractitemmodel.html#public-functions">QAbstractItemModel</a></li>
38
 
<li><div class="fn"></div>29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
39
 
</ul>
 
27
<h2>Public Functions</h2>
 
28
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
 
29
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qhelpcontentmodel.html#dtor.QHelpContentModel">~QHelpContentModel</a></b> ()</td></tr>
 
30
<tr><td class="memItemLeft" align="right" valign="top">QHelpContentItem * </td><td class="memItemRight" valign="bottom"><b><a href="qhelpcontentmodel.html#contentItemAt">contentItemAt</a></b> ( const QModelIndex &amp; <i>index</i> ) const</td></tr>
 
31
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qhelpcontentmodel.html#createContents">createContents</a></b> ( const QString &amp; <i>customFilterName</i> )</td></tr>
 
32
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qhelpcontentmodel.html#isCreatingContents">isCreatingContents</a></b> () const</td></tr>
 
33
</table>
 
34
<hr />
 
35
<a name="reimplemented-public-functions"></a>
 
36
<h2>Reimplemented Public Functions</h2>
 
37
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
 
38
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><b><a href="qhelpcontentmodel.html#columnCount">columnCount</a></b> ( const QModelIndex &amp; <i>parent</i> = QModelIndex() ) const</td></tr>
 
39
<tr><td class="memItemLeft" align="right" valign="top">virtual QVariant </td><td class="memItemRight" valign="bottom"><b><a href="qhelpcontentmodel.html#data">data</a></b> ( const QModelIndex &amp; <i>index</i>, int <i>role</i> ) const</td></tr>
 
40
<tr><td class="memItemLeft" align="right" valign="top">virtual QModelIndex </td><td class="memItemRight" valign="bottom"><b><a href="qhelpcontentmodel.html#index">index</a></b> ( int <i>row</i>, int <i>column</i>, const QModelIndex &amp; <i>parent</i> = QModelIndex() ) const</td></tr>
 
41
<tr><td class="memItemLeft" align="right" valign="top">virtual QModelIndex </td><td class="memItemRight" valign="bottom"><b><a href="qhelpcontentmodel.html#parent">parent</a></b> ( const QModelIndex &amp; <i>index</i> ) const</td></tr>
 
42
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><b><a href="qhelpcontentmodel.html#rowCount">rowCount</a></b> ( const QModelIndex &amp; <i>parent</i> = QModelIndex() ) const</td></tr>
 
43
</table>
 
44
<ul>
 
45
<li><div bar="2" class="fn"></div>35 public functions inherited from <a href="qabstractitemmodel.html#public-functions">QAbstractItemModel</a></li>
 
46
<li><div bar="2" class="fn"></div>29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
 
47
</ul>
 
48
<hr />
40
49
<a name="signals"></a>
41
 
<h3>Signals</h3>
42
 
<ul>
43
 
<li><div class="fn"></div>void <b><a href="qhelpcontentmodel.html#contentsCreated">contentsCreated</a></b> ()</li>
44
 
<li><div class="fn"></div>void <b><a href="qhelpcontentmodel.html#contentsCreationStarted">contentsCreationStarted</a></b> ()</li>
45
 
</ul>
46
 
<ul>
47
 
<li><div class="fn"></div>14 signals inherited from <a href="qabstractitemmodel.html#signals">QAbstractItemModel</a></li>
48
 
<li><div class="fn"></div>1 signal inherited from <a href="qobject.html#signals">QObject</a></li>
 
50
<h2>Signals</h2>
 
51
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
 
52
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qhelpcontentmodel.html#contentsCreated">contentsCreated</a></b> ()</td></tr>
 
53
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qhelpcontentmodel.html#contentsCreationStarted">contentsCreationStarted</a></b> ()</td></tr>
 
54
</table>
 
55
<ul>
 
56
<li><div bar="2" class="fn"></div>18 signals inherited from <a href="qabstractitemmodel.html#signals">QAbstractItemModel</a></li>
 
57
<li><div bar="2" class="fn"></div>1 signal inherited from <a href="qobject.html#signals">QObject</a></li>
49
58
</ul>
50
59
<h3>Additional Inherited Members</h3>
51
60
<ul>
53
62
<li><div class="fn"></div>2 public slots inherited from <a href="qabstractitemmodel.html#public-slots">QAbstractItemModel</a></li>
54
63
<li><div class="fn"></div>1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>
55
64
<li><div class="fn"></div>5 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>
56
 
<li><div class="fn"></div>14 protected functions inherited from <a href="qabstractitemmodel.html#protected-functions">QAbstractItemModel</a></li>
 
65
<li><div class="fn"></div>21 protected functions inherited from <a href="qabstractitemmodel.html#protected-functions">QAbstractItemModel</a></li>
57
66
<li><div class="fn"></div>7 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>
58
67
</ul>
59
68
<a name="details"></a>
62
71
<p>The QHelpContentModel class provides a model that supplies content to views.</p>
63
72
<hr />
64
73
<h2>Member Function Documentation</h2>
 
74
<a name="//apple_ref/cpp/instm/QHelpContentModel/~QHelpContentModel" />
65
75
<h3 class="fn"><a name="dtor.QHelpContentModel"></a>QHelpContentModel::~QHelpContentModel ()</h3>
66
76
<p>Destroys the help content model.</p>
 
77
<a name="//apple_ref/cpp/instm/QHelpContentModel/columnCount" />
67
78
<h3 class="fn"><a name="columnCount"></a>int QHelpContentModel::columnCount ( const <a href="qmodelindex.html">QModelIndex</a> &amp; <i>parent</i> = QModelIndex() ) const&nbsp;&nbsp;<tt> [virtual]</tt></h3>
 
79
<p>Reimplemented from <a href="qabstractitemmodel.html#columnCount">QAbstractItemModel::columnCount</a>().</p>
68
80
<p>Returns the number of columns under the given <i>parent</i>. Currently returns always 1.</p>
69
 
<p>Reimplemented from <a href="qabstractitemmodel.html#columnCount">QAbstractItemModel</a>.</p>
 
81
<a name="//apple_ref/cpp/instm/QHelpContentModel/contentItemAt" />
70
82
<h3 class="fn"><a name="contentItemAt"></a><a href="qhelpcontentitem.html">QHelpContentItem</a> * QHelpContentModel::contentItemAt ( const <a href="qmodelindex.html">QModelIndex</a> &amp; <i>index</i> ) const</h3>
71
83
<p>Returns the help content item at the model index position <i>index</i>.</p>
 
84
<a name="//apple_ref/cpp/instm/QHelpContentModel/contentsCreated" />
72
85
<h3 class="fn"><a name="contentsCreated"></a>void QHelpContentModel::contentsCreated ()&nbsp;&nbsp;<tt> [signal]</tt></h3>
73
86
<p>This signal is emitted when the contents have been created.</p>
 
87
<a name="//apple_ref/cpp/instm/QHelpContentModel/contentsCreationStarted" />
74
88
<h3 class="fn"><a name="contentsCreationStarted"></a>void QHelpContentModel::contentsCreationStarted ()&nbsp;&nbsp;<tt> [signal]</tt></h3>
75
89
<p>This signal is emitted when the creation of the contents has started. The current contents are invalid from this point on until the signal <a href="qhelpcontentmodel.html#contentsCreated">contentsCreated</a>() is emitted.</p>
76
90
<p>See also <a href="qhelpcontentmodel.html#isCreatingContents">isCreatingContents</a>().</p>
 
91
<a name="//apple_ref/cpp/instm/QHelpContentModel/createContents" />
77
92
<h3 class="fn"><a name="createContents"></a>void QHelpContentModel::createContents ( const <a href="qstring.html">QString</a> &amp; <i>customFilterName</i> )</h3>
78
93
<p>Creates new contents by querying the help system for contents specified for the <i>customFilterName</i>.</p>
 
94
<a name="//apple_ref/cpp/instm/QHelpContentModel/data" />
79
95
<h3 class="fn"><a name="data"></a><a href="qvariant.html">QVariant</a> QHelpContentModel::data ( const <a href="qmodelindex.html">QModelIndex</a> &amp; <i>index</i>, int <i>role</i> ) const&nbsp;&nbsp;<tt> [virtual]</tt></h3>
 
96
<p>Reimplemented from <a href="qabstractitemmodel.html#data">QAbstractItemModel::data</a>().</p>
80
97
<p>Returns the data stored under the given <i>role</i> for the item referred to by the <i>index</i>.</p>
81
 
<p>Reimplemented from <a href="qabstractitemmodel.html#data">QAbstractItemModel</a>.</p>
 
98
<a name="//apple_ref/cpp/instm/QHelpContentModel/index" />
82
99
<h3 class="fn"><a name="index"></a><a href="qmodelindex.html">QModelIndex</a> QHelpContentModel::index ( int <i>row</i>, int <i>column</i>, const <a href="qmodelindex.html">QModelIndex</a> &amp; <i>parent</i> = QModelIndex() ) const&nbsp;&nbsp;<tt> [virtual]</tt></h3>
 
100
<p>Reimplemented from <a href="qabstractitemmodel.html#index">QAbstractItemModel::index</a>().</p>
83
101
<p>Returns the index of the item in the model specified by the given <i>row</i>, <i>column</i> and <i>parent</i> index.</p>
84
 
<p>Reimplemented from <a href="qabstractitemmodel.html#index">QAbstractItemModel</a>.</p>
 
102
<a name="//apple_ref/cpp/instm/QHelpContentModel/isCreatingContents" />
85
103
<h3 class="fn"><a name="isCreatingContents"></a>bool QHelpContentModel::isCreatingContents () const</h3>
86
104
<p>Returns true if the contents are currently rebuilt, otherwise false.</p>
 
105
<a name="//apple_ref/cpp/instm/QHelpContentModel/parent" />
87
106
<h3 class="fn"><a name="parent"></a><a href="qmodelindex.html">QModelIndex</a> QHelpContentModel::parent ( const <a href="qmodelindex.html">QModelIndex</a> &amp; <i>index</i> ) const&nbsp;&nbsp;<tt> [virtual]</tt></h3>
 
107
<p>Reimplemented from <a href="qabstractitemmodel.html#parent">QAbstractItemModel::parent</a>().</p>
88
108
<p>Returns the parent of the model item with the given <i>index</i>, or QModelIndex() if it has no parent.</p>
89
 
<p>Reimplemented from <a href="qabstractitemmodel.html#parent">QAbstractItemModel</a>.</p>
 
109
<a name="//apple_ref/cpp/instm/QHelpContentModel/rowCount" />
90
110
<h3 class="fn"><a name="rowCount"></a>int QHelpContentModel::rowCount ( const <a href="qmodelindex.html">QModelIndex</a> &amp; <i>parent</i> = QModelIndex() ) const&nbsp;&nbsp;<tt> [virtual]</tt></h3>
 
111
<p>Reimplemented from <a href="qabstractitemmodel.html#rowCount">QAbstractItemModel::rowCount</a>().</p>
91
112
<p>Returns the number of rows under the given <i>parent</i>.</p>
92
 
<p>Reimplemented from <a href="qabstractitemmodel.html#rowCount">QAbstractItemModel</a>.</p>
93
113
<p /><address><hr /><div align="center">
94
114
<table width="100%" cellspacing="0" border="0"><tr class="address">
95
 
<td width="30%" align="left">Copyright &copy; 2009 Nokia Corporation and/or its subsidiary(-ies)</td>
96
 
<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>
97
 
<td width="30%" align="right"><div align="right">Qt 4.5.2</div></td>
98
 
</tr></table></div></address></body>
 
115
<td width="40%" align="left">Copyright &copy; 2009 Nokia Corporation and/or its subsidiary(-ies)</td>
 
116
<td width="20%" align="center"><a href="trademarks.html">Trademarks</a></td>
 
117
<td width="40%" align="right"><div align="right">Qt 4.6.0</div></td>
 
118
<script type="text/javascript" src="http://www.google.com/jsapi"></script><script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script><script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en"></script><script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en"></script></tr></table></div></address></body>
99
119
</html>