diff options
Diffstat (limited to 'doc/html/tqobject.html')
| -rw-r--r-- | doc/html/tqobject.html | 86 |
1 files changed, 43 insertions, 43 deletions
diff --git a/doc/html/tqobject.html b/doc/html/tqobject.html index 85cb488d0..627bb032b 100644 --- a/doc/html/tqobject.html +++ b/doc/html/tqobject.html @@ -57,9 +57,9 @@ body { background: #ffffff; color: black; } <li class=fn>int <a href="#startTimer"><b>startTimer</b></a> ( int interval )</li> <li class=fn>void <a href="#killTimer"><b>killTimer</b></a> ( int id )</li> <li class=fn>void <a href="#killTimers"><b>killTimers</b></a> ()</li> -<li class=fn>TQObject * <a href="#child"><b>child</b></a> ( const char * objName, const char * inheritsClass = 0, bool recursiveSearch = TRUE )</li> +<li class=fn>TQObject * <a href="#child"><b>child</b></a> ( const char * objName, const char * inheritsClass = 0, bool recursiveSearch = true )</li> <li class=fn>const TQObjectList * <a href="#children"><b>children</b></a> () const</li> -<li class=fn>TQObjectList * <a href="#queryList"><b>queryList</b></a> ( const char * inheritsClass = 0, const char * objName = 0, bool regexpMatch = TRUE, bool recursiveSearch = TRUE ) const</li> +<li class=fn>TQObjectList * <a href="#queryList"><b>queryList</b></a> ( const char * inheritsClass = 0, const char * objName = 0, bool regexpMatch = true, bool recursiveSearch = true ) const</li> <li class=fn>virtual void <a href="#insertChild"><b>insertChild</b></a> ( TQObject * obj )</li> <li class=fn>virtual void <a href="#removeChild"><b>removeChild</b></a> ( TQObject * obj )</li> <li class=fn>void <a href="#installEventFilter"><b>installEventFilter</b></a> ( const TQObject * filterObj )</li> @@ -197,7 +197,7 @@ delivered to the object. <h3 class=fn>void <a name="blockSignals"></a>TQObject::blockSignals ( bool block ) </h3> -Blocks signals if <em>block</em> is TRUE, or unblocks signals if <em>block</em> is FALSE. +Blocks signals if <em>block</em> is true, or unblocks signals if <em>block</em> is false. <p> Emitted signals disappear into hyperspace if signals are blocked. Note that the <a href="#destroyed">destroyed</a>() signals will be emitted even if the signals for this object have been blocked. @@ -206,19 +206,19 @@ for this object have been blocked. <h3 class=fn>bool <a name="checkConnectArgs"></a>TQObject::checkConnectArgs ( const char * signal, const <a href="tqobject.html">TQObject</a> * receiver, const char * member )<tt> [virtual protected]</tt> </h3> -<p> Returns TRUE if the <em>signal</em> and the <em>member</em> arguments are -compatible; otherwise returns FALSE. (The <em>receiver</em> argument is +<p> Returns true if the <em>signal</em> and the <em>member</em> arguments are +compatible; otherwise returns false. (The <em>receiver</em> argument is currently ignored.) <p> <b>Warning:</b> We recommend that you use the default implementation and do not reimplement this function. <p> -<h3 class=fn><a href="tqobject.html">TQObject</a> * <a name="child"></a>TQObject::child ( const char * objName, const char * inheritsClass = 0, bool recursiveSearch = TRUE ) +<h3 class=fn><a href="tqobject.html">TQObject</a> * <a name="child"></a>TQObject::child ( const char * objName, const char * inheritsClass = 0, bool recursiveSearch = true ) </h3> Searches the children and optionally grandchildren of this object, and returns a child that is called <em>objName</em> that inherits <em>inheritsClass</em>. If <em>inheritsClass</em> is 0 (the default), any class matches. -<p> If <em>recursiveSearch</em> is TRUE (the default), <a href="#child">child</a>() performs a +<p> If <em>recursiveSearch</em> is true (the default), <a href="#child">child</a>() performs a depth-first search of the object's children. <p> If there is no such object, this function returns 0. If there are more than one, the first one found is retured; if you need all of @@ -276,8 +276,8 @@ definition lacks the <a href="metaobjects.html#TQ_OBJECT">TQ_OBJECT</a> macro. <h3 class=fn>bool <a name="connect"></a>TQObject::connect ( const <a href="tqobject.html">TQObject</a> * sender, const char * signal, const <a href="tqobject.html">TQObject</a> * receiver, const char * member )<tt> [static]</tt> </h3> Connects <em>signal</em> from the <em>sender</em> object to <em>member</em> in object -<em>receiver</em>, and returns TRUE if the connection succeeds; otherwise -returns FALSE. +<em>receiver</em>, and returns true if the connection succeeds; otherwise +returns false. <p> You must use the TQ_SIGNAL() and TQ_SLOT() macros when specifying the <em>signal</em> and the <em>member</em>, for example: <pre> @@ -290,7 +290,7 @@ and the <em>member</em>, for example: <p> This example ensures that the label always displays the current scroll bar value. Note that the signal and slots parameters must not contain any variable names, only the type. E.g. the following would -not work and return FALSE: +not work and return false: <a href="#connect">TQObject::connect</a>( scroll, TQ_SIGNAL(valueChanged(int v)), label, TQ_SLOT(setNum(int v)) ); <p> A signal can also be connected to another signal: @@ -322,8 +322,8 @@ relates to MyWidget. can be connected to one slot. <p> If a signal is connected to several slots, the slots are activated in an arbitrary order when the signal is emitted. -<p> The function returns TRUE if it successfully connects the signal -to the slot. It will return FALSE if it cannot create the +<p> The function returns true if it successfully connects the signal +to the slot. It will return false if it cannot create the connection, for example, if TQObject is unable to verify the existence of either <em>signal</em> or <em>member</em>, or if their signatures aren't compatible. @@ -481,7 +481,7 @@ information). <h3 class=fn>bool <a name="event"></a>TQObject::event ( <a href="tqevent.html">TQEvent</a> * e )<tt> [virtual]</tt> </h3> This virtual function receives events to an object and should -return TRUE if the event <em>e</em> was recognized and processed. +return true if the event <em>e</em> was recognized and processed. <p> The <a href="#event">event</a>() function can be reimplemented to customize the behavior of an object. <p> <p>See also <a href="#installEventFilter">installEventFilter</a>(), <a href="#timerEvent">timerEvent</a>(), <a href="tqapplication.html#sendEvent">TQApplication::sendEvent</a>(), <a href="tqapplication.html#postEvent">TQApplication::postEvent</a>(), and <a href="tqwidget.html#event">TQWidget::event</a>(). @@ -493,7 +493,7 @@ Filters events if this object has been installed as an event filter for the <em>watched</em> object. <p> In your reimplementation of this function, if you want to filter the event <em>e</em>, out, i.e. stop it being handled further, return -TRUE; otherwise return FALSE. +true; otherwise return false. <p> Example: <pre> class MyMainWindow : public <a href="tqmainwindow.html">TQMainWindow</a> @@ -522,9 +522,9 @@ TRUE; otherwise return FALSE. if ( e->type() == TQEvent::KeyPress ) { <a href="tqkeyevent.html">TQKeyEvent</a> *k = (TQKeyEvent*)ev; <a href="tqapplication.html#qDebug">tqDebug</a>( "Ate key press %d", k-><a href="tqkeyevent.html#key">key</a>() ); - return TRUE; + return true; } else { - return FALSE; + return false; } } else { // pass the event on to the parent class @@ -538,7 +538,7 @@ the base class's <a href="#eventFilter">eventFilter</a>() function, since the ba might have reimplemented eventFilter() for its own internal purposes. <p> <b>Warning:</b> If you delete the receiver object in this function, be -sure to return TRUE. Otherwise, TQt will forward the event to the +sure to return true. Otherwise, TQt will forward the event to the deleted object and the program might crash. <p> <p>See also <a href="#installEventFilter">installEventFilter</a>(). @@ -546,7 +546,7 @@ deleted object and the program might crash. <h3 class=fn>bool <a name="highPriority"></a>TQObject::highPriority () const </h3> -<p> Returns TRUE if the object is a high-priority object, or FALSE if +<p> Returns true if the object is a high-priority object, or false if it is a standard-priority object. <p> High-priority objects are placed first in TQObject's list of children on the assumption that they will be referenced very @@ -554,21 +554,21 @@ often. <h3 class=fn>bool <a name="inherits"></a>TQObject::inherits ( const char * clname ) const </h3> -Returns TRUE if this object is an instance of a class that +Returns true if this object is an instance of a class that inherits <em>clname</em>, and <em>clname</em> inherits TQObject; otherwise -returns FALSE. +returns false. <p> A class is considered to inherit itself. <p> Example: <pre> <a href="tqtimer.html">TQTimer</a> *t = new <a href="tqtimer.html">TQTimer</a>; // TQTimer inherits TQObject - t-><a href="#inherits">inherits</a>( "TQTimer" ); // returns TRUE - t-><a href="#inherits">inherits</a>( "TQObject" ); // returns TRUE - t-><a href="#inherits">inherits</a>( "TQButton" ); // returns FALSE + t-><a href="#inherits">inherits</a>( "TQTimer" ); // returns true + t-><a href="#inherits">inherits</a>( "TQObject" ); // returns true + t-><a href="#inherits">inherits</a>( "TQButton" ); // returns false // TQScrollBar inherits TQWidget and TQRangeControl <a href="tqscrollbar.html">TQScrollBar</a> *s = new <a href="tqscrollbar.html">TQScrollBar</a>( 0 ); - s-><a href="#inherits">inherits</a>( "TQWidget" ); // returns TRUE - s-><a href="#inherits">inherits</a>( "TQRangeControl" ); // returns FALSE + s-><a href="#inherits">inherits</a>( "TQWidget" ); // returns true + s-><a href="#inherits">inherits</a>( "TQRangeControl" ); // returns false </pre> <p> (<a href="tqrangecontrol.html">TQRangeControl</a> is not a TQObject.) @@ -596,8 +596,8 @@ setting the parent widget in the constructor or by calling sent to this object. The filter can either stop the event or forward it to this object. The event filter <em>filterObj</em> receives events via its <a href="#eventFilter">eventFilter</a>() function. The eventFilter() function -must return TRUE if the event should be filtered, (i.e. stopped); -otherwise it must return FALSE. +must return true if the event should be filtered, (i.e. stopped); +otherwise it must return false. <p> If multiple event filters are installed on a single object, the filter that was installed last is activated first. <p> Here's a <tt>KeyPressEater</tt> class that eats the key presses of its @@ -616,10 +616,10 @@ monitored objects: // special processing for key press <a href="tqkeyevent.html">TQKeyEvent</a> *k = (TQKeyEvent *)e; <a href="tqapplication.html#qDebug">tqDebug</a>( "Ate key press %d", k-><a href="tqkeyevent.html#key">key</a>() ); - return TRUE; // eat event + return true; // eat event } else { // standard event processing - return FALSE; + return false; } } </pre> @@ -637,19 +637,19 @@ monitored objects: <p> The <a href="tqaccel.html">TQAccel</a> class, for example, uses this technique to intercept accelerator key presses. <p> <b>Warning:</b> If you delete the receiver object in your <a href="#eventFilter">eventFilter</a>() -function, be sure to return TRUE. If you return FALSE, TQt sends +function, be sure to return true. If you return false, TQt sends the event to the deleted object and the program will crash. <p> <p>See also <a href="#removeEventFilter">removeEventFilter</a>(), <a href="#eventFilter">eventFilter</a>(), and <a href="#event">event</a>(). <h3 class=fn>bool <a name="isA"></a>TQObject::isA ( const char * clname ) const </h3> -Returns TRUE if this object is an instance of the class <em>clname</em>; -otherwise returns FALSE. +Returns true if this object is an instance of the class <em>clname</em>; +otherwise returns false. <p> Example: <pre> <a href="tqtimer.html">TQTimer</a> *t = new <a href="tqtimer.html">TQTimer</a>; // TQTimer inherits TQObject - t-><a href="#isA">isA</a>( "TQTimer" ); // returns TRUE - t-><a href="#isA">isA</a>( "TQObject" ); // returns FALSE + t-><a href="#isA">isA</a>( "TQTimer" ); // returns true + t-><a href="#isA">isA</a>( "TQObject" ); // returns false </pre> <p> <p>See also <a href="#inherits">inherits</a>() and <a href="#metaObject">metaObject</a>(). @@ -657,7 +657,7 @@ otherwise returns FALSE. <h3 class=fn>bool <a name="isWidgetType"></a>TQObject::isWidgetType () const </h3> -<p> Returns TRUE if the object is a widget; otherwise returns FALSE. +<p> Returns true if the object is a widget; otherwise returns false. <p> Calling this function is equivalent to calling <a href="#inherits">inherits</a>("TQWidget"), except that it is much faster. @@ -727,22 +727,22 @@ Returns the value of the object's <em>name</em> property. the <a href="#metaObject">metaObject</a>(). <p> <p>See also <a href="#setProperty">setProperty</a>(), <a href="tqvariant.html#isValid">TQVariant::isValid</a>(), <a href="#metaObject">metaObject</a>(), <a href="tqmetaobject.html#propertyNames">TQMetaObject::propertyNames</a>(), and <a href="tqmetaobject.html#property">TQMetaObject::property</a>(). -<h3 class=fn><a href="tqobjectlist.html">TQObjectList</a> * <a name="queryList"></a>TQObject::queryList ( const char * inheritsClass = 0, const char * objName = 0, bool regexpMatch = TRUE, bool recursiveSearch = TRUE ) const +<h3 class=fn><a href="tqobjectlist.html">TQObjectList</a> * <a name="queryList"></a>TQObject::queryList ( const char * inheritsClass = 0, const char * objName = 0, bool regexpMatch = true, bool recursiveSearch = true ) const </h3> Searches the children and optionally grandchildren of this object, and returns a list of those objects that are named or that match <em>objName</em> and inherit <em>inheritsClass</em>. If <em>inheritsClass</em> is 0 (the default), all classes match. If <em>objName</em> is 0 (the default), all object names match. -<p> If <em>regexpMatch</em> is TRUE (the default), <em>objName</em> is a <a href="tqregexp.html#regular-expression">regular expression</a> that the objects's names must match. The syntax is that -of a <a href="tqregexp.html">TQRegExp</a>. If <em>regexpMatch</em> is FALSE, <em>objName</em> is a string +<p> If <em>regexpMatch</em> is true (the default), <em>objName</em> is a <a href="tqregexp.html#regular-expression">regular expression</a> that the objects's names must match. The syntax is that +of a <a href="tqregexp.html">TQRegExp</a>. If <em>regexpMatch</em> is false, <em>objName</em> is a string and object names must match it exactly. <p> Note that <em>inheritsClass</em> uses single inheritance from TQObject, the way <a href="#inherits">inherits</a>() does. According to inherits(), <a href="tqmenubar.html">TQMenuBar</a> inherits <a href="tqwidget.html">TQWidget</a> but not <a href="tqmenudata.html">TQMenuData</a>. This does not quite match reality, but is the best that can be done on the wide variety of compilers TQt supports. -<p> Finally, if <em>recursiveSearch</em> is TRUE (the default), <a href="#queryList">queryList</a>() +<p> Finally, if <em>recursiveSearch</em> is true (the default), <a href="#queryList">queryList</a>() searches <em>n</em>th-generation as well as first-generation children. <p> If all this seems a bit complex for your needs, the simpler <a href="#child">child</a>() function may be what you want. @@ -756,7 +756,7 @@ window: while ( (obj = it.current()) != 0 ) { // for each found object... ++it; - ((TQButton*)obj)->setEnabled( FALSE ); + ((TQButton*)obj)->setEnabled( false ); } delete l; // delete the list, not the objects </pre> @@ -808,8 +808,8 @@ Sets the object's name to <em>name</em>. <h3 class=fn>bool <a name="setProperty"></a>TQObject::setProperty ( const char * name, const <a href="tqvariant.html">TQVariant</a> & value )<tt> [virtual]</tt> </h3> Sets the value of the object's <em>name</em> property to <em>value</em>. -<p> Returns TRUE if the operation was successful; otherwise returns -FALSE. +<p> Returns true if the operation was successful; otherwise returns +false. <p> Information about all available properties is provided through the <a href="#metaObject">metaObject</a>(). <p> <p>See also <a href="#property">property</a>(), <a href="#metaObject">metaObject</a>(), <a href="tqmetaobject.html#propertyNames">TQMetaObject::propertyNames</a>(), and <a href="tqmetaobject.html#property">TQMetaObject::property</a>(). @@ -817,7 +817,7 @@ FALSE. <h3 class=fn>bool <a name="signalsBlocked"></a>TQObject::signalsBlocked () const </h3> -<p> Returns TRUE if signals are blocked; otherwise returns FALSE. +<p> Returns true if signals are blocked; otherwise returns false. <p> Signals are not blocked by default. <p> <p>See also <a href="#blockSignals">blockSignals</a>(). |