<!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.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><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="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_b47abd1aad201a152869566145babb61.html">src</a> » <a class="el" href="dir_695ba8f8357372e02d38c40b3c6dbe81.html">vidalia</a> » <a class="el" href="dir_b6d10de2e9b292c6ec1000704888fbb8.html">help</a> » <a class="el" href="dir_29e5c2bf20d56a63773809b26e49a915.html">browser</a>
</div>
</div>
<div class="contents">
<h1>HelpBrowser.h</h1><a href="_help_browser_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">** This file is part of Vidalia, and is subject to the license terms in the</span>
<a name="l00003"></a>00003 <span class="comment">** LICENSE file, found in the top level directory of this distribution. If you</span>
<a name="l00004"></a>00004 <span class="comment">** did not receive the LICENSE file with this file, you may obtain it from the</span>
<a name="l00005"></a>00005 <span class="comment">** Vidalia source package distributed by the Vidalia Project at</span>
<a name="l00006"></a>00006 <span class="comment">** http://www.vidalia-project.net/. No part of Vidalia, including this file,</span>
<a name="l00007"></a>00007 <span class="comment">** may be copied, modified, propagated, or distributed except according to the</span>
<a name="l00008"></a>00008 <span class="comment">** terms described in the LICENSE file.</span>
<a name="l00009"></a>00009 <span class="comment">*/</span>
<a name="l00010"></a>00010
<a name="l00011"></a>00011 <span class="comment">/*</span>
<a name="l00012"></a>00012 <span class="comment">** \file HelpBrowser.h</span>
<a name="l00013"></a>00013 <span class="comment">** \version $Id: HelpBrowser.h 3735 2009-04-28 20:28:01Z edmanm $ </span>
<a name="l00014"></a>00014 <span class="comment">** \brief Displays a list of help topics and content</span>
<a name="l00015"></a>00015 <span class="comment">*/</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef _HELPBROWSER_H</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define _HELPBROWSER_H</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include "ui_HelpBrowser.h"</span>
<a name="l00021"></a>00021 <span class="preprocessor">#include "<a class="code" href="_vidalia_window_8h.html">VidaliaWindow.h</a>"</span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="preprocessor">#include <QMainWindow></span>
<a name="l00024"></a>00024 <span class="preprocessor">#include <QCloseEvent></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include <QDomDocument></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <QDomElement></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <QDomNodeList></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <QTreeWidgetItem></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <QTextBrowser></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <QTextCursor></span>
<a name="l00031"></a>00031
<a name="l00032"></a>00032
<a name="l00033"></a><a class="code" href="class_help_browser.html">00033</a> <span class="keyword">class </span><a class="code" href="class_help_browser.html">HelpBrowser</a> : <span class="keyword">public</span> <a class="code" href="class_vidalia_window.html">VidaliaWindow</a>
<a name="l00034"></a>00034 {
<a name="l00035"></a>00035 Q_OBJECT
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00038"></a>00038 <span class="comment"> /** Default constructor **/</span>
<a name="l00039"></a>00039 <a class="code" href="class_help_browser.html#a7c96dde0b9aa69e2f995aed8d4ed306d">HelpBrowser</a>(QWidget *parent = 0);
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="keyword">public</span> slots:<span class="comment"></span>
<a name="l00042"></a>00042 <span class="comment"> /** Overrides the default QWidget::show() */</span>
<a name="l00043"></a>00043 <span class="keywordtype">void</span> <a class="code" href="class_vidalia_window.html#a58aa3cff3f3cd54497431cef227df8b6">showWindow</a>(QString topic = QString());
<a name="l00044"></a>00044
<a name="l00045"></a>00045 <span class="keyword">protected</span>:<span class="comment"></span>
<a name="l00046"></a>00046 <span class="comment"> /** Called when the user changes the UI translation. */</span>
<a name="l00047"></a>00047 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_help_browser.html#a42f7ceb51f15ee807eabd01fcf4d1856">retranslateUi</a>();
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="keyword">private</span> slots:<span class="comment"></span>
<a name="l00050"></a>00050 <span class="comment"> /** Called when the user clicks "Find Next" */</span>
<a name="l00051"></a>00051 <span class="keywordtype">void</span> <a class="code" href="class_help_browser.html#a23f1243d56aca0a036814e1e7c610fe9">findNext</a>();<span class="comment"></span>
<a name="l00052"></a>00052 <span class="comment"> /** Called when the user clicks "Find Previous" */</span>
<a name="l00053"></a>00053 <span class="keywordtype">void</span> <a class="code" href="class_help_browser.html#a79379cc2e363626933337e7f325e3a71">findPrev</a>();<span class="comment"></span>
<a name="l00054"></a>00054 <span class="comment"> /** Called when the user starts a search */</span>
<a name="l00055"></a>00055 <span class="keywordtype">void</span> <a class="code" href="class_help_browser.html#a9b8fb34d23d43045684e144633039d60">search</a>();<span class="comment"></span>
<a name="l00056"></a>00056 <span class="comment"> /** Called when the user selects a different item in the contents tree */</span>
<a name="l00057"></a>00057 <span class="keywordtype">void</span> <a class="code" href="class_help_browser.html#a11c17a4292c52bcb770beebc473cff45">contentsItemChanged</a>(QTreeWidgetItem *current, QTreeWidgetItem *prev);<span class="comment"></span>
<a name="l00058"></a>00058 <span class="comment"> /** Called when the user selects a different item in the search tree */</span>
<a name="l00059"></a>00059 <span class="keywordtype">void</span> <a class="code" href="class_help_browser.html#af7debfbeccfbcb956ff2f0681992acce">searchItemChanged</a>(QTreeWidgetItem *current, QTreeWidgetItem *prev);
<a name="l00060"></a>00060
<a name="l00061"></a>00061 <span class="keyword">private</span>:<span class="comment"></span>
<a name="l00062"></a>00062 <span class="comment"> /** Returns the language in which help topics should appear, or English</span>
<a name="l00063"></a>00063 <span class="comment"> * ("en") if no translated help files exist for the current GUI language. */</span>
<a name="l00064"></a>00064 QString <a class="code" href="class_help_browser.html#ae95bb0c544007699aa90897216d9deda">language</a>();<span class="comment"></span>
<a name="l00065"></a>00065 <span class="comment"> /** Load the contents of the help topics tree from the specified XML file. */</span>
<a name="l00066"></a>00066 <span class="keywordtype">void</span> <a class="code" href="class_help_browser.html#a6c778836327da46249d79d08de1f2bd0">loadContentsFromXml</a>(QString xmlFile);<span class="comment"></span>
<a name="l00067"></a>00067 <span class="comment"> /** Load the contents of the help topics tree from the given DOM document. */</span>
<a name="l00068"></a>00068 <span class="keywordtype">bool</span> <a class="code" href="class_help_browser.html#ad43fd7148c403b9390c30269909f94ec">loadContents</a>(<span class="keyword">const</span> QDomDocument *document, QString &errorString);<span class="comment"></span>
<a name="l00069"></a>00069 <span class="comment"> /** Parse a Topic element and handle all its children. */</span>
<a name="l00070"></a>00070 <span class="keywordtype">void</span> <a class="code" href="class_help_browser.html#ae7c004b8d205f92252188758b71d94cb">parseHelpTopic</a>(<span class="keyword">const</span> QDomElement &element, QTreeWidgetItem *parent);<span class="comment"></span>
<a name="l00071"></a>00071 <span class="comment"> /** Returns true if the given Topic element has the necessary attributes. */</span>
<a name="l00072"></a>00072 <span class="keywordtype">bool</span> <a class="code" href="class_help_browser.html#af1b92353c4777d628ce882af91d53ccb">isValidTopicElement</a>(<span class="keyword">const</span> QDomElement &topicElement);<span class="comment"></span>
<a name="l00073"></a>00073 <span class="comment"> /** Builds a resource path to an html file associated with a help topic. */</span>
<a name="l00074"></a>00074 QString <a class="code" href="class_help_browser.html#a59625e5b0e5adb8afe055a59b2c3e883">getResourcePath</a>(<span class="keyword">const</span> QDomElement &topicElement);<span class="comment"></span>
<a name="l00075"></a>00075 <span class="comment"> /** Searches the current page for the phrase in the Find box */</span>
<a name="l00076"></a>00076 <span class="keywordtype">void</span> <a class="code" href="class_help_browser.html#ad57653be8683ad2b94f973d31ad2bf82">find</a>(<span class="keywordtype">bool</span> forward);<span class="comment"></span>
<a name="l00077"></a>00077 <span class="comment"> /** Creates a new item to be placed in the topic tree. */</span>
<a name="l00078"></a>00078 QTreeWidgetItem* <a class="code" href="class_help_browser.html#a6099416803afd9fc7b5ffb0b2ff9c081">createTopicTreeItem</a>(<span class="keyword">const</span> QDomElement &topicElement,
<a name="l00079"></a>00079 QTreeWidgetItem *parent);<span class="comment"></span>
<a name="l00080"></a>00080 <span class="comment"> /** Called when the user selects a different item in the tree. */</span>
<a name="l00081"></a>00081 <span class="keywordtype">void</span> <a class="code" href="class_help_browser.html#a8042e2a5c5264ede08b64a9098649861">currentItemChanged</a>(QTreeWidgetItem *current, QTreeWidgetItem *prev);<span class="comment"></span>
<a name="l00082"></a>00082 <span class="comment"> /** Finds a topic in the topic tree. */</span>
<a name="l00083"></a>00083 QTreeWidgetItem* <a class="code" href="class_help_browser.html#a75fafd717174c766ff9c1a34bfcbe834">findTopicItem</a>(QTreeWidgetItem *startItem, QString topic);<span class="comment"></span>
<a name="l00084"></a>00084 <span class="comment"> /** Shows the help browser and finds a specific a topic in the browser. */</span>
<a name="l00085"></a>00085 <span class="keywordtype">void</span> <a class="code" href="class_help_browser.html#a36d2642ed0cfb1584ae903de2f4892ae">showTopic</a>(QString topic);
<a name="l00086"></a>00086 <span class="comment"></span>
<a name="l00087"></a>00087 <span class="comment"> /** List of DOM elements representing topics. */</span>
<a name="l00088"></a><a class="code" href="class_help_browser.html#a018b0fc1d8783d4ba72725c66c4137d9">00088</a> QList<QDomElement> <a class="code" href="class_help_browser.html#a018b0fc1d8783d4ba72725c66c4137d9">_elementList</a>;<span class="comment"></span>
<a name="l00089"></a>00089 <span class="comment"> /** Last phrase used for 'Find' */</span>
<a name="l00090"></a><a class="code" href="class_help_browser.html#a1e7afbaec5cf48534a92f1cdaec2f100">00090</a> QString <a class="code" href="class_help_browser.html#a1e7afbaec5cf48534a92f1cdaec2f100">_lastFind</a>;<span class="comment"></span>
<a name="l00091"></a>00091 <span class="comment"> /** Last phrase searched on */</span>
<a name="l00092"></a><a class="code" href="class_help_browser.html#a5fc1c44d6f56209cefa90158faf75717">00092</a> QString <a class="code" href="class_help_browser.html#a5fc1c44d6f56209cefa90158faf75717">_lastSearch</a>;<span class="comment"></span>
<a name="l00093"></a>00093 <span class="comment"> /** Indicates if phrase was previously found on current page */</span>
<a name="l00094"></a><a class="code" href="class_help_browser.html#a0cc45464b816dcb82a575b64776067d6">00094</a> <span class="keywordtype">bool</span> <a class="code" href="class_help_browser.html#a0cc45464b816dcb82a575b64776067d6">_foundBefore</a>;
<a name="l00095"></a>00095 <span class="comment"></span>
<a name="l00096"></a>00096 <span class="comment"> /** Qt Designer generated QObject */</span>
<a name="l00097"></a><a class="code" href="class_help_browser.html#a3c0d594bacec354376ba1a3b1cbf6545">00097</a> Ui::HelpBrowser <a class="code" href="class_help_browser.html#a3c0d594bacec354376ba1a3b1cbf6545">ui</a>;
<a name="l00098"></a>00098 };
<a name="l00099"></a>00099
<a name="l00100"></a>00100 <span class="preprocessor">#endif</span>
<a name="l00101"></a>00101 <span class="preprocessor"></span>
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Aug 30 22:58:54 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>
