<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Vidalia: HelpBrowser Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>HelpBrowser Class Reference</h1><!-- doxytag: class="HelpBrowser" --><!-- doxytag: inherits="VidaliaWindow" -->
<p><code>#include <<a class="el" href="_help_browser_8h_source.html">HelpBrowser.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for HelpBrowser:</div>
<div class="dynsection">
<div class="center">
<img src="class_help_browser.png" usemap="#HelpBrowser_map" alt=""/>
<map id="HelpBrowser_map" name="HelpBrowser_map">
<area href="class_vidalia_window.html" alt="VidaliaWindow" shape="rect" coords="0,0,95,24"/>
</map>
</div>
</div>
<p><a href="class_help_browser-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Slots</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_help_browser.html#aec97ccd1c00a10949bb485ed312cbe81">showWindow</a> (QString topic=QString())</td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_help_browser.html#a7c96dde0b9aa69e2f995aed8d4ed306d">HelpBrowser</a> (QWidget *parent=0)</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_help_browser.html#a42f7ceb51f15ee807eabd01fcf4d1856">retranslateUi</a> ()</td></tr>
<tr><td colspan="2"><h2>Private Slots</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_help_browser.html#a23f1243d56aca0a036814e1e7c610fe9">findNext</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_help_browser.html#a79379cc2e363626933337e7f325e3a71">findPrev</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_help_browser.html#a9b8fb34d23d43045684e144633039d60">search</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_help_browser.html#a11c17a4292c52bcb770beebc473cff45">contentsItemChanged</a> (QTreeWidgetItem *current, QTreeWidgetItem *prev)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_help_browser.html#af7debfbeccfbcb956ff2f0681992acce">searchItemChanged</a> (QTreeWidgetItem *current, QTreeWidgetItem *prev)</td></tr>
<tr><td colspan="2"><h2>Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_help_browser.html#ae95bb0c544007699aa90897216d9deda">language</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_help_browser.html#a6c778836327da46249d79d08de1f2bd0">loadContentsFromXml</a> (QString xmlFile)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_help_browser.html#ad43fd7148c403b9390c30269909f94ec">loadContents</a> (const QDomDocument *document, QString &errorString)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_help_browser.html#ae7c004b8d205f92252188758b71d94cb">parseHelpTopic</a> (const QDomElement &element, QTreeWidgetItem *parent)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_help_browser.html#af1b92353c4777d628ce882af91d53ccb">isValidTopicElement</a> (const QDomElement &topicElement)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_help_browser.html#a59625e5b0e5adb8afe055a59b2c3e883">getResourcePath</a> (const QDomElement &topicElement)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_help_browser.html#ad57653be8683ad2b94f973d31ad2bf82">find</a> (bool forward)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QTreeWidgetItem * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_help_browser.html#a6099416803afd9fc7b5ffb0b2ff9c081">createTopicTreeItem</a> (const QDomElement &topicElement, QTreeWidgetItem *parent)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_help_browser.html#a8042e2a5c5264ede08b64a9098649861">currentItemChanged</a> (QTreeWidgetItem *current, QTreeWidgetItem *prev)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QTreeWidgetItem * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_help_browser.html#a75fafd717174c766ff9c1a34bfcbe834">findTopicItem</a> (QTreeWidgetItem *startItem, QString topic)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_help_browser.html#a36d2642ed0cfb1584ae903de2f4892ae">showTopic</a> (QString topic)</td></tr>
<tr><td colspan="2"><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QList< QDomElement > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_help_browser.html#a018b0fc1d8783d4ba72725c66c4137d9">_elementList</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_help_browser.html#a1e7afbaec5cf48534a92f1cdaec2f100">_lastFind</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_help_browser.html#a5fc1c44d6f56209cefa90158faf75717">_lastSearch</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_help_browser.html#a0cc45464b816dcb82a575b64776067d6">_foundBefore</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Ui::HelpBrowser </td><td class="memItemRight" valign="bottom"><a class="el" href="class_help_browser.html#a3c0d594bacec354376ba1a3b1cbf6545">ui</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="_help_browser_8h_source.html#l00033">33</a> of file <a class="el" href="_help_browser_8h_source.html">HelpBrowser.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a7c96dde0b9aa69e2f995aed8d4ed306d"></a><!-- doxytag: member="HelpBrowser::HelpBrowser" ref="a7c96dde0b9aa69e2f995aed8d4ed306d" args="(QWidget *parent=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">HelpBrowser::HelpBrowser </td>
<td>(</td>
<td class="paramtype">QWidget * </td>
<td class="paramname"> <em>parent</em> = <code>0</code></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor</p>
<p>Constuctor. This will probably do more later </p>
<p>Definition at line <a class="el" href="_help_browser_8cpp_source.html#l00041">41</a> of file <a class="el" href="_help_browser_8cpp_source.html">HelpBrowser.cpp</a>.</p>
<p>References <a class="el" href="_help_browser_8cpp_source.html#l00225">contentsItemChanged()</a>, <a class="el" href="_vidalia_8cpp_source.html#l00387">Vidalia::createShortcut()</a>, <a class="el" href="_help_browser_8cpp_source.html#l00259">currentItemChanged()</a>, <a class="el" href="_help_browser_8cpp_source.html#l00325">findNext()</a>, <a class="el" href="_help_browser_8cpp_source.html#l00332">findPrev()</a>, <a class="el" href="_help_browser_8cpp_source.html#l00110">language()</a>, <a class="el" href="_help_browser_8cpp_source.html#l00023">LEFT_PANE_INDEX</a>, <a class="el" href="_help_browser_8cpp_source.html#l00120">loadContentsFromXml()</a>, <a class="el" href="_help_browser_8cpp_source.html#l00025">MINIMUM_PANE_SIZE</a>, <a class="el" href="_help_browser_8cpp_source.html#l00024">NO_STRETCH</a>, <a class="el" href="_help_browser_8cpp_source.html#l00411">search()</a>, <a class="el" href="_help_browser_8cpp_source.html#l00237">searchItemChanged()</a>, and <a class="el" href="_help_browser_8h_source.html#l00097">ui</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a11c17a4292c52bcb770beebc473cff45"></a><!-- doxytag: member="HelpBrowser::contentsItemChanged" ref="a11c17a4292c52bcb770beebc473cff45" args="(QTreeWidgetItem *current, QTreeWidgetItem *prev)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void HelpBrowser::contentsItemChanged </td>
<td>(</td>
<td class="paramtype">QTreeWidgetItem * </td>
<td class="paramname"> <em>current</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QTreeWidgetItem * </td>
<td class="paramname"> <em>prev</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [private, slot]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called when the user selects a different item in the contents tree</p>
<p>Called when the user selects a different item in the content topic tree </p>
<p>Definition at line <a class="el" href="_help_browser_8cpp_source.html#l00225">225</a> of file <a class="el" href="_help_browser_8cpp_source.html">HelpBrowser.cpp</a>.</p>
<p>References <a class="el" href="_help_browser_8cpp_source.html#l00259">currentItemChanged()</a>, and <a class="el" href="_help_browser_8h_source.html#l00097">ui</a>.</p>
<p>Referenced by <a class="el" href="_help_browser_8cpp_source.html#l00041">HelpBrowser()</a>.</p>
</div>
</div>
<a class="anchor" id="a6099416803afd9fc7b5ffb0b2ff9c081"></a><!-- doxytag: member="HelpBrowser::createTopicTreeItem" ref="a6099416803afd9fc7b5ffb0b2ff9c081" args="(const QDomElement &topicElement, QTreeWidgetItem *parent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QTreeWidgetItem * HelpBrowser::createTopicTreeItem </td>
<td>(</td>
<td class="paramtype">const QDomElement & </td>
<td class="paramname"> <em>topicElement</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QTreeWidgetItem * </td>
<td class="paramname"> <em>parent</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a new item to be placed in the topic tree.</p>
<p>Creates a new element to be inserted into the topic tree. </p>
<p>Definition at line <a class="el" href="_help_browser_8cpp_source.html#l00209">209</a> of file <a class="el" href="_help_browser_8cpp_source.html">HelpBrowser.cpp</a>.</p>
<p>References <a class="el" href="_help_browser_8cpp_source.html#l00030">ATTRIBUTE_TOPIC_ID</a>, <a class="el" href="_help_browser_8cpp_source.html#l00032">ATTRIBUTE_TOPIC_NAME</a>, <a class="el" href="_help_browser_8cpp_source.html#l00198">getResourcePath()</a>, <a class="el" href="_help_browser_8cpp_source.html#l00036">ROLE_TOPIC_ID</a>, and <a class="el" href="_help_browser_8cpp_source.html#l00037">ROLE_TOPIC_QRC_PATH</a>.</p>
<p>Referenced by <a class="el" href="_help_browser_8cpp_source.html#l00140">loadContents()</a>, <a class="el" href="_help_browser_8cpp_source.html#l00165">parseHelpTopic()</a>, and <a class="el" href="_help_browser_8cpp_source.html#l00411">search()</a>.</p>
</div>
</div>
<a class="anchor" id="a8042e2a5c5264ede08b64a9098649861"></a><!-- doxytag: member="HelpBrowser::currentItemChanged" ref="a8042e2a5c5264ede08b64a9098649861" args="(QTreeWidgetItem *current, QTreeWidgetItem *prev)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void HelpBrowser::currentItemChanged </td>
<td>(</td>
<td class="paramtype">QTreeWidgetItem * </td>
<td class="paramname"> <em>current</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QTreeWidgetItem * </td>
<td class="paramname"> <em>prev</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called when the user selects a different item in the tree. </p>
<p>Definition at line <a class="el" href="_help_browser_8cpp_source.html#l00259">259</a> of file <a class="el" href="_help_browser_8cpp_source.html">HelpBrowser.cpp</a>.</p>
<p>References <a class="el" href="_help_browser_8h_source.html#l00094">_foundBefore</a>, <a class="el" href="_help_browser_8cpp_source.html#l00037">ROLE_TOPIC_QRC_PATH</a>, and <a class="el" href="_help_browser_8h_source.html#l00097">ui</a>.</p>
<p>Referenced by <a class="el" href="_help_browser_8cpp_source.html#l00225">contentsItemChanged()</a>, <a class="el" href="_help_browser_8cpp_source.html#l00041">HelpBrowser()</a>, <a class="el" href="_help_browser_8cpp_source.html#l00237">searchItemChanged()</a>, and <a class="el" href="_help_browser_8cpp_source.html#l00302">showTopic()</a>.</p>
</div>
</div>
<a class="anchor" id="ad57653be8683ad2b94f973d31ad2bf82"></a><!-- doxytag: member="HelpBrowser::find" ref="ad57653be8683ad2b94f973d31ad2bf82" args="(bool forward)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void HelpBrowser::find </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>forward</em></td>
<td> ) </td>
<td><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Searches the current page for the phrase in the Find box</p>
<p>Searches the current page for the phrase in the Find box. Highlights the first instance found in the document </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>forward</em> </td><td>true search forward if true, backward if false </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_help_browser_8cpp_source.html#l00342">342</a> of file <a class="el" href="_help_browser_8cpp_source.html">HelpBrowser.cpp</a>.</p>
<p>References <a class="el" href="_help_browser_8h_source.html#l00094">_foundBefore</a>, <a class="el" href="_help_browser_8h_source.html#l00090">_lastFind</a>, and <a class="el" href="_help_browser_8h_source.html#l00097">ui</a>.</p>
<p>Referenced by <a class="el" href="_help_browser_8cpp_source.html#l00325">findNext()</a>, and <a class="el" href="_help_browser_8cpp_source.html#l00332">findPrev()</a>.</p>
</div>
</div>
<a class="anchor" id="a23f1243d56aca0a036814e1e7c610fe9"></a><!-- doxytag: member="HelpBrowser::findNext" ref="a23f1243d56aca0a036814e1e7c610fe9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void HelpBrowser::findNext </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [private, slot]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called when the user clicks "Find Next"</p>
<p>Called when the user clicks "Find Next". </p>
<p>Definition at line <a class="el" href="_help_browser_8cpp_source.html#l00325">325</a> of file <a class="el" href="_help_browser_8cpp_source.html">HelpBrowser.cpp</a>.</p>
<p>References <a class="el" href="_help_browser_8cpp_source.html#l00342">find()</a>.</p>
<p>Referenced by <a class="el" href="_help_browser_8cpp_source.html#l00041">HelpBrowser()</a>.</p>
</div>
</div>
<a class="anchor" id="a79379cc2e363626933337e7f325e3a71"></a><!-- doxytag: member="HelpBrowser::findPrev" ref="a79379cc2e363626933337e7f325e3a71" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void HelpBrowser::findPrev </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [private, slot]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called when the user clicks "Find Previous"</p>
<p>Called when the user clicks "Find Previous". </p>
<p>Definition at line <a class="el" href="_help_browser_8cpp_source.html#l00332">332</a> of file <a class="el" href="_help_browser_8cpp_source.html">HelpBrowser.cpp</a>.</p>
<p>References <a class="el" href="_help_browser_8cpp_source.html#l00342">find()</a>.</p>
<p>Referenced by <a class="el" href="_help_browser_8cpp_source.html#l00041">HelpBrowser()</a>.</p>
</div>
</div>
<a class="anchor" id="a75fafd717174c766ff9c1a34bfcbe834"></a><!-- doxytag: member="HelpBrowser::findTopicItem" ref="a75fafd717174c766ff9c1a34bfcbe834" args="(QTreeWidgetItem *startItem, QString topic)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QTreeWidgetItem * HelpBrowser::findTopicItem </td>
<td>(</td>
<td class="paramtype">QTreeWidgetItem * </td>
<td class="paramname"> <em>startItem</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"> <em>topic</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Finds a topic in the topic tree.</p>
<p>Searches for a topic in the topic tree. Returns a pointer to that topics item in the topic tree if it is found, 0 otherwise. </p>
<p>Definition at line <a class="el" href="_help_browser_8cpp_source.html#l00272">272</a> of file <a class="el" href="_help_browser_8cpp_source.html">HelpBrowser.cpp</a>.</p>
<p>References <a class="el" href="html_8cpp_source.html#l00033">i()</a>, <a class="el" href="_help_browser_8cpp_source.html#l00036">ROLE_TOPIC_ID</a>, and <a class="el" href="_help_browser_8h_source.html#l00097">ui</a>.</p>
<p>Referenced by <a class="el" href="_help_browser_8cpp_source.html#l00302">showTopic()</a>.</p>
</div>
</div>
<a class="anchor" id="a59625e5b0e5adb8afe055a59b2c3e883"></a><!-- doxytag: member="HelpBrowser::getResourcePath" ref="a59625e5b0e5adb8afe055a59b2c3e883" args="(const QDomElement &topicElement)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString HelpBrowser::getResourcePath </td>
<td>(</td>
<td class="paramtype">const QDomElement & </td>
<td class="paramname"> <em>topicElement</em></td>
<td> ) </td>
<td><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Builds a resource path to an html file associated with a help topic.</p>
<p>Builds a resource path to an html file associated with the given help topic. If the help topic needs an achor, the anchor will be formatted and appended. </p>
<p>Definition at line <a class="el" href="_help_browser_8cpp_source.html#l00198">198</a> of file <a class="el" href="_help_browser_8cpp_source.html">HelpBrowser.cpp</a>.</p>
<p>References <a class="el" href="_help_browser_8cpp_source.html#l00031">ATTRIBUTE_TOPIC_HTML</a>, <a class="el" href="_help_browser_8cpp_source.html#l00033">ATTRIBUTE_TOPIC_SECTION</a>, and <a class="el" href="_help_browser_8cpp_source.html#l00110">language()</a>.</p>
<p>Referenced by <a class="el" href="_help_browser_8cpp_source.html#l00209">createTopicTreeItem()</a>, and <a class="el" href="_help_browser_8cpp_source.html#l00411">search()</a>.</p>
</div>
</div>
<a class="anchor" id="af1b92353c4777d628ce882af91d53ccb"></a><!-- doxytag: member="HelpBrowser::isValidTopicElement" ref="af1b92353c4777d628ce882af91d53ccb" args="(const QDomElement &topicElement)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool HelpBrowser::isValidTopicElement </td>
<td>(</td>
<td class="paramtype">const QDomElement & </td>
<td class="paramname"> <em>topicElement</em></td>
<td> ) </td>
<td><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if the given Topic element has the necessary attributes. </p>
<p>Definition at line <a class="el" href="_help_browser_8cpp_source.html#l00187">187</a> of file <a class="el" href="_help_browser_8cpp_source.html">HelpBrowser.cpp</a>.</p>
<p>References <a class="el" href="_help_browser_8cpp_source.html#l00031">ATTRIBUTE_TOPIC_HTML</a>, <a class="el" href="_help_browser_8cpp_source.html#l00030">ATTRIBUTE_TOPIC_ID</a>, and <a class="el" href="_help_browser_8cpp_source.html#l00032">ATTRIBUTE_TOPIC_NAME</a>.</p>
<p>Referenced by <a class="el" href="_help_browser_8cpp_source.html#l00165">parseHelpTopic()</a>.</p>
</div>
</div>
<a class="anchor" id="ae95bb0c544007699aa90897216d9deda"></a><!-- doxytag: member="HelpBrowser::language" ref="ae95bb0c544007699aa90897216d9deda" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString HelpBrowser::language </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the language in which help topics should appear, or English ("en") if no translated help files exist for the current GUI language. </p>
<p>Definition at line <a class="el" href="_help_browser_8cpp_source.html#l00110">110</a> of file <a class="el" href="_help_browser_8cpp_source.html">HelpBrowser.cpp</a>.</p>
<p>Referenced by <a class="el" href="_help_browser_8cpp_source.html#l00198">getResourcePath()</a>, <a class="el" href="_help_browser_8cpp_source.html#l00041">HelpBrowser()</a>, and <a class="el" href="_help_browser_8cpp_source.html#l00097">retranslateUi()</a>.</p>
</div>
</div>
<a class="anchor" id="ad43fd7148c403b9390c30269909f94ec"></a><!-- doxytag: member="HelpBrowser::loadContents" ref="ad43fd7148c403b9390c30269909f94ec" args="(const QDomDocument *document, QString &errorString)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool HelpBrowser::loadContents </td>
<td>(</td>
<td class="paramtype">const QDomDocument * </td>
<td class="paramname"> <em>document</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QString & </td>
<td class="paramname"> <em>errorString</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Load the contents of the help topics tree from the given DOM document. </p>
<p>Definition at line <a class="el" href="_help_browser_8cpp_source.html#l00140">140</a> of file <a class="el" href="_help_browser_8cpp_source.html">HelpBrowser.cpp</a>.</p>
<p>References <a class="el" href="_help_browser_8h_source.html#l00088">_elementList</a>, <a class="el" href="_help_browser_8cpp_source.html#l00209">createTopicTreeItem()</a>, <a class="el" href="_help_browser_8cpp_source.html#l00028">ELEMENT_CONTENTS</a>, <a class="el" href="_help_browser_8cpp_source.html#l00029">ELEMENT_TOPIC</a>, <a class="el" href="_help_browser_8cpp_source.html#l00165">parseHelpTopic()</a>, and <a class="el" href="_help_browser_8h_source.html#l00097">ui</a>.</p>
<p>Referenced by <a class="el" href="_help_browser_8cpp_source.html#l00120">loadContentsFromXml()</a>.</p>
</div>
</div>
<a class="anchor" id="a6c778836327da46249d79d08de1f2bd0"></a><!-- doxytag: member="HelpBrowser::loadContentsFromXml" ref="a6c778836327da46249d79d08de1f2bd0" args="(QString xmlFile)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void HelpBrowser::loadContentsFromXml </td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"> <em>xmlFile</em></td>
<td> ) </td>
<td><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Load the contents of the help topics tree from the specified XML file. </p>
<p>Definition at line <a class="el" href="_help_browser_8cpp_source.html#l00120">120</a> of file <a class="el" href="_help_browser_8cpp_source.html">HelpBrowser.cpp</a>.</p>
<p>References <a class="el" href="_help_browser_8cpp_source.html#l00140">loadContents()</a>, and <a class="el" href="_help_browser_8h_source.html#l00097">ui</a>.</p>
<p>Referenced by <a class="el" href="_help_browser_8cpp_source.html#l00041">HelpBrowser()</a>, and <a class="el" href="_help_browser_8cpp_source.html#l00097">retranslateUi()</a>.</p>
</div>
</div>
<a class="anchor" id="ae7c004b8d205f92252188758b71d94cb"></a><!-- doxytag: member="HelpBrowser::parseHelpTopic" ref="ae7c004b8d205f92252188758b71d94cb" args="(const QDomElement &element, QTreeWidgetItem *parent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void HelpBrowser::parseHelpTopic </td>
<td>(</td>
<td class="paramtype">const QDomElement & </td>
<td class="paramname"> <em>topicElement</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QTreeWidgetItem * </td>
<td class="paramname"> <em>parent</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parse a Topic element and handle all its children.</p>
<p>Parse a Topic element and handle all its children recursively. </p>
<p>Definition at line <a class="el" href="_help_browser_8cpp_source.html#l00165">165</a> of file <a class="el" href="_help_browser_8cpp_source.html">HelpBrowser.cpp</a>.</p>
<p>References <a class="el" href="_help_browser_8h_source.html#l00088">_elementList</a>, <a class="el" href="_help_browser_8cpp_source.html#l00209">createTopicTreeItem()</a>, <a class="el" href="_help_browser_8cpp_source.html#l00029">ELEMENT_TOPIC</a>, and <a class="el" href="_help_browser_8cpp_source.html#l00187">isValidTopicElement()</a>.</p>
<p>Referenced by <a class="el" href="_help_browser_8cpp_source.html#l00140">loadContents()</a>.</p>
</div>
</div>
<a class="anchor" id="a42f7ceb51f15ee807eabd01fcf4d1856"></a><!-- doxytag: member="HelpBrowser::retranslateUi" ref="a42f7ceb51f15ee807eabd01fcf4d1856" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void HelpBrowser::retranslateUi </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called when the user changes the UI translation. </p>
<p>Reimplemented from <a class="el" href="class_vidalia_window.html#a0be6339c19826f3473d558a9e11ced56">VidaliaWindow</a>.</p>
<p>Definition at line <a class="el" href="_help_browser_8cpp_source.html#l00097">97</a> of file <a class="el" href="_help_browser_8cpp_source.html">HelpBrowser.cpp</a>.</p>
<p>References <a class="el" href="_help_browser_8cpp_source.html#l00110">language()</a>, <a class="el" href="_help_browser_8cpp_source.html#l00120">loadContentsFromXml()</a>, and <a class="el" href="_help_browser_8h_source.html#l00097">ui</a>.</p>
</div>
</div>
<a class="anchor" id="a9b8fb34d23d43045684e144633039d60"></a><!-- doxytag: member="HelpBrowser::search" ref="a9b8fb34d23d43045684e144633039d60" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void HelpBrowser::search </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [private, slot]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called when the user starts a search</p>
<p>Searches all help pages for the phrase the Search box. Fills treeSearch with documents containing matches and sets the status bar text appropriately. </p>
<p>Definition at line <a class="el" href="_help_browser_8cpp_source.html#l00411">411</a> of file <a class="el" href="_help_browser_8cpp_source.html">HelpBrowser.cpp</a>.</p>
<p>References <a class="el" href="_help_browser_8h_source.html#l00088">_elementList</a>, <a class="el" href="_help_browser_8h_source.html#l00092">_lastSearch</a>, <a class="el" href="_help_browser_8cpp_source.html#l00209">createTopicTreeItem()</a>, <a class="el" href="_help_browser_8cpp_source.html#l00198">getResourcePath()</a>, <a class="el" href="html_8cpp_source.html#l00033">i()</a>, <a class="el" href="_help_text_browser_8cpp_source.html#l00068">HelpTextBrowser::setSource()</a>, and <a class="el" href="_help_browser_8h_source.html#l00097">ui</a>.</p>
<p>Referenced by <a class="el" href="_help_browser_8cpp_source.html#l00041">HelpBrowser()</a>.</p>
</div>
</div>
<a class="anchor" id="af7debfbeccfbcb956ff2f0681992acce"></a><!-- doxytag: member="HelpBrowser::searchItemChanged" ref="af7debfbeccfbcb956ff2f0681992acce" args="(QTreeWidgetItem *current, QTreeWidgetItem *prev)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void HelpBrowser::searchItemChanged </td>
<td>(</td>
<td class="paramtype">QTreeWidgetItem * </td>
<td class="paramname"> <em>current</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QTreeWidgetItem * </td>
<td class="paramname"> <em>prev</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [private, slot]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called when the user selects a different item in the search tree</p>
<p>Called when the user selects a different item in the content topic tree </p>
<p>Definition at line <a class="el" href="_help_browser_8cpp_source.html#l00237">237</a> of file <a class="el" href="_help_browser_8cpp_source.html">HelpBrowser.cpp</a>.</p>
<p>References <a class="el" href="_help_browser_8h_source.html#l00092">_lastSearch</a>, <a class="el" href="_help_browser_8cpp_source.html#l00259">currentItemChanged()</a>, and <a class="el" href="_help_browser_8h_source.html#l00097">ui</a>.</p>
<p>Referenced by <a class="el" href="_help_browser_8cpp_source.html#l00041">HelpBrowser()</a>.</p>
</div>
</div>
<a class="anchor" id="a36d2642ed0cfb1584ae903de2f4892ae"></a><!-- doxytag: member="HelpBrowser::showTopic" ref="a36d2642ed0cfb1584ae903de2f4892ae" args="(QString topic)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void HelpBrowser::showTopic </td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"> <em>topic</em></td>
<td> ) </td>
<td><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Shows the help browser and finds a specific a topic in the browser.</p>
<p>Shows the help browser. If a sepcified topic was given, then search for that topic's ID (e.g., "log.basic") and display the appropriate page. </p>
<p>Definition at line <a class="el" href="_help_browser_8cpp_source.html#l00302">302</a> of file <a class="el" href="_help_browser_8cpp_source.html">HelpBrowser.cpp</a>.</p>
<p>References <a class="el" href="_help_browser_8cpp_source.html#l00259">currentItemChanged()</a>, <a class="el" href="_help_browser_8cpp_source.html#l00272">findTopicItem()</a>, and <a class="el" href="_help_browser_8h_source.html#l00097">ui</a>.</p>
<p>Referenced by <a class="el" href="_help_browser_8cpp_source.html#l00448">showWindow()</a>.</p>
</div>
</div>
<a class="anchor" id="aec97ccd1c00a10949bb485ed312cbe81"></a><!-- doxytag: member="HelpBrowser::showWindow" ref="aec97ccd1c00a10949bb485ed312cbe81" args="(QString topic=QString())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void HelpBrowser::showWindow </td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"> <em>topic</em> = <code>QString()</code></td>
<td> ) </td>
<td><code> [slot]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Overrides the default QWidget::show()</p>
<p>Overrides the default show method </p>
<p>Definition at line <a class="el" href="_help_browser_8cpp_source.html#l00448">448</a> of file <a class="el" href="_help_browser_8cpp_source.html">HelpBrowser.cpp</a>.</p>
<p>References <a class="el" href="_help_browser_8cpp_source.html#l00302">showTopic()</a>, and <a class="el" href="_vidalia_window_8h_source.html#l00065">VidaliaWindow::showWindow()</a>.</p>
<p>Referenced by <a class="el" href="_main_window_8cpp_source.html#l01703">MainWindow::showHelpDialog()</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a018b0fc1d8783d4ba72725c66c4137d9"></a><!-- doxytag: member="HelpBrowser::_elementList" ref="a018b0fc1d8783d4ba72725c66c4137d9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QList<QDomElement> <a class="el" href="class_help_browser.html#a018b0fc1d8783d4ba72725c66c4137d9">HelpBrowser::_elementList</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>List of DOM elements representing topics. </p>
<p>Definition at line <a class="el" href="_help_browser_8h_source.html#l00088">88</a> of file <a class="el" href="_help_browser_8h_source.html">HelpBrowser.h</a>.</p>
<p>Referenced by <a class="el" href="_help_browser_8cpp_source.html#l00140">loadContents()</a>, <a class="el" href="_help_browser_8cpp_source.html#l00165">parseHelpTopic()</a>, and <a class="el" href="_help_browser_8cpp_source.html#l00411">search()</a>.</p>
</div>
</div>
<a class="anchor" id="a0cc45464b816dcb82a575b64776067d6"></a><!-- doxytag: member="HelpBrowser::_foundBefore" ref="a0cc45464b816dcb82a575b64776067d6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="class_help_browser.html#a0cc45464b816dcb82a575b64776067d6">HelpBrowser::_foundBefore</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Indicates if phrase was previously found on current page </p>
<p>Definition at line <a class="el" href="_help_browser_8h_source.html#l00094">94</a> of file <a class="el" href="_help_browser_8h_source.html">HelpBrowser.h</a>.</p>
<p>Referenced by <a class="el" href="_help_browser_8cpp_source.html#l00259">currentItemChanged()</a>, and <a class="el" href="_help_browser_8cpp_source.html#l00342">find()</a>.</p>
</div>
</div>
<a class="anchor" id="a1e7afbaec5cf48534a92f1cdaec2f100"></a><!-- doxytag: member="HelpBrowser::_lastFind" ref="a1e7afbaec5cf48534a92f1cdaec2f100" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString <a class="el" href="class_help_browser.html#a1e7afbaec5cf48534a92f1cdaec2f100">HelpBrowser::_lastFind</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Last phrase used for 'Find' </p>
<p>Definition at line <a class="el" href="_help_browser_8h_source.html#l00090">90</a> of file <a class="el" href="_help_browser_8h_source.html">HelpBrowser.h</a>.</p>
<p>Referenced by <a class="el" href="_help_browser_8cpp_source.html#l00342">find()</a>.</p>
</div>
</div>
<a class="anchor" id="a5fc1c44d6f56209cefa90158faf75717"></a><!-- doxytag: member="HelpBrowser::_lastSearch" ref="a5fc1c44d6f56209cefa90158faf75717" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString <a class="el" href="class_help_browser.html#a5fc1c44d6f56209cefa90158faf75717">HelpBrowser::_lastSearch</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Last phrase searched on </p>
<p>Definition at line <a class="el" href="_help_browser_8h_source.html#l00092">92</a> of file <a class="el" href="_help_browser_8h_source.html">HelpBrowser.h</a>.</p>
<p>Referenced by <a class="el" href="_help_browser_8cpp_source.html#l00411">search()</a>, and <a class="el" href="_help_browser_8cpp_source.html#l00237">searchItemChanged()</a>.</p>
</div>
</div>
<a class="anchor" id="a3c0d594bacec354376ba1a3b1cbf6545"></a><!-- doxytag: member="HelpBrowser::ui" ref="a3c0d594bacec354376ba1a3b1cbf6545" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Ui::HelpBrowser <a class="el" href="class_help_browser.html#a3c0d594bacec354376ba1a3b1cbf6545">HelpBrowser::ui</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Qt Designer generated QObject </p>
<p>Definition at line <a class="el" href="_help_browser_8h_source.html#l00097">97</a> of file <a class="el" href="_help_browser_8h_source.html">HelpBrowser.h</a>.</p>
<p>Referenced by <a class="el" href="_help_browser_8cpp_source.html#l00225">contentsItemChanged()</a>, <a class="el" href="_help_browser_8cpp_source.html#l00259">currentItemChanged()</a>, <a class="el" href="_help_browser_8cpp_source.html#l00342">find()</a>, <a class="el" href="_help_browser_8cpp_source.html#l00272">findTopicItem()</a>, <a class="el" href="_help_browser_8cpp_source.html#l00041">HelpBrowser()</a>, <a class="el" href="_help_browser_8cpp_source.html#l00140">loadContents()</a>, <a class="el" href="_help_browser_8cpp_source.html#l00120">loadContentsFromXml()</a>, <a class="el" href="_help_browser_8cpp_source.html#l00097">retranslateUi()</a>, <a class="el" href="_help_browser_8cpp_source.html#l00411">search()</a>, <a class="el" href="_help_browser_8cpp_source.html#l00237">searchItemChanged()</a>, and <a class="el" href="_help_browser_8cpp_source.html#l00302">showTopic()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_help_browser_8h_source.html">HelpBrowser.h</a></li>
<li><a class="el" href="_help_browser_8cpp_source.html">HelpBrowser.cpp</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Aug 30 22:58:56 2010 for Vidalia by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.2
>
i586
>
media
>
contrib-backports
>
by-pkgid
>
9601c7beb4ff23e834bfa171795ed560
>
files
>
507
