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

<td width="1">  </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="mainclasses.html"><font color="#004faf">Main Classes</font></a> · <a href="annotated.html"><font color="#004faf">Annotated</font></a> · <a href="groups.html"><font color="#004faf">Grouped Classes</font></a> · <a href="functions.html"><font color="#004faf">Functions</font></a></td>

<td align="right" valign="top" width="230"><img src="images/trolltech-logo.png" align="right" width="203" height="32" border="0" /></td></tr></table><h1 align="center">Q3TextBrowser Class Reference</h1>

<p>The Q3TextBrowser class provides a rich text browser with hypertext navigation. <a href="#details">More...</a></p>

<pre>#include <Q3TextBrowser></pre><p><b>This class is part of the Qt 3 support library.</b> It is provided to keep old source code working. We strongly advise against using it in new code. See the <a href="porting4.html">Porting Guide</a> for more information.</p>

<p>Part of the <a href="qt3support.html">Qt3Support</a> module.</p>

<p>Inherits <a href="q3textedit.html">Q3TextEdit</a>.</p>

<ul>

<li><a href="q3textbrowser-members.html">List of all members, including inherited members</a></li>

</ul>

<h3>Properties</h3>

<ul>

<li><div class="fn"/><b><a href="q3textbrowser.html#source-prop">source</a></b> : QString</li>

</ul>

<ul>

<li><div class="fn"/>19 properties inherited from <a href="q3textedit.html#properties">Q3TextEdit</a></li>

<li><div class="fn"/>10 properties inherited from <a href="q3scrollview.html#properties">Q3ScrollView</a></li>

<li><div class="fn"/>2 properties inherited from <a href="q3frame.html#properties">Q3Frame</a></li>

<li><div class="fn"/>6 properties inherited from <a href="qframe.html#properties">QFrame</a></li>

<li><div class="fn"/>52 properties inherited from <a href="qwidget.html#properties">QWidget</a></li>

<li><div class="fn"/>1 property inherited from <a href="qobject.html#properties">QObject</a></li>

</ul>

<h3>Public Functions</h3>

<ul>

<li><div class="fn"/><b><a href="q3textbrowser.html#Q3TextBrowser">Q3TextBrowser</a></b> ( QWidget * <i>parent</i> = 0, const char * <i>name</i> = 0 )</li>

<li><div class="fn"/>QString <b><a href="q3textbrowser.html#source-prop">source</a></b> () const</li>

</ul>

<ul>

<li><div class="fn"/>51 public functions inherited from <a href="q3textedit.html#public-functions">Q3TextEdit</a></li>

<li><div class="fn"/>46 public functions inherited from <a href="q3scrollview.html#public-functions">Q3ScrollView</a></li>

<li><div class="fn"/>4 public functions inherited from <a href="q3frame.html#public-functions">Q3Frame</a></li>

<li><div class="fn"/>13 public functions inherited from <a href="qframe.html#public-functions">QFrame</a></li>

<li><div class="fn"/>183 public functions inherited from <a href="qwidget.html#public-functions">QWidget</a></li>

<li><div class="fn"/>28 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>

<li><div class="fn"/>10 public functions inherited from <a href="qpaintdevice.html#public-functions">QPaintDevice</a></li>

</ul>

<h3>Public Slots</h3>

<ul>

<li><div class="fn"/>virtual void <b><a href="q3textbrowser.html#backward">backward</a></b> ()</li>

<li><div class="fn"/>virtual void <b><a href="q3textbrowser.html#forward">forward</a></b> ()</li>

<li><div class="fn"/>virtual void <b><a href="q3textbrowser.html#home">home</a></b> ()</li>

<li><div class="fn"/>virtual void <b><a href="q3textbrowser.html#reload">reload</a></b> ()</li>

<li><div class="fn"/>virtual void <b><a href="q3textbrowser.html#source-prop">setSource</a></b> ( const QString & <i>name</i> )</li>

<li><div class="fn"/>void <b><a href="q3textbrowser.html#setText-2">setText</a></b> ( const QString & <i>txt</i> )</li>

</ul>

<ul>

<li><div class="fn"/>60 public slots inherited from <a href="q3textedit.html#public-slots">Q3TextEdit</a></li>

<li><div class="fn"/>8 public slots inherited from <a href="q3scrollview.html#public-slots">Q3ScrollView</a></li>

<li><div class="fn"/>17 public slots inherited from <a href="qwidget.html#public-slots">QWidget</a></li>

<li><div class="fn"/>1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>

</ul>

<h3>Signals</h3>

<ul>

<li><div class="fn"/>void <b><a href="q3textbrowser.html#anchorClicked">anchorClicked</a></b> ( const QString & <i>name</i>, const QString & <i>link</i> )</li>

<li><div class="fn"/>void <b><a href="q3textbrowser.html#backwardAvailable">backwardAvailable</a></b> ( bool <i>available</i> )</li>

<li><div class="fn"/>void <b><a href="q3textbrowser.html#forwardAvailable">forwardAvailable</a></b> ( bool <i>available</i> )</li>

<li><div class="fn"/>void <b><a href="q3textbrowser.html#highlighted">highlighted</a></b> ( const QString & <i>link</i> )</li>

<li><div class="fn"/>void <b><a href="q3textbrowser.html#linkClicked">linkClicked</a></b> ( const QString & <i>link</i> )</li>

<li><div class="fn"/>void <b><a href="q3textbrowser.html#sourceChanged">sourceChanged</a></b> ( const QString & <i>src</i> )</li>

</ul>

<ul>

<li><div class="fn"/>14 signals inherited from <a href="q3textedit.html#signals">Q3TextEdit</a></li>

<li><div class="fn"/>5 signals inherited from <a href="q3scrollview.html#signals">Q3ScrollView</a></li>

<li><div class="fn"/>1 signal inherited from <a href="qwidget.html#signals">QWidget</a></li>

<li><div class="fn"/>1 signal inherited from <a href="qobject.html#signals">QObject</a></li>

</ul>

<h3>Protected Functions</h3>

<ul>

<li><div class="fn"/>virtual void <b><a href="q3textbrowser.html#keyPressEvent">keyPressEvent</a></b> ( QKeyEvent * <i>e</i> )</li>

</ul>

<ul>

<li><div class="fn"/>6 protected functions inherited from <a href="q3textedit.html#protected-functions">Q3TextEdit</a></li>

<li><div class="fn"/>17 protected functions inherited from <a href="q3scrollview.html#protected-functions">Q3ScrollView</a></li>

<li><div class="fn"/>5 protected functions inherited from <a href="q3frame.html#protected-functions">Q3Frame</a></li>

<li><div class="fn"/>39 protected functions inherited from <a href="qwidget.html#protected-functions">QWidget</a></li>

<li><div class="fn"/>7 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>

</ul>

100

<h3>Additional Inherited Members</h3>

101

<ul>

102

<li><div class="fn"/>2 static public members inherited from <a href="qframe.html#static-public-members">QFrame</a></li>

103

<li><div class="fn"/>4 static public members inherited from <a href="qwidget.html#static-public-members">QWidget</a></li>

104

<li><div class="fn"/>4 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>

105

</ul>

106

107

<hr />

108

<h2>Detailed Description</h2>

109

<p>The Q3TextBrowser class provides a rich text browser with hypertext navigation.</p>

110

<p>This class extends <a href="q3textedit.html">Q3TextEdit</a> (in read-only mode), adding some navigation functionality so that users can follow links in hypertext documents. The contents of <a href="q3textedit.html">Q3TextEdit</a> is set with <a href="q3textbrowser.html#setText">setText</a>(), but Q3TextBrowser has an additional function, <a href="q3textbrowser.html#source-prop">setSource</a>(), which makes it possible to set the text to a named document. The name is looked up in the text view's mime source factory. If a document name ends with an anchor (for example, "<tt>#anchor"</tt>), the text browser automatically scrolls to that position (using <a href="q3textedit.html#scrollToAnchor">scrollToAnchor</a>()). When the user clicks on a hyperlink, the browser will call <a href="q3textbrowser.html#source-prop">setSource</a>() itself, with the link's <tt>href</tt> value as argument. You can track the current source by connetion to the <a href="q3textbrowser.html#sourceChanged">sourceChanged</a>() signal.</p>

111

<p>Q3TextBrowser provides <a href="q3textbrowser.html#backward">backward</a>() and <a href="q3textbrowser.html#forward">forward</a>() slots which you can use to implement Back and Forward buttons. The <a href="q3textbrowser.html#home">home</a>() slot sets the text to the very first document displayed. The <a href="q3textbrowser.html#linkClicked">linkClicked</a>() signal is emitted when the user clicks a link.</p>

112

<p>By using <a href="q3textedit.html#setMimeSourceFactory">Q3TextEdit::setMimeSourceFactory</a>() you can provide your own subclass of <a href="q3mimesourcefactory.html">Q3MimeSourceFactory</a>. This makes it possible to access data from anywhere, for example from a network or from a database. See <a href="q3mimesourcefactory.html#data">Q3MimeSourceFactory::data</a>() for details.</p>

113

<p>If you intend using the mime factory to read the data directly from the file system, you may have to specify the encoding for the file extension you are using. For example:</p>

114

<pre>  mimeSourceFactory()->setExtensionType("qml", "text/utf8");</pre>

115

<p>This is to ensure that the factory is able to resolve the document names.</p>

116

<p>Q3TextBrowser interprets the tags it processes in accordance with the default style sheet. Change the style sheet with <a href="q3textedit.html#setStyleSheet">setStyleSheet</a>(); see <a href="porting4.html#qstylesheet">QStyleSheet</a> for details.</p>

117

<p>If you want to provide your users with editable rich text use <a href="q3textedit.html">Q3TextEdit</a>. If you want a text browser without hypertext navigation use <a href="q3textedit.html">Q3TextEdit</a>, and use <a href="q3textedit.html#readOnly-prop">Q3TextEdit::setReadOnly</a>() to disable editing. If you just need to display a small piece of rich text use <a href="porting4.html#qsimplerichtext">QSimpleRichText</a> or <a href="qlabel.html">QLabel</a>.</p>

118

<hr />

119

<h2>Property Documentation</h2>

120

<h3 class="fn"><a name="source-prop"></a>source : <a href="qstring.html">QString</a></h3>

121

<p>This property holds the name of the displayed document.</p>

122

<p>This is a an empty string if no document is displayed or if the source is unknown.</p>

123

<p>Setting this property uses the <a href="q3textedit.html#mimeSourceFactory">mimeSourceFactory</a>() to lookup the named document. It also checks for optional anchors and scrolls the document accordingly.</p>

124

<p>If the first tag in the document is <tt><qt type=detail></tt>, the document is displayed as a popup rather than as new document in the browser window itself. Otherwise, the document is displayed normally in the text browser with the text set to the contents of the named document with <a href="q3textbrowser.html#setText">setText</a>().</p>

125

<p>If you are using the filesystem access capabilities of the mime source factory, you must ensure that the factory knows about the encoding of specified files; otherwise no data will be available. The default factory handles a couple of common file extensions such as <tt>*.html</tt> and <tt>*.txt</tt> with reasonable defaults. See <a href="q3mimesourcefactory.html#data">Q3MimeSourceFactory::data</a>() for details.</p>

126

<p>Access functions:</p>

127

<ul>

128

<li><div class="fn"/><b>QString source () const</b></li>

129

<li><div class="fn"/><b>virtual void setSource ( const QString & <i>name</i> )</b></li>

130

</ul>

131

<hr />

132

<h2>Member Function Documentation</h2>

133

<h3 class="fn"><a name="Q3TextBrowser"></a>Q3TextBrowser::Q3TextBrowser ( <a href="qwidget.html">QWidget</a> * <i>parent</i> = 0, const char * <i>name</i> = 0 )</h3>

134

<p>Constructs an empty <a href="q3textbrowser.html">Q3TextBrowser</a> called <i>name</i>, with parent <i>parent</i>.</p>

135

<h3 class="fn"><a name="anchorClicked"></a>void Q3TextBrowser::anchorClicked ( const <a href="qstring.html">QString</a> & <i>name</i>, const <a href="qstring.html">QString</a> & <i>link</i> )  <tt> [signal]</tt></h3>

136

<p>This signal is emitted when the user clicks an anchor. The <i>link</i> is the value of the <tt>href</tt> i.e. the name of the target document. The <i>name</i> is the name of the anchor.</p>

137

<p>See also <a href="q3textbrowser.html#linkClicked">linkClicked</a>().</p>

138

<h3 class="fn"><a name="backward"></a>void Q3TextBrowser::backward ()  <tt> [virtual slot]</tt></h3>

139

<p>Changes the document displayed to the previous document in the list of documents built by navigating links. Does nothing if there is no previous document.</p>

140

<p>See also <a href="q3textbrowser.html#forward">forward</a>() and <a href="q3textbrowser.html#backwardAvailable">backwardAvailable</a>().</p>

141

<h3 class="fn"><a name="backwardAvailable"></a>void Q3TextBrowser::backwardAvailable ( bool <i>available</i> )  <tt> [signal]</tt></h3>

142

<p>This signal is emitted when the availability of <a href="q3textbrowser.html#backward">backward</a>() changes. <i>available</i> is false when the user is at <a href="q3textbrowser.html#home">home</a>(); otherwise it is true.</p>

143

<h3 class="fn"><a name="forward"></a>void Q3TextBrowser::forward ()  <tt> [virtual slot]</tt></h3>

144

<p>Changes the document displayed to the next document in the list of documents built by navigating links. Does nothing if there is no next document.</p>

145

<p>See also <a href="q3textbrowser.html#backward">backward</a>() and <a href="q3textbrowser.html#forwardAvailable">forwardAvailable</a>().</p>

146

<h3 class="fn"><a name="forwardAvailable"></a>void Q3TextBrowser::forwardAvailable ( bool <i>available</i> )  <tt> [signal]</tt></h3>

147

<p>This signal is emitted when the availability of <a href="q3textbrowser.html#forward">forward</a>() changes. <i>available</i> is true after the user navigates <a href="q3textbrowser.html#backward">backward</a>() and false when the user navigates or goes <a href="q3textbrowser.html#forward">forward</a>().</p>

148

<h3 class="fn"><a name="highlighted"></a>void Q3TextBrowser::highlighted ( const <a href="qstring.html">QString</a> & <i>link</i> )  <tt> [signal]</tt></h3>

149

<p>This signal is emitted when the user has selected but not activated a link in the document. <i>link</i> is the value of the <tt>href</tt> i.e. the name of the target document.</p>

150

<h3 class="fn"><a name="home"></a>void Q3TextBrowser::home ()  <tt> [virtual slot]</tt></h3>

151

<p>Changes the document displayed to be the first document the browser displayed.</p>

152

<h3 class="fn"><a name="keyPressEvent"></a>void Q3TextBrowser::keyPressEvent ( <a href="qkeyevent.html">QKeyEvent</a> * <i>e</i> )  <tt> [virtual protected]</tt></h3>

153

<p>The event <i>e</i> is used to provide the following keyboard shortcuts:</p>

154

155

<tr valign="top" bgcolor="#a2c511"><th>Keypress</th><th>Action</th></tr>

156

<tr valign="top" bgcolor="#f0f0f0"><td>Alt+Left Arrow</td><td><a href="q3textbrowser.html#backward">backward</a>()</td></tr>

157

<tr valign="top" bgcolor="#e0e0e0"><td>Alt+Right Arrow</td><td><a href="q3textbrowser.html#forward">forward</a>()</td></tr>

158

<tr valign="top" bgcolor="#f0f0f0"><td>Alt+Up Arrow</td><td><a href="q3textbrowser.html#home">home</a>()</td></tr>

159

</table>

160

<p>Reimplemented from <a href="qwidget.html#keyPressEvent">QWidget</a>.</p>

161

<h3 class="fn"><a name="linkClicked"></a>void Q3TextBrowser::linkClicked ( const <a href="qstring.html">QString</a> & <i>link</i> )  <tt> [signal]</tt></h3>

162

<p>This signal is emitted when the user clicks a link. The <i>link</i> is the value of the <tt>href</tt> i.e. the name of the target document.</p>

163

<p>The <i>link</i> will be the absolute location of the document, based on the value of the anchor's href tag and the current context of the document.</p>

164

<p>See also <a href="q3textbrowser.html#anchorClicked">anchorClicked</a>().</p>

165

<h3 class="fn"><a name="reload"></a>void Q3TextBrowser::reload ()  <tt> [virtual slot]</tt></h3>

166

<p>Reloads the current set source.</p>

167

<h3 class="fn"><a name="setText-2"></a>void Q3TextBrowser::setText ( const <a href="qstring.html">QString</a> & <i>txt</i> )  <tt> [slot]</tt></h3>

168

<p>This is an overloaded member function, provided for convenience. It behaves essentially like the above function.</p>

169

170

<h3 class="fn"><a name="sourceChanged"></a>void Q3TextBrowser::sourceChanged ( const <a href="qstring.html">QString</a> & <i>src</i> )  <tt> [signal]</tt></h3>

171

<p>This signal is emitted when the mime source has changed, <i>src</i> being the new source.</p>

172

<p>Source changes happen both programmatically when calling <a href="q3textbrowser.html#source-prop">setSource</a>(), <a href="q3textbrowser.html#forward">forward</a>(), backword() or <a href="q3textbrowser.html#home">home</a>() or when the user clicks on links or presses the equivalent key sequences.</p>

173

174

175

176

<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>

177

178

</tr></table></div></address></body>

179

</html>

Older »