1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
|
'\" t
.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.
.\"
.ad l
.nh
.SH NAME
TQAssistantClient \- Means of using TQt Assistant as an application's help tool
.SH SYNOPSIS
\fC#include <tqassistantclient.h>\fR
.PP
Inherits TQObject.
.PP
.SS "Public Members"
.in +1c
.ti -1c
.BI "\fBTQAssistantClient\fR ( const TQString & path, TQObject * parent = 0, const char * name = 0 )"
.br
.ti -1c
.BI "\fB~TQAssistantClient\fR ()"
.br
.ti -1c
.BI "bool \fBisOpen\fR () const"
.br
.ti -1c
.BI "void \fBsetArguments\fR ( const TQStringList & args )"
.br
.in -1c
.SS "Public Slots"
.in +1c
.ti -1c
.BI "virtual void \fBopenAssistant\fR ()"
.br
.ti -1c
.BI "virtual void \fBcloseAssistant\fR ()"
.br
.ti -1c
.BI "virtual void \fBshowPage\fR ( const TQString & page )"
.br
.in -1c
.SS "Signals"
.in +1c
.ti -1c
.BI "void \fBassistantOpened\fR ()"
.br
.ti -1c
.BI "void \fBassistantClosed\fR ()"
.br
.ti -1c
.BI "void \fBerror\fR ( const TQString & msg )"
.br
.in -1c
.SS "Properties"
.in +1c
.ti -1c
.BI "bool \fBopen\fR - whether TQt Assistant is open \fI(read " "only" ")\fR"
.br
.in -1c
.SH DESCRIPTION
The TQAssistantClient class provides a means of using TQt Assistant as an application's help tool.
.PP
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 TQAssistantClient instance can open (openAssistant()) or close (closeAssistant()) TQt Assistant whenever required. If TQt Assistant is open, isOpen() returns TRUE.
.PP
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 \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
LIBS += -ltqassistantclient
.br
.fi
.PP
See also "Adding Documentation to TQt Assistant" in the TQt Assistant manual.
.SH MEMBER FUNCTION DOCUMENTATION
.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 "TQAssistantClient::~TQAssistantClient ()"
Destroys the assistant client object and frees up all allocated resources.
.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 TQAssistantClient::assistantOpened ()\fC [signal]\fR"
This signal is emitted when TQt Assistant is open and the client-server communication is set up.
.SH "void TQAssistantClient::closeAssistant ()\fC [virtual slot]\fR"
Use this function to close TQt Assistant.
.PP
See also assistantClosed().
.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 TQAssistantClient::isOpen () const"
Returns TRUE if TQt Assistant is open; otherwise returns FALSE. See the "open" property for details.
.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 TQAssistantClient::setArguments ( const TQStringList & args )"
Sets the command line arguments used when TQt Assistant is started to \fIargs\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.
.PP
See also open and assistantOpened().
.PP
Example: helpsystem/mainwindow.cpp.
.SS "Property Documentation"
.SH "bool open"
This property holds whether TQt Assistant is open.
.PP
Get this property's value with isOpen().
.SH "SEE ALSO"
.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
license file included in the distribution for a complete license
statement.
.SH AUTHOR
Generated automatically from the source code.
.SH BUGS
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 TQt documentation is provided in HTML format; it is
located at $TQTDIR/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.
.P
If you find errors in this manual page, please report them to
.BR [email protected] .
Please include the name of the manual page (tqassistantclient.3qt) and the Qt
version (3.3.8).
|
