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 0f3886e83..ecf6581e0 100644 --- a/doc/man/man3/tqassistantclient.3qt +++ b/doc/man/man3/tqassistantclient.3qt @@ -7,7 +7,7 @@ .ad l .nh .SH NAME -QAssistantClient \- Means of using Qt Assistant as an application's help tool +QAssistantClient \- Means of using TQt Assistant as an application's help tool .SH SYNOPSIS \fC#include <ntqassistantclient.h>\fR .PP @@ -55,21 +55,21 @@ Inherits QObject. .SS "Properties" .in +1c .ti -1c -.BI "bool \fBopen\fR - whether Qt Assistant is open \fI(read " "only" ")\fR" +.BI "bool \fBopen\fR - whether TQt Assistant is open \fI(read " "only" ")\fR" .br .in -1c .SH DESCRIPTION -The QAssistantClient class provides a means of using Qt Assistant as an application's help tool. +The QAssistantClient class provides a means of using TQt Assistant as an application's help tool. .PP -Using Qt Assistant is simple: Create a QAssistantClient instance, then call showPage() as often as necessary to show your help pages. When you call showPage(), Qt Assistant will be launched if it isn't already running. +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. .PP -The QAssistantClient instance can open (openAssistant()) or close (closeAssistant()) Qt Assistant whenever required. If Qt Assistant is open, isOpen() returns TRUE. +The QAssistantClient 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 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. +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. .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 Qt 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 Qt tools (\fCINSTALL\fR is the directory where Qt 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 \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: .PP .nf .br @@ -77,43 +77,43 @@ This class is not included in the Qt library itself. To use it you must link aga .br .fi .PP -See also "Adding Documentation to Qt Assistant" in the Qt Assistant manual. +See also "Adding Documentation to TQt Assistant" in the TQt Assistant manual. .SH MEMBER FUNCTION DOCUMENTATION .SH "QAssistantClient::QAssistantClient ( const QString & path, QObject * parent = 0, const char * name = 0 )" -Constructs an assistant client object. The \fIpath\fR specifies the path to the Qt Assistant executable. If \fIpath\fR is an empty string the system path (\fC%PATH%\fR or \fC$PATH\fR) is used. +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 ()" Destroys the assistant client object and frees up all allocated resources. .SH "void QAssistantClient::assistantClosed ()\fC [signal]\fR" -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 closeAssistant() is called. +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" -This signal is emitted when Qt Assistant is open and the client-server communication is set up. +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" -Use this function to close Qt Assistant. +Use this function to close TQt Assistant. .PP See also assistantClosed(). .SH "void QAssistantClient::error ( const QString & msg )\fC [signal]\fR" -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 \fImsg\fR provides an explanation of the error. +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" -Returns TRUE if Qt Assistant is open; otherwise returns FALSE. See the "open" property for details. +Returns TRUE if TQt Assistant is open; otherwise returns FALSE. See the "open" property for details. .SH "void QAssistantClient::openAssistant ()\fC [virtual slot]\fR" -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, error() is emitted. +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 QStringList & args )" -Sets the command line arguments used when Qt Assistant is started to \fIargs\fR. +Sets the command line arguments used when TQt Assistant is started to \fIargs\fR. .SH "void QAssistantClient::showPage ( const QString & page )\fC [virtual slot]\fR" -Call this function to make Qt Assistant show a particular \fIpage\fR. The \fIpage\fR is a filename (e.g. \fCmyhelpfile.html\fR). See "Adding Documentation to Qt Assistant" in the Qt Assistant manual for further information. +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 Qt Assistant hasn't been opened yet, this function will do nothing. You can use isOpen() to determine whether Qt Assistant is up and running, or you can connect to the asssistantOpened() signal. +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. .PP See also open and assistantOpened(). .PP Example: helpsystem/mainwindow.cpp. .SS "Property Documentation" .SH "bool open" -This property holds whether Qt Assistant is open. +This property holds whether TQt Assistant is open. .PP Get this property's value with isOpen(). @@ -131,8 +131,8 @@ If you find a bug in Qt, please report it as described in .BR http://doc.trolltech.com/bughowto.html . Good bug reports help us to help you. Thank you. .P -The definitive Qt documentation is provided in HTML format; it is -located at $QTDIR/doc/html and can be read using Qt Assistant or with +The definitive TQt documentation is provided in HTML format; it is +located at $QTDIR/doc/html and can be read using TQt Assistant or with a web browser. This man page is provided as a convenience for those users who prefer man pages, although this format is not officially supported by Trolltech. |