AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document qRemovePostRoutine() function and update qAddPostRoutine() doc

Browse Source 
The qRemovePostRoutine() function has been added as publicly exported
function in Qt 2.2.0 with behavior equivalent to that of today. It has
never been documented for unknown reasons, possibly simply forgotten.

This function provides needed symmetry for the already documented
qAddPostRoutine() function and is used in some real world applications.

Change-Id: Ied4709505d8335c883e9791ea634df8fb406d995
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Reviewed-by: Nico Vertriest <nico.vertriest@digia.com>
This commit is contained in:
Bartosz Brachaczek 2013-12-29 05:51:27 +01:00 committed by The Qt Project
parent 4a8ce53ad6
commit 4dfc27728e
1 changed files with 23 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
src/corelib/kernel/qcoreapplication.cpp
View File

@ -2628,10 +2628,12 @@ void QCoreApplication::setEventDispatcher(QAbstractEventDispatcher *eventDispatc
\fn void qAddPostRoutine(QtCleanUpFunction ptr) \fn void qAddPostRoutine(QtCleanUpFunction ptr)
\relates QCoreApplication \relates QCoreApplication
Adds a global routine that will be called from the QApplication Adds a global routine that will be called from the QCoreApplication
destructor. This function is normally used to add cleanup routines destructor. This function is normally used to add cleanup routines
for program-wide functionality. for program-wide functionality.
The cleanup routines are called in the reverse order of their addition.
The function specified by \a ptr should take no arguments and should The function specified by \a ptr should take no arguments and should
return nothing. For example: return nothing. For example:
@ -2640,8 +2642,11 @@ void QCoreApplication::setEventDispatcher(QAbstractEventDispatcher *eventDispatc
Note that for an application- or module-wide cleanup, Note that for an application- or module-wide cleanup,
qAddPostRoutine() is often not suitable. For example, if the qAddPostRoutine() is often not suitable. For example, if the
program is split into dynamically loaded modules, the relevant program is split into dynamically loaded modules, the relevant
module may be unloaded long before the QApplication destructor is module may be unloaded long before the QCoreApplication destructor is
called. called. In such cases, if using qAddPostRoutine() is still desirable,
qRemovePostRoutine() can be used to prevent a routine from being
called by the QCoreApplication destructor. For example, if that
routine was called before the module was unloaded.
For modules and libraries, using a reference-counted For modules and libraries, using a reference-counted
initialization manager or Qt's parent-child deletion mechanism may initialization manager or Qt's parent-child deletion mechanism may
@ -2653,6 +2658,21 @@ void QCoreApplication::setEventDispatcher(QAbstractEventDispatcher *eventDispatc
By selecting the right parent object, this can often be made to By selecting the right parent object, this can often be made to
clean up the module's data at the right moment. clean up the module's data at the right moment.
\sa qRemovePostRoutine()
*/
/*!
\fn void qRemovePostRoutine(QtCleanUpFunction ptr)
\relates QCoreApplication
\since 5.3
Removes the cleanup routine specified by \a ptr from the list of
routines called by the QCoreApplication destructor. The routine
must have been previously added to the list by a call to
qAddPostRoutine(), otherwise this function has no effect.
\sa qAddPostRoutine()
*/ */
/*! /*!