<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- q3textbrowser.cpp -->
<title>Qt 4.8: Q3TextBrowser Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/style.css" />
<script src="scripts/jquery.js" type="text/javascript"></script>
<script src="scripts/functions.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
<!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
<script src="scripts/superfish.js" type="text/javascript"></script>
<script src="scripts/narrow.js" type="text/javascript"></script>
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<div class="header" id="qtdocheader">
<div class="content">
<div id="nav-logo">
<a href="index.html">Home</a></div>
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
<div id="narrowsearch"></div>
<div id="nav-topright">
<ul>
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
DOC</a></li>
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
</ul>
</div>
<div id="shortCut">
<ul>
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
</ul>
</div>
<ul class="sf-menu" id="narrowmenu">
<li><a href="#">API Lookup</a>
<ul>
<li><a href="classes.html">Class index</a></li>
<li><a href="functions.html">Function index</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="qtglobal.html">Global Declarations</a></li>
<li><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</li>
<li><a href="#">Qt Topics</a>
<ul>
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li><a href="supported-platforms.html">Supported Platforms</a></li>
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</li>
<li><a href="#">Examples</a>
<ul>
<li><a href="all-examples.html">Examples</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
<li><a href="demos.html">Demos</a></li>
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="wrapper">
<div class="hd">
<span></span>
</div>
<div class="bd group">
<div class="sidebar">
<div class="searchlabel">
Search index:</div>
<div class="search" id="sidebarsearch">
<form id="qtdocsearch" action="" onsubmit="return false;">
<fieldset>
<input type="text" name="searchstring" id="pageType" value="" />
<div id="resultdialog">
<a href="#" id="resultclose">Close</a>
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p>
<ul id="resultlist" class="all">
</ul>
</div>
</fieldset>
</form>
</div>
<div class="box first bottombar" id="lookup">
<h2 title="API Lookup"><span></span>
API Lookup</h2>
<div id="list001" class="list">
<ul id="ul001" >
<li class="defaultLink"><a href="classes.html">Class index</a></li>
<li class="defaultLink"><a href="functions.html">Function index</a></li>
<li class="defaultLink"><a href="modules.html">Modules</a></li>
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</div>
</div>
<div class="box bottombar" id="topics">
<h2 title="Qt Topics"><span></span>
Qt Topics</h2>
<div id="list002" class="list">
<ul id="ul002" >
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</div>
</div>
<div class="box" id="examples">
<h2 title="Examples"><span></span>
Examples</h2>
<div id="list003" class="list">
<ul id="ul003">
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
<li class="defaultLink"><a href="demos.html">Demos</a></li>
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</div>
</div>
</div>
<div class="wrap">
<div class="toolbar">
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li>Qt3SupportLight</li>
<li>Q3TextBrowser</li>
</ul>
</div>
<div class="toolbuttons toolblock">
<ul>
<li id="smallA" class="t_button">A</li>
<li id="medA" class="t_button active">A</li>
<li id="bigA" class="t_button">A</li>
<li id="print" class="t_button"><a href="javascript:this.print();">
<span>Print</span></a></li>
</ul>
</div>
</div>
<div class="content mainContent">
<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="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#public-slots">Public Slots</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">Q3TextBrowser Class Reference</h1>
<!-- $$$Q3TextBrowser-brief -->
<p>The Q3TextBrowser class provides a rich text browser with hypertext navigation. <a href="#details">More...</a></p>
<!-- @@@Q3TextBrowser -->
<pre class="cpp"> <span class="preprocessor">#include <Q3TextBrowser></span></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 <a href="porting4.html">Porting to Qt 4</a> for more information.</p>
<p><b>Inherits: </b><a href="q3textedit.html">Q3TextEdit</a>.</p>
<ul>
<li><a href="q3textbrowser-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2>Properties</h2>
<ul>
<li class="fn"><b><a href="q3textbrowser.html#source-prop">source</a></b> : QString</li>
</ul>
<ul>
<li class="fn">19 properties inherited from <a href="q3textedit.html#properties">Q3TextEdit</a></li>
<li class="fn">10 properties inherited from <a href="q3scrollview.html#properties">Q3ScrollView</a></li>
<li class="fn">2 properties inherited from <a href="q3frame.html#properties">Q3Frame</a></li>
<li class="fn">6 properties inherited from <a href="qframe.html#properties">QFrame</a></li>
<li class="fn">58 properties inherited from <a href="qwidget.html#properties">QWidget</a></li>
<li class="fn">1 property inherited from <a href="qobject.html#properties">QObject</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3textbrowser.html#Q3TextBrowser">Q3TextBrowser</a></b> ( QWidget * <i>parent</i> = 0, const char * <i>name</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="q3textbrowser.html#source-prop">source</a></b> () const</td></tr>
</table>
<ul>
<li class="fn">53 public functions inherited from <a href="q3textedit.html#public-functions">Q3TextEdit</a></li>
<li class="fn">49 public functions inherited from <a href="q3scrollview.html#public-functions">Q3ScrollView</a></li>
<li class="fn">4 public functions inherited from <a href="q3frame.html#public-functions">Q3Frame</a></li>
<li class="fn">14 public functions inherited from <a href="qframe.html#public-functions">QFrame</a></li>
<li class="fn">221 public functions inherited from <a href="qwidget.html#public-functions">QWidget</a></li>
<li class="fn">29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
<li class="fn">13 public functions inherited from <a href="qpaintdevice.html#public-functions">QPaintDevice</a></li>
</ul>
<a name="public-slots"></a>
<h2>Public Slots</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3textbrowser.html#backward">backward</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3textbrowser.html#forward">forward</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3textbrowser.html#home">home</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3textbrowser.html#reload">reload</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3textbrowser.html#source-prop">setSource</a></b> ( const QString & <i>name</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3textbrowser.html#setText">setText</a></b> ( const QString & <i>txt</i>, const QString & <i>context</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3textbrowser.html#setText-2">setText</a></b> ( const QString & <i>txt</i> )</td></tr>
</table>
<ul>
<li class="fn">60 public slots inherited from <a href="q3textedit.html#public-slots">Q3TextEdit</a></li>
<li class="fn">8 public slots inherited from <a href="q3scrollview.html#public-slots">Q3ScrollView</a></li>
<li class="fn">19 public slots inherited from <a href="qwidget.html#public-slots">QWidget</a></li>
<li class="fn">1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>
</ul>
<a name="signals"></a>
<h2>Signals</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3textbrowser.html#anchorClicked">anchorClicked</a></b> ( const QString & <i>name</i>, const QString & <i>link</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3textbrowser.html#backwardAvailable">backwardAvailable</a></b> ( bool <i>available</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3textbrowser.html#forwardAvailable">forwardAvailable</a></b> ( bool <i>available</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3textbrowser.html#highlighted">highlighted</a></b> ( const QString & <i>link</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3textbrowser.html#linkClicked">linkClicked</a></b> ( const QString & <i>link</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3textbrowser.html#sourceChanged">sourceChanged</a></b> ( const QString & <i>src</i> )</td></tr>
</table>
<ul>
<li class="fn">14 signals inherited from <a href="q3textedit.html#signals">Q3TextEdit</a></li>
<li class="fn">5 signals inherited from <a href="q3scrollview.html#signals">Q3ScrollView</a></li>
<li class="fn">1 signal inherited from <a href="qwidget.html#signals">QWidget</a></li>
<li class="fn">1 signal inherited from <a href="qobject.html#signals">QObject</a></li>
</ul>
<a name="reimplemented-protected-functions"></a>
<h2>Reimplemented Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3textbrowser.html#keyPressEvent">keyPressEvent</a></b> ( QKeyEvent * <i>e</i> )</td></tr>
</table>
<ul>
<li class="fn">22 protected functions inherited from <a href="q3textedit.html#protected-functions">Q3TextEdit</a></li>
<li class="fn">26 protected functions inherited from <a href="q3scrollview.html#protected-functions">Q3ScrollView</a></li>
<li class="fn">5 protected functions inherited from <a href="q3frame.html#protected-functions">Q3Frame</a></li>
<li class="fn">3 protected functions inherited from <a href="qframe.html#protected-functions">QFrame</a></li>
<li class="fn">37 protected functions inherited from <a href="qwidget.html#protected-functions">QWidget</a></li>
<li class="fn">8 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>
<li class="fn">1 protected function inherited from <a href="qpaintdevice.html#protected-functions">QPaintDevice</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">4 static public members inherited from <a href="qwidget.html#static-public-members">QWidget</a></li>
<li class="fn">7 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>
<li class="fn">22 protected functions inherited from <a href="q3textedit.html#protected-functions">Q3TextEdit</a></li>
<li class="fn">26 protected functions inherited from <a href="q3scrollview.html#protected-functions">Q3ScrollView</a></li>
<li class="fn">5 protected functions inherited from <a href="q3frame.html#protected-functions">Q3Frame</a></li>
<li class="fn">3 protected functions inherited from <a href="qframe.html#protected-functions">QFrame</a></li>
<li class="fn">37 protected functions inherited from <a href="qwidget.html#protected-functions">QWidget</a></li>
<li class="fn">8 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>
<li class="fn">1 protected function inherited from <a href="qpaintdevice.html#protected-functions">QPaintDevice</a></li>
<li class="fn">1 protected slot inherited from <a href="qwidget.html#protected-slots">QWidget</a></li>
</ul>
<a name="details"></a>
<!-- $$$Q3TextBrowser-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The Q3TextBrowser class provides a rich text browser with hypertext navigation.</p>
<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>
<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>
<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>
<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>
<pre class="cpp"> <a href="q3textedit.html#mimeSourceFactory">mimeSourceFactory</a>()<span class="operator">-</span><span class="operator">></span>setExtensionType(<span class="string">"qml"</span><span class="operator">,</span> <span class="string">"text/utf8"</span>);</pre>
<p>This is to ensure that the factory is able to resolve the document names.</p>
<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>
<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>
</div>
<!-- @@@Q3TextBrowser -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$source-prop$$$source$$$setSourceconstQString& -->
<h3 class="fn"><a name="source-prop"></a><span class="name">source</span> : <span class="type"><a href="qstring.html">QString</a></span></h3>
<p>This property holds the name of the displayed document.</p>
<p>This is a an empty string if no document is displayed or if the source is unknown.</p>
<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>
<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>
<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>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QString </td><td class="memItemRight bottomAlign"><span class="name"><b>source</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> virtual void </td><td class="memItemRight bottomAlign"><span class="name"><b>setSource</b></span> ( const QString & <i>name</i> )</td></tr>
</table>
<!-- @@@source -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$Q3TextBrowser[overload1]$$$Q3TextBrowserQWidget*constchar* -->
<h3 class="fn"><a name="Q3TextBrowser"></a>Q3TextBrowser::<span class="name">Q3TextBrowser</span> ( <span class="type"><a href="qwidget.html">QWidget</a></span> * <i>parent</i> = 0, const <span class="type">char</span> * <i>name</i> = 0 )</h3>
<p>Constructs an empty <a href="q3textbrowser.html" class="compat">Q3TextBrowser</a> called <i>name</i>, with parent <i>parent</i>.</p>
<!-- @@@Q3TextBrowser -->
<!-- $$$anchorClicked[overload1]$$$anchorClickedconstQString&constQString& -->
<h3 class="fn"><a name="anchorClicked"></a><span class="type">void</span> Q3TextBrowser::<span class="name">anchorClicked</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>name</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>link</i> )<tt> [signal]</tt></h3>
<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>
<p><b>See also </b><a href="q3textbrowser.html#linkClicked">linkClicked</a>().</p>
<!-- @@@anchorClicked -->
<!-- $$$backward[overload1]$$$backward -->
<h3 class="fn"><a name="backward"></a><span class="type">void</span> Q3TextBrowser::<span class="name">backward</span> ()<tt> [virtual slot]</tt></h3>
<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>
<p><b>See also </b><a href="q3textbrowser.html#forward">forward</a>() and <a href="q3textbrowser.html#backwardAvailable">backwardAvailable</a>().</p>
<!-- @@@backward -->
<!-- $$$backwardAvailable[overload1]$$$backwardAvailablebool -->
<h3 class="fn"><a name="backwardAvailable"></a><span class="type">void</span> Q3TextBrowser::<span class="name">backwardAvailable</span> ( <span class="type">bool</span> <i>available</i> )<tt> [signal]</tt></h3>
<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>
<!-- @@@backwardAvailable -->
<!-- $$$forward[overload1]$$$forward -->
<h3 class="fn"><a name="forward"></a><span class="type">void</span> Q3TextBrowser::<span class="name">forward</span> ()<tt> [virtual slot]</tt></h3>
<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>
<p><b>See also </b><a href="q3textbrowser.html#backward">backward</a>() and <a href="q3textbrowser.html#forwardAvailable">forwardAvailable</a>().</p>
<!-- @@@forward -->
<!-- $$$forwardAvailable[overload1]$$$forwardAvailablebool -->
<h3 class="fn"><a name="forwardAvailable"></a><span class="type">void</span> Q3TextBrowser::<span class="name">forwardAvailable</span> ( <span class="type">bool</span> <i>available</i> )<tt> [signal]</tt></h3>
<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>
<!-- @@@forwardAvailable -->
<!-- $$$highlighted[overload1]$$$highlightedconstQString& -->
<h3 class="fn"><a name="highlighted"></a><span class="type">void</span> Q3TextBrowser::<span class="name">highlighted</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>link</i> )<tt> [signal]</tt></h3>
<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>
<!-- @@@highlighted -->
<!-- $$$home[overload1]$$$home -->
<h3 class="fn"><a name="home"></a><span class="type">void</span> Q3TextBrowser::<span class="name">home</span> ()<tt> [virtual slot]</tt></h3>
<p>Changes the document displayed to be the first document the browser displayed.</p>
<!-- @@@home -->
<!-- $$$keyPressEvent[overload1]$$$keyPressEventQKeyEvent* -->
<h3 class="fn"><a name="keyPressEvent"></a><span class="type">void</span> Q3TextBrowser::<span class="name">keyPressEvent</span> ( <span class="type"><a href="qkeyevent.html">QKeyEvent</a></span> * <i>e</i> )<tt> [virtual protected]</tt></h3>
<p>Reimplemented from <a href="qwidget.html#keyPressEvent">QWidget::keyPressEvent</a>().</p>
<p>The event <i>e</i> is used to provide the following keyboard shortcuts:</p>
<table class="generic">
<thead><tr class="qt-style"><th >Keypress</th><th >Action</th></tr></thead>
<tr valign="top" class="odd"><td >Alt+Left Arrow</td><td ><a href="q3textbrowser.html#backward">backward</a>()</td></tr>
<tr valign="top" class="even"><td >Alt+Right Arrow</td><td ><a href="q3textbrowser.html#forward">forward</a>()</td></tr>
<tr valign="top" class="odd"><td >Alt+Up Arrow</td><td ><a href="q3textbrowser.html#home">home</a>()</td></tr>
</table>
<!-- @@@keyPressEvent -->
<!-- $$$linkClicked[overload1]$$$linkClickedconstQString& -->
<h3 class="fn"><a name="linkClicked"></a><span class="type">void</span> Q3TextBrowser::<span class="name">linkClicked</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>link</i> )<tt> [signal]</tt></h3>
<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>
<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>
<p><b>See also </b><a href="q3textbrowser.html#anchorClicked">anchorClicked</a>().</p>
<!-- @@@linkClicked -->
<!-- $$$reload[overload1]$$$reload -->
<h3 class="fn"><a name="reload"></a><span class="type">void</span> Q3TextBrowser::<span class="name">reload</span> ()<tt> [virtual slot]</tt></h3>
<p>Reloads the current set source.</p>
<!-- @@@reload -->
<!-- $$$setText[overload1]$$$setTextconstQString&constQString& -->
<h3 class="fn"><a name="setText"></a><span class="type">void</span> Q3TextBrowser::<span class="name">setText</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>txt</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>context</i> )<tt> [virtual slot]</tt></h3>
<p>Reimplemented from <a href="q3textedit.html#text-prop">Q3TextEdit::setText</a>().</p>
<!-- @@@setText -->
<!-- $$$setText$$$setTextconstQString& -->
<h3 class="fn"><a name="setText-2"></a><span class="type">void</span> Q3TextBrowser::<span class="name">setText</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>txt</i> )<tt> [slot]</tt></h3>
<p>This is an overloaded function.</p>
<p>Sets the text to <i>txt</i>.</p>
<!-- @@@setText -->
<!-- $$$sourceChanged[overload1]$$$sourceChangedconstQString& -->
<h3 class="fn"><a name="sourceChanged"></a><span class="type">void</span> Q3TextBrowser::<span class="name">sourceChanged</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>src</i> )<tt> [signal]</tt></h3>
<p>This signal is emitted when the mime source has changed, <i>src</i> being the new source.</p>
<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>
<!-- @@@sourceChanged -->
</div>
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2013 Digia Plc and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
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.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Digia, Qt and their respective logos are trademarks of Digia Plc
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
<script src="scripts/functions.js" type="text/javascript"></script>
</body>
</html>
