diff options
Diffstat (limited to 'doc/man/man3/qsignalmapper.3qt')
| -rw-r--r-- | doc/man/man3/qsignalmapper.3qt | 118 |
1 files changed, 118 insertions, 0 deletions
diff --git a/doc/man/man3/qsignalmapper.3qt b/doc/man/man3/qsignalmapper.3qt new file mode 100644 index 000000000..0d9e85289 --- /dev/null +++ b/doc/man/man3/qsignalmapper.3qt @@ -0,0 +1,118 @@ +'\" t +.TH QSignalMapper 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 +QSignalMapper \- Bundles signals from identifiable senders +.SH SYNOPSIS +\fC#include <qsignalmapper.h>\fR +.PP +Inherits QObject. +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "\fBQSignalMapper\fR ( QObject * parent, const char * name = 0 )" +.br +.ti -1c +.BI "\fB~QSignalMapper\fR ()" +.br +.ti -1c +.BI "virtual void \fBsetMapping\fR ( const QObject * sender, int identifier )" +.br +.ti -1c +.BI "virtual void \fBsetMapping\fR ( const QObject * sender, const QString & identifier )" +.br +.ti -1c +.BI "void \fBremoveMappings\fR ( const QObject * sender )" +.br +.in -1c +.SS "Public Slots" +.in +1c +.ti -1c +.BI "void \fBmap\fR ()" +.br +.in -1c +.SS "Signals" +.in +1c +.ti -1c +.BI "void \fBmapped\fR ( int )" +.br +.ti -1c +.BI "void \fBmapped\fR ( const QString & )" +.br +.in -1c +.SH DESCRIPTION +The QSignalMapper class bundles signals from identifiable senders. +.PP +This class collects a set of parameterless signals, and re-emits them with integer or string parameters corresponding to the object that sent the signal. +.PP +See also Input/Output and Networking. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QSignalMapper::QSignalMapper ( QObject * parent, const char * name = 0 )" +Constructs a QSignalMapper called \fIname\fR, with parent \fIparent\fR. Like all QObjects, it will be deleted when the parent is deleted. +.SH "QSignalMapper::~QSignalMapper ()" +Destroys the QSignalMapper. +.SH "void QSignalMapper::map ()\fC [slot]\fR" +This slot emits signals based on which object sends signals to it. +.PP +Examples: +.)l i18n/main.cpp and themes/themes.cpp. +.SH "void QSignalMapper::mapped ( int )\fC [signal]\fR" +This signal is emitted when map() is signaled from an object that has an integer mapping set. +.PP +See also setMapping(). +.PP +Examples: +.)l i18n/main.cpp and themes/themes.cpp. +.SH "void QSignalMapper::mapped ( const QString & )\fC [signal]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +This signal is emitted when map() is signaled from an object that has a string mapping set. +.PP +See also setMapping(). +.SH "void QSignalMapper::removeMappings ( const QObject * sender )" +Removes all mappings for \fIsender\fR. This is done automatically when mapped objects are destroyed. +.SH "void QSignalMapper::setMapping ( const QObject * sender, int identifier )\fC [virtual]\fR" +Adds a mapping so that when map() is signaled from the given \fIsender\fR, the signal mapped(\fIidentifier\fR) is emitted. +.PP +There may be at most one integer identifier for each object. +.PP +Examples: +.)l i18n/main.cpp and themes/themes.cpp. +.SH "void QSignalMapper::setMapping ( const QObject * sender, const QString & identifier )\fC [virtual]\fR" +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +.PP +Adds a mapping so that when map() is signaled from the given \fIsender\fR, the signal mapper(\fIidentifier\fR) is emitted. +.PP +There may be at most one string identifier for each object, and it +may not be empty. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qsignalmapper.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 Qt documentation is provided in HTML format; it is +located at $QTDIR/doc/html and can be read using Qt 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 qt-bugs@trolltech.com . +Please include the name of the manual page (qsignalmapper.3qt) and the Qt +version (3.3.8). |