diff options
| author | Timothy Pearson <kb9vqf@pearsoncomputing.net> | 2011-07-10 15:24:15 -0500 |
|---|---|---|
| committer | Timothy Pearson <kb9vqf@pearsoncomputing.net> | 2011-07-10 15:24:15 -0500 |
| commit | bd0f3345a938b35ce6a12f6150373b0955b8dd12 (patch) | |
| tree | 7a520322212d48ebcb9fbe1087e7fca28b76185c /doc/html/qassistantclient.html | |
| download | qt3-bd0f3345a938b35ce6a12f6150373b0955b8dd12.tar.gz qt3-bd0f3345a938b35ce6a12f6150373b0955b8dd12.zip | |
Add Qt3 development HEAD version
Diffstat (limited to 'doc/html/qassistantclient.html')
| -rw-r--r-- | doc/html/qassistantclient.html | 179 |
1 files changed, 179 insertions, 0 deletions
diff --git a/doc/html/qassistantclient.html b/doc/html/qassistantclient.html new file mode 100644 index 0000000..af3a3c1 --- /dev/null +++ b/doc/html/qassistantclient.html @@ -0,0 +1,179 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/tools/assistant/lib/qassistantclient.cpp:55 --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>QAssistantClient Class</title> +<style type="text/css"><!-- +fn { margin-left: 1cm; text-indent: -1cm; } +a:link { color: #004faf; text-decoration: none } +a:visited { color: #672967; text-decoration: none } +body { background: #ffffff; color: black; } +--></style> +</head> +<body> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> +<tr bgcolor="#E5E5E5"> +<td 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="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QAssistantClient Class Reference</h1> + +<p>The QAssistantClient class provides a means of using Qt +Assistant as an application's help tool. +<a href="#details">More...</a> +<p><tt>#include <<a href="qassistantclient-h.html">qassistantclient.h</a>></tt> +<p>Inherits <a href="qobject.html">QObject</a>. +<p><a href="qassistantclient-members.html">List of all member functions.</a> +<h2>Public Members</h2> +<ul> +<li class=fn><a href="#QAssistantClient"><b>QAssistantClient</b></a> ( const QString & path, QObject * parent = 0, const char * name = 0 )</li> +<li class=fn><a href="#~QAssistantClient"><b>~QAssistantClient</b></a> ()</li> +<li class=fn>bool <a href="#isOpen"><b>isOpen</b></a> () const</li> +<li class=fn>void <a href="#setArguments"><b>setArguments</b></a> ( const QStringList & args )</li> +</ul> +<h2>Public Slots</h2> +<ul> +<li class=fn>virtual void <a href="#openAssistant"><b>openAssistant</b></a> ()</li> +<li class=fn>virtual void <a href="#closeAssistant"><b>closeAssistant</b></a> ()</li> +<li class=fn>virtual void <a href="#showPage"><b>showPage</b></a> ( const QString & page )</li> +</ul> +<h2>Signals</h2> +<ul> +<li class=fn>void <a href="#assistantOpened"><b>assistantOpened</b></a> ()</li> +<li class=fn>void <a href="#assistantClosed"><b>assistantClosed</b></a> ()</li> +<li class=fn>void <a href="#error"><b>error</b></a> ( const QString & msg )</li> +</ul> +<h2>Properties</h2> +<ul> +<li class=fn>bool <a href="#open-prop"><b>open</b></a> - whether Qt Assistant is open <em>(read only)</em></li> +</ul> +<hr><a name="details"></a><h2>Detailed Description</h2> + + +The QAssistantClient class provides a means of using Qt +Assistant as an application's help tool. +<p> Using Qt Assistant is simple: Create a QAssistantClient instance, +then call <a href="#showPage">showPage</a>() as often as necessary to show your help +pages. When you call showPage(), Qt Assistant will be launched if +it isn't already running. +<p> The QAssistantClient instance can open (<a href="#openAssistant">openAssistant</a>()) or close +(<a href="#closeAssistant">closeAssistant</a>()) Qt Assistant whenever required. If Qt Assistant +is open, <a href="#isOpen">isOpen</a>() returns TRUE. +<p> One QAssistantClient instance interacts with one Qt Assistant +instance, so every time you call openAssistant(), showPage() or +closeAssistant() they are applied to the particular Qt Assistant +instance associated with the QAssistantClient. +<p> When you call openAssistant() the <a href="#assistantOpened">assistantOpened</a>() signal is +emitted. Similarly when closeAssistant() is called, +<a href="#assistantClosed">assistantClosed</a>() is emitted. In either case, if an error occurs, +<a href="#error">error</a>() is emitted. +<p> This class is not included in the Qt library itself. To use it you +must link against <tt>libqassistantclient.a</tt> (Unix) or <tt>qassistantclient.lib</tt> (Windows), which is built into <tt>INSTALL/lib</tt> +if you built the Qt tools (<tt>INSTALL</tt> is the directory where Qt is +installed). If you use qmake, then you can simply add the following +line to your pro file: +<p> <pre> + LIBS += -lqassistantclient + </pre> + +<p> See also "Adding Documentation to Qt Assistant" in the <a href="assistant.html">Qt Assistant manual</a>. + +<hr><h2>Member Function Documentation</h2> +<h3 class=fn><a name="QAssistantClient"></a>QAssistantClient::QAssistantClient ( const <a href="qstring.html">QString</a> & path, <a href="qobject.html">QObject</a> * parent = 0, const char * name = 0 ) +</h3> +Constructs an assistant client object. The <em>path</em> specifies the +path to the Qt Assistant executable. If <em>path</em> is an empty +string the system path (<tt>%PATH%</tt> or <tt>$PATH</tt>) is used. +<p> The assistant client object is a child of <em>parent</em> and is called +<em>name</em>. + +<h3 class=fn><a name="~QAssistantClient"></a>QAssistantClient::~QAssistantClient () +</h3> +Destroys the assistant client object and frees up all allocated +resources. + +<h3 class=fn>void <a name="assistantClosed"></a>QAssistantClient::assistantClosed ()<tt> [signal]</tt> +</h3> + +<p> This signal is emitted when the connection to Qt Assistant is +closed. This happens when the user exits Qt Assistant, or when an +error in the server or client occurs, or if <a href="#closeAssistant">closeAssistant</a>() is +called. + +<h3 class=fn>void <a name="assistantOpened"></a>QAssistantClient::assistantOpened ()<tt> [signal]</tt> +</h3> + +<p> This signal is emitted when Qt Assistant is open and the +client-server communication is set up. + +<h3 class=fn>void <a name="closeAssistant"></a>QAssistantClient::closeAssistant ()<tt> [virtual slot]</tt> +</h3> +Use this function to close Qt Assistant. +<p> <p>See also <a href="#assistantClosed">assistantClosed</a>(). + +<h3 class=fn>void <a name="error"></a>QAssistantClient::error ( const <a href="qstring.html">QString</a> & msg )<tt> [signal]</tt> +</h3> + +<p> This signal is emitted if Qt Assistant cannot be started or if an +error occurs during the initialization of the connection between +Qt Assistant and the calling application. The <em>msg</em> provides an +explanation of the error. + +<h3 class=fn>bool <a name="isOpen"></a>QAssistantClient::isOpen () const +</h3><p>Returns TRUE if Qt Assistant is open; otherwise returns FALSE. +See the <a href="qassistantclient.html#open-prop">"open"</a> property for details. +<h3 class=fn>void <a name="openAssistant"></a>QAssistantClient::openAssistant ()<tt> [virtual slot]</tt> +</h3> +This function opens Qt Assistant and sets up the client-server +communiction between the application and Qt Assistant. If it is +already open, this function does nothing. If an error occurs, +<a href="#error">error</a>() is emitted. +<p> <p>See also <a href="#assistantOpened">assistantOpened</a>(). + +<h3 class=fn>void <a name="setArguments"></a>QAssistantClient::setArguments ( const <a href="qstringlist.html">QStringList</a> & args ) +</h3> +Sets the command line arguments used when Qt Assistant is +started to <em>args</em>. + +<h3 class=fn>void <a name="showPage"></a>QAssistantClient::showPage ( const <a href="qstring.html">QString</a> & page )<tt> [virtual slot]</tt> +</h3> +Call this function to make Qt Assistant show a particular <em>page</em>. +The <em>page</em> is a filename (e.g. <tt>myhelpfile.html</tt>). See "Adding +Documentation to Qt Assistant" in the <a href="assistant.html">Qt + Assistant manual</a> for further information. +<p> If Qt Assistant hasn't been <a href="#openAssistant">opened</a> +yet, this function will do nothing. You can use <a href="#isOpen">isOpen</a>() to +determine whether Qt Assistant is up and running, or you can +connect to the asssistantOpened() signal. +<p> <p>See also <a href="#open-prop">open</a> and <a href="#assistantOpened">assistantOpened</a>(). + +<p>Example: <a href="helpsystem-example.html#x2686">helpsystem/mainwindow.cpp</a>. +<hr><h2>Property Documentation</h2> +<h3 class=fn>bool <a name="open-prop"></a>open</h3> +<p>This property holds whether Qt Assistant is open. +<p> +<p>Get this property's value with <a href="#isOpen">isOpen</a>(). +<!-- eof --> +<hr><p> +This file is part of the <a href="index.html">Qt toolkit</a>. +Copyright © 1995-2007 +<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center> +<table width=100% cellspacing=0 border=0><tr> +<td>Copyright © 2007 +<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a> +<td align=right><div align=right>Qt 3.3.8</div> +</table></div></address></body> +</html> |