diff options
Diffstat (limited to 'doc/man/man3/tqsocketnotifier.3qt')
| -rw-r--r-- | doc/man/man3/tqsocketnotifier.3qt | 54 |
1 files changed, 27 insertions, 27 deletions
diff --git a/doc/man/man3/tqsocketnotifier.3qt b/doc/man/man3/tqsocketnotifier.3qt index 432975247..d351b028d 100644 --- a/doc/man/man3/tqsocketnotifier.3qt +++ b/doc/man/man3/tqsocketnotifier.3qt @@ -1,5 +1,5 @@ '\" t -.TH QSocketNotifier 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- +.TH TQSocketNotifier 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,9 +7,9 @@ .ad l .nh .SH NAME -QSocketNotifier \- Support for socket callbacks +TQSocketNotifier \- Support for socket callbacks .SH SYNOPSIS -\fC#include <ntqsocketnotifier.h>\fR +\fC#include <tqsocketnotifier.h>\fR .PP Inherits TQObject. .PP @@ -19,10 +19,10 @@ Inherits TQObject. .BI "enum \fBType\fR { Read, Write, Exception }" .br .ti -1c -.BI "\fBQSocketNotifier\fR ( int socket, Type type, TQObject * parent = 0, const char * name = 0 )" +.BI "\fBTQSocketNotifier\fR ( int socket, Type type, TQObject * parent = 0, const char * name = 0 )" .br .ti -1c -.BI "\fB~QSocketNotifier\fR ()" +.BI "\fB~TQSocketNotifier\fR ()" .br .ti -1c .BI "int \fBsocket\fR () const" @@ -44,23 +44,23 @@ Inherits TQObject. .br .in -1c .SH DESCRIPTION -The QSocketNotifier class provides support for socket callbacks. +The TQSocketNotifier class provides support for socket callbacks. .PP This class makes it possible to write asynchronous socket-based code in Qt. Using synchronous socket operations blocks the program, which is clearly not acceptable for an event-driven GUI program. .PP Once you have opened a non-blocking socket (whether for TCP, UDP, a UNIX-domain socket, or any other protocol family your operating system supports), you can create a socket notifier to monitor the socket. Then you connect the activated() signal to the slot you want to be called when a socket event occurs. .PP -Note for Windows users: the socket passed to QSocketNotifier will become non-blocking, even if it was created as a blocking socket. +Note for Windows users: the socket passed to TQSocketNotifier will become non-blocking, even if it was created as a blocking socket. .PP There are three types of socket notifiers (read, write and exception); you must specify one of these in the constructor. .PP The type specifies when the activated() signal is to be emitted: <ol type=1> .IP 1 -QSocketNotifier::Read - There is data to be read (socket read event). +TQSocketNotifier::Read - There is data to be read (socket read event). .IP 2 -QSocketNotifier::Write - Data can be written (socket write event). +TQSocketNotifier::Write - Data can be written (socket write event). .IP 3 -QSocketNofifier::Exception - An exception has occurred (socket exception event). We recommend against using this. +TQSocketNofifier::Exception - An exception has occurred (socket exception event). We recommend against using this. .PP For example, if you need to monitor both reads and writes for the same socket you must create two socket notifiers. .PP @@ -78,41 +78,41 @@ Socket action is detected in the main event loop of Qt. The X11 version of TQt h .PP Note that on XFree86 for OS/2, select() works only in the thread in which main() is running; you should therefore use that thread for GUI operations. .PP -See also QSocket, QServerSocket, QSocketDevice, QFile::handle(), and Input/Output and Networking. +See also TQSocket, TQServerSocket, TQSocketDevice, TQFile::handle(), and Input/Output and Networking. .SS "Member Type Documentation" -.SH "QSocketNotifier::Type" +.SH "TQSocketNotifier::Type" .TP -\fCQSocketNotifier::Read\fR +\fCTQSocketNotifier::Read\fR .TP -\fCQSocketNotifier::Write\fR +\fCTQSocketNotifier::Write\fR .TP -\fCQSocketNotifier::Exception\fR +\fCTQSocketNotifier::Exception\fR .SH MEMBER FUNCTION DOCUMENTATION -.SH "QSocketNotifier::QSocketNotifier ( int socket, Type type, TQObject * parent = 0, const char * name = 0 )" +.SH "TQSocketNotifier::TQSocketNotifier ( int socket, Type type, TQObject * parent = 0, const char * name = 0 )" Constructs a socket notifier called \fIname\fR, with the parent, \fIparent\fR. It watches \fIsocket\fR for \fItype\fR events, and enables it. .PP It is generally advisable to explicitly enable or disable the socket notifier, especially for write notifiers. .PP See also setEnabled() and isEnabled(). -.SH "QSocketNotifier::~QSocketNotifier ()" +.SH "TQSocketNotifier::~TQSocketNotifier ()" Destroys the socket notifier. -.SH "void QSocketNotifier::activated ( int socket )\fC [signal]\fR" +.SH "void TQSocketNotifier::activated ( int socket )\fC [signal]\fR" This signal is emitted under certain conditions specified by the notifier type(): <ol type=1> .TP -QSocketNotifier::Read - There is data to be read (socket read event). +TQSocketNotifier::Read - There is data to be read (socket read event). .TP -QSocketNotifier::Write - Data can be written (socket write event). +TQSocketNotifier::Write - Data can be written (socket write event). .TP -QSocketNofifier::Exception - An exception has occurred (socket exception event). +TQSocketNofifier::Exception - An exception has occurred (socket exception event). .PP The \fIsocket\fR argument is the socket identifier. .PP See also type() and socket(). -.SH "bool QSocketNotifier::isEnabled () const" +.SH "bool TQSocketNotifier::isEnabled () const" Returns TRUE if the notifier is enabled; otherwise returns FALSE. .PP See also setEnabled(). -.SH "void QSocketNotifier::setEnabled ( bool enable )\fC [virtual]\fR" +.SH "void TQSocketNotifier::setEnabled ( bool enable )\fC [virtual]\fR" Enables the notifier if \fIenable\fR is TRUE or disables it if \fIenable\fR is FALSE. .PP The notifier is enabled by default. @@ -122,17 +122,17 @@ If the notifier is enabled, it emits the activated() signal whenever a socket ev Write notifiers should normally be disabled immediately after the activated() signal has been emitted; see discussion of write notifiers in the class description above. .PP See also isEnabled() and activated(). -.SH "int QSocketNotifier::socket () const" +.SH "int TQSocketNotifier::socket () const" Returns the socket identifier specified to the constructor. .PP See also type(). -.SH "Type QSocketNotifier::type () const" -Returns the socket event type specified to the constructor: QSocketNotifier::Read, QSocketNotifier::Write, or QSocketNotifier::Exception. +.SH "Type TQSocketNotifier::type () const" +Returns the socket event type specified to the constructor: TQSocketNotifier::Read, TQSocketNotifier::Write, or TQSocketNotifier::Exception. .PP See also socket(). .SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsocketnotifier.html +.BR http://doc.trolltech.com/tqsocketnotifier.html .BR http://www.trolltech.com/faq/tech.html .SH COPYRIGHT Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the |