1QAssistantClient(3qt) QAssistantClient(3qt)
2
3
4
6 QAssistantClient - Means of using Qt Assistant as an application's help
7 tool
8
10 #include <qassistantclient.h>
11
12 Inherits QObject.
13
14 Public Members
15 QAssistantClient ( const QString & path, QObject * parent = 0, const
16 char * name = 0 )
17 ~QAssistantClient ()
18 bool isOpen () const
19 void setArguments ( const QStringList & args )
20
21 Public Slots
22 virtual void openAssistant ()
23 virtual void closeAssistant ()
24 virtual void showPage ( const QString & page )
25
26 Signals
27 void assistantOpened ()
28 void assistantClosed ()
29 void error ( const QString & msg )
30
31 Properties
32 bool open - whether Qt Assistant is open (read only)
33
35 The QAssistantClient class provides a means of using Qt Assistant as an
36 application's help tool.
37
38 Using Qt Assistant is simple: Create a QAssistantClient instance, then
39 call showPage() as often as necessary to show your help pages. When you
40 call showPage(), Qt Assistant will be launched if it isn't already
41 running.
42
43 The QAssistantClient instance can open (openAssistant()) or close
44 (closeAssistant()) Qt Assistant whenever required. If Qt Assistant is
45 open, isOpen() returns TRUE.
46
47 One QAssistantClient instance interacts with one Qt Assistant instance,
48 so every time you call openAssistant(), showPage() or closeAssistant()
49 they are applied to the particular Qt Assistant instance associated
50 with the QAssistantClient.
51
52 When you call openAssistant() the assistantOpened() signal is emitted.
53 Similarly when closeAssistant() is called, assistantClosed() is
54 emitted. In either case, if an error occurs, error() is emitted.
55
56 This class is not included in the Qt library itself. To use it you must
57 link against libqassistantclient.a (Unix) or qassistantclient.lib
58 (Windows), which is built into INSTALL/lib if you built the Qt tools
59 (INSTALL is the directory where Qt is installed). If you use qmake,
60 then you can simply add the following line to your pro file:
61
62 LIBS += -lqassistantclient
63
64 See also "Adding Documentation to Qt Assistant" in the Qt Assistant
65 manual.
66
69 0, const char * name = 0 )
70 Constructs an assistant client object. The path specifies the path to
71 the Qt Assistant executable. If path is an empty string the system path
72 (%PATH% or $PATH) is used.
73
74 The assistant client object is a child of parent and is called name.
75
77 Destroys the assistant client object and frees up all allocated
78 resources.
79
81 This signal is emitted when the connection to Qt Assistant is closed.
82 This happens when the user exits Qt Assistant, or when an error in the
83 server or client occurs, or if closeAssistant() is called.
84
86 This signal is emitted when Qt Assistant is open and the client-server
87 communication is set up.
88
90 Use this function to close Qt Assistant.
91
92 See also assistantClosed().
93
95 This signal is emitted if Qt Assistant cannot be started or if an error
96 occurs during the initialization of the connection between Qt Assistant
97 and the calling application. The msg provides an explanation of the
98 error.
99
101 Returns TRUE if Qt Assistant is open; otherwise returns FALSE. See the
102 "open" property for details.
103
105 This function opens Qt Assistant and sets up the client-server
106 communiction between the application and Qt Assistant. If it is already
107 open, this function does nothing. If an error occurs, error() is
108 emitted.
109
110 See also assistantOpened().
111
113 Sets the command line arguments used when Qt Assistant is started to
114 args.
115
117 Call this function to make Qt Assistant show a particular page. The
118 page is a filename (e.g. myhelpfile.html). See "Adding Documentation to
119 Qt Assistant" in the Qt Assistant manual for further information.
120
121 If Qt Assistant hasn't been opened yet, this function will do nothing.
122 You can use isOpen() to determine whether Qt Assistant is up and
123 running, or you can connect to the asssistantOpened() signal.
124
125 See also open and assistantOpened().
126
127 Example: helpsystem/mainwindow.cpp.
128
129 Property Documentation
131 This property holds whether Qt Assistant is open.
132
133 Get this property's value with isOpen().
134
135
137 http://doc.trolltech.com/qassistantclient.html
138 http://www.trolltech.com/faq/tech.html
139
141 Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the
142 license file included in the distribution for a complete license
143 statement.
144
146 Generated automatically from the source code.
147
149 If you find a bug in Qt, please report it as described in
150 http://doc.trolltech.com/bughowto.html. Good bug reports help us to
151 help you. Thank you.
152
153 The definitive Qt documentation is provided in HTML format; it is
154 located at $QTDIR/doc/html and can be read using Qt Assistant or with a
155 web browser. This man page is provided as a convenience for those users
156 who prefer man pages, although this format is not officially supported
157 by Trolltech.
158
159 If you find errors in this manual page, please report them to qt-
160 bugs@trolltech.com. Please include the name of the manual page
161 (qassistantclient.3qt) and the Qt version (3.3.8).
162
163
164
165Trolltech AS 2 February 2007 QAssistantClient(3qt)