diff options
Diffstat (limited to 'doc/man/man3/tqassistantclient.3qt')
| -rw-r--r-- | doc/man/man3/tqassistantclient.3qt | 42 |
1 files changed, 21 insertions, 21 deletions
diff --git a/doc/man/man3/tqassistantclient.3qt b/doc/man/man3/tqassistantclient.3qt index bd734cf5..279b51d9 100644 --- a/doc/man/man3/tqassistantclient.3qt +++ b/doc/man/man3/tqassistantclient.3qt @@ -1,5 +1,5 @@ '\" t -.TH QAssistantClient 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- +.TH TQAssistantClient 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- .\" Copyright 1992-2007 Trolltech ASA. All rights reserved. See the .\" license file included in the distribution for a complete license .\" statement. @@ -7,19 +7,19 @@ .ad l .nh .SH NAME -QAssistantClient \- Means of using TQt Assistant as an application's help tool +TQAssistantClient \- Means of using TQt Assistant as an application's help tool .SH SYNOPSIS -\fC#include <ntqassistantclient.h>\fR +\fC#include <tqassistantclient.h>\fR .PP Inherits TQObject. .PP .SS "Public Members" .in +1c .ti -1c -.BI "\fBQAssistantClient\fR ( const TQString & path, TQObject * parent = 0, const char * name = 0 )" +.BI "\fBTQAssistantClient\fR ( const TQString & path, TQObject * parent = 0, const char * name = 0 )" .br .ti -1c -.BI "\fB~QAssistantClient\fR ()" +.BI "\fB~TQAssistantClient\fR ()" .br .ti -1c .BI "bool \fBisOpen\fR () const" @@ -59,17 +59,17 @@ Inherits TQObject. .br .in -1c .SH DESCRIPTION -The QAssistantClient class provides a means of using TQt Assistant as an application's help tool. +The TQAssistantClient class provides a means of using TQt Assistant as an application's help tool. .PP -Using TQt Assistant is simple: Create a QAssistantClient instance, then call showPage() as often as necessary to show your help pages. When you call showPage(), TQt Assistant will be launched if it isn't already running. +Using TQt Assistant is simple: Create a TQAssistantClient instance, then call showPage() as often as necessary to show your help pages. When you call showPage(), TQt Assistant will be launched if it isn't already running. .PP -The QAssistantClient instance can open (openAssistant()) or close (closeAssistant()) TQt Assistant whenever required. If TQt Assistant is open, isOpen() returns TRUE. +The TQAssistantClient instance can open (openAssistant()) or close (closeAssistant()) TQt Assistant whenever required. If TQt Assistant is open, isOpen() returns TRUE. .PP -One QAssistantClient instance interacts with one TQt Assistant instance, so every time you call openAssistant(), showPage() or closeAssistant() they are applied to the particular TQt Assistant instance associated with the QAssistantClient. +One TQAssistantClient instance interacts with one TQt Assistant instance, so every time you call openAssistant(), showPage() or closeAssistant() they are applied to the particular TQt Assistant instance associated with the TQAssistantClient. .PP When you call openAssistant() the assistantOpened() signal is emitted. Similarly when closeAssistant() is called, assistantClosed() is emitted. In either case, if an error occurs, error() is emitted. .PP -This class is not included in the TQt library itself. To use it you must link against \fClibtqassistantclient.a\fR (Unix) or \fCqassistantclient.lib\fR (Windows), which is built into \fCINSTALL/lib\fR if you built the TQt tools (\fCINSTALL\fR is the directory where TQt is installed). If you use qmake, then you can simply add the following line to your pro file: +This class is not included in the TQt library itself. To use it you must link against \fClibtqassistantclient.a\fR (Unix) or \fCtqassistantclient.lib\fR (Windows), which is built into \fCINSTALL/lib\fR if you built the TQt tools (\fCINSTALL\fR is the directory where TQt is installed). If you use qmake, then you can simply add the following line to your pro file: .PP .nf .br @@ -79,31 +79,31 @@ This class is not included in the TQt library itself. To use it you must link ag .PP See also "Adding Documentation to TQt Assistant" in the TQt Assistant manual. .SH MEMBER FUNCTION DOCUMENTATION -.SH "QAssistantClient::QAssistantClient ( const TQString & path, TQObject * parent = 0, const char * name = 0 )" +.SH "TQAssistantClient::TQAssistantClient ( const TQString & path, TQObject * parent = 0, const char * name = 0 )" Constructs an assistant client object. The \fIpath\fR specifies the path to the TQt Assistant executable. If \fIpath\fR is an empty string the system path (\fC%PATH%\fR or \fC$PATH\fR) is used. .PP The assistant client object is a child of \fIparent\fR and is called \fIname\fR. -.SH "QAssistantClient::~QAssistantClient ()" +.SH "TQAssistantClient::~TQAssistantClient ()" Destroys the assistant client object and frees up all allocated resources. -.SH "void QAssistantClient::assistantClosed ()\fC [signal]\fR" +.SH "void TQAssistantClient::assistantClosed ()\fC [signal]\fR" This signal is emitted when the connection to TQt Assistant is closed. This happens when the user exits TQt Assistant, or when an error in the server or client occurs, or if closeAssistant() is called. -.SH "void QAssistantClient::assistantOpened ()\fC [signal]\fR" +.SH "void TQAssistantClient::assistantOpened ()\fC [signal]\fR" This signal is emitted when TQt Assistant is open and the client-server communication is set up. -.SH "void QAssistantClient::closeAssistant ()\fC [virtual slot]\fR" +.SH "void TQAssistantClient::closeAssistant ()\fC [virtual slot]\fR" Use this function to close TQt Assistant. .PP See also assistantClosed(). -.SH "void QAssistantClient::error ( const TQString & msg )\fC [signal]\fR" +.SH "void TQAssistantClient::error ( const TQString & msg )\fC [signal]\fR" This signal is emitted if TQt Assistant cannot be started or if an error occurs during the initialization of the connection between TQt Assistant and the calling application. The \fImsg\fR provides an explanation of the error. -.SH "bool QAssistantClient::isOpen () const" +.SH "bool TQAssistantClient::isOpen () const" Returns TRUE if TQt Assistant is open; otherwise returns FALSE. See the "open" property for details. -.SH "void QAssistantClient::openAssistant ()\fC [virtual slot]\fR" +.SH "void TQAssistantClient::openAssistant ()\fC [virtual slot]\fR" This function opens TQt Assistant and sets up the client-server communiction between the application and TQt Assistant. If it is already open, this function does nothing. If an error occurs, error() is emitted. .PP See also assistantOpened(). -.SH "void QAssistantClient::setArguments ( const TQStringList & args )" +.SH "void TQAssistantClient::setArguments ( const TQStringList & args )" Sets the command line arguments used when TQt Assistant is started to \fIargs\fR. -.SH "void QAssistantClient::showPage ( const TQString & page )\fC [virtual slot]\fR" +.SH "void TQAssistantClient::showPage ( const TQString & page )\fC [virtual slot]\fR" Call this function to make TQt Assistant show a particular \fIpage\fR. The \fIpage\fR is a filename (e.g. \fCmyhelpfile.html\fR). See "Adding Documentation to TQt Assistant" in the TQt Assistant manual for further information. .PP If TQt Assistant hasn't been opened yet, this function will do nothing. You can use isOpen() to determine whether TQt Assistant is up and running, or you can connect to the asssistantOpened() signal. @@ -118,7 +118,7 @@ This property holds whether TQt Assistant is open. Get this property's value with isOpen(). .SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqassistantclient.html +.BR http://doc.trolltech.com/tqassistantclient.html .BR http://www.trolltech.com/faq/tech.html .SH COPYRIGHT Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the |