diff options
| author | Timothy Pearson <kb9vqf@pearsoncomputing.net> | 2011-07-10 15:24:15 -0500 |
|---|---|---|
| committer | Timothy Pearson <kb9vqf@pearsoncomputing.net> | 2011-07-10 15:24:15 -0500 |
| commit | bd0f3345a938b35ce6a12f6150373b0955b8dd12 (patch) | |
| tree | 7a520322212d48ebcb9fbe1087e7fca28b76185c /doc/html/qsignal.html | |
| download | qt3-bd0f3345a938b35ce6a12f6150373b0955b8dd12.tar.gz qt3-bd0f3345a938b35ce6a12f6150373b0955b8dd12.zip | |
Add Qt3 development HEAD version
Diffstat (limited to 'doc/html/qsignal.html')
| -rw-r--r-- | doc/html/qsignal.html | 182 |
1 files changed, 182 insertions, 0 deletions
diff --git a/doc/html/qsignal.html b/doc/html/qsignal.html new file mode 100644 index 0000000..946a522 --- /dev/null +++ b/doc/html/qsignal.html @@ -0,0 +1,182 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/kernel/qsignal.cpp:42 --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>QSignal Class</title> +<style type="text/css"><!-- +fn { margin-left: 1cm; text-indent: -1cm; } +a:link { color: #004faf; text-decoration: none } +a:visited { color: #672967; text-decoration: none } +body { background: #ffffff; color: black; } +--></style> +</head> +<body> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> +<tr bgcolor="#E5E5E5"> +<td valign=center> + <a href="index.html"> +<font color="#004faf">Home</font></a> + | <a href="classes.html"> +<font color="#004faf">All Classes</font></a> + | <a href="mainclasses.html"> +<font color="#004faf">Main Classes</font></a> + | <a href="annotated.html"> +<font color="#004faf">Annotated</font></a> + | <a href="groups.html"> +<font color="#004faf">Grouped Classes</font></a> + | <a href="functions.html"> +<font color="#004faf">Functions</font></a> +</td> +<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QSignal Class Reference</h1> + +<p>The QSignal class can be used to send signals for classes +that don't inherit QObject. +<a href="#details">More...</a> +<p><tt>#include <<a href="qsignal-h.html">qsignal.h</a>></tt> +<p>Inherits <a href="qobject.html">QObject</a>. +<p><a href="qsignal-members.html">List of all member functions.</a> +<h2>Public Members</h2> +<ul> +<li class=fn><a href="#QSignal"><b>QSignal</b></a> ( QObject * parent = 0, const char * name = 0 )</li> +<li class=fn><a href="#~QSignal"><b>~QSignal</b></a> ()</li> +<li class=fn>bool <a href="#connect"><b>connect</b></a> ( const QObject * receiver, const char * member )</li> +<li class=fn>bool <a href="#disconnect"><b>disconnect</b></a> ( const QObject * receiver, const char * member = 0 )</li> +<li class=fn>void <a href="#activate"><b>activate</b></a> ()</li> +<li class=fn>bool isBlocked () const <em>(obsolete)</em></li> +<li class=fn>void block ( bool b ) <em>(obsolete)</em></li> +<li class=fn>void setParameter ( int value ) <em>(obsolete)</em></li> +<li class=fn>int parameter () const <em>(obsolete)</em></li> +<li class=fn>void <a href="#setValue"><b>setValue</b></a> ( const QVariant & value )</li> +<li class=fn>QVariant <a href="#value"><b>value</b></a> () const</li> +</ul> +<hr><a name="details"></a><h2>Detailed Description</h2> + + +The QSignal class can be used to send signals for classes +that don't inherit <a href="qobject.html">QObject</a>. +<p> + +<p> If you want to send signals from a class that does not inherit +QObject, you can create an internal QSignal object to emit the +signal. You must also provide a function that connects the signal +to an outside object slot. This is how we have implemented +signals in the <a href="qmenudata.html">QMenuData</a> class, which is not a QObject. +<p> In general, we recommend inheriting QObject instead. QObject +provides much more functionality. +<p> You can set a single <a href="qvariant.html">QVariant</a> parameter for the signal with +<a href="#setValue">setValue</a>(). +<p> Note that QObject is a <em>private</em> base class of QSignal, i.e. you +cannot call any QObject member functions from a QSignal object. +<p> Example: +<pre> + #include <<a href="qsignal-h.html">qsignal.h</a>> + + class MyClass + { + public: + MyClass(); + ~MyClass(); + + void doSomething(); + + void connect( <a href="qobject.html">QObject</a> *receiver, const char *member ); + + private: + QSignal *sig; + }; + + MyClass::MyClass() + { + sig = new QSignal; + } + + MyClass::~MyClass() + { + delete sig; + } + + void MyClass::doSomething() + { + // ... does something + sig-><a href="#activate">activate</a>(); // emits the signal + } + + void MyClass::connect( <a href="qobject.html">QObject</a> *receiver, const char *member ) + { + sig-><a href="#connect">connect</a>( receiver, member ); + } + </pre> + +<p>See also <a href="io.html">Input/Output and Networking</a> and <a href="misc.html">Miscellaneous Classes</a>. + +<hr><h2>Member Function Documentation</h2> +<h3 class=fn><a name="QSignal"></a>QSignal::QSignal ( <a href="qobject.html">QObject</a> * parent = 0, const char * name = 0 ) +</h3> +Constructs a signal object called <em>name</em>, with the parent object +<em>parent</em>. These arguments are passed directly to <a href="qobject.html">QObject</a>. + +<h3 class=fn><a name="~QSignal"></a>QSignal::~QSignal () +</h3> +Destroys the signal. All connections are removed, as is the case +with all QObjects. + +<h3 class=fn>void <a name="activate"></a>QSignal::activate () +</h3> + +<p> Emits the signal. If the platform supports <a href="qvariant.html">QVariant</a> and a +parameter has been set with <a href="#setValue">setValue</a>(), this value is passed in +the signal. + +<h3 class=fn>void <a name="block"></a>QSignal::block ( bool b ) +</h3> + +<b>This function is obsolete.</b> It is provided to keep old source working. We strongly advise against using it in new code. +<p> Blocks the signal if <em>b</em> is TRUE, or unblocks the signal if <em>b</em> is FALSE. +<p> An activated signal disappears into hyperspace if it is blocked. +<p> <p>See also <a href="#isBlocked">isBlocked</a>(), <a href="#activate">activate</a>(), and <a href="qobject.html#blockSignals">QObject::blockSignals</a>(). + +<h3 class=fn>bool <a name="connect"></a>QSignal::connect ( const <a href="qobject.html">QObject</a> * receiver, const char * member ) +</h3> +Connects the signal to <em>member</em> in object <em>receiver</em>. +<p> <p>See also <a href="#disconnect">disconnect</a>() and <a href="qobject.html#connect">QObject::connect</a>(). + +<h3 class=fn>bool <a name="disconnect"></a>QSignal::disconnect ( const <a href="qobject.html">QObject</a> * receiver, const char * member = 0 ) +</h3> +Disonnects the signal from <em>member</em> in object <em>receiver</em>. +<p> <p>See also <a href="#connect">connect</a>() and <a href="qobject.html#disconnect">QObject::disconnect</a>(). + +<h3 class=fn>bool <a name="isBlocked"></a>QSignal::isBlocked () const +</h3> + +<b>This function is obsolete.</b> It is provided to keep old source working. We strongly advise against using it in new code. +<p> Returns TRUE if the signal is blocked, or FALSE if it is not blocked. +<p> The signal is not blocked by default. +<p> <p>See also <a href="#block">block</a>() and <a href="qobject.html#signalsBlocked">QObject::signalsBlocked</a>(). + +<h3 class=fn>int <a name="parameter"></a>QSignal::parameter () const +</h3> <b>This function is obsolete.</b> It is provided to keep old source working. We strongly advise against using it in new code. + +<h3 class=fn>void <a name="setParameter"></a>QSignal::setParameter ( int value ) +</h3> <b>This function is obsolete.</b> It is provided to keep old source working. We strongly advise against using it in new code. + +<h3 class=fn>void <a name="setValue"></a>QSignal::setValue ( const <a href="qvariant.html">QVariant</a> & value ) +</h3> +Sets the signal's parameter to <em>value</em> + +<h3 class=fn><a href="qvariant.html">QVariant</a> <a name="value"></a>QSignal::value () const +</h3> +Returns the signal's parameter + +<!-- eof --> +<hr><p> +This file is part of the <a href="index.html">Qt toolkit</a>. +Copyright © 1995-2007 +<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center> +<table width=100% cellspacing=0 border=0><tr> +<td>Copyright © 2007 +<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a> +<td align=right><div align=right>Qt 3.3.8</div> +</table></div></address></body> +</html> |