Doc: Adding mark-up to boolean default values.
Default values should have mark-up to denote that they are code. This commit changes: -"property is true" to "property is \c true". -"Returns true" to "Returns \c true". -"property is false" to "property is \c false". -"returns true" to "returns \c true". -"returns false" to "returns \c false". src/3rdparty and non-documentation instances were ignored. Task-number: QTBUG-33360 Change-Id: Ie87eaa57af947caa1230602b61c5c46292a4cf4e Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
This commit is contained in:
parent
50dd0232b6
commit
4533cc9944
@ -75,7 +75,7 @@
|
||||
|
||||
\snippet code/src_concurrent_qtconcurrentfilter.cpp 0
|
||||
|
||||
T must match the type stored in the sequence. The function returns true if
|
||||
T must match the type stored in the sequence. The function returns \c true if
|
||||
the item should be kept, false if it should be discarded.
|
||||
|
||||
This example shows how to keep strings that are all lower-case from a
|
||||
@ -193,7 +193,7 @@
|
||||
\relates <QtConcurrentFilter>
|
||||
|
||||
Calls \a filterFunction once for each item in \a sequence. If
|
||||
\a filterFunction returns true, the item is kept in \a sequence;
|
||||
\a filterFunction returns \c true, the item is kept in \a sequence;
|
||||
otherwise, the item is removed from \a sequence.
|
||||
*/
|
||||
|
||||
@ -202,7 +202,7 @@
|
||||
\relates <QtConcurrentFilter>
|
||||
|
||||
Calls \a filterFunction once for each item in \a sequence and returns a
|
||||
new Sequence of kept items. If \a filterFunction returns true, a copy of
|
||||
new Sequence of kept items. If \a filterFunction returns \c true, a copy of
|
||||
the item is put in the new Sequence. Otherwise, the item will \e not
|
||||
appear in the new Sequence.
|
||||
*/
|
||||
@ -212,7 +212,7 @@
|
||||
\relates <QtConcurrentFilter>
|
||||
|
||||
Calls \a filterFunction once for each item from \a begin to \a end and
|
||||
returns a new Sequence of kept items. If \a filterFunction returns true, a
|
||||
returns a new Sequence of kept items. If \a filterFunction returns \c true, a
|
||||
copy of the item is put in the new Sequence. Otherwise, the item will
|
||||
\e not appear in the new Sequence.
|
||||
*/
|
||||
@ -222,9 +222,9 @@
|
||||
\relates <QtConcurrentFilter>
|
||||
|
||||
Calls \a filterFunction once for each item in \a sequence. If
|
||||
\a filterFunction returns true for an item, that item is then passed to
|
||||
\a filterFunction returns \c true for an item, that item is then passed to
|
||||
\a reduceFunction. In other words, the return value is the result of
|
||||
\a reduceFunction for each item where \a filterFunction returns true.
|
||||
\a reduceFunction for each item where \a filterFunction returns \c true.
|
||||
|
||||
Note that while \a filterFunction is called concurrently, only one thread
|
||||
at a time will call \a reduceFunction. The order in which \a reduceFunction
|
||||
@ -239,9 +239,9 @@
|
||||
\relates <QtConcurrentFilter>
|
||||
|
||||
Calls \a filterFunction once for each item from \a begin to \a end. If
|
||||
\a filterFunction returns true for an item, that item is then passed to
|
||||
\a filterFunction returns \c true for an item, that item is then passed to
|
||||
\a reduceFunction. In other words, the return value is the result of
|
||||
\a reduceFunction for each item where \a filterFunction returns true.
|
||||
\a reduceFunction for each item where \a filterFunction returns \c true.
|
||||
|
||||
Note that while \a filterFunction is called concurrently, only one thread
|
||||
at a time will call \a reduceFunction. The order in which
|
||||
@ -255,7 +255,7 @@
|
||||
\fn void QtConcurrent::blockingFilter(Sequence &sequence, FilterFunction filterFunction)
|
||||
|
||||
Calls \a filterFunction once for each item in \a sequence. If
|
||||
\a filterFunction returns true, the item is kept in \a sequence;
|
||||
\a filterFunction returns \c true, the item is kept in \a sequence;
|
||||
otherwise, the item is removed from \a sequence.
|
||||
|
||||
\note This function will block until all items in the sequence have been processed.
|
||||
@ -265,7 +265,7 @@
|
||||
\fn Sequence QtConcurrent::blockingFiltered(const Sequence &sequence, FilterFunction filterFunction)
|
||||
|
||||
Calls \a filterFunction once for each item in \a sequence and returns a
|
||||
new Sequence of kept items. If \a filterFunction returns true, a copy of
|
||||
new Sequence of kept items. If \a filterFunction returns \c true, a copy of
|
||||
the item is put in the new Sequence. Otherwise, the item will \e not
|
||||
appear in the new Sequence.
|
||||
|
||||
@ -278,7 +278,7 @@
|
||||
\fn Sequence QtConcurrent::blockingFiltered(ConstIterator begin, ConstIterator end, FilterFunction filterFunction)
|
||||
|
||||
Calls \a filterFunction once for each item from \a begin to \a end and
|
||||
returns a new Sequence of kept items. If \a filterFunction returns true, a
|
||||
returns a new Sequence of kept items. If \a filterFunction returns \c true, a
|
||||
copy of the item is put in the new Sequence. Otherwise, the item will
|
||||
\e not appear in the new Sequence.
|
||||
|
||||
@ -292,9 +292,9 @@
|
||||
\fn T QtConcurrent::blockingFilteredReduced(const Sequence &sequence, FilterFunction filterFunction, ReduceFunction reduceFunction, QtConcurrent::ReduceOptions reduceOptions)
|
||||
|
||||
Calls \a filterFunction once for each item in \a sequence. If
|
||||
\a filterFunction returns true for an item, that item is then passed to
|
||||
\a filterFunction returns \c true for an item, that item is then passed to
|
||||
\a reduceFunction. In other words, the return value is the result of
|
||||
\a reduceFunction for each item where \a filterFunction returns true.
|
||||
\a reduceFunction for each item where \a filterFunction returns \c true.
|
||||
|
||||
Note that while \a filterFunction is called concurrently, only one thread
|
||||
at a time will call \a reduceFunction. The order in which \a reduceFunction
|
||||
@ -312,9 +312,9 @@
|
||||
\fn T QtConcurrent::blockingFilteredReduced(ConstIterator begin, ConstIterator end, FilterFunction filterFunction, ReduceFunction reduceFunction, QtConcurrent::ReduceOptions reduceOptions)
|
||||
|
||||
Calls \a filterFunction once for each item from \a begin to \a end. If
|
||||
\a filterFunction returns true for an item, that item is then passed to
|
||||
\a filterFunction returns \c true for an item, that item is then passed to
|
||||
\a reduceFunction. In other words, the return value is the result of
|
||||
\a reduceFunction for each item where \a filterFunction returns true.
|
||||
\a reduceFunction for each item where \a filterFunction returns \c true.
|
||||
|
||||
Note that while \a filterFunction is called concurrently, only one thread
|
||||
at a time will call \a reduceFunction. The order in which
|
||||
|
@ -507,7 +507,7 @@ void QUnifiedTimer::uninstallAnimationDriver(QAnimationDriver *d)
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if \a d is the currently installed animation driver
|
||||
Returns \c true if \a d is the currently installed animation driver
|
||||
and is not the default animation driver (which can never be uninstalled).
|
||||
*/
|
||||
bool QUnifiedTimer::canUninstallAnimationDriver(QAnimationDriver *d)
|
||||
|
@ -828,8 +828,8 @@ QString QTextCodec::toUnicode(const QByteArray& a) const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the Unicode character \a ch can be fully encoded
|
||||
with this codec; otherwise returns false.
|
||||
Returns \c true if the Unicode character \a ch can be fully encoded
|
||||
with this codec; otherwise returns \c false.
|
||||
*/
|
||||
bool QTextCodec::canEncode(QChar ch) const
|
||||
{
|
||||
|
@ -323,13 +323,13 @@
|
||||
\row \li \l{QListIterator::toBack()}{toBack()}
|
||||
\li Moves the iterator to the back of the list (after the last item)
|
||||
\row \li \l{QListIterator::hasNext()}{hasNext()}
|
||||
\li Returns true if the iterator isn't at the back of the list
|
||||
\li Returns \c true if the iterator isn't at the back of the list
|
||||
\row \li \l{QListIterator::next()}{next()}
|
||||
\li Returns the next item and advances the iterator by one position
|
||||
\row \li \l{QListIterator::peekNext()}{peekNext()}
|
||||
\li Returns the next item without moving the iterator
|
||||
\row \li \l{QListIterator::hasPrevious()}{hasPrevious()}
|
||||
\li Returns true if the iterator isn't at the front of the list
|
||||
\li Returns \c true if the iterator isn't at the front of the list
|
||||
\row \li \l{QListIterator::previous()}{previous()}
|
||||
\li Returns the previous item and moves the iterator back by one position
|
||||
\row \li \l{QListIterator::peekPrevious()}{peekPrevious()}
|
||||
|
@ -671,7 +671,7 @@
|
||||
it does not duplicate an existing connection. i.e., if the same
|
||||
signal is already connected to the same slot for the same pair
|
||||
of objects, then the connection is not made and connect()
|
||||
returns false.
|
||||
returns \c false.
|
||||
|
||||
\endlist
|
||||
|
||||
|
@ -346,15 +346,15 @@ Q_CORE_EXPORT void *qMemSet(void *dest, int c, size_t n);
|
||||
/*!
|
||||
\fn bool QFlags::operator!() const
|
||||
|
||||
Returns true if no flag is set (i.e., if the value stored by the
|
||||
QFlags object is 0); otherwise returns false.
|
||||
Returns \c true if no flag is set (i.e., if the value stored by the
|
||||
QFlags object is 0); otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bool QFlags::testFlag(Enum flag) const
|
||||
\since 4.2
|
||||
|
||||
Returns true if the \a flag is set, otherwise false.
|
||||
Returns \c true if the \a flag is set, otherwise false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
@ -2295,7 +2295,7 @@ bool qputenv(const char *varName, const QByteArray& value)
|
||||
|
||||
This function deletes the variable \a varName from the environment.
|
||||
|
||||
Returns true on success.
|
||||
Returns \c true on success.
|
||||
|
||||
\since 5.1
|
||||
|
||||
|
@ -270,8 +270,8 @@
|
||||
earlier versions. They could be used again in the future.
|
||||
|
||||
The QGlobalStatic::exists() and QGlobalStatic::isDestroyed() functions
|
||||
operate solely on the guard variable: the former returns true if the guard
|
||||
is negative, whereas the latter returns true only if it is -2.
|
||||
operate solely on the guard variable: the former returns \c true if the guard
|
||||
is negative, whereas the latter returns \c true only if it is -2.
|
||||
|
||||
The Q_GLOBAL_STATIC_INTERNAL macro implements the actual construction and
|
||||
destruction. There are two implementations of it: one for compilers that
|
||||
@ -374,9 +374,9 @@
|
||||
/*!
|
||||
\fn bool QGlobalStatic::isDestroyed() const
|
||||
|
||||
This function returns true if the global static object has already
|
||||
This function returns \c true if the global static object has already
|
||||
completed destruction (that is, if the destructor for the type has already
|
||||
returned). In specific, note that this function returns false if
|
||||
returned). In specific, note that this function returns \c false if
|
||||
the destruction is still in progress.
|
||||
|
||||
Once this function has returned true once, it will never return
|
||||
@ -404,9 +404,9 @@
|
||||
/*!
|
||||
\fn bool QGlobalStatic::exists() const
|
||||
|
||||
This function returns true if the global static object has already
|
||||
This function returns \c true if the global static object has already
|
||||
completed initialization (that is, if the constructor for the type has
|
||||
already returned). In specific, note that this function returns false if
|
||||
already returned). In specific, note that this function returns \c false if
|
||||
the initialization is still in progress.
|
||||
|
||||
Once this function has returned true once, it will never return false again
|
||||
|
@ -253,7 +253,7 @@ QLibraryInfo::buildDate()
|
||||
|
||||
/*!
|
||||
\since 5.0
|
||||
Returns true if this build of Qt was built with debugging enabled, or
|
||||
Returns \c true if this build of Qt was built with debugging enabled, or
|
||||
false if it was built in release mode.
|
||||
*/
|
||||
bool
|
||||
|
@ -2234,7 +2234,7 @@
|
||||
of rich text.
|
||||
|
||||
\value AutoText The text string is interpreted as for
|
||||
Qt::RichText if Qt::mightBeRichText() returns true, otherwise
|
||||
Qt::RichText if Qt::mightBeRichText() returns \c true, otherwise
|
||||
as Qt::PlainText.
|
||||
*/
|
||||
|
||||
|
@ -45,37 +45,37 @@
|
||||
QT_BEGIN_NAMESPACE
|
||||
|
||||
/*!
|
||||
Returns true if the double \a {d} is equivalent to infinity.
|
||||
Returns \c true if the double \a {d} is equivalent to infinity.
|
||||
\relates <QtGlobal>
|
||||
*/
|
||||
Q_CORE_EXPORT bool qIsInf(double d) { return qt_is_inf(d); }
|
||||
|
||||
/*!
|
||||
Returns true if the double \a {d} is not a number (NaN).
|
||||
Returns \c true if the double \a {d} is not a number (NaN).
|
||||
\relates <QtGlobal>
|
||||
*/
|
||||
Q_CORE_EXPORT bool qIsNaN(double d) { return qt_is_nan(d); }
|
||||
|
||||
/*!
|
||||
Returns true if the double \a {d} is a finite number.
|
||||
Returns \c true if the double \a {d} is a finite number.
|
||||
\relates <QtGlobal>
|
||||
*/
|
||||
Q_CORE_EXPORT bool qIsFinite(double d) { return qt_is_finite(d); }
|
||||
|
||||
/*!
|
||||
Returns true if the float \a {f} is equivalent to infinity.
|
||||
Returns \c true if the float \a {f} is equivalent to infinity.
|
||||
\relates <QtGlobal>
|
||||
*/
|
||||
Q_CORE_EXPORT bool qIsInf(float f) { return qt_is_inf(f); }
|
||||
|
||||
/*!
|
||||
Returns true if the float \a {f} is not a number (NaN).
|
||||
Returns \c true if the float \a {f} is not a number (NaN).
|
||||
\relates <QtGlobal>
|
||||
*/
|
||||
Q_CORE_EXPORT bool qIsNaN(float f) { return qt_is_nan(f); }
|
||||
|
||||
/*!
|
||||
Returns true if the float \a {f} is a finite number.
|
||||
Returns \c true if the float \a {f} is a finite number.
|
||||
\relates <QtGlobal>
|
||||
*/
|
||||
Q_CORE_EXPORT bool qIsFinite(float f) { return qt_is_finite(f); }
|
||||
|
@ -377,8 +377,8 @@ QAbstractFileEngine::~QAbstractFileEngine()
|
||||
/*!
|
||||
\fn bool QAbstractFileEngine::open(QIODevice::OpenMode mode)
|
||||
|
||||
Opens the file in the specified \a mode. Returns true if the file
|
||||
was successfully opened; otherwise returns false.
|
||||
Opens the file in the specified \a mode. Returns \c true if the file
|
||||
was successfully opened; otherwise returns \c false.
|
||||
|
||||
The \a mode is an OR combination of QIODevice::OpenMode and
|
||||
QIODevice::HandlingMode values.
|
||||
@ -390,9 +390,9 @@ bool QAbstractFileEngine::open(QIODevice::OpenMode openMode)
|
||||
}
|
||||
|
||||
/*!
|
||||
Closes the file, returning true if successful; otherwise returns false.
|
||||
Closes the file, returning true if successful; otherwise returns \c false.
|
||||
|
||||
The default implementation always returns false.
|
||||
The default implementation always returns \c false.
|
||||
*/
|
||||
bool QAbstractFileEngine::close()
|
||||
{
|
||||
@ -404,8 +404,8 @@ bool QAbstractFileEngine::close()
|
||||
|
||||
Flushes and syncs the file to disk.
|
||||
|
||||
Returns true if successful; otherwise returns false.
|
||||
The default implementation always returns false.
|
||||
Returns \c true if successful; otherwise returns \c false.
|
||||
The default implementation always returns \c false.
|
||||
*/
|
||||
bool QAbstractFileEngine::syncToDisk()
|
||||
{
|
||||
@ -416,7 +416,7 @@ bool QAbstractFileEngine::syncToDisk()
|
||||
Flushes the open file, returning true if successful; otherwise returns
|
||||
false.
|
||||
|
||||
The default implementation always returns false.
|
||||
The default implementation always returns \c false.
|
||||
*/
|
||||
bool QAbstractFileEngine::flush()
|
||||
{
|
||||
@ -444,8 +444,8 @@ qint64 QAbstractFileEngine::pos() const
|
||||
/*!
|
||||
\fn bool QAbstractFileEngine::seek(qint64 offset)
|
||||
|
||||
Sets the file position to the given \a offset. Returns true if
|
||||
the position was successfully set; otherwise returns false.
|
||||
Sets the file position to the given \a offset. Returns \c true if
|
||||
the position was successfully set; otherwise returns \c false.
|
||||
|
||||
The offset is from the beginning of the file, unless the
|
||||
file is sequential.
|
||||
@ -459,7 +459,7 @@ bool QAbstractFileEngine::seek(qint64 pos)
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the file is a sequential access device; returns
|
||||
Returns \c true if the file is a sequential access device; returns
|
||||
false if the file is a direct access device.
|
||||
|
||||
Operations involving size() and seek(int) are not valid on
|
||||
@ -485,7 +485,7 @@ bool QAbstractFileEngine::remove()
|
||||
|
||||
/*!
|
||||
Copies the contents of this file to a file with the name \a newName.
|
||||
Returns true on success; otherwise, false is returned.
|
||||
Returns \c true on success; otherwise, false is returned.
|
||||
*/
|
||||
bool QAbstractFileEngine::copy(const QString &newName)
|
||||
{
|
||||
@ -513,7 +513,7 @@ bool QAbstractFileEngine::rename(const QString &newName)
|
||||
|
||||
Requests that the file be renamed to \a newName in the file
|
||||
system. If the new name already exists, it must be overwritten.
|
||||
If the operation succeeds, returns true; otherwise returns
|
||||
If the operation succeeds, returns \c true; otherwise returns
|
||||
false.
|
||||
|
||||
This virtual function must be reimplemented by all subclasses.
|
||||
@ -530,7 +530,7 @@ bool QAbstractFileEngine::renameOverwrite(const QString &newName)
|
||||
Creates a link from the file currently specified by fileName() to
|
||||
\a newName. What a link is depends on the underlying filesystem
|
||||
(be it a shortcut on Windows or a symbolic link on Unix). Returns
|
||||
true if successful; otherwise returns false.
|
||||
true if successful; otherwise returns \c false.
|
||||
*/
|
||||
bool QAbstractFileEngine::link(const QString &newName)
|
||||
{
|
||||
@ -772,8 +772,8 @@ int QAbstractFileEngine::handle() const
|
||||
/*!
|
||||
\since 4.3
|
||||
|
||||
Returns true if the current position is at the end of the file; otherwise,
|
||||
returns false.
|
||||
Returns \c true if the current position is at the end of the file; otherwise,
|
||||
returns \c false.
|
||||
|
||||
This function bases its behavior on calling extension() with
|
||||
AtEndExtension. If the engine does not support this extension, false is
|
||||
@ -790,7 +790,7 @@ bool QAbstractFileEngine::atEnd() const
|
||||
\since 4.4
|
||||
|
||||
Maps \a size bytes of the file into memory starting at \a offset.
|
||||
Returns a pointer to the memory if successful; otherwise returns false
|
||||
Returns a pointer to the memory if successful; otherwise returns \c false
|
||||
if, for example, an error occurs.
|
||||
|
||||
This function bases its behavior on calling extension() with
|
||||
@ -817,8 +817,8 @@ uchar *QAbstractFileEngine::map(qint64 offset, qint64 size, QFile::MemoryMapFlag
|
||||
/*!
|
||||
\since 4.4
|
||||
|
||||
Unmaps the memory \a address. Returns true if the unmap succeeds; otherwise
|
||||
returns false.
|
||||
Unmaps the memory \a address. Returns \c true if the unmap succeeds; otherwise
|
||||
returns \c false.
|
||||
|
||||
This function bases its behavior on calling extension() with
|
||||
UnMapExtensionOption. If the engine does not support this extension, false is
|
||||
@ -867,7 +867,7 @@ bool QAbstractFileEngine::unmap(uchar *address)
|
||||
You can call dirName() to get the directory name, nameFilters() to get a
|
||||
stringlist of name filters, and filters() to get the entry filters.
|
||||
|
||||
The pure virtual function hasNext() returns true if the current directory
|
||||
The pure virtual function hasNext() returns \c true if the current directory
|
||||
has at least one more entry (i.e., the directory name is valid and
|
||||
accessible, and we have not reached the end of the entry list), and false
|
||||
otherwise. Reimplement next() to seek to the next entry.
|
||||
@ -1056,7 +1056,7 @@ QVariant QAbstractFileEngineIterator::entryInfo(EntryInfoType type) const
|
||||
/*!
|
||||
\fn virtual bool QAbstractFileEngineIterator::hasNext() const = 0
|
||||
|
||||
This pure virtual function returns true if there is at least one more
|
||||
This pure virtual function returns \c true if there is at least one more
|
||||
entry in the current directory (i.e., the iterator path is valid and
|
||||
accessible, and the iterator has not reached the end of the entry list).
|
||||
|
||||
@ -1147,14 +1147,14 @@ qint64 QAbstractFileEngine::readLine(char *data, qint64 maxlen)
|
||||
buffering to report end-of-file status without having to check the size of
|
||||
the file. It is also useful for sequential files, where the size of the
|
||||
file cannot be used to determine whether or not you have reached the end.
|
||||
This extension returns true if the file is at the end; otherwise it returns
|
||||
This extension returns \c true if the file is at the end; otherwise it returns
|
||||
false. The input and output arguments to extension() are ignored.
|
||||
|
||||
\value FastReadLineExtension Whether the file engine provides a
|
||||
fast implementation for readLine() or not. If readLine() remains
|
||||
unimplemented in the file engine, QAbstractFileEngine will provide
|
||||
an implementation based on calling read() repeatedly. If
|
||||
supportsExtension() returns false for this extension, however,
|
||||
supportsExtension() returns \c false for this extension, however,
|
||||
QIODevice can provide a faster implementation by making use of its
|
||||
internal buffer. For engines that already provide a fast readLine()
|
||||
implementation, returning false for this extension can avoid
|
||||
@ -1201,7 +1201,7 @@ qint64 QAbstractFileEngine::readLine(char *data, qint64 maxlen)
|
||||
You can call supportsExtension() to check if an extension is supported by
|
||||
the file engine.
|
||||
|
||||
By default, no extensions are supported, and this function returns false.
|
||||
By default, no extensions are supported, and this function returns \c false.
|
||||
|
||||
\sa supportsExtension(), Extension
|
||||
*/
|
||||
@ -1216,7 +1216,7 @@ bool QAbstractFileEngine::extension(Extension extension, const ExtensionOption *
|
||||
/*!
|
||||
\since 4.3
|
||||
|
||||
This virtual function returns true if the file engine supports \a
|
||||
This virtual function returns \c true if the file engine supports \a
|
||||
extension; otherwise, false is returned. By default, no extensions are
|
||||
supported.
|
||||
|
||||
|
@ -402,9 +402,9 @@ void QDataStream::unsetDevice()
|
||||
/*!
|
||||
\fn bool QDataStream::atEnd() const
|
||||
|
||||
Returns true if the I/O device has reached the end position (end of
|
||||
Returns \c true if the I/O device has reached the end position (end of
|
||||
the stream or file) or if there is no I/O device set; otherwise
|
||||
returns false.
|
||||
returns \c false.
|
||||
|
||||
\sa QIODevice::atEnd()
|
||||
*/
|
||||
|
@ -169,7 +169,7 @@ QT_BEGIN_NAMESPACE
|
||||
/*!
|
||||
\fn bool QDebug::autoInsertSpaces() const
|
||||
|
||||
Returns true if this QDebug instance will automatically insert spaces
|
||||
Returns \c true if this QDebug instance will automatically insert spaces
|
||||
between writes.
|
||||
|
||||
\since 5.0
|
||||
|
@ -855,8 +855,8 @@ QString QDir::fromNativeSeparators(const QString &pathName)
|
||||
/*!
|
||||
Changes the QDir's directory to \a dirName.
|
||||
|
||||
Returns true if the new directory exists and is readable;
|
||||
otherwise returns false. Note that the logical cd() operation is
|
||||
Returns \c true if the new directory exists and is readable;
|
||||
otherwise returns \c false. Note that the logical cd() operation is
|
||||
not performed if the new directory does not exist.
|
||||
|
||||
Calling cd("..") is equivalent to calling cdUp().
|
||||
@ -923,8 +923,8 @@ bool QDir::cd(const QString &dirName)
|
||||
Changes directory by moving one directory up from the QDir's
|
||||
current directory.
|
||||
|
||||
Returns true if the new directory exists and is readable;
|
||||
otherwise returns false. Note that the logical cdUp() operation is
|
||||
Returns \c true if the new directory exists and is readable;
|
||||
otherwise returns \c false. Note that the logical cdUp() operation is
|
||||
not performed if the new directory does not exist.
|
||||
|
||||
\sa cd(), isReadable(), exists(), path()
|
||||
@ -1373,7 +1373,7 @@ QFileInfoList QDir::entryInfoList(const QStringList &nameFilters, Filters filter
|
||||
/*!
|
||||
Creates a sub-directory called \a dirName.
|
||||
|
||||
Returns true on success; otherwise returns false.
|
||||
Returns \c true on success; otherwise returns \c false.
|
||||
|
||||
If the directory already exists when this function is called, it will return false.
|
||||
|
||||
@ -1399,7 +1399,7 @@ bool QDir::mkdir(const QString &dirName) const
|
||||
|
||||
The directory must be empty for rmdir() to succeed.
|
||||
|
||||
Returns true if successful; otherwise returns false.
|
||||
Returns \c true if successful; otherwise returns \c false.
|
||||
|
||||
\sa mkdir()
|
||||
*/
|
||||
@ -1425,7 +1425,7 @@ bool QDir::rmdir(const QString &dirName) const
|
||||
The function will create all parent directories necessary to
|
||||
create the directory.
|
||||
|
||||
Returns true if successful; otherwise returns false.
|
||||
Returns \c true if successful; otherwise returns \c false.
|
||||
|
||||
If the path already exists when this function is called, it will return true.
|
||||
|
||||
@ -1453,7 +1453,7 @@ bool QDir::mkpath(const QString &dirPath) const
|
||||
provided that they are empty. This is the opposite of
|
||||
mkpath(dirPath).
|
||||
|
||||
Returns true if successful; otherwise returns false.
|
||||
Returns \c true if successful; otherwise returns \c false.
|
||||
|
||||
\sa mkpath()
|
||||
*/
|
||||
@ -1476,13 +1476,13 @@ bool QDir::rmpath(const QString &dirPath) const
|
||||
\since 5.0
|
||||
Removes the directory, including all its contents.
|
||||
|
||||
Returns true if successful, otherwise false.
|
||||
Returns \c true if successful, otherwise false.
|
||||
|
||||
If a file or directory cannot be removed, removeRecursively() keeps going
|
||||
and attempts to delete as many files and sub-directories as possible,
|
||||
then returns false.
|
||||
then returns \c false.
|
||||
|
||||
If the directory was already removed, the method returns true
|
||||
If the directory was already removed, the method returns \c true
|
||||
(expected result already reached).
|
||||
|
||||
Note: this function is meant for removing a small application-internal
|
||||
@ -1520,8 +1520,8 @@ bool QDir::removeRecursively()
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the directory is readable \e and we can open files
|
||||
by name; otherwise returns false.
|
||||
Returns \c true if the directory is readable \e and we can open files
|
||||
by name; otherwise returns \c false.
|
||||
|
||||
\warning A false value from this function is not a guarantee that
|
||||
files in the directory are not accessible.
|
||||
@ -1550,7 +1550,7 @@ bool QDir::isReadable() const
|
||||
/*!
|
||||
\overload
|
||||
|
||||
Returns true if the directory exists; otherwise returns false.
|
||||
Returns \c true if the directory exists; otherwise returns \c false.
|
||||
(If a file with the same name is found this function will return false).
|
||||
|
||||
The overload of this function that accepts an argument is used to test
|
||||
@ -1564,11 +1564,11 @@ bool QDir::exists() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the directory is the root directory; otherwise
|
||||
returns false.
|
||||
Returns \c true if the directory is the root directory; otherwise
|
||||
returns \c false.
|
||||
|
||||
Note: If the directory is a symbolic link to the root directory
|
||||
this function returns false. If you want to test for this use
|
||||
this function returns \c false. If you want to test for this use
|
||||
canonicalPath(), e.g.
|
||||
|
||||
\snippet code/src_corelib_io_qdir.cpp 9
|
||||
@ -1585,8 +1585,8 @@ bool QDir::isRoot() const
|
||||
/*!
|
||||
\fn bool QDir::isAbsolute() const
|
||||
|
||||
Returns true if the directory's path is absolute; otherwise
|
||||
returns false. See isAbsolutePath().
|
||||
Returns \c true if the directory's path is absolute; otherwise
|
||||
returns \c false. See isAbsolutePath().
|
||||
|
||||
\sa isRelative(), makeAbsolute(), cleanPath()
|
||||
*/
|
||||
@ -1594,14 +1594,14 @@ bool QDir::isRoot() const
|
||||
/*!
|
||||
\fn bool QDir::isAbsolutePath(const QString &)
|
||||
|
||||
Returns true if \a path is absolute; returns false if it is
|
||||
Returns \c true if \a path is absolute; returns \c false if it is
|
||||
relative.
|
||||
|
||||
\sa isAbsolute(), isRelativePath(), makeAbsolute(), cleanPath()
|
||||
*/
|
||||
|
||||
/*!
|
||||
Returns true if the directory path is relative; otherwise returns
|
||||
Returns \c true if the directory path is relative; otherwise returns
|
||||
false. (Under Unix a path is relative if it does not start with a
|
||||
"/").
|
||||
|
||||
@ -1617,8 +1617,8 @@ bool QDir::isRelative() const
|
||||
|
||||
/*!
|
||||
Converts the directory path to an absolute path. If it is already
|
||||
absolute nothing happens. Returns true if the conversion
|
||||
succeeded; otherwise returns false.
|
||||
absolute nothing happens. Returns \c true if the conversion
|
||||
succeeded; otherwise returns \c false.
|
||||
|
||||
\sa isAbsolute(), isAbsolutePath(), isRelative(), cleanPath()
|
||||
*/
|
||||
@ -1643,9 +1643,9 @@ bool QDir::makeAbsolute()
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if directory \a dir and this directory have the same
|
||||
Returns \c true if directory \a dir and this directory have the same
|
||||
path and their sort and filter settings are the same; otherwise
|
||||
returns false.
|
||||
returns \c false.
|
||||
|
||||
Example:
|
||||
|
||||
@ -1730,7 +1730,7 @@ QDir &QDir::operator=(const QString &path)
|
||||
/*!
|
||||
\fn bool QDir::operator!=(const QDir &dir) const
|
||||
|
||||
Returns true if directory \a dir and this directory have different
|
||||
Returns \c true if directory \a dir and this directory have different
|
||||
paths or different sort or filter settings; otherwise returns
|
||||
false.
|
||||
|
||||
@ -1742,8 +1742,8 @@ QDir &QDir::operator=(const QString &path)
|
||||
/*!
|
||||
Removes the file, \a fileName.
|
||||
|
||||
Returns true if the file is removed successfully; otherwise
|
||||
returns false.
|
||||
Returns \c true if the file is removed successfully; otherwise
|
||||
returns \c false.
|
||||
*/
|
||||
bool QDir::remove(const QString &fileName)
|
||||
{
|
||||
@ -1756,7 +1756,7 @@ bool QDir::remove(const QString &fileName)
|
||||
|
||||
/*!
|
||||
Renames a file or directory from \a oldName to \a newName, and returns
|
||||
true if successful; otherwise returns false.
|
||||
true if successful; otherwise returns \c false.
|
||||
|
||||
On most file systems, rename() fails only if \a oldName does not
|
||||
exist, or if a file with the new name already exists.
|
||||
@ -1784,7 +1784,7 @@ bool QDir::rename(const QString &oldName, const QString &newName)
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the file called \a name exists; otherwise returns
|
||||
Returns \c true if the file called \a name exists; otherwise returns
|
||||
false.
|
||||
|
||||
Unless \a name contains an absolute file path, the file name is assumed
|
||||
@ -1841,8 +1841,8 @@ QChar QDir::separator()
|
||||
|
||||
/*!
|
||||
Sets the application's current working directory to \a path.
|
||||
Returns true if the directory was successfully changed; otherwise
|
||||
returns false.
|
||||
Returns \c true if the directory was successfully changed; otherwise
|
||||
returns \c false.
|
||||
|
||||
\sa current(), currentPath(), home(), root(), temp()
|
||||
*/
|
||||
@ -1980,8 +1980,8 @@ QString QDir::rootPath()
|
||||
/*!
|
||||
\overload
|
||||
|
||||
Returns true if the \a fileName matches any of the wildcard (glob)
|
||||
patterns in the list of \a filters; otherwise returns false. The
|
||||
Returns \c true if the \a fileName matches any of the wildcard (glob)
|
||||
patterns in the list of \a filters; otherwise returns \c false. The
|
||||
matching is case insensitive.
|
||||
|
||||
\sa {QRegExp wildcard matching}, QRegExp::exactMatch(), entryList(), entryInfoList()
|
||||
@ -1997,8 +1997,8 @@ bool QDir::match(const QStringList &filters, const QString &fileName)
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the \a fileName matches the wildcard (glob)
|
||||
pattern \a filter; otherwise returns false. The \a filter may
|
||||
Returns \c true if the \a fileName matches the wildcard (glob)
|
||||
pattern \a filter; otherwise returns \c false. The \a filter may
|
||||
contain multiple patterns separated by spaces or semicolons.
|
||||
The matching is case insensitive.
|
||||
|
||||
@ -2159,7 +2159,7 @@ QString QDir::cleanPath(const QString &path)
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if \a path is relative; returns false if it is
|
||||
Returns \c true if \a path is relative; returns \c false if it is
|
||||
absolute.
|
||||
|
||||
\sa isRelative(), isAbsolutePath(), makeAbsolute()
|
||||
|
@ -308,7 +308,7 @@ void QDirIteratorPrivate::checkAndPushDirectory(const QFileInfo &fileInfo)
|
||||
This convenience function implements the iterator's filtering logics and
|
||||
applies then to the current directory entry.
|
||||
|
||||
It returns true if the current entry matches the filters (i.e., the
|
||||
It returns \c true if the current entry matches the filters (i.e., the
|
||||
current entry will be returned as part of the directory iteration);
|
||||
otherwise, false is returned.
|
||||
*/
|
||||
@ -476,7 +476,7 @@ QDirIterator::~QDirIterator()
|
||||
|
||||
/*!
|
||||
Advances the iterator to the next entry, and returns the file path of this
|
||||
new entry. If hasNext() returns false, this function does nothing, and
|
||||
new entry. If hasNext() returns \c false, this function does nothing, and
|
||||
returns a null QString.
|
||||
|
||||
You can call fileName() or filePath() to get the current entry file name
|
||||
@ -491,7 +491,7 @@ QString QDirIterator::next()
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if there is at least one more entry in the directory;
|
||||
Returns \c true if there is at least one more entry in the directory;
|
||||
otherwise, false is returned.
|
||||
|
||||
\sa next(), fileName(), filePath(), fileInfo()
|
||||
|
@ -143,7 +143,7 @@ QAbstractFileEngine *QFilePrivate::engine() const
|
||||
The size of the file is returned by size(). You can get the
|
||||
current file position using pos(), or move to a new file position
|
||||
using seek(). If you've reached the end of the file, atEnd()
|
||||
returns true.
|
||||
returns \c true.
|
||||
|
||||
\section1 Reading Files Directly
|
||||
|
||||
@ -403,8 +403,8 @@ QFile::setFileName(const QString &name)
|
||||
/*!
|
||||
\overload
|
||||
|
||||
Returns true if the file specified by fileName() exists; otherwise
|
||||
returns false.
|
||||
Returns \c true if the file specified by fileName() exists; otherwise
|
||||
returns \c false.
|
||||
|
||||
\sa fileName(), setFileName()
|
||||
*/
|
||||
@ -419,8 +419,8 @@ QFile::exists() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the file specified by \a fileName exists; otherwise
|
||||
returns false.
|
||||
Returns \c true if the file specified by \a fileName exists; otherwise
|
||||
returns \c false.
|
||||
|
||||
\note If \a fileName is a symlink that points to a non-existing
|
||||
file, false is returned.
|
||||
@ -442,7 +442,7 @@ QFile::exists(const QString &fileName)
|
||||
link.
|
||||
|
||||
This name may not represent an existing file; it is only a string.
|
||||
QFile::exists() returns true if the symlink points to an existing file.
|
||||
QFile::exists() returns \c true if the symlink points to an existing file.
|
||||
|
||||
\sa fileName(), setFileName()
|
||||
*/
|
||||
@ -468,7 +468,7 @@ QFile::readLink() const
|
||||
empty string if the \a fileName does not correspond to a symbolic link.
|
||||
|
||||
This name may not represent an existing file; it is only a string.
|
||||
QFile::exists() returns true if the symlink points to an existing file.
|
||||
QFile::exists() returns \c true if the symlink points to an existing file.
|
||||
*/
|
||||
|
||||
/*!
|
||||
@ -483,8 +483,8 @@ QFile::readLink(const QString &fileName)
|
||||
}
|
||||
|
||||
/*!
|
||||
Removes the file specified by fileName(). Returns true if successful;
|
||||
otherwise returns false.
|
||||
Removes the file specified by fileName(). Returns \c true if successful;
|
||||
otherwise returns \c false.
|
||||
|
||||
The file is closed before it is removed.
|
||||
|
||||
@ -516,7 +516,7 @@ QFile::remove()
|
||||
|
||||
Removes the file specified by the \a fileName given.
|
||||
|
||||
Returns true if successful; otherwise returns false.
|
||||
Returns \c true if successful; otherwise returns \c false.
|
||||
|
||||
\sa remove()
|
||||
*/
|
||||
@ -529,9 +529,9 @@ QFile::remove(const QString &fileName)
|
||||
|
||||
/*!
|
||||
Renames the file currently specified by fileName() to \a newName.
|
||||
Returns true if successful; otherwise returns false.
|
||||
Returns \c true if successful; otherwise returns \c false.
|
||||
|
||||
If a file with the name \a newName already exists, rename() returns false
|
||||
If a file with the name \a newName already exists, rename() returns \c false
|
||||
(i.e., QFile will not overwrite it).
|
||||
|
||||
The file is closed before it is renamed.
|
||||
@ -660,10 +660,10 @@ QFile::rename(const QString &newName)
|
||||
/*!
|
||||
\overload
|
||||
|
||||
Renames the file \a oldName to \a newName. Returns true if
|
||||
successful; otherwise returns false.
|
||||
Renames the file \a oldName to \a newName. Returns \c true if
|
||||
successful; otherwise returns \c false.
|
||||
|
||||
If a file with the name \a newName already exists, rename() returns false
|
||||
If a file with the name \a newName already exists, rename() returns \c false
|
||||
(i.e., QFile will not overwrite it).
|
||||
|
||||
\sa rename()
|
||||
@ -679,8 +679,8 @@ QFile::rename(const QString &oldName, const QString &newName)
|
||||
|
||||
Creates a link named \a linkName that points to the file currently specified by
|
||||
fileName(). What a link is depends on the underlying filesystem (be it a
|
||||
shortcut on Windows or a symbolic link on Unix). Returns true if successful;
|
||||
otherwise returns false.
|
||||
shortcut on Windows or a symbolic link on Unix). Returns \c true if successful;
|
||||
otherwise returns \c false.
|
||||
|
||||
This function will not overwrite an already existing entity in the file system;
|
||||
in this case, \c link() will return false and set \l{QFile::}{error()} to
|
||||
@ -713,8 +713,8 @@ QFile::link(const QString &linkName)
|
||||
|
||||
Creates a link named \a linkName that points to the file \a fileName. What a link is
|
||||
depends on the underlying filesystem (be it a shortcut on Windows
|
||||
or a symbolic link on Unix). Returns true if successful; otherwise
|
||||
returns false.
|
||||
or a symbolic link on Unix). Returns \c true if successful; otherwise
|
||||
returns \c false.
|
||||
|
||||
\sa link()
|
||||
*/
|
||||
@ -727,10 +727,10 @@ QFile::link(const QString &fileName, const QString &linkName)
|
||||
|
||||
/*!
|
||||
Copies the file currently specified by fileName() to a file called
|
||||
\a newName. Returns true if successful; otherwise returns false.
|
||||
\a newName. Returns \c true if successful; otherwise returns \c false.
|
||||
|
||||
Note that if a file with the name \a newName already exists,
|
||||
copy() returns false (i.e. QFile will not overwrite it).
|
||||
copy() returns \c false (i.e. QFile will not overwrite it).
|
||||
|
||||
The source file is closed before it is copied.
|
||||
|
||||
@ -830,10 +830,10 @@ QFile::copy(const QString &newName)
|
||||
/*!
|
||||
\overload
|
||||
|
||||
Copies the file \a fileName to \a newName. Returns true if successful;
|
||||
otherwise returns false.
|
||||
Copies the file \a fileName to \a newName. Returns \c true if successful;
|
||||
otherwise returns \c false.
|
||||
|
||||
If a file with the name \a newName already exists, copy() returns false
|
||||
If a file with the name \a newName already exists, copy() returns \c false
|
||||
(i.e., QFile will not overwrite it).
|
||||
|
||||
\sa rename()
|
||||
@ -894,7 +894,7 @@ bool QFile::open(OpenMode mode)
|
||||
|
||||
Opens the existing file handle \a fh in the given \a mode.
|
||||
\a handleFlags may be used to specify additional options.
|
||||
Returns true if successful; otherwise returns false.
|
||||
Returns \c true if successful; otherwise returns \c false.
|
||||
|
||||
Example:
|
||||
\snippet code/src_corelib_io_qfile.cpp 3
|
||||
@ -966,7 +966,7 @@ bool QFile::open(FILE *fh, OpenMode mode, FileHandleFlags handleFlags)
|
||||
|
||||
Opens the existing file descriptor \a fd in the given \a mode.
|
||||
\a handleFlags may be used to specify additional options.
|
||||
Returns true if successful; otherwise returns false.
|
||||
Returns \c true if successful; otherwise returns \c false.
|
||||
|
||||
When a QFile is opened using this function, behaviour of close() is
|
||||
controlled by the AutoCloseHandle flag.
|
||||
@ -1031,7 +1031,7 @@ bool QFile::resize(qint64 sz)
|
||||
/*!
|
||||
\overload
|
||||
|
||||
Sets \a fileName to size (in bytes) \a sz. Returns true if the file if
|
||||
Sets \a fileName to size (in bytes) \a sz. Returns \c true if the file if
|
||||
the resize succeeds; false otherwise. If \a sz is larger than \a
|
||||
fileName currently is the new bytes will be set to 0, if \a sz is
|
||||
smaller the file is simply truncated.
|
||||
@ -1068,7 +1068,7 @@ QFile::permissions(const QString &fileName)
|
||||
|
||||
/*!
|
||||
Sets the permissions for the file to the \a permissions specified.
|
||||
Returns true if successful, or false if the permissions cannot be
|
||||
Returns \c true if successful, or false if the permissions cannot be
|
||||
modified.
|
||||
|
||||
\sa permissions(), setFileName()
|
||||
|
@ -232,8 +232,8 @@ QFileDevice::~QFileDevice()
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the file can only be manipulated sequentially;
|
||||
otherwise returns false.
|
||||
Returns \c true if the file can only be manipulated sequentially;
|
||||
otherwise returns \c false.
|
||||
|
||||
Most files support random-access, but some special files may not.
|
||||
|
||||
@ -286,8 +286,8 @@ static inline qint64 _qfile_writeData(QAbstractFileEngine *engine, QRingBuffer *
|
||||
}
|
||||
|
||||
/*!
|
||||
Flushes any buffered data to the file. Returns true if successful;
|
||||
otherwise returns false.
|
||||
Flushes any buffered data to the file. Returns \c true if successful;
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
bool QFileDevice::flush()
|
||||
{
|
||||
@ -351,11 +351,11 @@ qint64 QFileDevice::pos() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the end of the file has been reached; otherwise returns
|
||||
Returns \c true if the end of the file has been reached; otherwise returns
|
||||
false.
|
||||
|
||||
For regular empty files on Unix (e.g. those in \c /proc), this function
|
||||
returns true, since the file system reports that the size of such a file is
|
||||
returns \c true, since the file system reports that the size of such a file is
|
||||
0. Therefore, you should not depend on atEnd() when reading data from such a
|
||||
file, but rather call read() until no more data can be read.
|
||||
*/
|
||||
@ -578,7 +578,7 @@ qint64 QFileDevice::writeData(const char *data, qint64 len)
|
||||
Returns the file error status.
|
||||
|
||||
The I/O device status returns an error code. For example, if open()
|
||||
returns false, or a read/write operation returns -1, this function can
|
||||
returns \c false, or a read/write operation returns -1, this function can
|
||||
be called to find out the reason why the operation failed.
|
||||
|
||||
\sa unsetError()
|
||||
@ -617,7 +617,7 @@ qint64 QFileDevice::size() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Sets the file size (in bytes) \a sz. Returns true if the file if the
|
||||
Sets the file size (in bytes) \a sz. Returns \c true if the file if the
|
||||
resize succeeds; false otherwise. If \a sz is larger than the file
|
||||
currently is the new bytes will be set to 0, if \a sz is smaller the
|
||||
file is simply truncated.
|
||||
@ -657,7 +657,7 @@ QFile::Permissions QFileDevice::permissions() const
|
||||
|
||||
/*!
|
||||
Sets the permissions for the file to the \a permissions specified.
|
||||
Returns true if successful, or false if the permissions cannot be
|
||||
Returns \c true if successful, or false if the permissions cannot be
|
||||
modified.
|
||||
|
||||
\sa permissions()
|
||||
@ -715,7 +715,7 @@ uchar *QFileDevice::map(qint64 offset, qint64 size, MemoryMapFlags flags)
|
||||
/*!
|
||||
Unmaps the memory \a address.
|
||||
|
||||
Returns true if the unmap succeeds; false otherwise.
|
||||
Returns \c true if the unmap succeeds; false otherwise.
|
||||
|
||||
\sa map()
|
||||
*/
|
||||
|
@ -379,15 +379,15 @@ QFileInfo::~QFileInfo()
|
||||
/*!
|
||||
\fn bool QFileInfo::operator!=(const QFileInfo &fileinfo) const
|
||||
|
||||
Returns true if this QFileInfo object refers to a different file
|
||||
than the one specified by \a fileinfo; otherwise returns false.
|
||||
Returns \c true if this QFileInfo object refers to a different file
|
||||
than the one specified by \a fileinfo; otherwise returns \c false.
|
||||
|
||||
\sa operator==()
|
||||
*/
|
||||
|
||||
/*!
|
||||
Returns true if this QFileInfo object refers to a file in the same
|
||||
location as \a fileinfo; otherwise returns false.
|
||||
Returns \c true if this QFileInfo object refers to a file in the same
|
||||
location as \a fileinfo; otherwise returns \c false.
|
||||
|
||||
Note that the result of comparing two empty QFileInfo objects,
|
||||
containing no file references (file paths that do not exist or
|
||||
@ -615,14 +615,14 @@ QString QFileInfo::path() const
|
||||
/*!
|
||||
\fn bool QFileInfo::isAbsolute() const
|
||||
|
||||
Returns true if the file path name is absolute, otherwise returns
|
||||
Returns \c true if the file path name is absolute, otherwise returns
|
||||
false if the path is relative.
|
||||
|
||||
\sa isRelative()
|
||||
*/
|
||||
|
||||
/*!
|
||||
Returns true if the file path name is relative, otherwise returns
|
||||
Returns \c true if the file path name is relative, otherwise returns
|
||||
false if the path is absolute (e.g. under Unix a path is absolute
|
||||
if it begins with a "/").
|
||||
|
||||
@ -640,7 +640,7 @@ bool QFileInfo::isRelative() const
|
||||
|
||||
/*!
|
||||
Converts the file's path to an absolute path if it is not already in that form.
|
||||
Returns true to indicate that the path was converted; otherwise returns false
|
||||
Returns \c true to indicate that the path was converted; otherwise returns \c false
|
||||
to indicate that the path was already absolute.
|
||||
|
||||
\sa filePath(), isRelative()
|
||||
@ -656,7 +656,7 @@ bool QFileInfo::makeAbsolute()
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the file exists; otherwise returns false.
|
||||
Returns \c true if the file exists; otherwise returns \c false.
|
||||
|
||||
\note If the file is a symlink that points to a non-existing
|
||||
file, false is returned.
|
||||
@ -675,7 +675,7 @@ bool QFileInfo::exists() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the \a file exists; otherwise returns false.
|
||||
Returns \c true if the \a file exists; otherwise returns \c false.
|
||||
|
||||
\note If \a file is a symlink that points to a non-existing
|
||||
file, false is returned.
|
||||
@ -884,7 +884,7 @@ QDir QFileInfo::absoluteDir() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the user can read the file; otherwise returns false.
|
||||
Returns \c true if the user can read the file; otherwise returns \c false.
|
||||
|
||||
\sa isWritable(), isExecutable(), permission()
|
||||
*/
|
||||
@ -902,7 +902,7 @@ bool QFileInfo::isReadable() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the user can write to the file; otherwise returns false.
|
||||
Returns \c true if the user can write to the file; otherwise returns \c false.
|
||||
|
||||
\sa isReadable(), isExecutable(), permission()
|
||||
*/
|
||||
@ -920,7 +920,7 @@ bool QFileInfo::isWritable() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the file is executable; otherwise returns false.
|
||||
Returns \c true if the file is executable; otherwise returns \c false.
|
||||
|
||||
\sa isReadable(), isWritable(), permission()
|
||||
*/
|
||||
@ -938,9 +938,9 @@ bool QFileInfo::isExecutable() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if this is a `hidden' file; otherwise returns false.
|
||||
Returns \c true if this is a `hidden' file; otherwise returns \c false.
|
||||
|
||||
\b{Note:} This function returns true for the special entries
|
||||
\b{Note:} This function returns \c true for the special entries
|
||||
"." and ".." on Unix, even though QDir::entryList threats them as shown.
|
||||
*/
|
||||
bool QFileInfo::isHidden() const
|
||||
@ -958,8 +958,8 @@ bool QFileInfo::isHidden() const
|
||||
|
||||
/*!
|
||||
\since 5.0
|
||||
Returns true if the file path can be used directly with native APIs.
|
||||
Returns false if the file is otherwise supported by a virtual file system
|
||||
Returns \c true if the file path can be used directly with native APIs.
|
||||
Returns \c false if the file is otherwise supported by a virtual file system
|
||||
inside Qt, such as \l{the Qt Resource System}.
|
||||
|
||||
\b{Note:} Native paths may still require conversion of path separators
|
||||
@ -980,8 +980,8 @@ bool QFileInfo::isNativePath() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if this object points to a file or to a symbolic
|
||||
link to a file. Returns false if the
|
||||
Returns \c true if this object points to a file or to a symbolic
|
||||
link to a file. Returns \c false if the
|
||||
object points to something which isn't a file, such as a directory.
|
||||
|
||||
\sa isDir(), isSymLink(), isBundle()
|
||||
@ -1000,8 +1000,8 @@ bool QFileInfo::isFile() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if this object points to a directory or to a symbolic
|
||||
link to a directory; otherwise returns false.
|
||||
Returns \c true if this object points to a directory or to a symbolic
|
||||
link to a directory; otherwise returns \c false.
|
||||
|
||||
\sa isFile(), isSymLink(), isBundle()
|
||||
*/
|
||||
@ -1021,8 +1021,8 @@ bool QFileInfo::isDir() const
|
||||
|
||||
/*!
|
||||
\since 4.3
|
||||
Returns true if this object points to a bundle or to a symbolic
|
||||
link to a bundle on Mac OS X; otherwise returns false.
|
||||
Returns \c true if this object points to a bundle or to a symbolic
|
||||
link to a bundle on Mac OS X; otherwise returns \c false.
|
||||
|
||||
\sa isDir(), isSymLink(), isFile()
|
||||
*/
|
||||
@ -1040,8 +1040,8 @@ bool QFileInfo::isBundle() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if this object points to a symbolic link (or to a
|
||||
shortcut on Windows); otherwise returns false.
|
||||
Returns \c true if this object points to a symbolic link (or to a
|
||||
shortcut on Windows); otherwise returns \c false.
|
||||
|
||||
On Unix (including Mac OS X), opening a symlink effectively opens
|
||||
the \l{symLinkTarget()}{link's target}. On Windows, it opens the \c
|
||||
@ -1070,9 +1070,9 @@ bool QFileInfo::isSymLink() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the object points to a directory or to a symbolic
|
||||
Returns \c true if the object points to a directory or to a symbolic
|
||||
link to a directory, and that directory is the root directory; otherwise
|
||||
returns false.
|
||||
returns \c false.
|
||||
*/
|
||||
bool QFileInfo::isRoot() const
|
||||
{
|
||||
@ -1105,7 +1105,7 @@ bool QFileInfo::isRoot() const
|
||||
link.
|
||||
|
||||
This name may not represent an existing file; it is only a string.
|
||||
QFileInfo::exists() returns true if the symlink points to an
|
||||
QFileInfo::exists() returns \c true if the symlink points to an
|
||||
existing file.
|
||||
|
||||
\sa exists(), isSymLink(), isDir(), isFile()
|
||||
@ -1208,7 +1208,7 @@ uint QFileInfo::groupId() const
|
||||
for permission combinations.
|
||||
|
||||
On systems where files do not have permissions this function
|
||||
always returns true.
|
||||
always returns \c true.
|
||||
|
||||
Example:
|
||||
\snippet code/src_corelib_io_qfileinfo.cpp 10
|
||||
@ -1348,7 +1348,7 @@ QFileInfoPrivate* QFileInfo::d_func()
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if caching is enabled; otherwise returns false.
|
||||
Returns \c true if caching is enabled; otherwise returns \c false.
|
||||
|
||||
\sa setCaching(), refresh()
|
||||
*/
|
||||
|
@ -224,8 +224,8 @@ bool QFSFileEngine::open(QIODevice::OpenMode openMode)
|
||||
}
|
||||
|
||||
/*!
|
||||
Opens the file handle \a fh in \a openMode mode. Returns true on
|
||||
success; otherwise returns false.
|
||||
Opens the file handle \a fh in \a openMode mode. Returns \c true on
|
||||
success; otherwise returns \c false.
|
||||
*/
|
||||
bool QFSFileEngine::open(QIODevice::OpenMode openMode, FILE *fh)
|
||||
{
|
||||
@ -285,8 +285,8 @@ bool QFSFileEnginePrivate::openFh(QIODevice::OpenMode openMode, FILE *fh)
|
||||
}
|
||||
|
||||
/*!
|
||||
Opens the file descriptor \a fd in \a openMode mode. Returns true
|
||||
on success; otherwise returns false.
|
||||
Opens the file descriptor \a fd in \a openMode mode. Returns \c true
|
||||
on success; otherwise returns \c false.
|
||||
*/
|
||||
bool QFSFileEngine::open(QIODevice::OpenMode openMode, int fd)
|
||||
{
|
||||
@ -837,7 +837,7 @@ bool QFSFileEngine::supportsExtension(Extension extension) const
|
||||
}
|
||||
|
||||
/*! \fn bool QFSFileEngine::caseSensitive() const
|
||||
Returns true for Windows, false for Unix.
|
||||
Returns \c true for Windows, false for Unix.
|
||||
*/
|
||||
|
||||
/*! \fn bool QFSFileEngine::copy(const QString ©Name)
|
||||
@ -892,7 +892,7 @@ bool QFSFileEngine::supportsExtension(Extension extension) const
|
||||
Creates a link from the file currently specified by fileName() to
|
||||
\a newName. What a link is depends on the underlying filesystem
|
||||
(be it a shortcut on Windows or a symbolic link on Unix). Returns
|
||||
true if successful; otherwise returns false.
|
||||
true if successful; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*! \fn bool QFSFileEngine::mkdir(const QString &name, bool createParentDirectories) const
|
||||
@ -935,8 +935,8 @@ bool QFSFileEngine::supportsExtension(Extension extension) const
|
||||
*/
|
||||
|
||||
/*! \fn bool QFSFileEngine::setCurrentPath(const QString &path)
|
||||
Sets the current path (e.g., for QDir), to \a path. Returns true if the
|
||||
new path exists; otherwise this function does nothing, and returns false.
|
||||
Sets the current path (e.g., for QDir), to \a path. Returns \c true if the
|
||||
new path exists; otherwise this function does nothing, and returns \c false.
|
||||
|
||||
\sa currentPath()
|
||||
*/
|
||||
|
@ -400,7 +400,7 @@ QIODevice::~QIODevice()
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if this device is sequential; otherwise returns
|
||||
Returns \c true if this device is sequential; otherwise returns
|
||||
false.
|
||||
|
||||
Sequential devices, as opposed to a random-access devices, have no
|
||||
@ -476,7 +476,7 @@ void QIODevice::setTextModeEnabled(bool enabled)
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the \l Text flag is enabled; otherwise returns false.
|
||||
Returns \c true if the \l Text flag is enabled; otherwise returns \c false.
|
||||
|
||||
\sa setTextModeEnabled()
|
||||
*/
|
||||
@ -486,9 +486,9 @@ bool QIODevice::isTextModeEnabled() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the device is open; otherwise returns false. A
|
||||
Returns \c true if the device is open; otherwise returns \c false. A
|
||||
device is open if it can be read from and/or written to. By
|
||||
default, this function returns false if openMode() returns
|
||||
default, this function returns \c false if openMode() returns
|
||||
\c NotOpen.
|
||||
|
||||
\sa openMode(), OpenMode
|
||||
@ -499,7 +499,7 @@ bool QIODevice::isOpen() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if data can be read from the device; otherwise returns
|
||||
Returns \c true if data can be read from the device; otherwise returns
|
||||
false. Use bytesAvailable() to determine how many bytes can be read.
|
||||
|
||||
This is a convenience function which checks if the OpenMode of the
|
||||
@ -513,7 +513,7 @@ bool QIODevice::isReadable() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if data can be written to the device; otherwise returns
|
||||
Returns \c true if data can be written to the device; otherwise returns
|
||||
false.
|
||||
|
||||
This is a convenience function which checks if the OpenMode of the
|
||||
@ -527,8 +527,8 @@ bool QIODevice::isWritable() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Opens the device and sets its OpenMode to \a mode. Returns true if successful;
|
||||
otherwise returns false. This function should be called from any
|
||||
Opens the device and sets its OpenMode to \a mode. Returns \c true if successful;
|
||||
otherwise returns \c false. This function should be called from any
|
||||
reimplementations of open() or other functions that open the device.
|
||||
|
||||
\sa openMode(), OpenMode
|
||||
@ -665,9 +665,9 @@ bool QIODevice::seek(qint64 pos)
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the current read and write position is at the end
|
||||
Returns \c true if the current read and write position is at the end
|
||||
of the device (i.e. there is no more data available for reading on
|
||||
the device); otherwise returns false.
|
||||
the device); otherwise returns \c false.
|
||||
|
||||
For some devices, atEnd() can return true even though there is more data
|
||||
to read. This special case only applies to devices that generate data in
|
||||
@ -688,7 +688,7 @@ bool QIODevice::atEnd() const
|
||||
|
||||
/*!
|
||||
Seeks to the start of input for random-access devices. Returns
|
||||
true on success; otherwise returns false (for example, if the
|
||||
true on success; otherwise returns \c false (for example, if the
|
||||
device is not open).
|
||||
|
||||
Note that when using a QTextStream on a QFile, calling reset() on
|
||||
@ -1268,8 +1268,8 @@ qint64 QIODevice::readLineData(char *data, qint64 maxSize)
|
||||
#endif
|
||||
|
||||
/*!
|
||||
Returns true if a complete line of data can be read from the device;
|
||||
otherwise returns false.
|
||||
Returns \c true if a complete line of data can be read from the device;
|
||||
otherwise returns \c false.
|
||||
|
||||
Note that unbuffered devices, which have no way of determining what
|
||||
can be read, always return false.
|
||||
@ -1426,8 +1426,8 @@ void QIODevice::ungetChar(char c)
|
||||
|
||||
/*! \fn bool QIODevice::putChar(char c)
|
||||
|
||||
Writes the character \a c to the device. Returns true on success;
|
||||
otherwise returns false.
|
||||
Writes the character \a c to the device. Returns \c true on success;
|
||||
otherwise returns \c false.
|
||||
|
||||
\sa write(), getChar(), ungetChar()
|
||||
*/
|
||||
@ -1476,8 +1476,8 @@ QByteArray QIODevicePrivate::peek(qint64 maxSize)
|
||||
/*! \fn bool QIODevice::getChar(char *c)
|
||||
|
||||
Reads one character from the device and stores it in \a c. If \a c
|
||||
is 0, the character is discarded. Returns true on success;
|
||||
otherwise returns false.
|
||||
is 0, the character is discarded. Returns \c true on success;
|
||||
otherwise returns \c false.
|
||||
|
||||
\sa read(), putChar(), ungetChar()
|
||||
*/
|
||||
@ -1537,7 +1537,7 @@ QByteArray QIODevice::peek(qint64 maxSize)
|
||||
signal has been emitted, or until \a msecs milliseconds have
|
||||
passed. If msecs is -1, this function will not time out.
|
||||
|
||||
Returns true if new data is available for reading; otherwise returns
|
||||
Returns \c true if new data is available for reading; otherwise returns
|
||||
false (if the operation timed out or if an error occurred).
|
||||
|
||||
This function can operate without an event loop. It is
|
||||
@ -1548,7 +1548,7 @@ QByteArray QIODevice::peek(qint64 maxSize)
|
||||
readyRead() will not be reemitted.
|
||||
|
||||
Reimplement this function to provide a blocking API for a custom
|
||||
device. The default implementation does nothing, and returns false.
|
||||
device. The default implementation does nothing, and returns \c false.
|
||||
|
||||
\warning Calling this function from the main (GUI) thread
|
||||
might cause your user interface to freeze.
|
||||
@ -1568,8 +1568,8 @@ bool QIODevice::waitForReadyRead(int msecs)
|
||||
milliseconds have passed. If msecs is -1, this function will
|
||||
not time out. For unbuffered devices, it returns immediately.
|
||||
|
||||
Returns true if a payload of data was written to the device;
|
||||
otherwise returns false (i.e. if the operation timed out, or if an
|
||||
Returns \c true if a payload of data was written to the device;
|
||||
otherwise returns \c false (i.e. if the operation timed out, or if an
|
||||
error occurred).
|
||||
|
||||
This function can operate without an event loop. It is
|
||||
@ -1580,7 +1580,7 @@ bool QIODevice::waitForReadyRead(int msecs)
|
||||
bytesWritten() will not be reemitted.
|
||||
|
||||
Reimplement this function to provide a blocking API for a custom
|
||||
device. The default implementation does nothing, and returns false.
|
||||
device. The default implementation does nothing, and returns \c false.
|
||||
|
||||
\warning Calling this function from the main (GUI) thread
|
||||
might cause your user interface to freeze.
|
||||
|
@ -154,8 +154,8 @@ int QLockFile::staleLockTime() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the lock was acquired by this QLockFile instance,
|
||||
otherwise returns false.
|
||||
Returns \c true if the lock was acquired by this QLockFile instance,
|
||||
otherwise returns \c false.
|
||||
|
||||
\sa lock(), unlock(), tryLock()
|
||||
*/
|
||||
@ -175,7 +175,7 @@ bool QLockFile::isLocked() const
|
||||
thread without unlocking first is not allowed. This function will
|
||||
\e dead-lock when the file is locked recursively.
|
||||
|
||||
Returns true if the lock was acquired, false if it could not be acquired
|
||||
Returns \c true if the lock was acquired, false if it could not be acquired
|
||||
due to an unrecoverable error, such as no permissions in the parent directory.
|
||||
|
||||
\sa unlock(), tryLock()
|
||||
@ -186,8 +186,8 @@ bool QLockFile::lock()
|
||||
}
|
||||
|
||||
/*!
|
||||
Attempts to create the lock file. This function returns true if the
|
||||
lock was obtained; otherwise it returns false. If another process (or
|
||||
Attempts to create the lock file. This function returns \c true if the
|
||||
lock was obtained; otherwise it returns \c false. If another process (or
|
||||
another thread) has created the lock file already, this function will
|
||||
wait for at most \a timeout milliseconds for the lock file to become
|
||||
available.
|
||||
@ -255,7 +255,7 @@ bool QLockFile::tryLock(int timeout)
|
||||
/*!
|
||||
Retrieves information about the current owner of the lock file.
|
||||
|
||||
If tryLock() returns false, and error() returns LockFailedError,
|
||||
If tryLock() returns \c false, and error() returns LockFailedError,
|
||||
this function can be called to find out more information about the existing
|
||||
lock file:
|
||||
\list
|
||||
@ -272,7 +272,7 @@ bool QLockFile::tryLock(int timeout)
|
||||
the choice to delete it. After removing the file using removeStaleLockFile(),
|
||||
the application can call tryLock() again.
|
||||
|
||||
This function returns true if the information could be successfully retrieved, false
|
||||
This function returns \c true if the information could be successfully retrieved, false
|
||||
if the lock file doesn't exist or doesn't contain the expected data.
|
||||
This can happen if the lock file was deleted between the time where tryLock() failed
|
||||
and the call to this function. Simply call tryLock() again if this happens.
|
||||
@ -318,7 +318,7 @@ bool QLockFilePrivate::getLockInfo(qint64 *pid, QString *hostname, QString *appn
|
||||
with staleLockTime(0), and after tryLock() returned LockFailedError, and the user
|
||||
agreed on removing the lock file.
|
||||
|
||||
Returns true on success, false if the lock file couldn't be removed. This happens
|
||||
Returns \c true on success, false if the lock file couldn't be removed. This happens
|
||||
on Windows, when the application owning the lock is still running.
|
||||
*/
|
||||
bool QLockFile::removeStaleLockFile()
|
||||
@ -334,7 +334,7 @@ bool QLockFile::removeStaleLockFile()
|
||||
/*!
|
||||
Returns the lock file error status.
|
||||
|
||||
If tryLock() returns false, this function can be called to find out
|
||||
If tryLock() returns \c false, this function can be called to find out
|
||||
the reason why the locking failed.
|
||||
*/
|
||||
QLockFile::LockError QLockFile::error() const
|
||||
|
@ -80,7 +80,7 @@ public:
|
||||
QLockFile::LockError tryLock_sys();
|
||||
bool removeStaleLock();
|
||||
bool getLockInfo(qint64 *pid, QString *hostname, QString *appname) const;
|
||||
// Returns true if the lock belongs to dead PID, or is old.
|
||||
// Returns \c true if the lock belongs to dead PID, or is old.
|
||||
// The attempt to delete it will tell us if it was really stale or not, though.
|
||||
bool isApparentlyStale() const;
|
||||
|
||||
|
@ -89,7 +89,7 @@ QT_BEGIN_NAMESPACE
|
||||
/*!
|
||||
\fn virtual bool QNonContiguousByteDevice::atEnd()
|
||||
|
||||
Returns true if everything has been read and the read
|
||||
Returns \c true if everything has been read and the read
|
||||
pointer cannot be advanced anymore.
|
||||
|
||||
\sa readPointer(), advanceReadPointer(), reset()
|
||||
@ -100,7 +100,7 @@ QT_BEGIN_NAMESPACE
|
||||
\fn virtual bool QNonContiguousByteDevice::reset()
|
||||
|
||||
Moves the internal read pointer back to the beginning.
|
||||
Returns false if this was not possible.
|
||||
Returns \c false if this was not possible.
|
||||
|
||||
\sa atEnd(), disableReset()
|
||||
|
||||
|
@ -249,13 +249,13 @@ QProcessEnvironment &QProcessEnvironment::operator=(const QProcessEnvironment &o
|
||||
/*!
|
||||
\fn bool QProcessEnvironment::operator !=(const QProcessEnvironment &other) const
|
||||
|
||||
Returns true if this and the \a other QProcessEnvironment objects are different.
|
||||
Returns \c true if this and the \a other QProcessEnvironment objects are different.
|
||||
|
||||
\sa operator==()
|
||||
*/
|
||||
|
||||
/*!
|
||||
Returns true if this and the \a other QProcessEnvironment objects are equal.
|
||||
Returns \c true if this and the \a other QProcessEnvironment objects are equal.
|
||||
|
||||
Two QProcessEnvironment objects are considered equal if they have the same
|
||||
set of key=value pairs. The comparison of keys is done case-sensitive on
|
||||
@ -275,7 +275,7 @@ bool QProcessEnvironment::operator==(const QProcessEnvironment &other) const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if this QProcessEnvironment object is empty: that is
|
||||
Returns \c true if this QProcessEnvironment object is empty: that is
|
||||
there are no key=value pairs set.
|
||||
|
||||
\sa clear(), systemEnvironment(), insert()
|
||||
@ -301,7 +301,7 @@ void QProcessEnvironment::clear()
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the environment variable of name \a name is found in
|
||||
Returns \c true if the environment variable of name \a name is found in
|
||||
this QProcessEnvironment object.
|
||||
|
||||
|
||||
@ -1587,8 +1587,8 @@ void QProcess::close()
|
||||
|
||||
/*! \reimp
|
||||
|
||||
Returns true if the process is not running, and no more data is available
|
||||
for reading; otherwise returns false.
|
||||
Returns \c true if the process is not running, and no more data is available
|
||||
for reading; otherwise returns \c false.
|
||||
*/
|
||||
bool QProcess::atEnd() const
|
||||
{
|
||||
@ -1735,8 +1735,8 @@ QProcessEnvironment QProcess::processEnvironment() const
|
||||
Blocks until the process has started and the started() signal has
|
||||
been emitted, or until \a msecs milliseconds have passed.
|
||||
|
||||
Returns true if the process was started successfully; otherwise
|
||||
returns false (if the operation timed out or if an error
|
||||
Returns \c true if the process was started successfully; otherwise
|
||||
returns \c false (if the operation timed out or if an error
|
||||
occurred).
|
||||
|
||||
This function can operate without an event loop. It is
|
||||
@ -1798,7 +1798,7 @@ bool QProcess::waitForBytesWritten(int msecs)
|
||||
Blocks until the process has finished and the finished() signal
|
||||
has been emitted, or until \a msecs milliseconds have passed.
|
||||
|
||||
Returns true if the process finished; otherwise returns false (if
|
||||
Returns \c true if the process finished; otherwise returns \c false (if
|
||||
the operation timed out, if an error occurred, or if this QProcess
|
||||
is already finished).
|
||||
|
||||
@ -2366,8 +2366,8 @@ int QProcess::execute(const QString &program)
|
||||
|
||||
/*!
|
||||
Starts the program \a program with the arguments \a arguments in a
|
||||
new process, and detaches from it. Returns true on success;
|
||||
otherwise returns false. If the calling process exits, the
|
||||
new process, and detaches from it. Returns \c true on success;
|
||||
otherwise returns \c false. If the calling process exits, the
|
||||
detached process will continue to live.
|
||||
|
||||
Note that arguments that contain spaces are not passed to the
|
||||
@ -2400,8 +2400,8 @@ bool QProcess::startDetached(const QString &program,
|
||||
|
||||
/*!
|
||||
Starts the program \a program with the given \a arguments in a
|
||||
new process, and detaches from it. Returns true on success;
|
||||
otherwise returns false. If the calling process exits, the
|
||||
new process, and detaches from it. Returns \c true on success;
|
||||
otherwise returns \c false. If the calling process exits, the
|
||||
detached process will continue to live.
|
||||
|
||||
\note Arguments that contain spaces are not passed to the
|
||||
|
@ -451,7 +451,7 @@ QString QResource::absoluteFilePath() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the resource really exists in the resource hierarchy,
|
||||
Returns \c true if the resource really exists in the resource hierarchy,
|
||||
false otherwise.
|
||||
|
||||
*/
|
||||
@ -466,7 +466,7 @@ bool QResource::isValid() const
|
||||
/*!
|
||||
\fn bool QResource::isFile() const
|
||||
|
||||
Returns true if the resource represents a file and thus has data
|
||||
Returns \c true if the resource represents a file and thus has data
|
||||
backing it, false if it represents a directory.
|
||||
|
||||
\sa isDir()
|
||||
@ -474,7 +474,7 @@ bool QResource::isValid() const
|
||||
|
||||
|
||||
/*!
|
||||
Returns true if the resource represents a file and the data backing it
|
||||
Returns \c true if the resource represents a file and the data backing it
|
||||
is in a compressed format, false otherwise.
|
||||
|
||||
\sa data(), isFile()
|
||||
@ -517,7 +517,7 @@ const uchar *QResource::data() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the resource represents a directory and thus may have
|
||||
Returns \c true if the resource represents a directory and thus may have
|
||||
children() in it, false if it represents a file.
|
||||
|
||||
\sa isFile()
|
||||
@ -1044,8 +1044,8 @@ static QString qt_resource_fixResourceRoot(QString r) {
|
||||
\fn bool QResource::registerResource(const QString &rccFileName, const QString &mapRoot)
|
||||
|
||||
Registers the resource with the given \a rccFileName at the location in the
|
||||
resource tree specified by \a mapRoot, and returns true if the file is
|
||||
successfully opened; otherwise returns false.
|
||||
resource tree specified by \a mapRoot, and returns \c true if the file is
|
||||
successfully opened; otherwise returns \c false.
|
||||
|
||||
\sa unregisterResource()
|
||||
*/
|
||||
@ -1075,9 +1075,9 @@ QResource::registerResource(const QString &rccFilename, const QString &resourceR
|
||||
\fn bool QResource::unregisterResource(const QString &rccFileName, const QString &mapRoot)
|
||||
|
||||
Unregisters the resource with the given \a rccFileName at the location in
|
||||
the resource tree specified by \a mapRoot, and returns true if the
|
||||
the resource tree specified by \a mapRoot, and returns \c true if the
|
||||
resource is successfully unloaded and no references exist for the
|
||||
resource; otherwise returns false.
|
||||
resource; otherwise returns \c false.
|
||||
|
||||
\sa registerResource()
|
||||
*/
|
||||
@ -1112,8 +1112,8 @@ QResource::unregisterResource(const QString &rccFilename, const QString &resourc
|
||||
\since 4.3
|
||||
|
||||
Registers the resource with the given \a rccData at the location in the
|
||||
resource tree specified by \a mapRoot, and returns true if the file is
|
||||
successfully opened; otherwise returns false.
|
||||
resource tree specified by \a mapRoot, and returns \c true if the file is
|
||||
successfully opened; otherwise returns \c false.
|
||||
|
||||
\warning The data must remain valid throughout the life of any QFile
|
||||
that may reference the resource data.
|
||||
@ -1147,8 +1147,8 @@ QResource::registerResource(const uchar *rccData, const QString &resourceRoot)
|
||||
\since 4.3
|
||||
|
||||
Unregisters the resource with the given \a rccData at the location in the
|
||||
resource tree specified by \a mapRoot, and returns true if the resource is
|
||||
successfully unloaded and no references exist into the resource; otherwise returns false.
|
||||
resource tree specified by \a mapRoot, and returns \c true if the resource is
|
||||
successfully unloaded and no references exist into the resource; otherwise returns \c false.
|
||||
|
||||
\sa registerResource()
|
||||
*/
|
||||
|
@ -253,8 +253,8 @@ void QSaveFile::close()
|
||||
It is mandatory to call this at the end of the saving operation, otherwise the file will be
|
||||
discarded.
|
||||
|
||||
If an error happened during writing, deletes the temporary file and returns false.
|
||||
Otherwise, renames it to the final fileName and returns true on success.
|
||||
If an error happened during writing, deletes the temporary file and returns \c false.
|
||||
Otherwise, renames it to the final fileName and returns \c true on success.
|
||||
Finally, closes the device.
|
||||
|
||||
\sa cancelWriting()
|
||||
@ -372,7 +372,7 @@ void QSaveFile::setDirectWriteFallback(bool enabled)
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the fallback solution for saving files in read-only
|
||||
Returns \c true if the fallback solution for saving files in read-only
|
||||
directories is enabled.
|
||||
|
||||
\sa setDirectWriteFallback()
|
||||
|
@ -1714,7 +1714,7 @@ break_out_of_outer_loop:
|
||||
}
|
||||
|
||||
/*
|
||||
Returns false on parse error. However, as many keys are read as
|
||||
Returns \c false on parse error. However, as many keys are read as
|
||||
possible, so if the user doesn't check the status he will get the
|
||||
most out of the file anyway.
|
||||
*/
|
||||
@ -3181,8 +3181,8 @@ QStringList QSettings::childGroups() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if settings can be written using this QSettings
|
||||
object; returns false otherwise.
|
||||
Returns \c true if settings can be written using this QSettings
|
||||
object; returns \c false otherwise.
|
||||
|
||||
One reason why isWritable() might return false is if
|
||||
QSettings operates on a read-only file.
|
||||
@ -3267,7 +3267,7 @@ void QSettings::remove(const QString &key)
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if there exists a setting called \a key; returns
|
||||
Returns \c true if there exists a setting called \a key; returns
|
||||
false otherwise.
|
||||
|
||||
If a group is set using beginGroup(), \a key is taken to be
|
||||
@ -3301,7 +3301,7 @@ void QSettings::setFallbacksEnabled(bool b)
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if fallbacks are enabled; returns false otherwise.
|
||||
Returns \c true if fallbacks are enabled; returns \c false otherwise.
|
||||
|
||||
By default, fallbacks are enabled.
|
||||
|
||||
|
@ -390,7 +390,7 @@ void QStandardPaths::setTestModeEnabled(bool testMode)
|
||||
|
||||
\internal
|
||||
|
||||
Returns true if test mode is enabled in QStandardPaths; otherwise returns false.
|
||||
Returns \c true if test mode is enabled in QStandardPaths; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
bool QStandardPaths::isTestModeEnabled()
|
||||
|
@ -242,7 +242,7 @@ QTemporaryDir::~QTemporaryDir()
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the QTemporaryDir was created successfully.
|
||||
Returns \c true if the QTemporaryDir was created successfully.
|
||||
*/
|
||||
bool QTemporaryDir::isValid() const
|
||||
{
|
||||
@ -259,7 +259,7 @@ QString QTemporaryDir::path() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the QTemporaryDir is in auto remove
|
||||
Returns \c true if the QTemporaryDir is in auto remove
|
||||
mode. Auto-remove mode will automatically delete the directory from
|
||||
disk upon destruction. This makes it very easy to create your
|
||||
QTemporaryDir object on the stack, fill it with files, do something with
|
||||
@ -290,7 +290,7 @@ void QTemporaryDir::setAutoRemove(bool b)
|
||||
/*!
|
||||
Removes the temporary directory, including all its contents.
|
||||
|
||||
Returns true if removing was successful.
|
||||
Returns \c true if removing was successful.
|
||||
*/
|
||||
bool QTemporaryDir::remove()
|
||||
{
|
||||
|
@ -587,7 +587,7 @@ QTemporaryFile::~QTemporaryFile()
|
||||
*/
|
||||
|
||||
/*!
|
||||
Returns true if the QTemporaryFile is in auto remove
|
||||
Returns \c true if the QTemporaryFile is in auto remove
|
||||
mode. Auto-remove mode will automatically delete the filename from
|
||||
disk upon destruction. This makes it very easy to create your
|
||||
QTemporaryFile object on the stack, fill it with data, read from
|
||||
|
@ -1085,8 +1085,8 @@ void QTextStream::flush()
|
||||
}
|
||||
|
||||
/*!
|
||||
Seeks to the position \a pos in the device. Returns true on
|
||||
success; otherwise returns false.
|
||||
Seeks to the position \a pos in the device. Returns \c true on
|
||||
success; otherwise returns \c false.
|
||||
*/
|
||||
bool QTextStream::seek(qint64 pos)
|
||||
{
|
||||
@ -1185,7 +1185,7 @@ qint64 QTextStream::pos() const
|
||||
character.
|
||||
|
||||
Whitespace characters are all characters for which
|
||||
QChar::isSpace() returns true.
|
||||
QChar::isSpace() returns \c true.
|
||||
|
||||
\sa operator>>()
|
||||
*/
|
||||
@ -1517,8 +1517,8 @@ void QTextStream::setStatus(Status status)
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if there is no more data to be read from the
|
||||
QTextStream; otherwise returns false. This is similar to, but not
|
||||
Returns \c true if there is no more data to be read from the
|
||||
QTextStream; otherwise returns \c false. This is similar to, but not
|
||||
the same as calling QIODevice::atEnd(), as QTextStream also takes
|
||||
into account its internal Unicode buffer.
|
||||
*/
|
||||
@ -2091,7 +2091,7 @@ QTextStream &QTextStream::operator>>(double &f)
|
||||
/*!
|
||||
Reads a word from the stream and stores it in \a str, then returns
|
||||
a reference to the stream. Words are separated by whitespace
|
||||
(i.e., all characters for which QChar::isSpace() returns true).
|
||||
(i.e., all characters for which QChar::isSpace() returns \c true).
|
||||
|
||||
Leading whitespace is skipped.
|
||||
*/
|
||||
@ -2943,8 +2943,8 @@ void QTextStream::setAutoDetectUnicode(bool enabled)
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if automatic Unicode detection is enabled, otherwise
|
||||
returns false. Automatic Unicode detection is enabled by default.
|
||||
Returns \c true if automatic Unicode detection is enabled, otherwise
|
||||
returns \c false. Automatic Unicode detection is enabled by default.
|
||||
|
||||
\sa setAutoDetectUnicode(), setCodec()
|
||||
*/
|
||||
@ -2974,8 +2974,8 @@ void QTextStream::setGenerateByteOrderMark(bool generate)
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if QTextStream is set to generate the UTF BOM (Byte Order
|
||||
Mark) when using a UTF codec; otherwise returns false. UTF BOM generation is
|
||||
Returns \c true if QTextStream is set to generate the UTF BOM (Byte Order
|
||||
Mark) when using a UTF codec; otherwise returns \c false. UTF BOM generation is
|
||||
set to false by default.
|
||||
|
||||
\sa setGenerateByteOrderMark()
|
||||
|
@ -77,7 +77,7 @@
|
||||
password at once.
|
||||
|
||||
Call isValid() to check if the URL is valid. This can be done at any point
|
||||
during the constructing of a URL. If isValid() returns false, you should
|
||||
during the constructing of a URL. If isValid() returns \c false, you should
|
||||
clear() the URL before proceeding, or start over by parsing a new URL with
|
||||
setUrl().
|
||||
|
||||
@ -1749,7 +1749,7 @@ QUrl::~QUrl()
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the URL is non-empty and valid; otherwise returns false.
|
||||
Returns \c true if the URL is non-empty and valid; otherwise returns \c false.
|
||||
|
||||
The URL is run through a conformance test. Every part of the URL
|
||||
must conform to the standard encoding rules of the URI standard
|
||||
@ -1767,7 +1767,7 @@ bool QUrl::isValid() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the URL has no data; otherwise returns false.
|
||||
Returns \c true if the URL has no data; otherwise returns \c false.
|
||||
|
||||
\sa clear()
|
||||
*/
|
||||
@ -2507,7 +2507,7 @@ QString QUrl::fileName(ComponentFormattingOptions options) const
|
||||
/*!
|
||||
\since 4.2
|
||||
|
||||
Returns true if this URL contains a Query (i.e., if ? was seen on it).
|
||||
Returns \c true if this URL contains a Query (i.e., if ? was seen on it).
|
||||
|
||||
\sa setQuery(), query(), hasFragment()
|
||||
*/
|
||||
@ -2714,7 +2714,7 @@ void QUrl::setQuery(const QUrlQuery &query)
|
||||
\fn bool QUrl::hasQueryItem(const QString &key) const
|
||||
\deprecated
|
||||
|
||||
Returns true if there is a query string pair whose key is equal
|
||||
Returns \c true if there is a query string pair whose key is equal
|
||||
to \a key from the URL.
|
||||
|
||||
\obsolete Use QUrlQuery.
|
||||
@ -2727,7 +2727,7 @@ void QUrl::setQuery(const QUrlQuery &query)
|
||||
\deprecated
|
||||
\since 4.4
|
||||
|
||||
Returns true if there is a query string pair whose key is equal
|
||||
Returns \c true if there is a query string pair whose key is equal
|
||||
to \a key from the URL.
|
||||
|
||||
\obsolete Use QUrlQuery.
|
||||
@ -2998,7 +2998,7 @@ QString QUrl::fragment(ComponentFormattingOptions options) const
|
||||
/*!
|
||||
\since 4.2
|
||||
|
||||
Returns true if this URL contains a fragment (i.e., if # was seen on it).
|
||||
Returns \c true if this URL contains a fragment (i.e., if # was seen on it).
|
||||
|
||||
\sa fragment(), setFragment()
|
||||
*/
|
||||
@ -3114,7 +3114,7 @@ QUrl QUrl::resolved(const QUrl &relative) const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the URL is relative; otherwise returns false. A URL is
|
||||
Returns \c true if the URL is relative; otherwise returns \c false. A URL is
|
||||
relative reference if its scheme is undefined; this function is therefore
|
||||
equivalent to calling scheme().isEmpty().
|
||||
|
||||
@ -3441,7 +3441,7 @@ QByteArray QUrl::toAce(const QString &domain)
|
||||
/*!
|
||||
\internal
|
||||
|
||||
Returns true if this URL is "less than" the given \a url. This
|
||||
Returns \c true if this URL is "less than" the given \a url. This
|
||||
provides a means of ordering URLs.
|
||||
*/
|
||||
bool QUrl::operator <(const QUrl &url) const
|
||||
@ -3493,8 +3493,8 @@ bool QUrl::operator <(const QUrl &url) const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if this URL and the given \a url are equal;
|
||||
otherwise returns false.
|
||||
Returns \c true if this URL and the given \a url are equal;
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
bool QUrl::operator ==(const QUrl &url) const
|
||||
{
|
||||
@ -3522,8 +3522,8 @@ bool QUrl::operator ==(const QUrl &url) const
|
||||
/*!
|
||||
\since 5.2
|
||||
|
||||
Returns true if this URL and the given \a url are equal after
|
||||
applying \a options to both; otherwise returns false.
|
||||
Returns \c true if this URL and the given \a url are equal after
|
||||
applying \a options to both; otherwise returns \c false.
|
||||
|
||||
This is equivalent to calling adjusted(options) on both URLs
|
||||
and comparing the resulting urls, but faster.
|
||||
@ -3589,8 +3589,8 @@ bool QUrl::matches(const QUrl &url, FormattingOptions options) const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if this URL and the given \a url are not equal;
|
||||
otherwise returns false.
|
||||
Returns \c true if this URL and the given \a url are not equal;
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
bool QUrl::operator !=(const QUrl &url) const
|
||||
{
|
||||
@ -3735,7 +3735,7 @@ QString QUrl::toLocalFile() const
|
||||
|
||||
/*!
|
||||
\since 4.8
|
||||
Returns true if this URL is pointing to a local file path. A URL is a
|
||||
Returns \c true if this URL is pointing to a local file path. A URL is a
|
||||
local file path if the scheme is "file".
|
||||
|
||||
Note that this function considers URLs with hostnames to be local file
|
||||
@ -3754,7 +3754,7 @@ bool QUrl::isLocalFile() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if this URL is a parent of \a childUrl. \a childUrl is a child
|
||||
Returns \c true if this URL is a parent of \a childUrl. \a childUrl is a child
|
||||
of this URL if the two URLs share the same scheme and authority,
|
||||
and this URL's path is a parent of the path of \a childUrl.
|
||||
*/
|
||||
@ -3905,7 +3905,7 @@ static inline void appendComponentIfPresent(QString &msg, bool present, const ch
|
||||
|
||||
Returns an error message if the last operation that modified this QUrl
|
||||
object ran into a parsing error. If no error was detected, this function
|
||||
returns an empty string and isValid() returns true.
|
||||
returns an empty string and isValid() returns \c true.
|
||||
|
||||
The error message returned by this function is technical in nature and may
|
||||
not be understood by end users. It is mostly useful to developers trying to
|
||||
|
@ -407,7 +407,7 @@ QUrlQuery::~QUrlQuery()
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if this object and the \a other object contain the same
|
||||
Returns \c true if this object and the \a other object contain the same
|
||||
contents, in the same order, and use the same query delimiters.
|
||||
*/
|
||||
bool QUrlQuery::operator ==(const QUrlQuery &other) const
|
||||
@ -422,7 +422,7 @@ bool QUrlQuery::operator ==(const QUrlQuery &other) const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if this QUrlQUery object contains no key-value pairs, such as
|
||||
Returns \c true if this QUrlQUery object contains no key-value pairs, such as
|
||||
after being default-constructed or after parsing an empty query string.
|
||||
|
||||
\sa setQuery(), clear()
|
||||
@ -636,7 +636,7 @@ QList<QPair<QString, QString> > QUrlQuery::queryItems(QUrl::ComponentFormattingO
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if there is a query string pair whose key is equal
|
||||
Returns \c true if there is a query string pair whose key is equal
|
||||
to \a key from the URL.
|
||||
|
||||
\sa addQueryItem(), queryItemValue()
|
||||
@ -781,7 +781,7 @@ void QUrlQuery::removeAllQueryItems(const QString &key)
|
||||
/*!
|
||||
\fn bool QUrlQuery::operator!=(const QUrlQuery &other) const
|
||||
|
||||
Returns true if \a other is not equal to this QUrlQuery. Otherwise, returns false.
|
||||
Returns \c true if \a other is not equal to this QUrlQuery. Otherwise, returns \c false.
|
||||
|
||||
\sa operator==()
|
||||
*/
|
||||
|
@ -247,7 +247,7 @@ void QWindowsPipeReader::startAsyncRead()
|
||||
/*!
|
||||
\internal
|
||||
Sets the correct size of the read buffer after a read operation.
|
||||
Returns false, if an error occurred or the connection dropped.
|
||||
Returns \c false, if an error occurred or the connection dropped.
|
||||
*/
|
||||
bool QWindowsPipeReader::completeAsyncRead(DWORD bytesRead, DWORD errorCode)
|
||||
{
|
||||
@ -297,7 +297,7 @@ DWORD QWindowsPipeReader::checkPipeState()
|
||||
|
||||
/*!
|
||||
Waits for the completion of the asynchronous read operation.
|
||||
Returns true, if we've emitted the readyRead signal.
|
||||
Returns \c true, if we've emitted the readyRead signal.
|
||||
*/
|
||||
bool QWindowsPipeReader::waitForReadyRead(int msecs)
|
||||
{
|
||||
|
@ -2149,7 +2149,7 @@ void QAbstractItemModel::fetchMore(const QModelIndex &)
|
||||
|
||||
The default implementation always returns \c{false}.
|
||||
|
||||
If canFetchMore() returns true, the fetchMore() function should
|
||||
If canFetchMore() returns \c true, the fetchMore() function should
|
||||
be called. This is the behavior of QAbstractItemView, for example.
|
||||
|
||||
\sa fetchMore()
|
||||
|
@ -190,8 +190,8 @@ QT_BEGIN_NAMESPACE
|
||||
/*!
|
||||
\fn bool QItemSelectionRange::contains(const QModelIndex &index) const
|
||||
|
||||
Returns true if the model item specified by the \a index lies within the
|
||||
range of selected items; otherwise returns false.
|
||||
Returns \c true if the model item specified by the \a index lies within the
|
||||
range of selected items; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
@ -199,16 +199,16 @@ QT_BEGIN_NAMESPACE
|
||||
const QModelIndex &parentIndex) const
|
||||
\overload
|
||||
|
||||
Returns true if the model item specified by (\a row, \a column)
|
||||
Returns \c true if the model item specified by (\a row, \a column)
|
||||
and with \a parentIndex as the parent item lies within the range
|
||||
of selected items; otherwise returns false.
|
||||
of selected items; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bool QItemSelectionRange::intersects(const QItemSelectionRange &other) const
|
||||
|
||||
Returns true if this selection range intersects (overlaps with) the \a other
|
||||
range given; otherwise returns false.
|
||||
Returns \c true if this selection range intersects (overlaps with) the \a other
|
||||
range given; otherwise returns \c false.
|
||||
|
||||
*/
|
||||
bool QItemSelectionRange::intersects(const QItemSelectionRange &other) const
|
||||
@ -254,24 +254,24 @@ QItemSelectionRange QItemSelectionRange::intersected(const QItemSelectionRange &
|
||||
/*!
|
||||
\fn bool QItemSelectionRange::operator==(const QItemSelectionRange &other) const
|
||||
|
||||
Returns true if the selection range is exactly the same as the \a other
|
||||
range given; otherwise returns false.
|
||||
Returns \c true if the selection range is exactly the same as the \a other
|
||||
range given; otherwise returns \c false.
|
||||
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bool QItemSelectionRange::operator!=(const QItemSelectionRange &other) const
|
||||
|
||||
Returns true if the selection range differs from the \a other range given;
|
||||
otherwise returns false.
|
||||
Returns \c true if the selection range differs from the \a other range given;
|
||||
otherwise returns \c false.
|
||||
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bool QItemSelectionRange::operator<(const QItemSelectionRange &other) const
|
||||
|
||||
Returns true if the selection range is less than the \a other
|
||||
range given; otherwise returns false.
|
||||
Returns \c true if the selection range is less than the \a other
|
||||
range given; otherwise returns \c false.
|
||||
|
||||
The less than calculation is not directly useful to developers - the way that ranges
|
||||
with different parents compare is not defined. This operator only exists so that the
|
||||
@ -282,7 +282,7 @@ QItemSelectionRange QItemSelectionRange::intersected(const QItemSelectionRange &
|
||||
/*!
|
||||
\fn bool QItemSelectionRange::isValid() const
|
||||
|
||||
Returns true if the selection range is valid; otherwise returns false.
|
||||
Returns \c true if the selection range is valid; otherwise returns \c false.
|
||||
|
||||
*/
|
||||
|
||||
@ -322,7 +322,7 @@ static void indexesFromRange(const QItemSelectionRange &range, ModelIndexContain
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the selection range contains no selectable item
|
||||
Returns \c true if the selection range contains no selectable item
|
||||
\since 4.7
|
||||
*/
|
||||
|
||||
@ -442,8 +442,8 @@ void QItemSelection::select(const QModelIndex &topLeft, const QModelIndex &botto
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the selection contains the given \a index; otherwise
|
||||
returns false.
|
||||
Returns \c true if the selection contains the given \a index; otherwise
|
||||
returns \c false.
|
||||
*/
|
||||
|
||||
bool QItemSelection::contains(const QModelIndex &index) const
|
||||
@ -1331,7 +1331,7 @@ QModelIndex QItemSelectionModel::currentIndex() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the given model item \a index is selected.
|
||||
Returns \c true if the given model item \a index is selected.
|
||||
*/
|
||||
bool QItemSelectionModel::isSelected(const QModelIndex &index) const
|
||||
{
|
||||
@ -1368,7 +1368,7 @@ bool QItemSelectionModel::isSelected(const QModelIndex &index) const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if all items are selected in the \a row with the given
|
||||
Returns \c true if all items are selected in the \a row with the given
|
||||
\a parent.
|
||||
|
||||
Note that this function is usually faster than calling isSelected()
|
||||
@ -1428,7 +1428,7 @@ bool QItemSelectionModel::isRowSelected(int row, const QModelIndex &parent) cons
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if all items are selected in the \a column with the given
|
||||
Returns \c true if all items are selected in the \a column with the given
|
||||
\a parent.
|
||||
|
||||
Note that this function is usually faster than calling isSelected()
|
||||
@ -1488,7 +1488,7 @@ bool QItemSelectionModel::isColumnSelected(int column, const QModelIndex &parent
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if there are any items selected in the \a row with the given
|
||||
Returns \c true if there are any items selected in the \a row with the given
|
||||
\a parent.
|
||||
*/
|
||||
bool QItemSelectionModel::rowIntersectsSelection(int row, const QModelIndex &parent) const
|
||||
@ -1520,7 +1520,7 @@ bool QItemSelectionModel::rowIntersectsSelection(int row, const QModelIndex &par
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if there are any items selected in the \a column with the given
|
||||
Returns \c true if there are any items selected in the \a column with the given
|
||||
\a parent.
|
||||
*/
|
||||
bool QItemSelectionModel::columnIntersectsSelection(int column, const QModelIndex &parent) const
|
||||
@ -1551,8 +1551,8 @@ bool QItemSelectionModel::columnIntersectsSelection(int column, const QModelInde
|
||||
/*!
|
||||
\since 4.2
|
||||
|
||||
Returns true if the selection model contains any selection ranges;
|
||||
otherwise returns false.
|
||||
Returns \c true if the selection model contains any selection ranges;
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
bool QItemSelectionModel::hasSelection() const
|
||||
{
|
||||
|
@ -2587,9 +2587,9 @@ void QSortFilterProxyModel::invalidateFilter()
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the value of the item referred to by the given
|
||||
Returns \c true if the value of the item referred to by the given
|
||||
index \a left is less than the value of the item referred to by
|
||||
the given index \a right, otherwise returns false.
|
||||
the given index \a right, otherwise returns \c false.
|
||||
|
||||
This function is used as the < operator when sorting, and handles
|
||||
the following QVariant types:
|
||||
@ -2661,11 +2661,11 @@ bool QSortFilterProxyModel::lessThan(const QModelIndex &left, const QModelIndex
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the item in the row indicated by the given \a source_row
|
||||
Returns \c true if the item in the row indicated by the given \a source_row
|
||||
and \a source_parent should be included in the model; otherwise returns
|
||||
false.
|
||||
|
||||
The default implementation returns true if the value held by the relevant item
|
||||
The default implementation returns \c true if the value held by the relevant item
|
||||
matches the filter string, wildcard string or regular expression.
|
||||
|
||||
\note By default, the Qt::DisplayRole is used to determine if the row
|
||||
@ -2697,10 +2697,10 @@ bool QSortFilterProxyModel::filterAcceptsRow(int source_row, const QModelIndex &
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the item in the column indicated by the given \a source_column
|
||||
and \a source_parent should be included in the model; otherwise returns false.
|
||||
Returns \c true if the item in the column indicated by the given \a source_column
|
||||
and \a source_parent should be included in the model; otherwise returns \c false.
|
||||
|
||||
The default implementation returns true if the value held by the relevant item
|
||||
The default implementation returns \c true if the value held by the relevant item
|
||||
matches the filter string, wildcard string or regular expression.
|
||||
|
||||
\note By default, the Qt::DisplayRole is used to determine if the row
|
||||
|
@ -372,7 +372,7 @@ QJsonDocument QJsonDocument::fromJson(const QByteArray &json, QJsonParseError *e
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the document doesn't contain any data.
|
||||
Returns \c true if the document doesn't contain any data.
|
||||
*/
|
||||
bool QJsonDocument::isEmpty() const
|
||||
{
|
||||
@ -403,7 +403,7 @@ QByteArray QJsonDocument::toBinaryData() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the document contains an array.
|
||||
Returns \c true if the document contains an array.
|
||||
|
||||
\sa array(), isObject()
|
||||
*/
|
||||
@ -417,7 +417,7 @@ bool QJsonDocument::isArray() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the document contains an object.
|
||||
Returns \c true if the document contains an object.
|
||||
|
||||
\sa object(), isArray()
|
||||
*/
|
||||
@ -549,7 +549,7 @@ bool QJsonDocument::operator==(const QJsonDocument &other) const
|
||||
*/
|
||||
|
||||
/*!
|
||||
returns true if this document is null.
|
||||
returns \c true if this document is null.
|
||||
|
||||
Null documents are documents created through the default constructor.
|
||||
|
||||
|
@ -271,13 +271,13 @@ QJsonValue &QJsonValue::operator =(const QJsonValue &other)
|
||||
/*!
|
||||
\fn bool QJsonValue::isNull() const
|
||||
|
||||
Returns true if the value is null.
|
||||
Returns \c true if the value is null.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bool QJsonValue::isBool() const
|
||||
|
||||
Returns true if the value contains a boolean.
|
||||
Returns \c true if the value contains a boolean.
|
||||
|
||||
\sa toBool()
|
||||
*/
|
||||
@ -285,7 +285,7 @@ QJsonValue &QJsonValue::operator =(const QJsonValue &other)
|
||||
/*!
|
||||
\fn bool QJsonValue::isDouble() const
|
||||
|
||||
Returns true if the value contains a double.
|
||||
Returns \c true if the value contains a double.
|
||||
|
||||
\sa toDouble()
|
||||
*/
|
||||
@ -293,7 +293,7 @@ QJsonValue &QJsonValue::operator =(const QJsonValue &other)
|
||||
/*!
|
||||
\fn bool QJsonValue::isString() const
|
||||
|
||||
Returns true if the value contains a string.
|
||||
Returns \c true if the value contains a string.
|
||||
|
||||
\sa toString()
|
||||
*/
|
||||
@ -301,7 +301,7 @@ QJsonValue &QJsonValue::operator =(const QJsonValue &other)
|
||||
/*!
|
||||
\fn bool QJsonValue::isArray() const
|
||||
|
||||
Returns true if the value contains an array.
|
||||
Returns \c true if the value contains an array.
|
||||
|
||||
\sa toArray()
|
||||
*/
|
||||
@ -309,7 +309,7 @@ QJsonValue &QJsonValue::operator =(const QJsonValue &other)
|
||||
/*!
|
||||
\fn bool QJsonValue::isObject() const
|
||||
|
||||
Returns true if the value contains an object.
|
||||
Returns \c true if the value contains an object.
|
||||
|
||||
\sa toObject()
|
||||
*/
|
||||
@ -317,7 +317,7 @@ QJsonValue &QJsonValue::operator =(const QJsonValue &other)
|
||||
/*!
|
||||
\fn bool QJsonValue::isUndefined() const
|
||||
|
||||
Returns true if the value is undefined. This can happen in certain
|
||||
Returns \c true if the value is undefined. This can happen in certain
|
||||
error cases as e.g. accessing a non existing key in a QJsonObject.
|
||||
*/
|
||||
|
||||
@ -540,7 +540,7 @@ QJsonObject QJsonValue::toObject() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the value is equal to \a other.
|
||||
Returns \c true if the value is equal to \a other.
|
||||
*/
|
||||
bool QJsonValue::operator==(const QJsonValue &other) const
|
||||
{
|
||||
@ -576,7 +576,7 @@ bool QJsonValue::operator==(const QJsonValue &other) const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the value is not equal to \a other.
|
||||
Returns \c true if the value is not equal to \a other.
|
||||
*/
|
||||
bool QJsonValue::operator!=(const QJsonValue &other) const
|
||||
{
|
||||
|
@ -179,8 +179,8 @@ QAbstractEventDispatcher *QAbstractEventDispatcher::instance(QThread *thread)
|
||||
\fn bool QAbstractEventDispatcher::processEvents(QEventLoop::ProcessEventsFlags flags)
|
||||
|
||||
Processes pending events that match \a flags until there are no
|
||||
more events to process. Returns true if an event was processed;
|
||||
otherwise returns false.
|
||||
more events to process. Returns \c true if an event was processed;
|
||||
otherwise returns \c false.
|
||||
|
||||
This function is especially useful if you have a long running
|
||||
operation and want to show its progress without allowing user
|
||||
@ -211,7 +211,7 @@ QAbstractEventDispatcher *QAbstractEventDispatcher::instance(QThread *thread)
|
||||
|
||||
/*! \fn bool QAbstractEventDispatcher::hasPendingEvents()
|
||||
|
||||
Returns true if there is an event waiting; otherwise returns
|
||||
Returns \c true if there is an event waiting; otherwise returns
|
||||
false.
|
||||
*/
|
||||
|
||||
@ -271,7 +271,7 @@ int QAbstractEventDispatcher::registerTimer(int interval, Qt::TimerType timerTyp
|
||||
\fn bool QAbstractEventDispatcher::unregisterTimer(int timerId)
|
||||
|
||||
Unregisters the timer with the given \a timerId.
|
||||
Returns true if successful; otherwise returns false.
|
||||
Returns \c true if successful; otherwise returns \c false.
|
||||
|
||||
\sa registerTimer(), unregisterTimers()
|
||||
*/
|
||||
@ -280,7 +280,7 @@ int QAbstractEventDispatcher::registerTimer(int interval, Qt::TimerType timerTyp
|
||||
\fn bool QAbstractEventDispatcher::unregisterTimers(QObject *object)
|
||||
|
||||
Unregisters all the timers associated with the given \a object.
|
||||
Returns true if all timers were successful removed; otherwise returns false.
|
||||
Returns \c true if all timers were successful removed; otherwise returns \c false.
|
||||
|
||||
\sa unregisterTimer(), registeredTimers()
|
||||
*/
|
||||
@ -435,8 +435,8 @@ void QAbstractEventDispatcher::removeNativeEventFilter(QAbstractNativeEventFilte
|
||||
|
||||
/*!
|
||||
Sends \a message through the event filters that were set by
|
||||
installNativeEventFilter(). This function returns true as soon as an
|
||||
event filter returns true, and false otherwise to indicate that
|
||||
installNativeEventFilter(). This function returns \c true as soon as an
|
||||
event filter returns \c true, and false otherwise to indicate that
|
||||
the processing of the event should continue.
|
||||
|
||||
Subclasses of QAbstractEventDispatcher \e must call this function
|
||||
@ -474,8 +474,8 @@ bool QAbstractEventDispatcher::filterNativeEvent(const QByteArray &eventType, vo
|
||||
\deprecated
|
||||
|
||||
Calls filterNativeEvent() with an empty eventType and \a message.
|
||||
This function returns true as soon as an
|
||||
event filter returns true, and false otherwise to indicate that
|
||||
This function returns \c true as soon as an
|
||||
event filter returns \c true, and false otherwise to indicate that
|
||||
the processing of the event should continue.
|
||||
*/
|
||||
|
||||
|
@ -62,7 +62,7 @@ QT_BEGIN_NAMESPACE
|
||||
function with a timeout interval and with a pointer to a QObject
|
||||
subclass. When the timer times out it will send a timer event to
|
||||
the QObject subclass. The timer can be stopped at any time using
|
||||
stop(). isActive() returns true for a timer that is running;
|
||||
stop(). isActive() returns \c true for a timer that is running;
|
||||
i.e. it has been started, has not reached the timeout time, and
|
||||
has not been stopped. The timer's ID can be retrieved using
|
||||
timerId().
|
||||
@ -90,8 +90,8 @@ QT_BEGIN_NAMESPACE
|
||||
/*!
|
||||
\fn bool QBasicTimer::isActive() const
|
||||
|
||||
Returns true if the timer is running and has not been stopped; otherwise
|
||||
returns false.
|
||||
Returns \c true if the timer is running and has not been stopped; otherwise
|
||||
returns \c false.
|
||||
|
||||
\sa start(), stop()
|
||||
*/
|
||||
|
@ -810,8 +810,8 @@ void QCoreApplication::setAttribute(Qt::ApplicationAttribute attribute, bool on)
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if attribute \a attribute is set;
|
||||
otherwise returns false.
|
||||
Returns \c true if attribute \a attribute is set;
|
||||
otherwise returns \c false.
|
||||
|
||||
\sa setAttribute()
|
||||
*/
|
||||
@ -826,15 +826,15 @@ bool QCoreApplication::testAttribute(Qt::ApplicationAttribute attribute)
|
||||
/*!
|
||||
\property QCoreApplication::quitLockEnabled
|
||||
|
||||
Returns true if the use of the QEventLoopLocker feature can cause the
|
||||
application to quit, otherwise returns false.
|
||||
Returns \c true if the use of the QEventLoopLocker feature can cause the
|
||||
application to quit, otherwise returns \c false.
|
||||
|
||||
\sa QEventLoopLocker
|
||||
*/
|
||||
|
||||
/*!
|
||||
Returns true if the use of the QEventLoopLocker feature can cause the
|
||||
application to quit, otherwise returns false.
|
||||
Returns \c true if the use of the QEventLoopLocker feature can cause the
|
||||
application to quit, otherwise returns \c false.
|
||||
|
||||
\sa QEventLoopLocker
|
||||
*/
|
||||
@ -892,7 +892,7 @@ bool QCoreApplication::notifyInternal(QObject *receiver, QEvent *event)
|
||||
For certain types of events (e.g. mouse and key events),
|
||||
the event will be propagated to the receiver's parent and so on up to
|
||||
the top-level object if the receiver is not interested in the event
|
||||
(i.e., it returns false).
|
||||
(i.e., it returns \c false).
|
||||
|
||||
There are five different ways that events can be processed;
|
||||
reimplementing this virtual function is just one of them. All five
|
||||
@ -1000,8 +1000,8 @@ bool QCoreApplicationPrivate::notify_helper(QObject *receiver, QEvent * event)
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if an application object has not been created yet;
|
||||
otherwise returns false.
|
||||
Returns \c true if an application object has not been created yet;
|
||||
otherwise returns \c false.
|
||||
|
||||
\sa closingDown()
|
||||
*/
|
||||
@ -1012,8 +1012,8 @@ bool QCoreApplication::startingUp()
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the application objects are being destroyed;
|
||||
otherwise returns false.
|
||||
Returns \c true if the application objects are being destroyed;
|
||||
otherwise returns \c false.
|
||||
|
||||
\sa startingUp()
|
||||
*/
|
||||
@ -1283,7 +1283,7 @@ void QCoreApplication::postEvent(QObject *receiver, QEvent *event, int priority)
|
||||
|
||||
/*!
|
||||
\internal
|
||||
Returns true if \a event was compressed away (possibly deleted) and should not be added to the list.
|
||||
Returns \c true if \a event was compressed away (possibly deleted) and should not be added to the list.
|
||||
*/
|
||||
bool QCoreApplication::compressEvent(QEvent *event, QObject *receiver, QPostEventList *postedEvents)
|
||||
{
|
||||
@ -1711,7 +1711,7 @@ void QCoreApplication::quit()
|
||||
generated by Qt Designer provide a \c retranslateUi() function that can be
|
||||
called.
|
||||
|
||||
The function returns true on success and false on failure.
|
||||
The function returns \c true on success and false on failure.
|
||||
|
||||
\sa removeTranslator(), translate(), QTranslator::load(), {Dynamic Translation}
|
||||
*/
|
||||
@ -1744,7 +1744,7 @@ bool QCoreApplication::installTranslator(QTranslator *translationFile)
|
||||
translation files used by this application. (It does not delete the
|
||||
translation file from the file system.)
|
||||
|
||||
The function returns true on success and false on failure.
|
||||
The function returns \c true on success and false on failure.
|
||||
|
||||
\sa installTranslator(), translate(), QObject::tr()
|
||||
*/
|
||||
@ -2478,8 +2478,8 @@ void QCoreApplication::removeNativeEventFilter(QAbstractNativeEventFilter *filte
|
||||
}
|
||||
|
||||
/*!
|
||||
This function returns true if there are pending events; otherwise
|
||||
returns false. Pending events can be either from the window
|
||||
This function returns \c true if there are pending events; otherwise
|
||||
returns \c false. Pending events can be either from the window
|
||||
system or posted events using postEvent().
|
||||
|
||||
\sa QAbstractEventDispatcher::hasPendingEvents()
|
||||
|
@ -61,9 +61,9 @@ QT_BEGIN_NAMESPACE
|
||||
QEvents, and sends the translated events to \l{QObject}s.
|
||||
|
||||
In general, events come from the underlying window system
|
||||
(spontaneous() returns true), but it is also possible to manually
|
||||
(spontaneous() returns \c true), but it is also possible to manually
|
||||
send events using QCoreApplication::sendEvent() and
|
||||
QCoreApplication::postEvent() (spontaneous() returns false).
|
||||
QCoreApplication::postEvent() (spontaneous() returns \c false).
|
||||
|
||||
QObjects receive events by having their QObject::event() function
|
||||
called. The function can be reimplemented in subclasses to
|
||||
@ -382,8 +382,8 @@ QEvent::~QEvent()
|
||||
/*!
|
||||
\fn bool QEvent::spontaneous() const
|
||||
|
||||
Returns true if the event originated outside the application (a
|
||||
system event); otherwise returns false.
|
||||
Returns \c true if the event originated outside the application (a
|
||||
system event); otherwise returns \c false.
|
||||
|
||||
The return value of this function is not defined for paint events.
|
||||
*/
|
||||
@ -487,7 +487,7 @@ QTimerEvent::~QTimerEvent()
|
||||
added or removed.
|
||||
|
||||
In both cases you can only rely on the child being a QObject (or,
|
||||
if QObject::isWidgetType() returns true, a QWidget). This is
|
||||
if QObject::isWidgetType() returns \c true, a QWidget). This is
|
||||
because in the QEvent::ChildAdded case the child is not yet fully
|
||||
constructed; in the QEvent::ChildRemoved case it might have
|
||||
already been destructed.
|
||||
@ -524,21 +524,21 @@ QChildEvent::~QChildEvent()
|
||||
/*!
|
||||
\fn bool QChildEvent::added() const
|
||||
|
||||
Returns true if type() is QEvent::ChildAdded; otherwise returns
|
||||
Returns \c true if type() is QEvent::ChildAdded; otherwise returns
|
||||
false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bool QChildEvent::removed() const
|
||||
|
||||
Returns true if type() is QEvent::ChildRemoved; otherwise returns
|
||||
Returns \c true if type() is QEvent::ChildRemoved; otherwise returns
|
||||
false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bool QChildEvent::polished() const
|
||||
|
||||
Returns true if type() is QEvent::ChildPolished; otherwise returns
|
||||
Returns \c true if type() is QEvent::ChildPolished; otherwise returns
|
||||
false.
|
||||
*/
|
||||
|
||||
|
@ -117,8 +117,8 @@ QEventLoop::~QEventLoop()
|
||||
|
||||
/*!
|
||||
Processes pending events that match \a flags until there are no
|
||||
more events to process. Returns true if pending events were handled;
|
||||
otherwise returns false.
|
||||
more events to process. Returns \c true if pending events were handled;
|
||||
otherwise returns \c false.
|
||||
|
||||
This function is especially useful if you have a long running
|
||||
operation and want to show its progress without allowing user
|
||||
@ -272,7 +272,7 @@ void QEventLoop::exit(int returnCode)
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the event loop is running; otherwise returns
|
||||
Returns \c true if the event loop is running; otherwise returns
|
||||
false. The event loop is considered running from the time when
|
||||
exec() is called until exit() is called.
|
||||
|
||||
|
@ -548,9 +548,9 @@ int QMetaObject::classInfoCount() const
|
||||
return n;
|
||||
}
|
||||
|
||||
// Returns true if the method defined by the given meta-object&handle
|
||||
// Returns \c true if the method defined by the given meta-object&handle
|
||||
// matches the given name, argument count and argument types, otherwise
|
||||
// returns false.
|
||||
// returns \c false.
|
||||
static bool methodMatch(const QMetaObject *m, int handle,
|
||||
const QByteArray &name, int argc,
|
||||
const QArgumentType *types)
|
||||
@ -886,8 +886,8 @@ QMetaMethod QMetaObjectPrivate::signal(const QMetaObject *m, int signal_index)
|
||||
/*!
|
||||
\internal
|
||||
|
||||
Returns true if the \a signalTypes and \a methodTypes are
|
||||
compatible; otherwise returns false.
|
||||
Returns \c true if the \a signalTypes and \a methodTypes are
|
||||
compatible; otherwise returns \c false.
|
||||
*/
|
||||
bool QMetaObjectPrivate::checkConnectArgs(int signalArgc, const QArgumentType *signalTypes,
|
||||
int methodArgc, const QArgumentType *methodTypes)
|
||||
@ -904,8 +904,8 @@ bool QMetaObjectPrivate::checkConnectArgs(int signalArgc, const QArgumentType *s
|
||||
/*!
|
||||
\internal
|
||||
|
||||
Returns true if the \a signal and \a method arguments are
|
||||
compatible; otherwise returns false.
|
||||
Returns \c true if the \a signal and \a method arguments are
|
||||
compatible; otherwise returns \c false.
|
||||
*/
|
||||
bool QMetaObjectPrivate::checkConnectArgs(const QMetaMethodPrivate *signal,
|
||||
const QMetaMethodPrivate *method)
|
||||
@ -1191,8 +1191,8 @@ QMetaClassInfo QMetaObject::classInfo(int index) const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the \a signal and \a method arguments are
|
||||
compatible; otherwise returns false.
|
||||
Returns \c true if the \a signal and \a method arguments are
|
||||
compatible; otherwise returns \c false.
|
||||
|
||||
Both \a signal and \a method are expected to be normalized.
|
||||
|
||||
@ -1217,8 +1217,8 @@ bool QMetaObject::checkConnectArgs(const char *signal, const char *method)
|
||||
\since 5.0
|
||||
\overload
|
||||
|
||||
Returns true if the \a signal and \a method arguments are
|
||||
compatible; otherwise returns false.
|
||||
Returns \c true if the \a signal and \a method arguments are
|
||||
compatible; otherwise returns \c false.
|
||||
*/
|
||||
bool QMetaObject::checkConnectArgs(const QMetaMethod &signal,
|
||||
const QMetaMethod &method)
|
||||
@ -1340,7 +1340,7 @@ enum { MaximumParamCount = 11 }; // up to 10 arguments + 1 return value
|
||||
|
||||
/*!
|
||||
Invokes the \a member (a signal or a slot name) on the object \a
|
||||
obj. Returns true if the member could be invoked. Returns false
|
||||
obj. Returns \c true if the member could be invoked. Returns \c false
|
||||
if there is no such member or the parameters did not match.
|
||||
|
||||
The invocation can be either synchronous or asynchronous,
|
||||
@ -1549,8 +1549,8 @@ bool QMetaObject::invokeMethod(QObject *obj,
|
||||
\fn bool QMetaMethod::isValid() const
|
||||
\since 5.0
|
||||
|
||||
Returns true if this method is valid (can be introspected and
|
||||
invoked), otherwise returns false.
|
||||
Returns \c true if this method is valid (can be introspected and
|
||||
invoked), otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*! \fn bool operator==(const QMetaMethod &m1, const QMetaMethod &m2)
|
||||
@ -1558,8 +1558,8 @@ bool QMetaObject::invokeMethod(QObject *obj,
|
||||
\relates QMetaMethod
|
||||
\overload
|
||||
|
||||
Returns true if method \a m1 is equal to method \a m2,
|
||||
otherwise returns false.
|
||||
Returns \c true if method \a m1 is equal to method \a m2,
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*! \fn bool operator!=(const QMetaMethod &m1, const QMetaMethod &m2)
|
||||
@ -1567,8 +1567,8 @@ bool QMetaObject::invokeMethod(QObject *obj,
|
||||
\relates QMetaMethod
|
||||
\overload
|
||||
|
||||
Returns true if method \a m1 is not equal to method \a m2,
|
||||
otherwise returns false.
|
||||
Returns \c true if method \a m1 is not equal to method \a m2,
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
@ -2007,8 +2007,8 @@ QMetaMethod QMetaMethod::fromSignalImpl(const QMetaObject *metaObject, void **si
|
||||
}
|
||||
|
||||
/*!
|
||||
Invokes this method on the object \a object. Returns true if the member could be invoked.
|
||||
Returns false if there is no such member or the parameters did not match.
|
||||
Invokes this method on the object \a object. Returns \c true if the member could be invoked.
|
||||
Returns \c false if there is no such member or the parameters did not match.
|
||||
|
||||
The invocation can be either synchronous or asynchronous, depending on the
|
||||
\a connectionType:
|
||||
@ -2308,7 +2308,7 @@ bool QMetaMethod::invoke(QObject *object,
|
||||
/*!
|
||||
\fn bool QMetaEnum::isValid() const
|
||||
|
||||
Returns true if this enum is valid (has a name); otherwise returns
|
||||
Returns \c true if this enum is valid (has a name); otherwise returns
|
||||
false.
|
||||
|
||||
\sa name()
|
||||
@ -2388,7 +2388,7 @@ int QMetaEnum::value(int index) const
|
||||
|
||||
|
||||
/*!
|
||||
Returns true if this enumerator is used as a flag; otherwise returns
|
||||
Returns \c true if this enumerator is used as a flag; otherwise returns
|
||||
false.
|
||||
|
||||
When used as flags, enumerators can be combined using the OR
|
||||
@ -2575,7 +2575,7 @@ static QByteArray qualifiedName(const QMetaEnum &e)
|
||||
attributes that specify its behavior: isReadable(), isWritable(),
|
||||
isDesignable(), isScriptable(), revision(), and isStored().
|
||||
|
||||
If the property is an enumeration, isEnumType() returns true; if the
|
||||
If the property is an enumeration, isEnumType() returns \c true; if the
|
||||
property is an enumeration that is also a flag (i.e. its values
|
||||
can be combined using the OR operator), isEnumType() and
|
||||
isFlagType() both return true. The enumerator for these types is
|
||||
@ -2597,8 +2597,8 @@ static QByteArray qualifiedName(const QMetaEnum &e)
|
||||
/*!
|
||||
\fn bool QMetaProperty::isValid() const
|
||||
|
||||
Returns true if this property is valid (readable); otherwise
|
||||
returns false.
|
||||
Returns \c true if this property is valid (readable); otherwise
|
||||
returns \c false.
|
||||
|
||||
\sa isReadable()
|
||||
*/
|
||||
@ -2722,8 +2722,8 @@ int QMetaProperty::propertyIndex() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the property's type is an enumeration value that
|
||||
is used as a flag; otherwise returns false.
|
||||
Returns \c true if the property's type is an enumeration value that
|
||||
is used as a flag; otherwise returns \c false.
|
||||
|
||||
Flags can be combined using the OR operator. A flag type is
|
||||
implicitly also an enum type.
|
||||
@ -2737,8 +2737,8 @@ bool QMetaProperty::isFlagType() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the property's type is an enumeration value;
|
||||
otherwise returns false.
|
||||
Returns \c true if the property's type is an enumeration value;
|
||||
otherwise returns \c false.
|
||||
|
||||
\sa enumerator(), isFlagType()
|
||||
*/
|
||||
@ -2754,7 +2754,7 @@ bool QMetaProperty::isEnumType() const
|
||||
/*!
|
||||
\internal
|
||||
|
||||
Returns true if the property has a C++ setter function that
|
||||
Returns \c true if the property has a C++ setter function that
|
||||
follows Qt's standard "name" / "setName" pattern. Designer and uic
|
||||
query hasStdCppSet() in order to avoid expensive
|
||||
QObject::setProperty() calls. All properties in Qt [should] follow
|
||||
@ -2853,7 +2853,7 @@ QVariant QMetaProperty::read(const QObject *object) const
|
||||
|
||||
/*!
|
||||
Writes \a value as the property's value to the given \a object. Returns
|
||||
true if the write succeeded; otherwise returns false.
|
||||
true if the write succeeded; otherwise returns \c false.
|
||||
|
||||
\sa read(), reset(), isWritable()
|
||||
*/
|
||||
@ -2925,7 +2925,7 @@ bool QMetaProperty::write(QObject *object, const QVariant &value) const
|
||||
|
||||
/*!
|
||||
Resets the property for the given \a object with a reset method.
|
||||
Returns true if the reset worked; otherwise returns false.
|
||||
Returns \c true if the reset worked; otherwise returns \c false.
|
||||
|
||||
Reset methods are optional; only a few properties support them.
|
||||
|
||||
@ -2941,8 +2941,8 @@ bool QMetaProperty::reset(QObject *object) const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if this property can be reset to a default value; otherwise
|
||||
returns false.
|
||||
Returns \c true if this property can be reset to a default value; otherwise
|
||||
returns \c false.
|
||||
|
||||
\sa reset()
|
||||
*/
|
||||
@ -2955,7 +2955,7 @@ bool QMetaProperty::isResettable() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if this property is readable; otherwise returns false.
|
||||
Returns \c true if this property is readable; otherwise returns \c false.
|
||||
|
||||
\sa isWritable(), read(), isValid()
|
||||
*/
|
||||
@ -2968,8 +2968,8 @@ bool QMetaProperty::isReadable() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if this property has a corresponding change notify signal;
|
||||
otherwise returns false.
|
||||
Returns \c true if this property has a corresponding change notify signal;
|
||||
otherwise returns \c false.
|
||||
|
||||
\sa notifySignal()
|
||||
*/
|
||||
@ -3048,7 +3048,7 @@ int QMetaProperty::revision() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if this property is writable; otherwise returns
|
||||
Returns \c true if this property is writable; otherwise returns
|
||||
false.
|
||||
|
||||
\sa isReadable(), write()
|
||||
@ -3063,12 +3063,12 @@ bool QMetaProperty::isWritable() const
|
||||
|
||||
|
||||
/*!
|
||||
Returns true if this property is designable for the given \a object;
|
||||
otherwise returns false.
|
||||
Returns \c true if this property is designable for the given \a object;
|
||||
otherwise returns \c false.
|
||||
|
||||
If no \a object is given, the function returns false if the
|
||||
If no \a object is given, the function returns \c false if the
|
||||
\c{Q_PROPERTY()}'s \c DESIGNABLE attribute is false; otherwise
|
||||
returns true (if the attribute is true or is a function or expression).
|
||||
returns \c true (if the attribute is true or is a function or expression).
|
||||
|
||||
\sa isScriptable(), isStored()
|
||||
*/
|
||||
@ -3089,10 +3089,10 @@ bool QMetaProperty::isDesignable(const QObject *object) const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the property is scriptable for the given \a object;
|
||||
otherwise returns false.
|
||||
Returns \c true if the property is scriptable for the given \a object;
|
||||
otherwise returns \c false.
|
||||
|
||||
If no \a object is given, the function returns false if the
|
||||
If no \a object is given, the function returns \c false if the
|
||||
\c{Q_PROPERTY()}'s \c SCRIPTABLE attribute is false; otherwise returns
|
||||
true (if the attribute is true or is a function or expression).
|
||||
|
||||
@ -3113,10 +3113,10 @@ bool QMetaProperty::isScriptable(const QObject *object) const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the property is stored for \a object; otherwise returns
|
||||
Returns \c true if the property is stored for \a object; otherwise returns
|
||||
false.
|
||||
|
||||
If no \a object is given, the function returns false if the
|
||||
If no \a object is given, the function returns \c false if the
|
||||
\c{Q_PROPERTY()}'s \c STORED attribute is false; otherwise returns
|
||||
true (if the attribute is true or is a function or expression).
|
||||
|
||||
@ -3137,13 +3137,13 @@ bool QMetaProperty::isStored(const QObject *object) const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if this property is designated as the \c USER
|
||||
Returns \c true if this property is designated as the \c USER
|
||||
property, i.e., the one that the user can edit for \a object or
|
||||
that is significant in some other way. Otherwise it returns
|
||||
false. e.g., the \c text property is the \c USER editable property
|
||||
of a QLineEdit.
|
||||
|
||||
If \a object is null, the function returns false if the \c
|
||||
If \a object is null, the function returns \c false if the \c
|
||||
{Q_PROPERTY()}'s \c USER attribute is false. Otherwise it returns
|
||||
true.
|
||||
|
||||
@ -3165,7 +3165,7 @@ bool QMetaProperty::isUser(const QObject *object) const
|
||||
|
||||
/*!
|
||||
\since 4.6
|
||||
Returns true if the property is constant; otherwise returns false.
|
||||
Returns \c true if the property is constant; otherwise returns \c false.
|
||||
|
||||
A property is constant if the \c{Q_PROPERTY()}'s \c CONSTANT attribute
|
||||
is set.
|
||||
@ -3180,7 +3180,7 @@ bool QMetaProperty::isConstant() const
|
||||
|
||||
/*!
|
||||
\since 4.6
|
||||
Returns true if the property is final; otherwise returns false.
|
||||
Returns \c true if the property is final; otherwise returns \c false.
|
||||
|
||||
A property is final if the \c{Q_PROPERTY()}'s \c FINAL attribute
|
||||
is set.
|
||||
@ -3196,10 +3196,10 @@ bool QMetaProperty::isFinal() const
|
||||
/*!
|
||||
\obsolete
|
||||
|
||||
Returns true if the property is editable for the given \a object;
|
||||
otherwise returns false.
|
||||
Returns \c true if the property is editable for the given \a object;
|
||||
otherwise returns \c false.
|
||||
|
||||
If no \a object is given, the function returns false if the
|
||||
If no \a object is given, the function returns \c false if the
|
||||
\c{Q_PROPERTY()}'s \c EDITABLE attribute is false; otherwise returns
|
||||
true (if the attribute is true or is a function or expression).
|
||||
|
||||
|
@ -2144,7 +2144,7 @@ QByteArray QMetaPropertyBuilder::type() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if this property has a notify signal; false otherwise.
|
||||
Returns \c true if this property has a notify signal; false otherwise.
|
||||
|
||||
\sa notifySignal(), setNotifySignal(), removeNotifySignal()
|
||||
*/
|
||||
@ -2205,7 +2205,7 @@ void QMetaPropertyBuilder::removeNotifySignal()
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if this property is readable; otherwise returns false.
|
||||
Returns \c true if this property is readable; otherwise returns \c false.
|
||||
The default value is true.
|
||||
|
||||
\sa setReadable(), isWritable()
|
||||
@ -2220,7 +2220,7 @@ bool QMetaPropertyBuilder::isReadable() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if this property is writable; otherwise returns false.
|
||||
Returns \c true if this property is writable; otherwise returns \c false.
|
||||
The default value is true.
|
||||
|
||||
\sa setWritable(), isReadable()
|
||||
@ -2235,8 +2235,8 @@ bool QMetaPropertyBuilder::isWritable() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if this property can be reset to a default value; otherwise
|
||||
returns false. The default value is false.
|
||||
Returns \c true if this property can be reset to a default value; otherwise
|
||||
returns \c false. The default value is false.
|
||||
|
||||
\sa setResettable()
|
||||
*/
|
||||
@ -2250,7 +2250,7 @@ bool QMetaPropertyBuilder::isResettable() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if this property is designable; otherwise returns false.
|
||||
Returns \c true if this property is designable; otherwise returns \c false.
|
||||
This default value is false.
|
||||
|
||||
\sa setDesignable(), isScriptable(), isStored()
|
||||
@ -2265,7 +2265,7 @@ bool QMetaPropertyBuilder::isDesignable() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the property is scriptable; otherwise returns false.
|
||||
Returns \c true if the property is scriptable; otherwise returns \c false.
|
||||
This default value is true.
|
||||
|
||||
\sa setScriptable(), isDesignable(), isStored()
|
||||
@ -2280,7 +2280,7 @@ bool QMetaPropertyBuilder::isScriptable() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the property is stored; otherwise returns false.
|
||||
Returns \c true if the property is stored; otherwise returns \c false.
|
||||
This default value is false.
|
||||
|
||||
\sa setStored(), isDesignable(), isScriptable()
|
||||
@ -2295,7 +2295,7 @@ bool QMetaPropertyBuilder::isStored() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the property is editable; otherwise returns false.
|
||||
Returns \c true if the property is editable; otherwise returns \c false.
|
||||
This default value is false.
|
||||
|
||||
\sa setEditable(), isDesignable(), isScriptable(), isStored()
|
||||
@ -2310,7 +2310,7 @@ bool QMetaPropertyBuilder::isEditable() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if this property is designated as the \c USER
|
||||
Returns \c true if this property is designated as the \c USER
|
||||
property, i.e., the one that the user can edit or that is
|
||||
significant in some other way. Otherwise it returns
|
||||
false. This default value is false.
|
||||
@ -2327,7 +2327,7 @@ bool QMetaPropertyBuilder::isUser() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the property has a C++ setter function that
|
||||
Returns \c true if the property has a C++ setter function that
|
||||
follows Qt's standard "name" / "setName" pattern. Designer and uic
|
||||
query hasStdCppSet() in order to avoid expensive
|
||||
QObject::setProperty() calls. All properties in Qt [should] follow
|
||||
@ -2345,8 +2345,8 @@ bool QMetaPropertyBuilder::hasStdCppSet() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the property is an enumerator or flag type;
|
||||
otherwise returns false. This default value is false.
|
||||
Returns \c true if the property is an enumerator or flag type;
|
||||
otherwise returns \c false. This default value is false.
|
||||
|
||||
\sa setEnumOrFlag()
|
||||
*/
|
||||
@ -2360,7 +2360,7 @@ bool QMetaPropertyBuilder::isEnumOrFlag() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the property is constant; otherwise returns false.
|
||||
Returns \c true if the property is constant; otherwise returns \c false.
|
||||
The default value is false.
|
||||
*/
|
||||
bool QMetaPropertyBuilder::isConstant() const
|
||||
@ -2373,7 +2373,7 @@ bool QMetaPropertyBuilder::isConstant() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the property is final; otherwise returns false.
|
||||
Returns \c true if the property is final; otherwise returns \c false.
|
||||
The default value is false.
|
||||
*/
|
||||
bool QMetaPropertyBuilder::isFinal() const
|
||||
@ -2600,7 +2600,7 @@ QByteArray QMetaEnumBuilder::name() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if this enumerator is used as a flag; otherwise returns
|
||||
Returns \c true if this enumerator is used as a flag; otherwise returns
|
||||
false.
|
||||
|
||||
\sa setIsFlag()
|
||||
|
@ -331,7 +331,7 @@ struct DefinedTypesFilter {
|
||||
\fn bool QMetaType::isValid() const
|
||||
\since 5.0
|
||||
|
||||
Returns true if this QMetaType object contains valid
|
||||
Returns \c true if this QMetaType object contains valid
|
||||
information about a type, false otherwise.
|
||||
*/
|
||||
|
||||
@ -339,7 +339,7 @@ struct DefinedTypesFilter {
|
||||
\fn bool QMetaType::isRegistered() const
|
||||
\since 5.0
|
||||
|
||||
Returns true if this QMetaType object contains valid
|
||||
Returns \c true if this QMetaType object contains valid
|
||||
information about a type, false otherwise.
|
||||
*/
|
||||
|
||||
@ -540,7 +540,7 @@ Q_GLOBAL_STATIC(QMetaTypeDebugStreamRegistry, customTypesDebugStreamRegistry)
|
||||
\fn bool QMetaType::registerConverter()
|
||||
\since 5.2
|
||||
Registers the possibility of an implicit conversion from type From to type To in the meta
|
||||
type system. Returns true if the registration succeeded, otherwise false.
|
||||
type system. Returns \c true if the registration succeeded, otherwise false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
@ -548,7 +548,7 @@ Q_GLOBAL_STATIC(QMetaTypeDebugStreamRegistry, customTypesDebugStreamRegistry)
|
||||
\since 5.2
|
||||
\overload
|
||||
Registers a method \a function like To From::function() const as converter from type From
|
||||
to type To in the meta type system. Returns true if the registration succeeded, otherwise false.
|
||||
to type To in the meta type system. Returns \c true if the registration succeeded, otherwise false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
@ -556,7 +556,7 @@ Q_GLOBAL_STATIC(QMetaTypeDebugStreamRegistry, customTypesDebugStreamRegistry)
|
||||
\since 5.2
|
||||
\overload
|
||||
Registers a method \a function like To From::function(bool *ok) const as converter from type From
|
||||
to type To in the meta type system. Returns true if the registration succeeded, otherwise false.
|
||||
to type To in the meta type system. Returns \c true if the registration succeeded, otherwise false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
@ -564,7 +564,7 @@ Q_GLOBAL_STATIC(QMetaTypeDebugStreamRegistry, customTypesDebugStreamRegistry)
|
||||
\since 5.2
|
||||
\overload
|
||||
Registers a unary function object \a function as converter from type From
|
||||
to type To in the meta type system. Returns true if the registration succeeded, otherwise false.
|
||||
to type To in the meta type system. Returns \c true if the registration succeeded, otherwise false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
@ -572,7 +572,7 @@ Q_GLOBAL_STATIC(QMetaTypeDebugStreamRegistry, customTypesDebugStreamRegistry)
|
||||
\since 5.2
|
||||
Registers comparison operetarors for the user-registered type T. This requires T to have
|
||||
both an operator== and an operator<.
|
||||
Returns true if the registration succeeded, otherwise false.
|
||||
Returns \c true if the registration succeeded, otherwise false.
|
||||
*/
|
||||
|
||||
#ifndef QT_NO_DEBUG_STREAM
|
||||
@ -580,14 +580,14 @@ Q_GLOBAL_STATIC(QMetaTypeDebugStreamRegistry, customTypesDebugStreamRegistry)
|
||||
\fn bool QMetaType::registerDebugStreamOperator()
|
||||
Registers the debug stream operator for the user-registered type T. This requires T to have
|
||||
an operator<<(QDebug dbg, T).
|
||||
Returns true if the registration succeeded, otherwise false.
|
||||
Returns \c true if the registration succeeded, otherwise false.
|
||||
*/
|
||||
#endif
|
||||
|
||||
/*!
|
||||
Registers function \a f as converter function from type id \a from to \a to.
|
||||
If there's already a conversion registered, this does nothing but deleting \a f.
|
||||
Returns true if the registration succeeded, otherwise false.
|
||||
Returns \c true if the registration succeeded, otherwise false.
|
||||
\since 5.2
|
||||
\internal
|
||||
*/
|
||||
@ -624,12 +624,12 @@ bool QMetaType::registerComparatorFunction(const QtPrivate::AbstractComparatorFu
|
||||
|
||||
/*!
|
||||
\fn bool QMetaType::hasRegisteredComparators()
|
||||
Returns true, if the meta type system has registered comparators for type T.
|
||||
Returns \c true, if the meta type system has registered comparators for type T.
|
||||
\since 5.2
|
||||
*/
|
||||
|
||||
/*!
|
||||
Returns true, if the meta type system has registered comparators for type id \a typeId.
|
||||
Returns \c true, if the meta type system has registered comparators for type id \a typeId.
|
||||
\since 5.2
|
||||
*/
|
||||
bool QMetaType::hasRegisteredComparators(int typeId)
|
||||
@ -650,12 +650,12 @@ bool QMetaType::registerDebugStreamOperatorFunction(const QtPrivate::AbstractDeb
|
||||
|
||||
/*!
|
||||
\fn bool QMetaType::hasRegisteredDebugStreamOperator()
|
||||
Returns true, if the meta type system has a registered debug stream operator for type T.
|
||||
Returns \c true, if the meta type system has a registered debug stream operator for type T.
|
||||
\since 5.2
|
||||
*/
|
||||
|
||||
/*!
|
||||
Returns true, if the meta type system has a registered debug stream operator for type
|
||||
Returns \c true, if the meta type system has a registered debug stream operator for type
|
||||
id \a typeId.
|
||||
\since 5.2
|
||||
*/
|
||||
@ -667,7 +667,7 @@ bool QMetaType::hasRegisteredDebugStreamOperator(int typeId)
|
||||
|
||||
/*!
|
||||
Converts the object at \a from from \a fromTypeId to the preallocated space at \a to
|
||||
typed \a toTypeId. Returns true, if the conversion succeeded, otherwise false.
|
||||
typed \a toTypeId. Returns \c true, if the conversion succeeded, otherwise false.
|
||||
\since 5.2
|
||||
*/
|
||||
bool QMetaType::convert(const void *from, int fromTypeId, void *to, int toTypeId)
|
||||
@ -680,7 +680,7 @@ bool QMetaType::convert(const void *from, int fromTypeId, void *to, int toTypeId
|
||||
/*!
|
||||
Compares the objects at \a lhs and \a rhs. Both objects need to be of type \a typeId.
|
||||
\a result is set to less than, equal to or greater than zero, if \a lhs is less than, equal to
|
||||
or greater than \a rhs. Returns true, if the comparison succeeded, otherwiess false.
|
||||
or greater than \a rhs. Returns \c true, if the comparison succeeded, otherwiess false.
|
||||
\since 5.2
|
||||
*/
|
||||
bool QMetaType::compare(const void *lhs, const void *rhs, int typeId, int* result)
|
||||
@ -697,7 +697,7 @@ bool QMetaType::compare(const void *lhs, const void *rhs, int typeId, int* resul
|
||||
}
|
||||
|
||||
/*!
|
||||
Streams the object at \a rhs of type \a typeId to the debug stream \a dbg. Returns true
|
||||
Streams the object at \a rhs of type \a typeId to the debug stream \a dbg. Returns \c true
|
||||
on success, otherwise false.
|
||||
\since 5.2
|
||||
*/
|
||||
@ -712,13 +712,13 @@ bool QMetaType::debugStream(QDebug& dbg, const void *rhs, int typeId)
|
||||
|
||||
/*!
|
||||
\fn bool QMetaType::hasRegisteredConverterFunction()
|
||||
Returns true, if the meta type system has a registered conversion from type From to type To.
|
||||
Returns \c true, if the meta type system has a registered conversion from type From to type To.
|
||||
\since 5.2
|
||||
\overload
|
||||
*/
|
||||
|
||||
/*!
|
||||
Returns true, if the meta type system has a registered conversion from meta type id \a fromTypeId
|
||||
Returns \c true, if the meta type system has a registered conversion from meta type id \a fromTypeId
|
||||
to \a toTypeId
|
||||
\since 5.2
|
||||
*/
|
||||
@ -1027,8 +1027,8 @@ int QMetaType::registerNormalizedTypedef(const NS(QByteArray) &normalizedTypeNam
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the datatype with ID \a type is registered;
|
||||
otherwise returns false.
|
||||
Returns \c true if the datatype with ID \a type is registered;
|
||||
otherwise returns \c false.
|
||||
|
||||
\sa type(), typeName(), Type
|
||||
*/
|
||||
@ -1103,8 +1103,8 @@ int qMetaTypeTypeInternal(const char *typeName)
|
||||
#ifndef QT_NO_DATASTREAM
|
||||
/*!
|
||||
Writes the object pointed to by \a data with the ID \a type to
|
||||
the given \a stream. Returns true if the object is saved
|
||||
successfully; otherwise returns false.
|
||||
the given \a stream. Returns \c true if the object is saved
|
||||
successfully; otherwise returns \c false.
|
||||
|
||||
The type must have been registered with qRegisterMetaType() and
|
||||
qRegisterMetaTypeStreamOperators() beforehand.
|
||||
@ -1320,8 +1320,8 @@ bool QMetaType::save(QDataStream &stream, int type, const void *data)
|
||||
|
||||
/*!
|
||||
Reads the object of the specified \a type from the given \a
|
||||
stream into \a data. Returns true if the object is loaded
|
||||
successfully; otherwise returns false.
|
||||
stream into \a data. Returns \c true if the object is loaded
|
||||
successfully; otherwise returns \c false.
|
||||
|
||||
The type must have been registered with qRegisterMetaType() and
|
||||
qRegisterMetaTypeStreamOperators() beforehand.
|
||||
|
@ -363,8 +363,8 @@ void QMimeData::setUrls(const QList<QUrl> &urls)
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the object can return a list of urls; otherwise
|
||||
returns false.
|
||||
Returns \c true if the object can return a list of urls; otherwise
|
||||
returns \c false.
|
||||
|
||||
URLs correspond to the MIME type \c text/uri-list.
|
||||
|
||||
@ -402,8 +402,8 @@ void QMimeData::setText(const QString &text)
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the object can return plain text (MIME type \c
|
||||
text/plain); otherwise returns false.
|
||||
Returns \c true if the object can return plain text (MIME type \c
|
||||
text/plain); otherwise returns \c false.
|
||||
|
||||
\sa setText(), text(), hasHtml(), hasFormat()
|
||||
*/
|
||||
@ -438,8 +438,8 @@ void QMimeData::setHtml(const QString &html)
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the object can return HTML (MIME type \c
|
||||
text/html); otherwise returns false.
|
||||
Returns \c true if the object can return HTML (MIME type \c
|
||||
text/html); otherwise returns \c false.
|
||||
|
||||
\sa setHtml(), html(), hasFormat()
|
||||
*/
|
||||
@ -484,7 +484,7 @@ void QMimeData::setImageData(const QVariant &image)
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the object can return an image; otherwise returns
|
||||
Returns \c true if the object can return an image; otherwise returns
|
||||
false.
|
||||
|
||||
\sa setImageData(), imageData(), hasFormat()
|
||||
@ -528,8 +528,8 @@ void QMimeData::setColorData(const QVariant &color)
|
||||
|
||||
|
||||
/*!
|
||||
Returns true if the object can return a color (MIME type \c
|
||||
application/x-color); otherwise returns false.
|
||||
Returns \c true if the object can return a color (MIME type \c
|
||||
application/x-color); otherwise returns \c false.
|
||||
|
||||
\sa setColorData(), colorData(), hasFormat()
|
||||
*/
|
||||
@ -572,8 +572,8 @@ void QMimeData::setData(const QString &mimeType, const QByteArray &data)
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the object can return data for the MIME type
|
||||
specified by \a mimeType; otherwise returns false.
|
||||
Returns \c true if the object can return data for the MIME type
|
||||
specified by \a mimeType; otherwise returns \c false.
|
||||
|
||||
For the most common types of data, you can call the higher-level
|
||||
functions hasText(), hasHtml(), hasUrls(), hasImage(), and
|
||||
|
@ -1005,9 +1005,9 @@ QObjectPrivate::Connection::~Connection()
|
||||
/*!
|
||||
\fn bool QObject::inherits(const char *className) const
|
||||
|
||||
Returns true if this object is an instance of a class that
|
||||
Returns \c true if this object is an instance of a class that
|
||||
inherits \a className or a QObject subclass that inherits \a
|
||||
className; otherwise returns false.
|
||||
className; otherwise returns \c false.
|
||||
|
||||
A class is considered to inherit itself.
|
||||
|
||||
@ -1068,7 +1068,7 @@ void QObject::setObjectName(const QString &name)
|
||||
/*!
|
||||
\fn bool QObject::isWidgetType() const
|
||||
|
||||
Returns true if the object is a widget; otherwise returns false.
|
||||
Returns \c true if the object is a widget; otherwise returns \c false.
|
||||
|
||||
Calling this function is equivalent to calling
|
||||
\c{inherits("QWidget")}, except that it is much faster.
|
||||
@ -1077,7 +1077,7 @@ void QObject::setObjectName(const QString &name)
|
||||
/*!
|
||||
\fn bool QObject::isWindowType() const
|
||||
|
||||
Returns true if the object is a window; otherwise returns false.
|
||||
Returns \c true if the object is a window; otherwise returns \c false.
|
||||
|
||||
Calling this function is equivalent to calling
|
||||
\c{inherits("QWindow")}, except that it is much faster.
|
||||
@ -1172,7 +1172,7 @@ void QObject::timerEvent(QTimerEvent *)
|
||||
QEvent::ChildAdded and QEvent::ChildRemoved events are sent to
|
||||
objects when children are added or removed. In both cases you can
|
||||
only rely on the child being a QObject, or if isWidgetType()
|
||||
returns true, a QWidget. (This is because, in the
|
||||
returns \c true, a QWidget. (This is because, in the
|
||||
\l{QEvent::ChildAdded}{ChildAdded} case, the child is not yet
|
||||
fully constructed, and in the \l{QEvent::ChildRemoved}{ChildRemoved}
|
||||
case it might have been destructed already).
|
||||
@ -1249,7 +1249,7 @@ bool QObject::eventFilter(QObject * /* watched */, QEvent * /* event */)
|
||||
/*!
|
||||
\fn bool QObject::signalsBlocked() const
|
||||
|
||||
Returns true if signals are blocked; otherwise returns false.
|
||||
Returns \c true if signals are blocked; otherwise returns \c false.
|
||||
|
||||
Signals are not blocked by default.
|
||||
|
||||
@ -2279,8 +2279,8 @@ int QObject::receivers(const char *signal) const
|
||||
|
||||
/*!
|
||||
\since 5.0
|
||||
Returns true if the \a signal is connected to at least one receiver,
|
||||
otherwise returns false.
|
||||
Returns \c true if the \a signal is connected to at least one receiver,
|
||||
otherwise returns \c false.
|
||||
|
||||
\a signal must be a signal member of this object, otherwise the behaviour
|
||||
is undefined.
|
||||
@ -2682,8 +2682,8 @@ QMetaObject::Connection QObject::connect(const QObject *sender, const QMetaMetho
|
||||
\threadsafe
|
||||
|
||||
Disconnects \a signal in object \a sender from \a method in object
|
||||
\a receiver. Returns true if the connection is successfully broken;
|
||||
otherwise returns false.
|
||||
\a receiver. Returns \c true if the connection is successfully broken;
|
||||
otherwise returns \c false.
|
||||
|
||||
A signal-slot connection is removed when either of the objects
|
||||
involved are destroyed.
|
||||
@ -2848,8 +2848,8 @@ bool QObject::disconnect(const QObject *sender, const char *signal,
|
||||
\since 4.8
|
||||
|
||||
Disconnects \a signal in object \a sender from \a method in object
|
||||
\a receiver. Returns true if the connection is successfully broken;
|
||||
otherwise returns false.
|
||||
\a receiver. Returns \c true if the connection is successfully broken;
|
||||
otherwise returns \c false.
|
||||
|
||||
This function provides the same possibilities like
|
||||
disconnect(const QObject *sender, const char *signal, const QObject *receiver, const char *method)
|
||||
@ -2998,7 +2998,7 @@ void QObject::connectNotify(const QMetaMethod &signal)
|
||||
If all signals were disconnected from this object (e.g., the
|
||||
signal argument to disconnect() was 0), disconnectNotify()
|
||||
is only called once, and the \a signal will be an invalid
|
||||
QMetaMethod (QMetaMethod::isValid() returns false).
|
||||
QMetaMethod (QMetaMethod::isValid() returns \c false).
|
||||
|
||||
\warning This function violates the object-oriented principle of
|
||||
modularity. However, it might be useful for optimizing access to
|
||||
@ -4506,8 +4506,8 @@ bool QObject::disconnect(const QMetaObject::Connection &connection)
|
||||
\threadsafe
|
||||
|
||||
Disconnects \a signal in object \a sender from \a method in object
|
||||
\a receiver. Returns true if the connection is successfully broken;
|
||||
otherwise returns false.
|
||||
\a receiver. Returns \c true if the connection is successfully broken;
|
||||
otherwise returns \c false.
|
||||
|
||||
A signal-slot connection is removed when either of the objects
|
||||
involved are destroyed.
|
||||
@ -4657,7 +4657,7 @@ QMetaObject::Connection::~Connection()
|
||||
/*!
|
||||
\fn QMetaObject::Connection::operator bool() const
|
||||
|
||||
Returns true if the connection is valid.
|
||||
Returns \c true if the connection is valid.
|
||||
|
||||
The connection is valid if the call to QObject::connect succeeded.
|
||||
The connection is invalid if QObject::connect was not able to find
|
||||
|
@ -237,7 +237,7 @@ public:
|
||||
|
||||
/*! \internal
|
||||
|
||||
Returns true if the signal with index \a signal_index from object \a sender is connected.
|
||||
Returns \c true if the signal with index \a signal_index from object \a sender is connected.
|
||||
Signals with indices above a certain range are always considered connected (see connectedSignals
|
||||
in QObjectPrivate). If a signal spy is installed, all signals are considered connected.
|
||||
|
||||
|
@ -63,7 +63,7 @@ QT_BEGIN_NAMESPACE
|
||||
someone else it will automatically be removed from the cleanup
|
||||
handler. You can delete all the objects in the cleanup handler
|
||||
with clear(), or by destroying the cleanup handler. isEmpty()
|
||||
returns true if the QObjectCleanupHandler has no objects to keep
|
||||
returns \c true if the QObjectCleanupHandler has no objects to keep
|
||||
track of.
|
||||
|
||||
\sa QPointer
|
||||
@ -119,7 +119,7 @@ void QObjectCleanupHandler::remove(QObject *object)
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if this cleanup handler is empty or if all objects in
|
||||
Returns \c true if this cleanup handler is empty or if all objects in
|
||||
this cleanup handler have been destroyed; otherwise return false.
|
||||
|
||||
\sa add(), remove(), clear()
|
||||
|
@ -153,7 +153,7 @@
|
||||
\fn bool QPointer::isNull() const
|
||||
|
||||
Returns \c true if the referenced object has been destroyed or if
|
||||
there is no referenced object; otherwise returns false.
|
||||
there is no referenced object; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
@ -191,45 +191,45 @@
|
||||
\fn bool operator==(const T *o, const QPointer<T> &p)
|
||||
\relates QPointer
|
||||
|
||||
Equality operator. Returns true if \a o and the guarded
|
||||
Equality operator. Returns \c true if \a o and the guarded
|
||||
pointer \a p are pointing to the same object, otherwise
|
||||
returns false.
|
||||
returns \c false.
|
||||
|
||||
*/
|
||||
/*!
|
||||
\fn bool operator==(const QPointer<T> &p, const T *o)
|
||||
\relates QPointer
|
||||
|
||||
Equality operator. Returns true if \a o and the guarded
|
||||
Equality operator. Returns \c true if \a o and the guarded
|
||||
pointer \a p are pointing to the same object, otherwise
|
||||
returns false.
|
||||
returns \c false.
|
||||
|
||||
*/
|
||||
/*!
|
||||
\fn bool operator==(T *o, const QPointer<T> &p)
|
||||
\relates QPointer
|
||||
|
||||
Equality operator. Returns true if \a o and the guarded
|
||||
Equality operator. Returns \c true if \a o and the guarded
|
||||
pointer \a p are pointing to the same object, otherwise
|
||||
returns false.
|
||||
returns \c false.
|
||||
|
||||
*/
|
||||
/*!
|
||||
\fn bool operator==(const QPointer<T> &p, T *o)
|
||||
\relates QPointer
|
||||
|
||||
Equality operator. Returns true if \a o and the guarded
|
||||
Equality operator. Returns \c true if \a o and the guarded
|
||||
pointer \a p are pointing to the same object, otherwise
|
||||
returns false.
|
||||
returns \c false.
|
||||
|
||||
*/
|
||||
/*!
|
||||
\fn bool operator==(const QPointer<T> &p1, const QPointer<T> &p2)
|
||||
\relates QPointer
|
||||
|
||||
Equality operator. Returns true if the guarded pointers \a p1 and \a p2
|
||||
Equality operator. Returns \c true if the guarded pointers \a p1 and \a p2
|
||||
are pointing to the same object, otherwise
|
||||
returns false.
|
||||
returns \c false.
|
||||
|
||||
*/
|
||||
|
||||
@ -238,41 +238,41 @@
|
||||
\fn bool operator!=(const T *o, const QPointer<T> &p)
|
||||
\relates QPointer
|
||||
|
||||
Inequality operator. Returns true if \a o and the guarded
|
||||
Inequality operator. Returns \c true if \a o and the guarded
|
||||
pointer \a p are not pointing to the same object, otherwise
|
||||
returns false.
|
||||
returns \c false.
|
||||
*/
|
||||
/*!
|
||||
\fn bool operator!=(const QPointer<T> &p, const T *o)
|
||||
\relates QPointer
|
||||
|
||||
Inequality operator. Returns true if \a o and the guarded
|
||||
Inequality operator. Returns \c true if \a o and the guarded
|
||||
pointer \a p are not pointing to the same object, otherwise
|
||||
returns false.
|
||||
returns \c false.
|
||||
*/
|
||||
/*!
|
||||
\fn bool operator!=(T *o, const QPointer<T> &p)
|
||||
\relates QPointer
|
||||
|
||||
Inequality operator. Returns true if \a o and the guarded
|
||||
Inequality operator. Returns \c true if \a o and the guarded
|
||||
pointer \a p are not pointing to the same object, otherwise
|
||||
returns false.
|
||||
returns \c false.
|
||||
*/
|
||||
/*!
|
||||
\fn bool operator!=(const QPointer<T> &p, T *o)
|
||||
\relates QPointer
|
||||
|
||||
Inequality operator. Returns true if \a o and the guarded
|
||||
Inequality operator. Returns \c true if \a o and the guarded
|
||||
pointer \a p are not pointing to the same object, otherwise
|
||||
returns false.
|
||||
returns \c false.
|
||||
*/
|
||||
/*!
|
||||
\fn bool operator!=(const QPointer<T> &p1, const QPointer<T> &p2)
|
||||
\relates QPointer
|
||||
|
||||
Inequality operator. Returns true if the guarded pointers \a p1 and
|
||||
Inequality operator. Returns \c true if the guarded pointers \a p1 and
|
||||
\a p2 are not pointing to the same object, otherwise
|
||||
returns false.
|
||||
returns \c false.
|
||||
*/
|
||||
/*!
|
||||
\fn QPointer<T> qPointerFromVariant(const QVariant &variant)
|
||||
|
@ -389,7 +389,7 @@ int QSharedMemory::size() const
|
||||
identified by the key that was passed to the constructor or to a
|
||||
call to setKey() or setNativeKey(). The access \a mode is \l {QSharedMemory::}
|
||||
{ReadWrite} by default. It can also be \l {QSharedMemory::}
|
||||
{ReadOnly}. Returns true if the attach operation is successful. If
|
||||
{ReadOnly}. Returns \c true if the attach operation is successful. If
|
||||
false is returned, call error() to determine which error occurred.
|
||||
After attaching the shared memory segment, a pointer to the shared
|
||||
memory can be obtained by calling data().
|
||||
@ -415,7 +415,7 @@ bool QSharedMemory::attach(AccessMode mode)
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if this process is attached to the shared memory
|
||||
Returns \c true if this process is attached to the shared memory
|
||||
segment.
|
||||
|
||||
\sa attach(), detach()
|
||||
@ -430,8 +430,8 @@ bool QSharedMemory::isAttached() const
|
||||
Detaches the process from the shared memory segment. If this was the
|
||||
last process attached to the shared memory segment, then the shared
|
||||
memory segment is released by the system, i.e., the contents are
|
||||
destroyed. The function returns true if it detaches the shared
|
||||
memory segment. If it returns false, it usually means the segment
|
||||
destroyed. The function returns \c true if it detaches the shared
|
||||
memory segment. If it returns \c false, it usually means the segment
|
||||
either isn't attached, or it is locked by another process.
|
||||
|
||||
\sa attach(), isAttached()
|
||||
@ -493,9 +493,9 @@ const void *QSharedMemory::data() const
|
||||
#ifndef QT_NO_SYSTEMSEMAPHORE
|
||||
/*!
|
||||
This is a semaphore that locks the shared memory segment for access
|
||||
by this process and returns true. If another process has locked the
|
||||
by this process and returns \c true. If another process has locked the
|
||||
segment, this function blocks until the lock is released. Then it
|
||||
acquires the lock and returns true. If this function returns false,
|
||||
acquires the lock and returns \c true. If this function returns \c false,
|
||||
it means that you have ignored a false return from create() or attach(),
|
||||
that you have set the key with setNativeKey() or that
|
||||
QSystemSemaphore::acquire() failed due to an unknown system error.
|
||||
@ -520,7 +520,7 @@ bool QSharedMemory::lock()
|
||||
}
|
||||
|
||||
/*!
|
||||
Releases the lock on the shared memory segment and returns true, if
|
||||
Releases the lock on the shared memory segment and returns \c true, if
|
||||
the lock is currently held by this process. If the segment is not
|
||||
locked, or if the lock is held by another process, nothing happens
|
||||
and false is returned.
|
||||
|
@ -143,7 +143,7 @@ key_t QSharedMemoryPrivate::handle()
|
||||
/*!
|
||||
\internal
|
||||
Creates the unix file if needed.
|
||||
returns true if the unix file was created.
|
||||
returns \c true if the unix file was created.
|
||||
|
||||
-1 error
|
||||
0 already existed
|
||||
|
@ -238,7 +238,7 @@ QSocketNotifier::Type QSocketNotifier::type() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the notifier is enabled; otherwise returns false.
|
||||
Returns \c true if the notifier is enabled; otherwise returns \c false.
|
||||
|
||||
\sa setEnabled()
|
||||
*/
|
||||
|
@ -261,7 +261,7 @@ QString QSystemSemaphore::key() const
|
||||
|
||||
/*!
|
||||
Acquires one of the resources guarded by this semaphore, if there is
|
||||
one available, and returns true. If all the resources guarded by this
|
||||
one available, and returns \c true. If all the resources guarded by this
|
||||
semaphore have already been acquired, the call blocks until one of
|
||||
them is released by another process or thread having a semaphore
|
||||
with the same key.
|
||||
@ -278,7 +278,7 @@ bool QSystemSemaphore::acquire()
|
||||
}
|
||||
|
||||
/*!
|
||||
Releases \a n resources guarded by the semaphore. Returns true
|
||||
Releases \a n resources guarded by the semaphore. Returns \c true
|
||||
unless there is a system error.
|
||||
|
||||
Example: Create a system semaphore having five resources; acquire
|
||||
|
@ -175,14 +175,14 @@ QTimer::~QTimer()
|
||||
\property QTimer::active
|
||||
\since 4.3
|
||||
|
||||
This boolean property is true if the timer is running; otherwise
|
||||
This boolean property is \c true if the timer is running; otherwise
|
||||
false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bool QTimer::isActive() const
|
||||
|
||||
Returns true if the timer is running (pending); otherwise returns
|
||||
Returns \c true if the timer is running (pending); otherwise returns
|
||||
false.
|
||||
*/
|
||||
|
||||
|
@ -108,7 +108,7 @@ timespec qAbsTimespec(const timespec &t)
|
||||
}
|
||||
|
||||
/*
|
||||
Returns true if the real time clock has changed by more than 10%
|
||||
Returns \c true if the real time clock has changed by more than 10%
|
||||
relative to the processor time since the last time this function was
|
||||
called. This presumably means that the system time has been changed.
|
||||
|
||||
|
@ -431,8 +431,8 @@ QTranslator::~QTranslator()
|
||||
|
||||
Loads \a filename + \a suffix (".qm" if the \a suffix is not
|
||||
specified), which may be an absolute file name or relative to \a
|
||||
directory. Returns true if the translation is successfully loaded;
|
||||
otherwise returns false.
|
||||
directory. Returns \c true if the translation is successfully loaded;
|
||||
otherwise returns \c false.
|
||||
|
||||
If \a directory is not specified, the directory of the
|
||||
application's executable is used (i.e., as
|
||||
@ -708,8 +708,8 @@ static QString find_translation(const QLocale & locale,
|
||||
|
||||
Loads \a filename + \a prefix + \l{QLocale::uiLanguages()}{ui language
|
||||
name} + \a suffix (".qm" if the \a suffix is not specified), which may be
|
||||
an absolute file name or relative to \a directory. Returns true if the
|
||||
translation is successfully loaded; otherwise returns false.
|
||||
an absolute file name or relative to \a directory. Returns \c true if the
|
||||
translation is successfully loaded; otherwise returns \c false.
|
||||
|
||||
The previous contents of this translator object are discarded.
|
||||
|
||||
@ -1104,7 +1104,7 @@ QString QTranslator::translate(const char *context, const char *sourceText, cons
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if this translator is empty, otherwise returns false.
|
||||
Returns \c true if this translator is empty, otherwise returns \c false.
|
||||
This function works with stripped and unstripped translation files.
|
||||
*/
|
||||
bool QTranslator::isEmpty() const
|
||||
|
@ -1988,8 +1988,8 @@ QDataStream& operator<<(QDataStream &s, const QVariant::Type p)
|
||||
/*!
|
||||
\fn bool QVariant::isValid() const
|
||||
|
||||
Returns true if the storage type of this variant is not
|
||||
QVariant::Invalid; otherwise returns false.
|
||||
Returns \c true if the storage type of this variant is not
|
||||
QVariant::Invalid; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
template <typename T>
|
||||
@ -2521,12 +2521,12 @@ qulonglong QVariant::toULongLong(bool *ok) const
|
||||
/*!
|
||||
Returns the variant as a bool if the variant has userType() Bool.
|
||||
|
||||
Returns true if the variant has userType() \l QMetaType::Bool,
|
||||
Returns \c true if the variant has userType() \l QMetaType::Bool,
|
||||
\l QMetaType::QChar, \l QMetaType::Double, \l QMetaType::Int,
|
||||
\l QMetaType::LongLong, \l QMetaType::UInt, or \l QMetaType::ULongLong and
|
||||
the value is non-zero, or if the variant has type \l QMetaType::QString or
|
||||
\l QMetaType::QByteArray and its lower-case content is not one of the
|
||||
following: empty, "0" or "false"; otherwise returns false.
|
||||
following: empty, "0" or "false"; otherwise returns \c false.
|
||||
|
||||
\sa canConvert(), convert()
|
||||
*/
|
||||
@ -2694,7 +2694,7 @@ static const quint32 qCanConvertMatrix[QVariant::LastCoreType + 1] =
|
||||
|
||||
#ifndef QT_BOOTSTRAPPED
|
||||
/*!
|
||||
Returns true if from inherits to.
|
||||
Returns \c true if from inherits to.
|
||||
*/
|
||||
static bool canConvertMetaObject(const QMetaObject *from, const QMetaObject *to)
|
||||
{
|
||||
@ -2730,7 +2730,7 @@ static bool canConvertMetaObject(int fromId, int toId, QObject *fromObject)
|
||||
|
||||
|
||||
/*!
|
||||
Returns true if the variant's type can be cast to the requested
|
||||
Returns \c true if the variant's type can be cast to the requested
|
||||
type, \a targetTypeId. Such casting is done automatically when calling the
|
||||
toInt(), toBool(), ... methods.
|
||||
|
||||
@ -2933,8 +2933,8 @@ bool QVariant::canConvert(int targetTypeId) const
|
||||
|
||||
/*!
|
||||
Casts the variant to the requested type, \a targetTypeId. If the cast cannot be
|
||||
done, the variant is cleared. Returns true if the current type of
|
||||
the variant was successfully cast; otherwise returns false.
|
||||
done, the variant is cleared. Returns \c true if the current type of
|
||||
the variant was successfully cast; otherwise returns \c false.
|
||||
|
||||
A QVariant containing a pointer to a type derived from QObject will also convert
|
||||
and return true for this function if a qobject_cast to the type described
|
||||
@ -2991,7 +2991,7 @@ bool QVariant::convert(const int type, void *ptr) const
|
||||
|
||||
\relates QVariant
|
||||
|
||||
Returns true if \a v1 and \a v2 are equal; otherwise returns false.
|
||||
Returns \c true if \a v1 and \a v2 are equal; otherwise returns \c false.
|
||||
|
||||
If \a v1 and \a v2 have the same \l{QVariant::}{type()}, the
|
||||
type's equality operator is used for comparison. If not, it is
|
||||
@ -3012,7 +3012,7 @@ bool QVariant::convert(const int type, void *ptr) const
|
||||
|
||||
\relates QVariant
|
||||
|
||||
Returns false if \a v1 and \a v2 are equal; otherwise returns true.
|
||||
Returns \c false if \a v1 and \a v2 are equal; otherwise returns \c true.
|
||||
|
||||
\warning To make this function work with a custom type registered with
|
||||
qRegisterMetaType(), its comparison operator must be registered using
|
||||
@ -3021,8 +3021,8 @@ bool QVariant::convert(const int type, void *ptr) const
|
||||
|
||||
/*! \fn bool QVariant::operator==(const QVariant &v) const
|
||||
|
||||
Compares this QVariant with \a v and returns true if they are
|
||||
equal; otherwise returns false.
|
||||
Compares this QVariant with \a v and returns \c true if they are
|
||||
equal; otherwise returns \c false.
|
||||
|
||||
QVariant uses the equality operator of the type() it contains to
|
||||
check for equality. QVariant will try to convert() \a v if its
|
||||
@ -3037,8 +3037,8 @@ bool QVariant::convert(const int type, void *ptr) const
|
||||
/*!
|
||||
\fn bool QVariant::operator!=(const QVariant &v) const
|
||||
|
||||
Compares this QVariant with \a v and returns true if they are not
|
||||
equal; otherwise returns false.
|
||||
Compares this QVariant with \a v and returns \c true if they are not
|
||||
equal; otherwise returns \c false.
|
||||
|
||||
\warning To make this function work with a custom type registered with
|
||||
qRegisterMetaType(), its comparison operator must be registered using
|
||||
@ -3048,7 +3048,7 @@ bool QVariant::convert(const int type, void *ptr) const
|
||||
/*!
|
||||
\fn bool QVariant::operator<(const QVariant &v) const
|
||||
|
||||
Compares this QVariant with \a v and returns true if this is less than \a v.
|
||||
Compares this QVariant with \a v and returns \c true if this is less than \a v.
|
||||
|
||||
\note Comparability might not be availabe for the type stored in this QVariant
|
||||
or in \a v.
|
||||
@ -3061,7 +3061,7 @@ bool QVariant::convert(const int type, void *ptr) const
|
||||
/*!
|
||||
\fn bool QVariant::operator<=(const QVariant &v) const
|
||||
|
||||
Compares this QVariant with \a v and returns true if this is less or equal than \a v.
|
||||
Compares this QVariant with \a v and returns \c true if this is less or equal than \a v.
|
||||
|
||||
\note Comparability might not be available for the type stored in this QVariant
|
||||
or in \a v.
|
||||
@ -3074,7 +3074,7 @@ bool QVariant::convert(const int type, void *ptr) const
|
||||
/*!
|
||||
\fn bool QVariant::operator>(const QVariant &v) const
|
||||
|
||||
Compares this QVariant with \a v and returns true if this is larger than \a v.
|
||||
Compares this QVariant with \a v and returns \c true if this is larger than \a v.
|
||||
|
||||
\note Comparability might not be available for the type stored in this QVariant
|
||||
or in \a v.
|
||||
@ -3087,7 +3087,7 @@ bool QVariant::convert(const int type, void *ptr) const
|
||||
/*!
|
||||
\fn bool QVariant::operator>=(const QVariant &v) const
|
||||
|
||||
Compares this QVariant with \a v and returns true if this is larger or equal than \a v.
|
||||
Compares this QVariant with \a v and returns \c true if this is larger or equal than \a v.
|
||||
|
||||
\note Comparability might not be available for the type stored in this QVariant
|
||||
or in \a v.
|
||||
@ -3207,7 +3207,7 @@ void* QVariant::data()
|
||||
|
||||
|
||||
/*!
|
||||
Returns true if this is a null variant, false otherwise. A variant is
|
||||
Returns \c true if this is a null variant, false otherwise. A variant is
|
||||
considered null if it contains a default constructed value or a built-in
|
||||
type instance that has an isNull method, in which case the result
|
||||
would be the same as calling isNull on the wrapped object.
|
||||
@ -3298,7 +3298,7 @@ QDebug operator<<(QDebug dbg, const QVariant::Type p)
|
||||
|
||||
/*! \fn bool QVariant::canConvert() const
|
||||
|
||||
Returns true if the variant can be converted to the template type \c{T},
|
||||
Returns \c true if the variant can be converted to the template type \c{T},
|
||||
otherwise false.
|
||||
|
||||
Example:
|
||||
@ -3396,8 +3396,8 @@ QDebug operator<<(QDebug dbg, const QVariant::Type p)
|
||||
\relates QVariant
|
||||
\obsolete
|
||||
|
||||
Returns true if the given \a value can be converted to the
|
||||
template type specified; otherwise returns false.
|
||||
Returns \c true if the given \a value can be converted to the
|
||||
template type specified; otherwise returns \c false.
|
||||
|
||||
This function is equivalent to QVariant::canConvert(\a value).
|
||||
|
||||
@ -3608,8 +3608,8 @@ const QVariant QSequentialIterable::const_iterator::operator*() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if \a other points to the same item as this
|
||||
iterator; otherwise returns false.
|
||||
Returns \c true if \a other points to the same item as this
|
||||
iterator; otherwise returns \c false.
|
||||
|
||||
\sa operator!=()
|
||||
*/
|
||||
@ -3619,8 +3619,8 @@ bool QSequentialIterable::const_iterator::operator==(const const_iterator &other
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if \a other points to a different item than this
|
||||
iterator; otherwise returns false.
|
||||
Returns \c true if \a other points to a different item than this
|
||||
iterator; otherwise returns \c false.
|
||||
|
||||
\sa operator==()
|
||||
*/
|
||||
@ -3942,8 +3942,8 @@ const QVariant QAssociativeIterable::const_iterator::value() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if \a other points to the same item as this
|
||||
iterator; otherwise returns false.
|
||||
Returns \c true if \a other points to the same item as this
|
||||
iterator; otherwise returns \c false.
|
||||
|
||||
\sa operator!=()
|
||||
*/
|
||||
@ -3953,8 +3953,8 @@ bool QAssociativeIterable::const_iterator::operator==(const const_iterator &othe
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if \a other points to a different item than this
|
||||
iterator; otherwise returns false.
|
||||
Returns \c true if \a other points to a different item than this
|
||||
iterator; otherwise returns \c false.
|
||||
|
||||
\sa operator==()
|
||||
*/
|
||||
|
@ -183,7 +183,7 @@ HANDLE QWinEventNotifier::handle() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the notifier is enabled; otherwise returns false.
|
||||
Returns \c true if the notifier is enabled; otherwise returns \c false.
|
||||
|
||||
\sa setEnabled()
|
||||
*/
|
||||
|
@ -177,7 +177,7 @@ QMimeType::~QMimeType()
|
||||
|
||||
/*!
|
||||
\fn bool QMimeType::operator==(const QMimeType &other) const;
|
||||
Returns true if \a other equals this QMimeType object, otherwise returns false.
|
||||
Returns \c true if \a other equals this QMimeType object, otherwise returns \c false.
|
||||
The name is the unique identifier for a mimetype, so two mimetypes with
|
||||
the same name, are equal.
|
||||
*/
|
||||
@ -188,12 +188,12 @@ bool QMimeType::operator==(const QMimeType &other) const
|
||||
|
||||
/*!
|
||||
\fn bool QMimeType::operator!=(const QMimeType &other) const;
|
||||
Returns true if \a other does not equal this QMimeType object, otherwise returns false.
|
||||
Returns \c true if \a other does not equal this QMimeType object, otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bool QMimeType::isValid() const;
|
||||
Returns true if the QMimeType object contains valid data, otherwise returns false.
|
||||
Returns \c true if the QMimeType object contains valid data, otherwise returns \c false.
|
||||
A valid MIME type has a non-empty name().
|
||||
The invalid MIME type is the default-constructed QMimeType.
|
||||
*/
|
||||
@ -204,7 +204,7 @@ bool QMimeType::isValid() const
|
||||
|
||||
/*!
|
||||
\fn bool QMimeType::isDefault() const;
|
||||
Returns true if this MIME type is the default MIME type which
|
||||
Returns \c true if this MIME type is the default MIME type which
|
||||
applies to all files: application/octet-stream.
|
||||
*/
|
||||
bool QMimeType::isDefault() const
|
||||
@ -432,7 +432,7 @@ QString QMimeType::filterString() const
|
||||
|
||||
/*!
|
||||
\fn bool QMimeType::inherits(const QString &mimeTypeName) const;
|
||||
Returns true if this mimetype is \a mimeTypeName,
|
||||
Returns \c true if this mimetype is \a mimeTypeName,
|
||||
or inherits \a mimeTypeName (see parentMimeTypes()),
|
||||
or \a mimeTypeName is an alias for this mimetype.
|
||||
*/
|
||||
|
@ -223,7 +223,7 @@ static long qt_find_pattern(const char *s, ulong s_len,
|
||||
we can get the verification data without have to actually load the library.
|
||||
This lets us detect mismatches more safely.
|
||||
|
||||
Returns false if version information is not present, or if the
|
||||
Returns \c false if version information is not present, or if the
|
||||
information could not be read.
|
||||
Returns true if version information is present and successfully read.
|
||||
*/
|
||||
@ -560,8 +560,8 @@ bool QLibraryPrivate::loadPlugin()
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if \a fileName has a valid suffix for a loadable
|
||||
library; otherwise returns false.
|
||||
Returns \c true if \a fileName has a valid suffix for a loadable
|
||||
library; otherwise returns \c false.
|
||||
|
||||
\table
|
||||
\header \li Platform \li Valid suffixes
|
||||
@ -736,8 +736,8 @@ void QLibraryPrivate::updatePluginState()
|
||||
}
|
||||
|
||||
/*!
|
||||
Loads the library and returns true if the library was loaded
|
||||
successfully; otherwise returns false. Since resolve() always
|
||||
Loads the library and returns \c true if the library was loaded
|
||||
successfully; otherwise returns \c false. Since resolve() always
|
||||
calls this function before resolving any symbols it is not
|
||||
necessary to call it explicitly. In some situations you might want
|
||||
the library loaded in advance, in which case you would use this
|
||||
@ -756,8 +756,8 @@ bool QLibrary::load()
|
||||
}
|
||||
|
||||
/*!
|
||||
Unloads the library and returns true if the library could be
|
||||
unloaded; otherwise returns false.
|
||||
Unloads the library and returns \c true if the library could be
|
||||
unloaded; otherwise returns \c false.
|
||||
|
||||
This happens automatically on application termination, so you
|
||||
shouldn't normally need to call this function.
|
||||
@ -780,7 +780,7 @@ bool QLibrary::unload()
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the library is loaded; otherwise returns false.
|
||||
Returns \c true if the library is loaded; otherwise returns \c false.
|
||||
|
||||
\sa load()
|
||||
*/
|
||||
|
@ -219,8 +219,8 @@ QJsonObject QPluginLoader::metaData() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Loads the plugin and returns true if the plugin was loaded
|
||||
successfully; otherwise returns false. Since instance() always
|
||||
Loads the plugin and returns \c true if the plugin was loaded
|
||||
successfully; otherwise returns \c false. Since instance() always
|
||||
calls this function before resolving any symbols it is not
|
||||
necessary to call it explicitly. In some situations you might want
|
||||
the plugin loaded in advance, in which case you would use this
|
||||
@ -242,8 +242,8 @@ bool QPluginLoader::load()
|
||||
|
||||
|
||||
/*!
|
||||
Unloads the plugin and returns true if the plugin could be
|
||||
unloaded; otherwise returns false.
|
||||
Unloads the plugin and returns \c true if the plugin could be
|
||||
unloaded; otherwise returns \c false.
|
||||
|
||||
This happens automatically on application termination, so you
|
||||
shouldn't normally need to call this function.
|
||||
@ -269,7 +269,7 @@ bool QPluginLoader::unload()
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the plugin is loaded; otherwise returns false.
|
||||
Returns \c true if the plugin is loaded; otherwise returns \c false.
|
||||
|
||||
\sa load()
|
||||
*/
|
||||
|
@ -512,15 +512,15 @@ QUuid QUuid::fromRfc4122(const QByteArray &bytes)
|
||||
/*!
|
||||
\fn bool QUuid::operator==(const QUuid &other) const
|
||||
|
||||
Returns true if this QUuid and the \a other QUuid are identical;
|
||||
otherwise returns false.
|
||||
Returns \c true if this QUuid and the \a other QUuid are identical;
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bool QUuid::operator!=(const QUuid &other) const
|
||||
|
||||
Returns true if this QUuid and the \a other QUuid are different;
|
||||
otherwise returns false.
|
||||
Returns \c true if this QUuid and the \a other QUuid are different;
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
@ -735,8 +735,8 @@ QDataStream &operator>>(QDataStream &s, QUuid &id)
|
||||
#endif // QT_NO_DATASTREAM
|
||||
|
||||
/*!
|
||||
Returns true if this is the null UUID
|
||||
{00000000-0000-0000-0000-000000000000}; otherwise returns false.
|
||||
Returns \c true if this is the null UUID
|
||||
{00000000-0000-0000-0000-000000000000}; otherwise returns \c false.
|
||||
*/
|
||||
bool QUuid::isNull() const
|
||||
{
|
||||
@ -823,7 +823,7 @@ QUuid::Version QUuid::version() const
|
||||
/*!
|
||||
\fn bool QUuid::operator<(const QUuid &other) const
|
||||
|
||||
Returns true if this QUuid has the same \l{Variant field}
|
||||
Returns \c true if this QUuid has the same \l{Variant field}
|
||||
{variant field} as the \a other QUuid and is lexicographically
|
||||
\e{before} the \a other QUuid. If the \a other QUuid has a
|
||||
different variant field, the return value is determined by
|
||||
@ -849,7 +849,7 @@ bool QUuid::operator<(const QUuid &other) const
|
||||
/*!
|
||||
\fn bool QUuid::operator>(const QUuid &other) const
|
||||
|
||||
Returns true if this QUuid has the same \l{Variant field}
|
||||
Returns \c true if this QUuid has the same \l{Variant field}
|
||||
{variant field} as the \a other QUuid and is lexicographically
|
||||
\e{after} the \a other QUuid. If the \a other QUuid has a
|
||||
different variant field, the return value is determined by
|
||||
@ -992,15 +992,15 @@ QUuid QUuid::createUuid()
|
||||
/*!
|
||||
\fn bool QUuid::operator==(const GUID &guid) const
|
||||
|
||||
Returns true if this UUID is equal to the Windows GUID \a guid;
|
||||
otherwise returns false.
|
||||
Returns \c true if this UUID is equal to the Windows GUID \a guid;
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bool QUuid::operator!=(const GUID &guid) const
|
||||
|
||||
Returns true if this UUID is not equal to the Windows GUID \a
|
||||
guid; otherwise returns false.
|
||||
Returns \c true if this UUID is not equal to the Windows GUID \a
|
||||
guid; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
#ifndef QT_NO_DEBUG_STREAM
|
||||
|
@ -212,9 +212,9 @@ void QSignalTransition::setSignal(const QByteArray &signal)
|
||||
/*!
|
||||
\reimp
|
||||
|
||||
The default implementation returns true if the \a event is a
|
||||
The default implementation returns \c true if the \a event is a
|
||||
QStateMachine::SignalEvent object and the event's sender and signal index
|
||||
match this transition, and returns false otherwise.
|
||||
match this transition, and returns \c false otherwise.
|
||||
*/
|
||||
bool QSignalTransition::eventTest(QEvent *event)
|
||||
{
|
||||
|
@ -169,7 +169,7 @@ QT_BEGIN_NAMESPACE
|
||||
|
||||
\brief whether animations are enabled
|
||||
|
||||
The default value of this property is true.
|
||||
The default value of this property is \c true.
|
||||
|
||||
\sa QAbstractTransition::addAnimation()
|
||||
*/
|
||||
@ -862,8 +862,8 @@ bool QStateMachinePrivate::isInFinalState(QAbstractState* s) const
|
||||
|
||||
/*!
|
||||
\internal
|
||||
Returns true if the given state has saved the value of the given property,
|
||||
otherwise returns false.
|
||||
Returns \c true if the given state has saved the value of the given property,
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
bool QStateMachinePrivate::hasRestorable(QAbstractState *state, QObject *object,
|
||||
const QByteArray &propertyName) const
|
||||
@ -2264,8 +2264,8 @@ int QStateMachine::postDelayedEvent(QEvent *event, int delay)
|
||||
\threadsafe
|
||||
|
||||
Cancels the delayed event identified by the given \a id. The id should be a
|
||||
value returned by a call to postDelayedEvent(). Returns true if the event
|
||||
was successfully cancelled, otherwise returns false.
|
||||
value returned by a call to postDelayedEvent(). Returns \c true if the event
|
||||
was successfully cancelled, otherwise returns \c false.
|
||||
|
||||
\sa postDelayedEvent()
|
||||
*/
|
||||
|
@ -256,18 +256,18 @@
|
||||
|
||||
/*! \fn bool QAtomicInt::isReferenceCountingNative()
|
||||
|
||||
Returns true if reference counting is implemented using atomic
|
||||
Returns \c true if reference counting is implemented using atomic
|
||||
processor instructions, false otherwise.
|
||||
*/
|
||||
|
||||
/*! \fn bool QAtomicInt::isReferenceCountingWaitFree()
|
||||
|
||||
Returns true if atomic reference counting is wait-free, false
|
||||
Returns \c true if atomic reference counting is wait-free, false
|
||||
otherwise.
|
||||
*/
|
||||
|
||||
/*! \fn bool QAtomicInt::ref()
|
||||
Atomically increments the value of this QAtomicInt. Returns true
|
||||
Atomically increments the value of this QAtomicInt. Returns \c true
|
||||
if the new value is non-zero, false otherwise.
|
||||
|
||||
This function uses \e ordered \l {QAtomicInt#Memory
|
||||
@ -279,7 +279,7 @@
|
||||
*/
|
||||
|
||||
/*! \fn bool QAtomicInt::deref()
|
||||
Atomically decrements the value of this QAtomicInt. Returns true
|
||||
Atomically decrements the value of this QAtomicInt. Returns \c true
|
||||
if the new value is non-zero, false otherwise.
|
||||
|
||||
This function uses \e ordered \l {QAtomicInt#Memory
|
||||
@ -292,13 +292,13 @@
|
||||
|
||||
/*! \fn bool QAtomicInt::isTestAndSetNative()
|
||||
|
||||
Returns true if test-and-set is implemented using atomic processor
|
||||
Returns \c true if test-and-set is implemented using atomic processor
|
||||
instructions, false otherwise.
|
||||
*/
|
||||
|
||||
/*! \fn bool QAtomicInt::isTestAndSetWaitFree()
|
||||
|
||||
Returns true if atomic test-and-set is wait-free, false otherwise.
|
||||
Returns \c true if atomic test-and-set is wait-free, false otherwise.
|
||||
*/
|
||||
|
||||
/*! \fn bool QAtomicInt::testAndSetRelaxed(int expectedValue, int newValue)
|
||||
@ -308,7 +308,7 @@
|
||||
If the current value of this QAtomicInt is the \a expectedValue,
|
||||
the test-and-set functions assign the \a newValue to this
|
||||
QAtomicInt and return true. If the values are \e not the same,
|
||||
this function does nothing and returns false.
|
||||
this function does nothing and returns \c false.
|
||||
|
||||
This function uses \e relaxed \l {QAtomicInt#Memory
|
||||
ordering}{memory ordering} semantics, leaving the compiler and
|
||||
@ -322,7 +322,7 @@
|
||||
If the current value of this QAtomicInt is the \a expectedValue,
|
||||
the test-and-set functions assign the \a newValue to this
|
||||
QAtomicInt and return true. If the values are \e not the same,
|
||||
this function does nothing and returns false.
|
||||
this function does nothing and returns \c false.
|
||||
|
||||
This function uses \e acquire \l {QAtomicInt#Memory
|
||||
ordering}{memory ordering} semantics, which ensures that memory
|
||||
@ -337,7 +337,7 @@
|
||||
If the current value of this QAtomicInt is the \a expectedValue,
|
||||
the test-and-set functions assign the \a newValue to this
|
||||
QAtomicInt and return true. If the values are \e not the same,
|
||||
this function does nothing and returns false.
|
||||
this function does nothing and returns \c false.
|
||||
|
||||
This function uses \e release \l {QAtomicInt#Memory
|
||||
ordering}{memory ordering} semantics, which ensures that memory
|
||||
@ -352,7 +352,7 @@
|
||||
If the current value of this QAtomicInt is the \a expectedValue,
|
||||
the test-and-set functions assign the \a newValue to this
|
||||
QAtomicInt and return true. If the values are \e not the same,
|
||||
this function does nothing and returns false.
|
||||
this function does nothing and returns \c false.
|
||||
|
||||
This function uses \e ordered \l {QAtomicInt#Memory
|
||||
ordering}{memory ordering} semantics, which ensures that memory
|
||||
@ -362,13 +362,13 @@
|
||||
|
||||
/*! \fn bool QAtomicInt::isFetchAndStoreNative()
|
||||
|
||||
Returns true if fetch-and-store is implemented using atomic
|
||||
Returns \c true if fetch-and-store is implemented using atomic
|
||||
processor instructions, false otherwise.
|
||||
*/
|
||||
|
||||
/*! \fn bool QAtomicInt::isFetchAndStoreWaitFree()
|
||||
|
||||
Returns true if atomic fetch-and-store is wait-free, false
|
||||
Returns \c true if atomic fetch-and-store is wait-free, false
|
||||
otherwise.
|
||||
*/
|
||||
|
||||
@ -425,13 +425,13 @@
|
||||
|
||||
/*! \fn bool QAtomicInt::isFetchAndAddNative()
|
||||
|
||||
Returns true if fetch-and-add is implemented using atomic
|
||||
Returns \c true if fetch-and-add is implemented using atomic
|
||||
processor instructions, false otherwise.
|
||||
*/
|
||||
|
||||
/*! \fn bool QAtomicInt::isFetchAndAddWaitFree()
|
||||
|
||||
Returns true if atomic fetch-and-add is wait-free, false
|
||||
Returns \c true if atomic fetch-and-add is wait-free, false
|
||||
otherwise.
|
||||
*/
|
||||
|
||||
@ -828,13 +828,13 @@
|
||||
|
||||
/*! \fn bool QAtomicPointer::isTestAndSetNative()
|
||||
|
||||
Returns true if test-and-set is implemented using atomic processor
|
||||
Returns \c true if test-and-set is implemented using atomic processor
|
||||
instructions, false otherwise.
|
||||
*/
|
||||
|
||||
/*! \fn bool QAtomicPointer::isTestAndSetWaitFree()
|
||||
|
||||
Returns true if atomic test-and-set is wait-free, false otherwise.
|
||||
Returns \c true if atomic test-and-set is wait-free, false otherwise.
|
||||
*/
|
||||
|
||||
/*! \fn bool QAtomicPointer::testAndSetRelaxed(T *expectedValue, T *newValue)
|
||||
@ -844,7 +844,7 @@
|
||||
If the current value of this QAtomicPointer is the \a expectedValue,
|
||||
the test-and-set functions assign the \a newValue to this
|
||||
QAtomicPointer and return true. If the values are \e not the same,
|
||||
this function does nothing and returns false.
|
||||
this function does nothing and returns \c false.
|
||||
|
||||
This function uses \e relaxed \l {QAtomicPointer#Memory
|
||||
ordering}{memory ordering} semantics, leaving the compiler and
|
||||
@ -858,7 +858,7 @@
|
||||
If the current value of this QAtomicPointer is the \a expectedValue,
|
||||
the test-and-set functions assign the \a newValue to this
|
||||
QAtomicPointer and return true. If the values are \e not the same,
|
||||
this function does nothing and returns false.
|
||||
this function does nothing and returns \c false.
|
||||
|
||||
This function uses \e acquire \l {QAtomicPointer#Memory
|
||||
ordering}{memory ordering} semantics, which ensures that memory
|
||||
@ -873,7 +873,7 @@
|
||||
If the current value of this QAtomicPointer is the \a expectedValue,
|
||||
the test-and-set functions assign the \a newValue to this
|
||||
QAtomicPointer and return true. If the values are \e not the same,
|
||||
this function does nothing and returns false.
|
||||
this function does nothing and returns \c false.
|
||||
|
||||
This function uses \e release \l {QAtomicPointer#Memory
|
||||
ordering}{memory ordering} semantics, which ensures that memory
|
||||
@ -888,7 +888,7 @@
|
||||
If the current value of this QAtomicPointer is the \a expectedValue,
|
||||
the test-and-set functions assign the \a newValue to this
|
||||
QAtomicPointer and return true. If the values are \e not the same,
|
||||
this function does nothing and returns false.
|
||||
this function does nothing and returns \c false.
|
||||
|
||||
This function uses \e ordered \l {QAtomicPointer#Memory
|
||||
ordering}{memory ordering} semantics, which ensures that memory
|
||||
@ -898,13 +898,13 @@
|
||||
|
||||
/*! \fn bool QAtomicPointer::isFetchAndStoreNative()
|
||||
|
||||
Returns true if fetch-and-store is implemented using atomic
|
||||
Returns \c true if fetch-and-store is implemented using atomic
|
||||
processor instructions, false otherwise.
|
||||
*/
|
||||
|
||||
/*! \fn bool QAtomicPointer::isFetchAndStoreWaitFree()
|
||||
|
||||
Returns true if atomic fetch-and-store is wait-free, false
|
||||
Returns \c true if atomic fetch-and-store is wait-free, false
|
||||
otherwise.
|
||||
*/
|
||||
|
||||
@ -961,13 +961,13 @@
|
||||
|
||||
/*! \fn bool QAtomicPointer::isFetchAndAddNative()
|
||||
|
||||
Returns true if fetch-and-add is implemented using atomic
|
||||
Returns \c true if fetch-and-add is implemented using atomic
|
||||
processor instructions, false otherwise.
|
||||
*/
|
||||
|
||||
/*! \fn bool QAtomicPointer::isFetchAndAddWaitFree()
|
||||
|
||||
Returns true if atomic fetch-and-add is wait-free, false
|
||||
Returns \c true if atomic fetch-and-add is wait-free, false
|
||||
otherwise.
|
||||
*/
|
||||
|
||||
|
@ -127,12 +127,12 @@
|
||||
|
||||
/*! \fn bool QFuture::operator==(const QFuture &other) const
|
||||
|
||||
Returns true if \a other is a copy of this future; otherwise returns false.
|
||||
Returns \c true if \a other is a copy of this future; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*! \fn bool QFuture::operator!=(const QFuture &other) const
|
||||
|
||||
Returns true if \a other is \e not a copy of this future; otherwise returns
|
||||
Returns \c true if \a other is \e not a copy of this future; otherwise returns
|
||||
false.
|
||||
*/
|
||||
|
||||
@ -154,11 +154,11 @@
|
||||
|
||||
/*! \fn bool QFuture::isCanceled() const
|
||||
|
||||
Returns true if the asynchronous computation has been canceled with the
|
||||
cancel() function; otherwise returns false.
|
||||
Returns \c true if the asynchronous computation has been canceled with the
|
||||
cancel() function; otherwise returns \c false.
|
||||
|
||||
Be aware that the computation may still be running even though this
|
||||
function returns true. See cancel() for more details.
|
||||
function returns \c true. See cancel() for more details.
|
||||
*/
|
||||
|
||||
/*! \fn void QFuture::setPaused(bool paused)
|
||||
@ -182,11 +182,11 @@
|
||||
|
||||
/*! \fn bool QFuture::isPaused() const
|
||||
|
||||
Returns true if the asynchronous computation has been paused with the
|
||||
pause() function; otherwise returns false.
|
||||
Returns \c true if the asynchronous computation has been paused with the
|
||||
pause() function; otherwise returns \c false.
|
||||
|
||||
Be aware that the computation may still be running even though this
|
||||
function returns true. See setPaused() for more details.
|
||||
function returns \c true. See setPaused() for more details.
|
||||
|
||||
\sa setPaused(), togglePaused()
|
||||
*/
|
||||
@ -219,20 +219,20 @@
|
||||
|
||||
/*! \fn bool QFuture::isStarted() const
|
||||
|
||||
Returns true if the asynchronous computation represented by this future
|
||||
has been started; otherwise returns false.
|
||||
Returns \c true if the asynchronous computation represented by this future
|
||||
has been started; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*! \fn bool QFuture::isFinished() const
|
||||
|
||||
Returns true if the asynchronous computation represented by this future
|
||||
has finished; otherwise returns false.
|
||||
Returns \c true if the asynchronous computation represented by this future
|
||||
has finished; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*! \fn bool QFuture::isRunning() const
|
||||
|
||||
Returns true if the asynchronous computation represented by this future is
|
||||
currently running; otherwise returns false.
|
||||
Returns \c true if the asynchronous computation represented by this future is
|
||||
currently running; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*! \fn int QFuture::resultCount() const
|
||||
@ -301,8 +301,8 @@
|
||||
|
||||
/*! \fn bool QFuture::isResultReadyAt(int index) const
|
||||
|
||||
Returns true if the result at \a index is immediately available; otherwise
|
||||
returns false.
|
||||
Returns \c true if the result at \a index is immediately available; otherwise
|
||||
returns \c false.
|
||||
|
||||
\sa resultAt(), resultCount()
|
||||
*/
|
||||
@ -441,16 +441,16 @@
|
||||
|
||||
/*! \fn bool QFuture::const_iterator::operator!=(const const_iterator &other) const
|
||||
|
||||
Returns true if \a other points to a different result than this iterator;
|
||||
otherwise returns false.
|
||||
Returns \c true if \a other points to a different result than this iterator;
|
||||
otherwise returns \c false.
|
||||
|
||||
\sa operator==()
|
||||
*/
|
||||
|
||||
/*! \fn bool QFuture::const_iterator::operator==(const const_iterator &other) const
|
||||
|
||||
Returns true if \a other points to the same result as this iterator;
|
||||
otherwise returns false.
|
||||
Returns \c true if \a other points to the same result as this iterator;
|
||||
otherwise returns \c false.
|
||||
|
||||
\sa operator!=()
|
||||
*/
|
||||
@ -616,7 +616,7 @@
|
||||
|
||||
/*! \fn bool QFutureIterator::hasNext() const
|
||||
|
||||
Returns true if there is at least one result ahead of the iterator, e.g.,
|
||||
Returns \c true if there is at least one result ahead of the iterator, e.g.,
|
||||
the iterator is \e not at the back of the result list; otherwise returns
|
||||
false.
|
||||
|
||||
@ -645,7 +645,7 @@
|
||||
|
||||
/*! \fn bool QFutureIterator::hasPrevious() const
|
||||
|
||||
Returns true if there is at least one result ahead of the iterator, e.g.,
|
||||
Returns \c true if there is at least one result ahead of the iterator, e.g.,
|
||||
the iterator is \e not at the front of the result list; otherwise returns
|
||||
false.
|
||||
|
||||
@ -675,7 +675,7 @@
|
||||
/*! \fn bool QFutureIterator::findNext(const T &value)
|
||||
|
||||
Searches for \a value starting from the current iterator position forward.
|
||||
Returns true if \a value is found; otherwise returns false.
|
||||
Returns \c true if \a value is found; otherwise returns \c false.
|
||||
|
||||
After the call, if \a value was found, the iterator is positioned just
|
||||
after the matching result; otherwise, the iterator is positioned at the
|
||||
@ -687,7 +687,7 @@
|
||||
/*! \fn bool QFutureIterator::findPrevious(const T &value)
|
||||
|
||||
Searches for \a value starting from the current iterator position
|
||||
backward. Returns true if \a value is found; otherwise returns false.
|
||||
backward. Returns \c true if \a value is found; otherwise returns \c false.
|
||||
|
||||
After the call, if \a value was found, the iterator is positioned just
|
||||
before the matching result; otherwise, the iterator is positioned at the
|
||||
|
@ -114,7 +114,7 @@
|
||||
/*!
|
||||
\fn void QFutureSynchronizer::waitForFinished()
|
||||
|
||||
Waits for all futures to finish. If cancelOnWait() returns true, each
|
||||
Waits for all futures to finish. If cancelOnWait() returns \c true, each
|
||||
future is canceled before waiting for them to finish.
|
||||
|
||||
\sa cancelOnWait(), setCancelOnWait()
|
||||
@ -149,7 +149,7 @@
|
||||
/*!
|
||||
\fn bool QFutureSynchronizer::cancelOnWait() const
|
||||
|
||||
Returns true if the cancel-on-wait feature is enabled; otherwise returns
|
||||
Returns \c true if the cancel-on-wait feature is enabled; otherwise returns
|
||||
false. If cancel-on-wait is enabled, the waitForFinished() function will
|
||||
cancel all futures before waiting for them to finish.
|
||||
|
||||
|
@ -245,8 +245,8 @@ QString QFutureWatcherBase::progressText() const
|
||||
|
||||
/*! \fn bool QFutureWatcher::isStarted() const
|
||||
|
||||
Returns true if the asynchronous computation represented by the future()
|
||||
has been started; otherwise returns false.
|
||||
Returns \c true if the asynchronous computation represented by the future()
|
||||
has been started; otherwise returns \c false.
|
||||
*/
|
||||
bool QFutureWatcherBase::isStarted() const
|
||||
{
|
||||
@ -255,8 +255,8 @@ bool QFutureWatcherBase::isStarted() const
|
||||
|
||||
/*! \fn bool QFutureWatcher::isFinished() const
|
||||
|
||||
Returns true if the asynchronous computation represented by the future()
|
||||
has finished; otherwise returns false.
|
||||
Returns \c true if the asynchronous computation represented by the future()
|
||||
has finished; otherwise returns \c false.
|
||||
*/
|
||||
bool QFutureWatcherBase::isFinished() const
|
||||
{
|
||||
@ -266,8 +266,8 @@ bool QFutureWatcherBase::isFinished() const
|
||||
|
||||
/*! \fn bool QFutureWatcher::isRunning() const
|
||||
|
||||
Returns true if the asynchronous computation represented by the future()
|
||||
is currently running; otherwise returns false.
|
||||
Returns \c true if the asynchronous computation represented by the future()
|
||||
is currently running; otherwise returns \c false.
|
||||
*/
|
||||
bool QFutureWatcherBase::isRunning() const
|
||||
{
|
||||
@ -276,11 +276,11 @@ bool QFutureWatcherBase::isRunning() const
|
||||
|
||||
/*! \fn bool QFutureWatcher::isCanceled() const
|
||||
|
||||
Returns true if the asynchronous computation has been canceled with the
|
||||
cancel() function; otherwise returns false.
|
||||
Returns \c true if the asynchronous computation has been canceled with the
|
||||
cancel() function; otherwise returns \c false.
|
||||
|
||||
Be aware that the computation may still be running even though this
|
||||
function returns true. See cancel() for more details.
|
||||
function returns \c true. See cancel() for more details.
|
||||
*/
|
||||
bool QFutureWatcherBase::isCanceled() const
|
||||
{
|
||||
@ -289,11 +289,11 @@ bool QFutureWatcherBase::isCanceled() const
|
||||
|
||||
/*! \fn bool QFutureWatcher::isPaused() const
|
||||
|
||||
Returns true if the asynchronous computation has been paused with the
|
||||
pause() function; otherwise returns false.
|
||||
Returns \c true if the asynchronous computation has been paused with the
|
||||
pause() function; otherwise returns \c false.
|
||||
|
||||
Be aware that the computation may still be running even though this
|
||||
function returns true. See setPaused() for more details.
|
||||
function returns \c true. See setPaused() for more details.
|
||||
|
||||
\sa setPaused(), togglePaused()
|
||||
*/
|
||||
|
@ -227,8 +227,8 @@ void QMutex::lock() QT_MUTEX_LOCK_NOEXCEPT
|
||||
|
||||
/*! \fn bool QMutex::tryLock(int timeout)
|
||||
|
||||
Attempts to lock the mutex. This function returns true if the lock
|
||||
was obtained; otherwise it returns false. If another thread has
|
||||
Attempts to lock the mutex. This function returns \c true if the lock
|
||||
was obtained; otherwise it returns \c false. If another thread has
|
||||
locked the mutex, this function will wait for at most \a timeout
|
||||
milliseconds for the mutex to become available.
|
||||
|
||||
@ -281,7 +281,7 @@ void QMutex::unlock() Q_DECL_NOTHROW
|
||||
\fn void QMutex::isRecursive()
|
||||
\since 5.0
|
||||
|
||||
Returns true if the mutex is recursive
|
||||
Returns \c true if the mutex is recursive
|
||||
|
||||
*/
|
||||
bool QBasicMutex::isRecursive()
|
||||
|
@ -172,7 +172,7 @@ void QReadWriteLock::lockForRead()
|
||||
|
||||
/*!
|
||||
Attempts to lock for reading. If the lock was obtained, this
|
||||
function returns true, otherwise it returns false instead of
|
||||
function returns \c true, otherwise it returns \c false instead of
|
||||
waiting for the lock to become available, i.e. it does not block.
|
||||
|
||||
The lock attempt will fail if another thread has locked for
|
||||
@ -217,8 +217,8 @@ bool QReadWriteLock::tryLockForRead()
|
||||
|
||||
/*! \overload
|
||||
|
||||
Attempts to lock for reading. This function returns true if the
|
||||
lock was obtained; otherwise it returns false. If another thread
|
||||
Attempts to lock for reading. This function returns \c true if the
|
||||
lock was obtained; otherwise it returns \c false. If another thread
|
||||
has locked for writing, this function will wait for at most \a
|
||||
timeout milliseconds for the lock to become available.
|
||||
|
||||
@ -309,7 +309,7 @@ void QReadWriteLock::lockForWrite()
|
||||
|
||||
/*!
|
||||
Attempts to lock for writing. If the lock was obtained, this
|
||||
function returns true; otherwise, it returns false immediately.
|
||||
function returns \c true; otherwise, it returns \c false immediately.
|
||||
|
||||
The lock attempt will fail if another thread has locked for
|
||||
reading or writing.
|
||||
@ -352,8 +352,8 @@ bool QReadWriteLock::tryLockForWrite()
|
||||
|
||||
/*! \overload
|
||||
|
||||
Attempts to lock for writing. This function returns true if the
|
||||
lock was obtained; otherwise it returns false. If another thread
|
||||
Attempts to lock for writing. This function returns \c true if the
|
||||
lock was obtained; otherwise it returns \c false. If another thread
|
||||
has locked for reading or writing, this function will wait for at
|
||||
most \a timeout milliseconds for the lock to become available.
|
||||
|
||||
|
@ -53,7 +53,7 @@
|
||||
|
||||
You can use QThreadPool to execute your code in a separate
|
||||
thread. QThreadPool deletes the QRunnable automatically if
|
||||
autoDelete() returns true (the default). Use setAutoDelete() to
|
||||
autoDelete() returns \c true (the default). Use setAutoDelete() to
|
||||
change the auto-deletion flag.
|
||||
|
||||
QThreadPool supports executing the same QRunnable more than once
|
||||
@ -82,7 +82,7 @@
|
||||
|
||||
/*! \fn bool QRunnable::autoDelete() const
|
||||
|
||||
Returns true is auto-deletion is enabled; false otherwise.
|
||||
Returns \c true is auto-deletion is enabled; false otherwise.
|
||||
|
||||
If auto-deletion is enabled, QThreadPool will automatically delete
|
||||
this runnable after calling run(); otherwise, ownership remains
|
||||
|
@ -178,8 +178,8 @@ int QSemaphore::available() const
|
||||
|
||||
/*!
|
||||
Tries to acquire \c n resources guarded by the semaphore and
|
||||
returns true on success. If available() < \a n, this call
|
||||
immediately returns false without acquiring any resources.
|
||||
returns \c true on success. If available() < \a n, this call
|
||||
immediately returns \c false without acquiring any resources.
|
||||
|
||||
Example:
|
||||
|
||||
@ -199,7 +199,7 @@ bool QSemaphore::tryAcquire(int n)
|
||||
|
||||
/*!
|
||||
Tries to acquire \c n resources guarded by the semaphore and
|
||||
returns true on success. If available() < \a n, this call will
|
||||
returns \c true on success. If available() < \a n, this call will
|
||||
wait for at most \a timeout milliseconds for resources to become
|
||||
available.
|
||||
|
||||
|
@ -405,7 +405,7 @@ QThread::QThread(QThreadPrivate &dd, QObject *parent)
|
||||
|
||||
Note that deleting a QThread object will not stop the execution
|
||||
of the thread it manages. Deleting a running QThread (i.e.
|
||||
isFinished() returns false) will probably result in a program
|
||||
isFinished() returns \c false) will probably result in a program
|
||||
crash. Wait for the finished() signal before deleting the
|
||||
QThread.
|
||||
*/
|
||||
@ -427,7 +427,7 @@ QThread::~QThread()
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the thread is finished; otherwise returns false.
|
||||
Returns \c true if the thread is finished; otherwise returns \c false.
|
||||
|
||||
\sa isRunning()
|
||||
*/
|
||||
@ -439,7 +439,7 @@ bool QThread::isFinished() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if the thread is running; otherwise returns false.
|
||||
Returns \c true if the thread is running; otherwise returns \c false.
|
||||
|
||||
\sa isFinished()
|
||||
*/
|
||||
|
@ -441,10 +441,10 @@ QThreadPool *QThreadPool::globalInstance()
|
||||
be used to control the run queue's order of execution.
|
||||
|
||||
Note that the thread pool takes ownership of the \a runnable if
|
||||
\l{QRunnable::autoDelete()}{runnable->autoDelete()} returns true,
|
||||
\l{QRunnable::autoDelete()}{runnable->autoDelete()} returns \c true,
|
||||
and the \a runnable will be deleted automatically by the thread
|
||||
pool after the \l{QRunnable::run()}{runnable->run()} returns. If
|
||||
\l{QRunnable::autoDelete()}{runnable->autoDelete()} returns false,
|
||||
\l{QRunnable::autoDelete()}{runnable->autoDelete()} returns \c false,
|
||||
ownership of \a runnable remains with the caller. Note that
|
||||
changing the auto-deletion on \a runnable after calling this
|
||||
functions results in undefined behavior.
|
||||
@ -470,14 +470,14 @@ void QThreadPool::start(QRunnable *runnable, int priority)
|
||||
Attempts to reserve a thread to run \a runnable.
|
||||
|
||||
If no threads are available at the time of calling, then this function
|
||||
does nothing and returns false. Otherwise, \a runnable is run immediately
|
||||
using one available thread and this function returns true.
|
||||
does nothing and returns \c false. Otherwise, \a runnable is run immediately
|
||||
using one available thread and this function returns \c true.
|
||||
|
||||
Note that the thread pool takes ownership of the \a runnable if
|
||||
\l{QRunnable::autoDelete()}{runnable->autoDelete()} returns true,
|
||||
\l{QRunnable::autoDelete()}{runnable->autoDelete()} returns \c true,
|
||||
and the \a runnable will be deleted automatically by the thread
|
||||
pool after the \l{QRunnable::run()}{runnable->run()} returns. If
|
||||
\l{QRunnable::autoDelete()}{runnable->autoDelete()} returns false,
|
||||
\l{QRunnable::autoDelete()}{runnable->autoDelete()} returns \c false,
|
||||
ownership of \a runnable remains with the caller. Note that
|
||||
changing the auto-deletion on \a runnable after calling this
|
||||
function results in undefined behavior.
|
||||
@ -612,8 +612,8 @@ void QThreadPool::releaseThread()
|
||||
|
||||
/*!
|
||||
Waits up to \a msecs milliseconds for all threads to exit and removes all
|
||||
threads from the thread pool. Returns true if all threads were removed;
|
||||
otherwise it returns false. If \a msecs is -1 (the default), the timeout
|
||||
threads from the thread pool. Returns \c true if all threads were removed;
|
||||
otherwise it returns \c false. If \a msecs is -1 (the default), the timeout
|
||||
is ignored (waits for the last thread to exit).
|
||||
*/
|
||||
bool QThreadPool::waitForDone(int msecs)
|
||||
@ -630,7 +630,7 @@ bool QThreadPool::waitForDone(int msecs)
|
||||
|
||||
Removes the runnables that are not yet started from the queue.
|
||||
The runnables for which \l{QRunnable::autoDelete()}{runnable->autoDelete()}
|
||||
returns true are deleted.
|
||||
returns \c true are deleted.
|
||||
|
||||
\sa start()
|
||||
*/
|
||||
|
@ -282,7 +282,7 @@ void QThreadStorageData::finish(void **p)
|
||||
/*!
|
||||
\fn bool QThreadStorage::hasLocalData() const
|
||||
|
||||
If T is a pointer type, returns true if the calling thread has
|
||||
If T is a pointer type, returns \c true if the calling thread has
|
||||
non-zero data available.
|
||||
|
||||
If T is a value type, returns whether the data has already been
|
||||
|
@ -139,7 +139,7 @@
|
||||
\row \li \c{i - n} \li returns the iterator for the item \c n positions behind of iterator \c i
|
||||
\row \li \c{i - j} \li returns the number of items between iterators \c i and \c j
|
||||
\row \li \c{i[n]} \li same as \c{*(i + n)}
|
||||
\row \li \c{i < j} \li returns true if iterator \c j comes after iterator \c i
|
||||
\row \li \c{i < j} \li returns \c true if iterator \c j comes after iterator \c i
|
||||
\endtable
|
||||
|
||||
QList and QVector's non-const iterator types are random access iterators.
|
||||
@ -273,8 +273,8 @@
|
||||
Use std::equal instead.
|
||||
|
||||
Compares the items in the range [\a begin1, \a end1) with the
|
||||
items in the range [\a begin2, ...). Returns true if all the
|
||||
items compare equal; otherwise returns false.
|
||||
items in the range [\a begin2, ...). Returns \c true if all the
|
||||
items compare equal; otherwise returns \c false.
|
||||
|
||||
Example:
|
||||
\snippet code/doc_src_qalgorithms.cpp 6
|
||||
|
@ -262,7 +262,7 @@ void QBitArray::resize(int size)
|
||||
|
||||
/*! \fn bool QBitArray::isEmpty() const
|
||||
|
||||
Returns true if this bit array has size 0; otherwise returns
|
||||
Returns \c true if this bit array has size 0; otherwise returns
|
||||
false.
|
||||
|
||||
\sa size()
|
||||
@ -270,7 +270,7 @@ void QBitArray::resize(int size)
|
||||
|
||||
/*! \fn bool QBitArray::isNull() const
|
||||
|
||||
Returns true if this bit array is null; otherwise returns false.
|
||||
Returns \c true if this bit array is null; otherwise returns \c false.
|
||||
|
||||
Example:
|
||||
\snippet code/src_corelib_tools_qbitarray.cpp 5
|
||||
@ -286,7 +286,7 @@ void QBitArray::resize(int size)
|
||||
/*! \fn bool QBitArray::fill(bool value, int size = -1)
|
||||
|
||||
Sets every bit in the bit array to \a value, returning true if successful;
|
||||
otherwise returns false. If \a size is different from -1 (the default),
|
||||
otherwise returns \c false. If \a size is different from -1 (the default),
|
||||
the bit array is resized to \a size beforehand.
|
||||
|
||||
Example:
|
||||
@ -363,8 +363,8 @@ void QBitArray::fill(bool value, int begin, int end)
|
||||
|
||||
/*! \fn bool QBitArray::testBit(int i) const
|
||||
|
||||
Returns true if the bit at index position \a i is 1; otherwise
|
||||
returns false.
|
||||
Returns \c true if the bit at index position \a i is 1; otherwise
|
||||
returns \c false.
|
||||
|
||||
\a i must be a valid index position in the bit array (i.e., 0 <=
|
||||
\a i < size()).
|
||||
@ -478,16 +478,16 @@ void QBitArray::fill(bool value, int begin, int end)
|
||||
|
||||
/*! \fn bool QBitArray::operator==(const QBitArray &other) const
|
||||
|
||||
Returns true if \a other is equal to this bit array; otherwise
|
||||
returns false.
|
||||
Returns \c true if \a other is equal to this bit array; otherwise
|
||||
returns \c false.
|
||||
|
||||
\sa operator!=()
|
||||
*/
|
||||
|
||||
/*! \fn bool QBitArray::operator!=(const QBitArray &other) const
|
||||
|
||||
Returns true if \a other is not equal to this bit array;
|
||||
otherwise returns false.
|
||||
Returns \c true if \a other is not equal to this bit array;
|
||||
otherwise returns \c false.
|
||||
|
||||
\sa operator==()
|
||||
*/
|
||||
|
@ -1009,7 +1009,7 @@ QByteArray &QByteArray::operator=(const char *str)
|
||||
|
||||
/*! \fn bool QByteArray::isEmpty() const
|
||||
|
||||
Returns true if the byte array has size 0; otherwise returns false.
|
||||
Returns \c true if the byte array has size 0; otherwise returns \c false.
|
||||
|
||||
Example:
|
||||
\snippet code/src_corelib_tools_qbytearray.cpp 7
|
||||
@ -1212,8 +1212,8 @@ QByteArray &QByteArray::operator=(const char *str)
|
||||
|
||||
/*! \fn bool QByteArray::contains(const QByteArray &ba) const
|
||||
|
||||
Returns true if the byte array contains an occurrence of the byte
|
||||
array \a ba; otherwise returns false.
|
||||
Returns \c true if the byte array contains an occurrence of the byte
|
||||
array \a ba; otherwise returns \c false.
|
||||
|
||||
\sa indexOf(), count()
|
||||
*/
|
||||
@ -1222,16 +1222,16 @@ QByteArray &QByteArray::operator=(const char *str)
|
||||
|
||||
\overload
|
||||
|
||||
Returns true if the byte array contains the string \a str;
|
||||
otherwise returns false.
|
||||
Returns \c true if the byte array contains the string \a str;
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*! \fn bool QByteArray::contains(char ch) const
|
||||
|
||||
\overload
|
||||
|
||||
Returns true if the byte array contains the character \a ch;
|
||||
otherwise returns false.
|
||||
Returns \c true if the byte array contains the character \a ch;
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
@ -1334,7 +1334,7 @@ void QByteArray::chop(int n)
|
||||
|
||||
/*! \fn bool QByteArray::isNull() const
|
||||
|
||||
Returns true if this byte array is null; otherwise returns false.
|
||||
Returns \c true if this byte array is null; otherwise returns \c false.
|
||||
|
||||
Example:
|
||||
\snippet code/src_corelib_tools_qbytearray.cpp 13
|
||||
@ -2534,8 +2534,8 @@ int QByteArray::count(char ch) const
|
||||
*/
|
||||
|
||||
/*!
|
||||
Returns true if this byte array starts with byte array \a ba;
|
||||
otherwise returns false.
|
||||
Returns \c true if this byte array starts with byte array \a ba;
|
||||
otherwise returns \c false.
|
||||
|
||||
Example:
|
||||
\snippet code/src_corelib_tools_qbytearray.cpp 25
|
||||
@ -2553,8 +2553,8 @@ bool QByteArray::startsWith(const QByteArray &ba) const
|
||||
|
||||
/*! \overload
|
||||
|
||||
Returns true if this byte array starts with string \a str;
|
||||
otherwise returns false.
|
||||
Returns \c true if this byte array starts with string \a str;
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
bool QByteArray::startsWith(const char *str) const
|
||||
{
|
||||
@ -2568,8 +2568,8 @@ bool QByteArray::startsWith(const char *str) const
|
||||
|
||||
/*! \overload
|
||||
|
||||
Returns true if this byte array starts with character \a ch;
|
||||
otherwise returns false.
|
||||
Returns \c true if this byte array starts with character \a ch;
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
bool QByteArray::startsWith(char ch) const
|
||||
{
|
||||
@ -2579,8 +2579,8 @@ bool QByteArray::startsWith(char ch) const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if this byte array ends with byte array \a ba;
|
||||
otherwise returns false.
|
||||
Returns \c true if this byte array ends with byte array \a ba;
|
||||
otherwise returns \c false.
|
||||
|
||||
Example:
|
||||
\snippet code/src_corelib_tools_qbytearray.cpp 26
|
||||
@ -2598,8 +2598,8 @@ bool QByteArray::endsWith(const QByteArray &ba) const
|
||||
|
||||
/*! \overload
|
||||
|
||||
Returns true if this byte array ends with string \a str; otherwise
|
||||
returns false.
|
||||
Returns \c true if this byte array ends with string \a str; otherwise
|
||||
returns \c false.
|
||||
*/
|
||||
bool QByteArray::endsWith(const char *str) const
|
||||
{
|
||||
@ -2613,8 +2613,8 @@ bool QByteArray::endsWith(const char *str) const
|
||||
|
||||
/*! \overload
|
||||
|
||||
Returns true if this byte array ends with character \a ch;
|
||||
otherwise returns false.
|
||||
Returns \c true if this byte array ends with character \a ch;
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
bool QByteArray::endsWith(char ch) const
|
||||
{
|
||||
@ -2812,8 +2812,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba)
|
||||
|
||||
/*! \fn bool QByteArray::operator==(const QString &str) const
|
||||
|
||||
Returns true if this byte array is equal to string \a str;
|
||||
otherwise returns false.
|
||||
Returns \c true if this byte array is equal to string \a str;
|
||||
otherwise returns \c false.
|
||||
|
||||
The Unicode data is converted into 8-bit characters using
|
||||
QString::toUtf8().
|
||||
@ -2829,8 +2829,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba)
|
||||
|
||||
/*! \fn bool QByteArray::operator!=(const QString &str) const
|
||||
|
||||
Returns true if this byte array is not equal to string \a str;
|
||||
otherwise returns false.
|
||||
Returns \c true if this byte array is not equal to string \a str;
|
||||
otherwise returns \c false.
|
||||
|
||||
The Unicode data is converted into 8-bit characters using
|
||||
QString::toUtf8().
|
||||
@ -2846,8 +2846,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba)
|
||||
|
||||
/*! \fn bool QByteArray::operator<(const QString &str) const
|
||||
|
||||
Returns true if this byte array is lexically less than string \a
|
||||
str; otherwise returns false.
|
||||
Returns \c true if this byte array is lexically less than string \a
|
||||
str; otherwise returns \c false.
|
||||
|
||||
The Unicode data is converted into 8-bit characters using
|
||||
QString::toUtf8().
|
||||
@ -2863,8 +2863,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba)
|
||||
|
||||
/*! \fn bool QByteArray::operator>(const QString &str) const
|
||||
|
||||
Returns true if this byte array is lexically greater than string
|
||||
\a str; otherwise returns false.
|
||||
Returns \c true if this byte array is lexically greater than string
|
||||
\a str; otherwise returns \c false.
|
||||
|
||||
The Unicode data is converted into 8-bit characters using
|
||||
QString::toUtf8().
|
||||
@ -2880,8 +2880,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba)
|
||||
|
||||
/*! \fn bool QByteArray::operator<=(const QString &str) const
|
||||
|
||||
Returns true if this byte array is lexically less than or equal
|
||||
to string \a str; otherwise returns false.
|
||||
Returns \c true if this byte array is lexically less than or equal
|
||||
to string \a str; otherwise returns \c false.
|
||||
|
||||
The Unicode data is converted into 8-bit characters using
|
||||
QString::toUtf8().
|
||||
@ -2897,8 +2897,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba)
|
||||
|
||||
/*! \fn bool QByteArray::operator>=(const QString &str) const
|
||||
|
||||
Returns true if this byte array is greater than or equal to string
|
||||
\a str; otherwise returns false.
|
||||
Returns \c true if this byte array is greater than or equal to string
|
||||
\a str; otherwise returns \c false.
|
||||
|
||||
The Unicode data is converted into 8-bit characters using
|
||||
QString::toUtf8().
|
||||
@ -2917,8 +2917,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba)
|
||||
|
||||
\overload
|
||||
|
||||
Returns true if byte array \a a1 is equal to byte array \a a2;
|
||||
otherwise returns false.
|
||||
Returns \c true if byte array \a a1 is equal to byte array \a a2;
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*! \fn bool operator==(const QByteArray &a1, const char *a2)
|
||||
@ -2926,8 +2926,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba)
|
||||
|
||||
\overload
|
||||
|
||||
Returns true if byte array \a a1 is equal to string \a a2;
|
||||
otherwise returns false.
|
||||
Returns \c true if byte array \a a1 is equal to string \a a2;
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*! \fn bool operator==(const char *a1, const QByteArray &a2)
|
||||
@ -2935,8 +2935,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba)
|
||||
|
||||
\overload
|
||||
|
||||
Returns true if string \a a1 is equal to byte array \a a2;
|
||||
otherwise returns false.
|
||||
Returns \c true if string \a a1 is equal to byte array \a a2;
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*! \fn bool operator!=(const QByteArray &a1, const QByteArray &a2)
|
||||
@ -2944,8 +2944,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba)
|
||||
|
||||
\overload
|
||||
|
||||
Returns true if byte array \a a1 is not equal to byte array \a a2;
|
||||
otherwise returns false.
|
||||
Returns \c true if byte array \a a1 is not equal to byte array \a a2;
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*! \fn bool operator!=(const QByteArray &a1, const char *a2)
|
||||
@ -2953,8 +2953,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba)
|
||||
|
||||
\overload
|
||||
|
||||
Returns true if byte array \a a1 is not equal to string \a a2;
|
||||
otherwise returns false.
|
||||
Returns \c true if byte array \a a1 is not equal to string \a a2;
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*! \fn bool operator!=(const char *a1, const QByteArray &a2)
|
||||
@ -2962,8 +2962,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba)
|
||||
|
||||
\overload
|
||||
|
||||
Returns true if string \a a1 is not equal to byte array \a a2;
|
||||
otherwise returns false.
|
||||
Returns \c true if string \a a1 is not equal to byte array \a a2;
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*! \fn bool operator<(const QByteArray &a1, const QByteArray &a2)
|
||||
@ -2971,8 +2971,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba)
|
||||
|
||||
\overload
|
||||
|
||||
Returns true if byte array \a a1 is lexically less than byte array
|
||||
\a a2; otherwise returns false.
|
||||
Returns \c true if byte array \a a1 is lexically less than byte array
|
||||
\a a2; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*! \fn inline bool operator<(const QByteArray &a1, const char *a2)
|
||||
@ -2980,8 +2980,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba)
|
||||
|
||||
\overload
|
||||
|
||||
Returns true if byte array \a a1 is lexically less than string
|
||||
\a a2; otherwise returns false.
|
||||
Returns \c true if byte array \a a1 is lexically less than string
|
||||
\a a2; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*! \fn bool operator<(const char *a1, const QByteArray &a2)
|
||||
@ -2989,8 +2989,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba)
|
||||
|
||||
\overload
|
||||
|
||||
Returns true if string \a a1 is lexically less than byte array
|
||||
\a a2; otherwise returns false.
|
||||
Returns \c true if string \a a1 is lexically less than byte array
|
||||
\a a2; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*! \fn bool operator<=(const QByteArray &a1, const QByteArray &a2)
|
||||
@ -2998,8 +2998,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba)
|
||||
|
||||
\overload
|
||||
|
||||
Returns true if byte array \a a1 is lexically less than or equal
|
||||
to byte array \a a2; otherwise returns false.
|
||||
Returns \c true if byte array \a a1 is lexically less than or equal
|
||||
to byte array \a a2; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*! \fn bool operator<=(const QByteArray &a1, const char *a2)
|
||||
@ -3007,8 +3007,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba)
|
||||
|
||||
\overload
|
||||
|
||||
Returns true if byte array \a a1 is lexically less than or equal
|
||||
to string \a a2; otherwise returns false.
|
||||
Returns \c true if byte array \a a1 is lexically less than or equal
|
||||
to string \a a2; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*! \fn bool operator<=(const char *a1, const QByteArray &a2)
|
||||
@ -3016,8 +3016,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba)
|
||||
|
||||
\overload
|
||||
|
||||
Returns true if string \a a1 is lexically less than or equal
|
||||
to byte array \a a2; otherwise returns false.
|
||||
Returns \c true if string \a a1 is lexically less than or equal
|
||||
to byte array \a a2; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*! \fn bool operator>(const QByteArray &a1, const QByteArray &a2)
|
||||
@ -3025,8 +3025,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba)
|
||||
|
||||
\overload
|
||||
|
||||
Returns true if byte array \a a1 is lexically greater than byte
|
||||
array \a a2; otherwise returns false.
|
||||
Returns \c true if byte array \a a1 is lexically greater than byte
|
||||
array \a a2; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*! \fn bool operator>(const QByteArray &a1, const char *a2)
|
||||
@ -3034,8 +3034,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba)
|
||||
|
||||
\overload
|
||||
|
||||
Returns true if byte array \a a1 is lexically greater than string
|
||||
\a a2; otherwise returns false.
|
||||
Returns \c true if byte array \a a1 is lexically greater than string
|
||||
\a a2; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*! \fn bool operator>(const char *a1, const QByteArray &a2)
|
||||
@ -3043,8 +3043,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba)
|
||||
|
||||
\overload
|
||||
|
||||
Returns true if string \a a1 is lexically greater than byte array
|
||||
\a a2; otherwise returns false.
|
||||
Returns \c true if string \a a1 is lexically greater than byte array
|
||||
\a a2; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*! \fn bool operator>=(const QByteArray &a1, const QByteArray &a2)
|
||||
@ -3052,8 +3052,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba)
|
||||
|
||||
\overload
|
||||
|
||||
Returns true if byte array \a a1 is lexically greater than or
|
||||
equal to byte array \a a2; otherwise returns false.
|
||||
Returns \c true if byte array \a a1 is lexically greater than or
|
||||
equal to byte array \a a2; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*! \fn bool operator>=(const QByteArray &a1, const char *a2)
|
||||
@ -3061,8 +3061,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba)
|
||||
|
||||
\overload
|
||||
|
||||
Returns true if byte array \a a1 is lexically greater than or
|
||||
equal to string \a a2; otherwise returns false.
|
||||
Returns \c true if byte array \a a1 is lexically greater than or
|
||||
equal to string \a a2; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*! \fn bool operator>=(const char *a1, const QByteArray &a2)
|
||||
@ -3070,8 +3070,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba)
|
||||
|
||||
\overload
|
||||
|
||||
Returns true if string \a a1 is lexically greater than or
|
||||
equal to byte array \a a2; otherwise returns false.
|
||||
Returns \c true if string \a a1 is lexically greater than or
|
||||
equal to byte array \a a2; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*! \fn const QByteArray operator+(const QByteArray &a1, const QByteArray &a2)
|
||||
@ -3125,7 +3125,7 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba)
|
||||
replaced with a single space.
|
||||
|
||||
Whitespace means any character for which the standard C++
|
||||
isspace() function returns true. This includes the ASCII
|
||||
isspace() function returns \c true. This includes the ASCII
|
||||
characters '\\t', '\\n', '\\v', '\\f', '\\r', and ' '.
|
||||
|
||||
Example:
|
||||
@ -3163,7 +3163,7 @@ QByteArray QByteArray::simplified() const
|
||||
and the end.
|
||||
|
||||
Whitespace means any character for which the standard C++
|
||||
isspace() function returns true. This includes the ASCII
|
||||
isspace() function returns \c true. This includes the ASCII
|
||||
characters '\\t', '\\n', '\\v', '\\f', '\\r', and ' '.
|
||||
|
||||
Example:
|
||||
|
@ -134,8 +134,8 @@
|
||||
|
||||
/*! \fn bool QCache::isEmpty() const
|
||||
|
||||
Returns true if the cache contains no objects; otherwise
|
||||
returns false.
|
||||
Returns \c true if the cache contains no objects; otherwise
|
||||
returns \c false.
|
||||
|
||||
\sa size()
|
||||
*/
|
||||
@ -163,8 +163,8 @@
|
||||
deleted at any time. In particular, if \a cost is greater than
|
||||
maxCost(), the object will be deleted immediately.
|
||||
|
||||
The function returns true if the object was inserted into the
|
||||
cache; otherwise it returns false.
|
||||
The function returns \c true if the object was inserted into the
|
||||
cache; otherwise it returns \c false.
|
||||
|
||||
\sa take(), remove()
|
||||
*/
|
||||
@ -182,8 +182,8 @@
|
||||
|
||||
/*! \fn bool QCache::contains(const Key &key) const
|
||||
|
||||
Returns true if the cache contains an object associated with key \a
|
||||
key; otherwise returns false.
|
||||
Returns \c true if the cache contains an object associated with key \a
|
||||
key; otherwise returns \c false.
|
||||
|
||||
\sa take(), remove()
|
||||
*/
|
||||
@ -201,8 +201,8 @@
|
||||
|
||||
/*! \fn bool QCache::remove(const Key &key)
|
||||
|
||||
Deletes the object associated with key \a key. Returns true if the
|
||||
object was found in the cache; otherwise returns false.
|
||||
Deletes the object associated with key \a key. Returns \c true if the
|
||||
object was found in the cache; otherwise returns \c false.
|
||||
|
||||
\sa take(), clear()
|
||||
*/
|
||||
|
@ -115,7 +115,7 @@ QT_BEGIN_NAMESPACE
|
||||
operating on the full range of Unicode characters, not just for the ASCII
|
||||
range. They all return true if the character is a certain type of character;
|
||||
otherwise they return false. These classification functions are
|
||||
isNull() (returns true if the character is '\\0'), isPrint()
|
||||
isNull() (returns \c true if the character is '\\0'), isPrint()
|
||||
(true if the character is any sort of printable character,
|
||||
including whitespace), isPunct() (any sort of punctation),
|
||||
isMark() (Unicode Mark), isLetter() (a letter), isNumber() (any
|
||||
@ -123,7 +123,7 @@ QT_BEGIN_NAMESPACE
|
||||
isDigit() (decimal digits). All of these are wrappers around
|
||||
category() which return the Unicode-defined category of each
|
||||
character. Some of these also calculate the derived properties
|
||||
(for example isSpace() returns true if the character is of category
|
||||
(for example isSpace() returns \c true if the character is of category
|
||||
Separator_* or an exceptional code point from Other_Control category).
|
||||
|
||||
QChar also provides direction(), which indicates the "natural"
|
||||
@ -597,8 +597,8 @@ QT_BEGIN_NAMESPACE
|
||||
/*!
|
||||
\fn bool QChar::isNull() const
|
||||
|
||||
Returns true if the character is the Unicode character 0x0000
|
||||
('\\0'); otherwise returns false.
|
||||
Returns \c true if the character is the Unicode character 0x0000
|
||||
('\\0'); otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
@ -620,8 +620,8 @@ QT_BEGIN_NAMESPACE
|
||||
/*!
|
||||
\fn bool QChar::isPrint() const
|
||||
|
||||
Returns true if the character is a printable character; otherwise
|
||||
returns false. This is any character not of category Other_*.
|
||||
Returns \c true if the character is a printable character; otherwise
|
||||
returns \c false. This is any character not of category Other_*.
|
||||
|
||||
Note that this gives no indication of whether the character is
|
||||
available in a particular font.
|
||||
@ -631,8 +631,8 @@ QT_BEGIN_NAMESPACE
|
||||
\overload
|
||||
\since 5.0
|
||||
|
||||
Returns true if the UCS-4-encoded character specified by \a ucs4 is
|
||||
a printable character; otherwise returns false.
|
||||
Returns \c true if the UCS-4-encoded character specified by \a ucs4 is
|
||||
a printable character; otherwise returns \c false.
|
||||
This is any character not of category Other_*.
|
||||
|
||||
Note that this gives no indication of whether the character is
|
||||
@ -653,9 +653,9 @@ bool QChar::isPrint(uint ucs4)
|
||||
/*!
|
||||
\fn bool QChar::isSpace() const
|
||||
|
||||
Returns true if the character is a separator character
|
||||
Returns \c true if the character is a separator character
|
||||
(Separator_* categories or certain code points from Other_Control category);
|
||||
otherwise returns false.
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
@ -663,9 +663,9 @@ bool QChar::isPrint(uint ucs4)
|
||||
\overload
|
||||
\since 5.0
|
||||
|
||||
Returns true if the UCS-4-encoded character specified by \a ucs4 is
|
||||
Returns \c true if the UCS-4-encoded character specified by \a ucs4 is
|
||||
a separator character (Separator_* categories or certain code points
|
||||
from Other_Control category); otherwise returns false.
|
||||
from Other_Control category); otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
@ -684,8 +684,8 @@ bool QT_FASTCALL QChar::isSpace_helper(uint ucs4)
|
||||
/*!
|
||||
\fn bool QChar::isMark() const
|
||||
|
||||
Returns true if the character is a mark (Mark_* categories);
|
||||
otherwise returns false.
|
||||
Returns \c true if the character is a mark (Mark_* categories);
|
||||
otherwise returns \c false.
|
||||
|
||||
See QChar::Category for more information regarding marks.
|
||||
*/
|
||||
@ -694,8 +694,8 @@ bool QT_FASTCALL QChar::isSpace_helper(uint ucs4)
|
||||
\overload
|
||||
\since 5.0
|
||||
|
||||
Returns true if the UCS-4-encoded character specified by \a ucs4 is
|
||||
a mark (Mark_* categories); otherwise returns false.
|
||||
Returns \c true if the UCS-4-encoded character specified by \a ucs4 is
|
||||
a mark (Mark_* categories); otherwise returns \c false.
|
||||
*/
|
||||
bool QChar::isMark(uint ucs4)
|
||||
{
|
||||
@ -710,16 +710,16 @@ bool QChar::isMark(uint ucs4)
|
||||
/*!
|
||||
\fn bool QChar::isPunct() const
|
||||
|
||||
Returns true if the character is a punctuation mark (Punctuation_*
|
||||
categories); otherwise returns false.
|
||||
Returns \c true if the character is a punctuation mark (Punctuation_*
|
||||
categories); otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\overload
|
||||
\since 5.0
|
||||
|
||||
Returns true if the UCS-4-encoded character specified by \a ucs4 is
|
||||
a punctuation mark (Punctuation_* categories); otherwise returns false.
|
||||
Returns \c true if the UCS-4-encoded character specified by \a ucs4 is
|
||||
a punctuation mark (Punctuation_* categories); otherwise returns \c false.
|
||||
*/
|
||||
bool QChar::isPunct(uint ucs4)
|
||||
{
|
||||
@ -738,16 +738,16 @@ bool QChar::isPunct(uint ucs4)
|
||||
/*!
|
||||
\fn bool QChar::isSymbol() const
|
||||
|
||||
Returns true if the character is a symbol (Symbol_* categories);
|
||||
otherwise returns false.
|
||||
Returns \c true if the character is a symbol (Symbol_* categories);
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\overload
|
||||
\since 5.0
|
||||
|
||||
Returns true if the UCS-4-encoded character specified by \a ucs4 is
|
||||
a symbol (Symbol_* categories); otherwise returns false.
|
||||
Returns \c true if the UCS-4-encoded character specified by \a ucs4 is
|
||||
a symbol (Symbol_* categories); otherwise returns \c false.
|
||||
*/
|
||||
bool QChar::isSymbol(uint ucs4)
|
||||
{
|
||||
@ -763,8 +763,8 @@ bool QChar::isSymbol(uint ucs4)
|
||||
/*!
|
||||
\fn bool QChar::isLetter() const
|
||||
|
||||
Returns true if the character is a letter (Letter_* categories);
|
||||
otherwise returns false.
|
||||
Returns \c true if the character is a letter (Letter_* categories);
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
@ -772,8 +772,8 @@ bool QChar::isSymbol(uint ucs4)
|
||||
\overload
|
||||
\since 5.0
|
||||
|
||||
Returns true if the UCS-4-encoded character specified by \a ucs4 is
|
||||
a letter (Letter_* categories); otherwise returns false.
|
||||
Returns \c true if the UCS-4-encoded character specified by \a ucs4 is
|
||||
a letter (Letter_* categories); otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
@ -794,8 +794,8 @@ bool QT_FASTCALL QChar::isLetter_helper(uint ucs4)
|
||||
/*!
|
||||
\fn bool QChar::isNumber() const
|
||||
|
||||
Returns true if the character is a number (Number_* categories,
|
||||
not just 0-9); otherwise returns false.
|
||||
Returns \c true if the character is a number (Number_* categories,
|
||||
not just 0-9); otherwise returns \c false.
|
||||
|
||||
\sa isDigit()
|
||||
*/
|
||||
@ -805,8 +805,8 @@ bool QT_FASTCALL QChar::isLetter_helper(uint ucs4)
|
||||
\overload
|
||||
\since 5.0
|
||||
|
||||
Returns true if the UCS-4-encoded character specified by \a ucs4 is
|
||||
a number (Number_* categories, not just 0-9); otherwise returns false.
|
||||
Returns \c true if the UCS-4-encoded character specified by \a ucs4 is
|
||||
a number (Number_* categories, not just 0-9); otherwise returns \c false.
|
||||
|
||||
\sa isDigit()
|
||||
*/
|
||||
@ -827,8 +827,8 @@ bool QT_FASTCALL QChar::isNumber_helper(uint ucs4)
|
||||
/*!
|
||||
\fn bool QChar::isLetterOrNumber() const
|
||||
|
||||
Returns true if the character is a letter or number (Letter_* or
|
||||
Number_* categories); otherwise returns false.
|
||||
Returns \c true if the character is a letter or number (Letter_* or
|
||||
Number_* categories); otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
@ -836,8 +836,8 @@ bool QT_FASTCALL QChar::isNumber_helper(uint ucs4)
|
||||
\overload
|
||||
\since 5.0
|
||||
|
||||
Returns true if the UCS-4-encoded character specified by \a ucs4 is
|
||||
a letter or number (Letter_* or Number_* categories); otherwise returns false.
|
||||
Returns \c true if the UCS-4-encoded character specified by \a ucs4 is
|
||||
a letter or number (Letter_* or Number_* categories); otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
@ -861,8 +861,8 @@ bool QT_FASTCALL QChar::isLetterOrNumber_helper(uint ucs4)
|
||||
/*!
|
||||
\fn bool QChar::isDigit() const
|
||||
|
||||
Returns true if the character is a decimal digit
|
||||
(Number_DecimalDigit); otherwise returns false.
|
||||
Returns \c true if the character is a decimal digit
|
||||
(Number_DecimalDigit); otherwise returns \c false.
|
||||
|
||||
\sa isNumber()
|
||||
*/
|
||||
@ -872,8 +872,8 @@ bool QT_FASTCALL QChar::isLetterOrNumber_helper(uint ucs4)
|
||||
\overload
|
||||
\since 5.0
|
||||
|
||||
Returns true if the UCS-4-encoded character specified by \a ucs4 is
|
||||
a decimal digit (Number_DecimalDigit); otherwise returns false.
|
||||
Returns \c true if the UCS-4-encoded character specified by \a ucs4 is
|
||||
a decimal digit (Number_DecimalDigit); otherwise returns \c false.
|
||||
|
||||
\sa isNumber()
|
||||
*/
|
||||
@ -882,7 +882,7 @@ bool QT_FASTCALL QChar::isLetterOrNumber_helper(uint ucs4)
|
||||
\fn bool QChar::isNonCharacter() const
|
||||
\since 5.0
|
||||
|
||||
Returns true if the QChar is a non-character; false otherwise.
|
||||
Returns \c true if the QChar is a non-character; false otherwise.
|
||||
|
||||
Unicode has a certain number of code points that are classified
|
||||
as "non-characters:" that is, they can be used for internal purposes
|
||||
@ -894,14 +894,14 @@ bool QT_FASTCALL QChar::isLetterOrNumber_helper(uint ucs4)
|
||||
/*!
|
||||
\fn bool QChar::isHighSurrogate() const
|
||||
|
||||
Returns true if the QChar is the high part of a UTF16 surrogate
|
||||
Returns \c true if the QChar is the high part of a UTF16 surrogate
|
||||
(for example if its code point is in range [0xd800..0xdbff]); false otherwise.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bool QChar::isLowSurrogate() const
|
||||
|
||||
Returns true if the QChar is the low part of a UTF16 surrogate
|
||||
Returns \c true if the QChar is the low part of a UTF16 surrogate
|
||||
(for example if its code point is in range [0xdc00..0xdfff]); false otherwise.
|
||||
*/
|
||||
|
||||
@ -909,7 +909,7 @@ bool QT_FASTCALL QChar::isLetterOrNumber_helper(uint ucs4)
|
||||
\fn bool QChar::isSurrogate() const
|
||||
\since 5.0
|
||||
|
||||
Returns true if the QChar contains a code point that is in either
|
||||
Returns \c true if the QChar contains a code point that is in either
|
||||
the high or the low part of the UTF-16 surrogate range
|
||||
(for example if its code point is in range [0xd800..0xdfff]); false otherwise.
|
||||
*/
|
||||
@ -919,7 +919,7 @@ bool QT_FASTCALL QChar::isLetterOrNumber_helper(uint ucs4)
|
||||
\overload
|
||||
\since 5.0
|
||||
|
||||
Returns true if the UCS-4-encoded character specified by \a ucs4
|
||||
Returns \c true if the UCS-4-encoded character specified by \a ucs4
|
||||
is a non-character; false otherwise.
|
||||
|
||||
Unicode has a certain number of code points that are classified
|
||||
@ -933,7 +933,7 @@ bool QT_FASTCALL QChar::isLetterOrNumber_helper(uint ucs4)
|
||||
\fn static bool QChar::isHighSurrogate(uint ucs4)
|
||||
\overload
|
||||
|
||||
Returns true if the UCS-4-encoded character specified by \a ucs4
|
||||
Returns \c true if the UCS-4-encoded character specified by \a ucs4
|
||||
is the high part of a UTF16 surrogate
|
||||
(for example if its code point is in range [0xd800..0xdbff]); false otherwise.
|
||||
*/
|
||||
@ -942,7 +942,7 @@ bool QT_FASTCALL QChar::isLetterOrNumber_helper(uint ucs4)
|
||||
\fn static bool QChar::isLowSurrogate(uint ucs4)
|
||||
\overload
|
||||
|
||||
Returns true if the UCS-4-encoded character specified by \a ucs4
|
||||
Returns \c true if the UCS-4-encoded character specified by \a ucs4
|
||||
is the low part of a UTF16 surrogate
|
||||
(for example if its code point is in range [0xdc00..0xdfff]); false otherwise.
|
||||
*/
|
||||
@ -952,7 +952,7 @@ bool QT_FASTCALL QChar::isLetterOrNumber_helper(uint ucs4)
|
||||
\overload
|
||||
\since 5.0
|
||||
|
||||
Returns true if the UCS-4-encoded character specified by \a ucs4
|
||||
Returns \c true if the UCS-4-encoded character specified by \a ucs4
|
||||
contains a code point that is in either the high or the low part of the
|
||||
UTF-16 surrogate range (for example if its code point is in range [0xd800..0xdfff]);
|
||||
false otherwise.
|
||||
@ -961,7 +961,7 @@ bool QT_FASTCALL QChar::isLetterOrNumber_helper(uint ucs4)
|
||||
/*!
|
||||
\fn static bool QChar::requiresSurrogates(uint ucs4)
|
||||
|
||||
Returns true if the UCS-4-encoded character specified by \a ucs4
|
||||
Returns \c true if the UCS-4-encoded character specified by \a ucs4
|
||||
can be split into the high and low parts of a UTF16 surrogate
|
||||
(for example if its code point is greater than or equals to 0x10000);
|
||||
false otherwise.
|
||||
@ -1069,8 +1069,8 @@ QChar::Joining QChar::joining(uint ucs4)
|
||||
/*!
|
||||
\fn bool QChar::hasMirrored() const
|
||||
|
||||
Returns true if the character should be reversed if the text
|
||||
direction is reversed; otherwise returns false.
|
||||
Returns \c true if the character should be reversed if the text
|
||||
direction is reversed; otherwise returns \c false.
|
||||
|
||||
A bit faster equivalent of (ch.mirroredChar() != ch).
|
||||
|
||||
@ -1081,8 +1081,8 @@ QChar::Joining QChar::joining(uint ucs4)
|
||||
\overload
|
||||
\since 5.0
|
||||
|
||||
Returns true if the UCS-4-encoded character specified by \a ucs4
|
||||
should be reversed if the text direction is reversed; otherwise returns false.
|
||||
Returns \c true if the UCS-4-encoded character specified by \a ucs4
|
||||
should be reversed if the text direction is reversed; otherwise returns \c false.
|
||||
|
||||
A bit faster equivalent of (QChar::mirroredChar(ucs4) != ucs4).
|
||||
|
||||
@ -1098,7 +1098,7 @@ bool QChar::hasMirrored(uint ucs4)
|
||||
/*!
|
||||
\fn bool QChar::isLower() const
|
||||
|
||||
Returns true if the character is a lowercase letter, for example
|
||||
Returns \c true if the character is a lowercase letter, for example
|
||||
category() is Letter_Lowercase.
|
||||
|
||||
\sa isUpper(), toLower(), toUpper()
|
||||
@ -1109,7 +1109,7 @@ bool QChar::hasMirrored(uint ucs4)
|
||||
\overload
|
||||
\since 5.0
|
||||
|
||||
Returns true if the UCS-4-encoded character specified by \a ucs4
|
||||
Returns \c true if the UCS-4-encoded character specified by \a ucs4
|
||||
is a lowercase letter, for example category() is Letter_Lowercase.
|
||||
|
||||
\sa isUpper(), toLower(), toUpper()
|
||||
@ -1118,7 +1118,7 @@ bool QChar::hasMirrored(uint ucs4)
|
||||
/*!
|
||||
\fn bool QChar::isUpper() const
|
||||
|
||||
Returns true if the character is an uppercase letter, for example
|
||||
Returns \c true if the character is an uppercase letter, for example
|
||||
category() is Letter_Uppercase.
|
||||
|
||||
\sa isLower(), toUpper(), toLower()
|
||||
@ -1129,7 +1129,7 @@ bool QChar::hasMirrored(uint ucs4)
|
||||
\overload
|
||||
\since 5.0
|
||||
|
||||
Returns true if the UCS-4-encoded character specified by \a ucs4
|
||||
Returns \c true if the UCS-4-encoded character specified by \a ucs4
|
||||
is an uppercase letter, for example category() is Letter_Uppercase.
|
||||
|
||||
\sa isLower(), toUpper(), toLower()
|
||||
@ -1138,7 +1138,7 @@ bool QChar::hasMirrored(uint ucs4)
|
||||
/*!
|
||||
\fn bool QChar::isTitleCase() const
|
||||
|
||||
Returns true if the character is a titlecase letter, for example
|
||||
Returns \c true if the character is a titlecase letter, for example
|
||||
category() is Letter_Titlecase.
|
||||
|
||||
\sa isLower(), toUpper(), toLower(), toTitleCase()
|
||||
@ -1149,7 +1149,7 @@ bool QChar::hasMirrored(uint ucs4)
|
||||
\overload
|
||||
\since 5.0
|
||||
|
||||
Returns true if the UCS-4-encoded character specified by \a ucs4
|
||||
Returns \c true if the UCS-4-encoded character specified by \a ucs4
|
||||
is a titlecase letter, for example category() is Letter_Titlecase.
|
||||
|
||||
\sa isLower(), toUpper(), toLower(), toTitleCase()
|
||||
@ -1586,8 +1586,8 @@ QDataStream &operator>>(QDataStream &in, QChar &chr)
|
||||
|
||||
\relates QChar
|
||||
|
||||
Returns true if \a c1 and \a c2 are the same Unicode character;
|
||||
otherwise returns false.
|
||||
Returns \c true if \a c1 and \a c2 are the same Unicode character;
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
@ -1595,8 +1595,8 @@ QDataStream &operator>>(QDataStream &in, QChar &chr)
|
||||
|
||||
\relates QChar
|
||||
|
||||
Returns true if \a c1 and \a c2 are not the same Unicode
|
||||
character; otherwise returns false.
|
||||
Returns \c true if \a c1 and \a c2 are not the same Unicode
|
||||
character; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
@ -1604,8 +1604,8 @@ QDataStream &operator>>(QDataStream &in, QChar &chr)
|
||||
|
||||
\relates QChar
|
||||
|
||||
Returns true if the numeric Unicode value of \a c1 is less than
|
||||
or equal to that of \a c2; otherwise returns false.
|
||||
Returns \c true if the numeric Unicode value of \a c1 is less than
|
||||
or equal to that of \a c2; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
@ -1613,8 +1613,8 @@ QDataStream &operator>>(QDataStream &in, QChar &chr)
|
||||
|
||||
\relates QChar
|
||||
|
||||
Returns true if the numeric Unicode value of \a c1 is greater than
|
||||
or equal to that of \a c2; otherwise returns false.
|
||||
Returns \c true if the numeric Unicode value of \a c1 is greater than
|
||||
or equal to that of \a c2; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
@ -1622,8 +1622,8 @@ QDataStream &operator>>(QDataStream &in, QChar &chr)
|
||||
|
||||
\relates QChar
|
||||
|
||||
Returns true if the numeric Unicode value of \a c1 is less than
|
||||
that of \a c2; otherwise returns false.
|
||||
Returns \c true if the numeric Unicode value of \a c1 is less than
|
||||
that of \a c2; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
@ -1631,8 +1631,8 @@ QDataStream &operator>>(QDataStream &in, QChar &chr)
|
||||
|
||||
\relates QChar
|
||||
|
||||
Returns true if the numeric Unicode value of \a c1 is greater than
|
||||
that of \a c2; otherwise returns false.
|
||||
Returns \c true if the numeric Unicode value of \a c1 is greater than
|
||||
that of \a c2; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
|
||||
|
@ -184,7 +184,7 @@ QLocale QCollator::locale() const
|
||||
/*!
|
||||
\fn bool QCollator::numericMode() const
|
||||
|
||||
Returns true if numeric sorting is enabled, false otherwise.
|
||||
Returns \c true if numeric sorting is enabled, false otherwise.
|
||||
|
||||
\sa setNumericMode()
|
||||
*/
|
||||
@ -202,7 +202,7 @@ QLocale QCollator::locale() const
|
||||
/*!
|
||||
\fn bool QCollator::ignorePunctuation() const
|
||||
|
||||
Returns true if punctuation characters and symbols are ignored when determining sort order.
|
||||
Returns \c true if punctuation characters and symbols are ignored when determining sort order.
|
||||
|
||||
\sa setIgnorePunctuation()
|
||||
*/
|
||||
@ -303,8 +303,8 @@ QCollatorSortKey& QCollatorSortKey::operator=(const QCollatorSortKey &other)
|
||||
/*!
|
||||
\fn bool QCollatorSortKey::operator<(const QCollatorSortKey &otherKey) const
|
||||
|
||||
According to the QCollator that created the key, returns true if the
|
||||
key should be sorted before than \a otherKey; otherwise returns false.
|
||||
According to the QCollator that created the key, returns \c true if the
|
||||
key should be sorted before than \a otherKey; otherwise returns \c false.
|
||||
|
||||
\sa compare()
|
||||
*/
|
||||
|
@ -242,7 +242,7 @@ void QCommandLineParser::setSingleDashWordOptionMode(QCommandLineParser::SingleD
|
||||
/*!
|
||||
Adds the option \a option to look for while parsing.
|
||||
|
||||
Returns true if adding the option was successful; otherwise returns false.
|
||||
Returns \c true if adding the option was successful; otherwise returns \c false.
|
||||
|
||||
Adding the option fails if there is no name attached to the option, or
|
||||
the option has a name that clashes with an option name added before.
|
||||
@ -370,7 +370,7 @@ void QCommandLineParser::clearPositionalArguments()
|
||||
Most programs don't need to call this, a simple call to process() is enough.
|
||||
|
||||
parse() is more low-level, and only does the parsing. The application will have to
|
||||
take care of the error handling, using errorText() if parse() returns false.
|
||||
take care of the error handling, using errorText() if parse() returns \c false.
|
||||
This can be useful for instance to show a graphical error message in graphical programs.
|
||||
|
||||
Calling parse() instead of process() can also be useful in order to ignore unknown
|
||||
@ -379,7 +379,7 @@ void QCommandLineParser::clearPositionalArguments()
|
||||
|
||||
Don't forget that \a arguments must start with the name of the executable (ignored, though).
|
||||
|
||||
Returns false in case of a parse error (unknown option or missing value); returns true otherwise.
|
||||
Returns \c false in case of a parse error (unknown option or missing value); returns \c true otherwise.
|
||||
|
||||
\sa process()
|
||||
*/
|
||||
@ -390,7 +390,7 @@ bool QCommandLineParser::parse(const QStringList &arguments)
|
||||
|
||||
/*!
|
||||
Returns a translated error text for the user.
|
||||
This should only be called when parse() returns false.
|
||||
This should only be called when parse() returns \c false.
|
||||
*/
|
||||
QString QCommandLineParser::errorText() const
|
||||
{
|
||||
@ -453,7 +453,7 @@ void QCommandLineParserPrivate::checkParsed(const char *method)
|
||||
/*!
|
||||
\internal
|
||||
Looks up the option \a optionName (found on the command line) and register it as found.
|
||||
Returns true on success.
|
||||
Returns \c true on success.
|
||||
*/
|
||||
bool QCommandLineParserPrivate::registerFoundOption(const QString &optionName)
|
||||
{
|
||||
@ -476,7 +476,7 @@ bool QCommandLineParserPrivate::registerFoundOption(const QString &optionName)
|
||||
\param argument the argument from the command line currently parsed. Only used for -k=value parsing.
|
||||
\param argumentIterator iterator to the currently parsed argument. Incremented if the next argument contains the value.
|
||||
\param argsEnd args.end(), to check if ++argumentIterator goes out of bounds
|
||||
Returns true on success.
|
||||
Returns \c true on success.
|
||||
*/
|
||||
bool QCommandLineParserPrivate::parseOptionValue(const QString &optionName, const QString &argument,
|
||||
QStringList::const_iterator *argumentIterator, QStringList::const_iterator argsEnd)
|
||||
@ -620,7 +620,7 @@ bool QCommandLineParserPrivate::parse(const QStringList &args)
|
||||
/*!
|
||||
Checks whether the option \a name was passed to the application.
|
||||
|
||||
Returns true if the option \a name was set, false otherwise.
|
||||
Returns \c true if the option \a name was set, false otherwise.
|
||||
|
||||
The name provided can be any long or short name of any option that was
|
||||
added with \c addOption(). All the options names are treated as being
|
||||
@ -711,7 +711,7 @@ QStringList QCommandLineParser::values(const QString &optionName) const
|
||||
\overload
|
||||
Checks whether the \a option was passed to the application.
|
||||
|
||||
Returns true if the \a option was set, false otherwise.
|
||||
Returns \c true if the \a option was set, false otherwise.
|
||||
|
||||
This is the recommended way to check for options with no values.
|
||||
|
||||
|
@ -219,7 +219,7 @@ MyRecord record(int row) const
|
||||
|
||||
/*! \fn bool QContiguousCache::operator==(const QContiguousCache<T> &other) const
|
||||
|
||||
Returns true if \a other is equal to this cache; otherwise returns false.
|
||||
Returns \c true if \a other is equal to this cache; otherwise returns \c false.
|
||||
|
||||
Two caches are considered equal if they contain the same values at the same
|
||||
indexes. This function requires the value type to implement the \c operator==().
|
||||
@ -229,8 +229,8 @@ MyRecord record(int row) const
|
||||
|
||||
/*! \fn bool QContiguousCache::operator!=(const QContiguousCache<T> &other) const
|
||||
|
||||
Returns true if \a other is not equal to this cache; otherwise
|
||||
returns false.
|
||||
Returns \c true if \a other is not equal to this cache; otherwise
|
||||
returns \c false.
|
||||
|
||||
Two caches are considered equal if they contain the same values at the same
|
||||
indexes. This function requires the value type to implement the \c operator==().
|
||||
@ -261,14 +261,14 @@ MyRecord record(int row) const
|
||||
|
||||
/*! \fn bool QContiguousCache::isEmpty() const
|
||||
|
||||
Returns true if no items are stored within the cache.
|
||||
Returns \c true if no items are stored within the cache.
|
||||
|
||||
\sa size(), capacity()
|
||||
*/
|
||||
|
||||
/*! \fn bool QContiguousCache::isFull() const
|
||||
|
||||
Returns true if the number of items stored within the cache is equal
|
||||
Returns \c true if the number of items stored within the cache is equal
|
||||
to the capacity of the cache.
|
||||
|
||||
\sa size(), capacity()
|
||||
@ -373,7 +373,7 @@ MyRecord record(int row) const
|
||||
|
||||
/*! \fn bool QContiguousCache::containsIndex(int i) const
|
||||
|
||||
Returns true if the cache's index range includes the given index \a i.
|
||||
Returns \c true if the cache's index range includes the given index \a i.
|
||||
|
||||
\sa firstIndex(), lastIndex()
|
||||
*/
|
||||
|
@ -326,7 +326,7 @@ void QCryptographicHash::addData(const QByteArray &data)
|
||||
|
||||
/*!
|
||||
Reads the data from the open QIODevice \a device until it ends
|
||||
and hashes it. Returns true if reading was successful.
|
||||
and hashes it. Returns \c true if reading was successful.
|
||||
\since 5.0
|
||||
*/
|
||||
bool QCryptographicHash::addData(QIODevice* device)
|
||||
|
@ -383,7 +383,7 @@ static int fromOffsetString(const QString &offsetString, bool *valid)
|
||||
Constructs a date with year \a y, month \a m and day \a d.
|
||||
|
||||
If the specified date is invalid, the date is not set and
|
||||
isValid() returns false.
|
||||
isValid() returns \c false.
|
||||
|
||||
\warning Years 1 to 99 are interpreted as is. Year 0 is invalid.
|
||||
|
||||
@ -399,7 +399,7 @@ QDate::QDate(int y, int m, int d)
|
||||
/*!
|
||||
\fn bool QDate::isNull() const
|
||||
|
||||
Returns true if the date is null; otherwise returns false. A null
|
||||
Returns \c true if the date is null; otherwise returns \c false. A null
|
||||
date is invalid.
|
||||
|
||||
\note The behavior of this function is equivalent to isValid().
|
||||
@ -411,7 +411,7 @@ QDate::QDate(int y, int m, int d)
|
||||
/*!
|
||||
\fn bool QDate::isValid() const
|
||||
|
||||
Returns true if this date is valid; otherwise returns false.
|
||||
Returns \c true if this date is valid; otherwise returns \c false.
|
||||
|
||||
\sa isNull()
|
||||
*/
|
||||
@ -983,8 +983,8 @@ QString QDate::toString(const QString& format) const
|
||||
/*!
|
||||
\since 4.2
|
||||
|
||||
Sets the date's \a year, \a month, and \a day. Returns true if
|
||||
the date is valid; otherwise returns false.
|
||||
Sets the date's \a year, \a month, and \a day. Returns \c true if
|
||||
the date is valid; otherwise returns \c false.
|
||||
|
||||
If the specified date is invalid, the QDate object is set to be
|
||||
invalid.
|
||||
@ -1162,7 +1162,7 @@ qint64 QDate::daysTo(const QDate &d) const
|
||||
/*!
|
||||
\fn bool QDate::operator==(const QDate &d) const
|
||||
|
||||
Returns true if this date is equal to \a d; otherwise returns
|
||||
Returns \c true if this date is equal to \a d; otherwise returns
|
||||
false.
|
||||
|
||||
*/
|
||||
@ -1170,36 +1170,36 @@ qint64 QDate::daysTo(const QDate &d) const
|
||||
/*!
|
||||
\fn bool QDate::operator!=(const QDate &d) const
|
||||
|
||||
Returns true if this date is different from \a d; otherwise
|
||||
returns false.
|
||||
Returns \c true if this date is different from \a d; otherwise
|
||||
returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bool QDate::operator<(const QDate &d) const
|
||||
|
||||
Returns true if this date is earlier than \a d; otherwise returns
|
||||
Returns \c true if this date is earlier than \a d; otherwise returns
|
||||
false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bool QDate::operator<=(const QDate &d) const
|
||||
|
||||
Returns true if this date is earlier than or equal to \a d;
|
||||
otherwise returns false.
|
||||
Returns \c true if this date is earlier than or equal to \a d;
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bool QDate::operator>(const QDate &d) const
|
||||
|
||||
Returns true if this date is later than \a d; otherwise returns
|
||||
Returns \c true if this date is later than \a d; otherwise returns
|
||||
false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bool QDate::operator>=(const QDate &d) const
|
||||
|
||||
Returns true if this date is later than or equal to \a d;
|
||||
otherwise returns false.
|
||||
Returns \c true if this date is later than or equal to \a d;
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
@ -1373,8 +1373,8 @@ QDate QDate::fromString(const QString &string, const QString &format)
|
||||
/*!
|
||||
\overload
|
||||
|
||||
Returns true if the specified date (\a year, \a month, and \a
|
||||
day) is valid; otherwise returns false.
|
||||
Returns \c true if the specified date (\a year, \a month, and \a
|
||||
day) is valid; otherwise returns \c false.
|
||||
|
||||
Example:
|
||||
\snippet code/src_corelib_tools_qdatetime.cpp 4
|
||||
@ -1395,8 +1395,8 @@ bool QDate::isValid(int year, int month, int day)
|
||||
/*!
|
||||
\fn bool QDate::isLeapYear(int year)
|
||||
|
||||
Returns true if the specified \a year is a leap year; otherwise
|
||||
returns false.
|
||||
Returns \c true if the specified \a year is a leap year; otherwise
|
||||
returns \c false.
|
||||
*/
|
||||
|
||||
bool QDate::isLeapYear(int y)
|
||||
@ -1475,8 +1475,8 @@ bool QDate::isLeapYear(int y)
|
||||
\fn QTime::QTime()
|
||||
|
||||
Constructs a null time object. A null time can be a QTime(0, 0, 0, 0)
|
||||
(i.e., midnight) object, except that isNull() returns true and isValid()
|
||||
returns false.
|
||||
(i.e., midnight) object, except that isNull() returns \c true and isValid()
|
||||
returns \c false.
|
||||
|
||||
\sa isNull(), isValid()
|
||||
*/
|
||||
@ -1500,7 +1500,7 @@ QTime::QTime(int h, int m, int s, int ms)
|
||||
/*!
|
||||
\fn bool QTime::isNull() const
|
||||
|
||||
Returns true if the time is null (i.e., the QTime object was
|
||||
Returns \c true if the time is null (i.e., the QTime object was
|
||||
constructed using the default constructor); otherwise returns
|
||||
false. A null time is also an invalid time.
|
||||
|
||||
@ -1508,7 +1508,7 @@ QTime::QTime(int h, int m, int s, int ms)
|
||||
*/
|
||||
|
||||
/*!
|
||||
Returns true if the time is valid; otherwise returns false. For example,
|
||||
Returns \c true if the time is valid; otherwise returns \c false. For example,
|
||||
the time 23:30:55.746 is valid, but 24:12:30 is invalid.
|
||||
|
||||
\sa isNull()
|
||||
@ -1709,7 +1709,7 @@ QString QTime::toString(const QString& format) const
|
||||
|
||||
\a h must be in the range 0 to 23, \a m and \a s must be in the
|
||||
range 0 to 59, and \a ms must be in the range 0 to 999.
|
||||
Returns true if the set time is valid; otherwise returns false.
|
||||
Returns \c true if the set time is valid; otherwise returns \c false.
|
||||
|
||||
\sa isValid()
|
||||
*/
|
||||
@ -1835,39 +1835,39 @@ int QTime::msecsTo(const QTime &t) const
|
||||
/*!
|
||||
\fn bool QTime::operator==(const QTime &t) const
|
||||
|
||||
Returns true if this time is equal to \a t; otherwise returns false.
|
||||
Returns \c true if this time is equal to \a t; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bool QTime::operator!=(const QTime &t) const
|
||||
|
||||
Returns true if this time is different from \a t; otherwise returns false.
|
||||
Returns \c true if this time is different from \a t; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bool QTime::operator<(const QTime &t) const
|
||||
|
||||
Returns true if this time is earlier than \a t; otherwise returns false.
|
||||
Returns \c true if this time is earlier than \a t; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bool QTime::operator<=(const QTime &t) const
|
||||
|
||||
Returns true if this time is earlier than or equal to \a t;
|
||||
otherwise returns false.
|
||||
Returns \c true if this time is earlier than or equal to \a t;
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bool QTime::operator>(const QTime &t) const
|
||||
|
||||
Returns true if this time is later than \a t; otherwise returns false.
|
||||
Returns \c true if this time is later than \a t; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bool QTime::operator>=(const QTime &t) const
|
||||
|
||||
Returns true if this time is later than or equal to \a t;
|
||||
otherwise returns false.
|
||||
Returns \c true if this time is later than or equal to \a t;
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
@ -2074,7 +2074,7 @@ QTime QTime::fromString(const QString &string, const QString &format)
|
||||
/*!
|
||||
\overload
|
||||
|
||||
Returns true if the specified time is valid; otherwise returns
|
||||
Returns \c true if the specified time is valid; otherwise returns
|
||||
false.
|
||||
|
||||
The time is valid if \a h is in the range 0 to 23, \a m and
|
||||
@ -3060,8 +3060,8 @@ QDateTime &QDateTime::operator=(const QDateTime &other)
|
||||
*/
|
||||
|
||||
/*!
|
||||
Returns true if both the date and the time are null; otherwise
|
||||
returns false. A null datetime is invalid.
|
||||
Returns \c true if both the date and the time are null; otherwise
|
||||
returns \c false. A null datetime is invalid.
|
||||
|
||||
\sa QDate::isNull(), QTime::isNull(), isValid()
|
||||
*/
|
||||
@ -3072,8 +3072,8 @@ bool QDateTime::isNull() const
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if both the date and the time are valid and they are valid in
|
||||
the current Qt::TimeSpec, otherwise returns false.
|
||||
Returns \c true if both the date and the time are valid and they are valid in
|
||||
the current Qt::TimeSpec, otherwise returns \c false.
|
||||
|
||||
If the timeSpec() is Qt::LocalTime or Qt::TimeZone then the date and time are
|
||||
checked to see if they fall in the Standard Time to Daylight Time transition
|
||||
@ -3958,8 +3958,8 @@ QDateTime QDateTime::toTimeZone(const QTimeZone &timeZone) const
|
||||
#endif // QT_BOOTSTRAPPED
|
||||
|
||||
/*!
|
||||
Returns true if this datetime is equal to the \a other datetime;
|
||||
otherwise returns false.
|
||||
Returns \c true if this datetime is equal to the \a other datetime;
|
||||
otherwise returns \c false.
|
||||
|
||||
\sa operator!=()
|
||||
*/
|
||||
@ -3978,8 +3978,8 @@ bool QDateTime::operator==(const QDateTime &other) const
|
||||
/*!
|
||||
\fn bool QDateTime::operator!=(const QDateTime &other) const
|
||||
|
||||
Returns true if this datetime is different from the \a other
|
||||
datetime; otherwise returns false.
|
||||
Returns \c true if this datetime is different from the \a other
|
||||
datetime; otherwise returns \c false.
|
||||
|
||||
Two datetimes are different if either the date, the time, or the
|
||||
time zone components are different.
|
||||
@ -3988,8 +3988,8 @@ bool QDateTime::operator==(const QDateTime &other) const
|
||||
*/
|
||||
|
||||
/*!
|
||||
Returns true if this datetime is earlier than the \a other
|
||||
datetime; otherwise returns false.
|
||||
Returns \c true if this datetime is earlier than the \a other
|
||||
datetime; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
bool QDateTime::operator<(const QDateTime &other) const
|
||||
@ -4006,22 +4006,22 @@ bool QDateTime::operator<(const QDateTime &other) const
|
||||
/*!
|
||||
\fn bool QDateTime::operator<=(const QDateTime &other) const
|
||||
|
||||
Returns true if this datetime is earlier than or equal to the
|
||||
\a other datetime; otherwise returns false.
|
||||
Returns \c true if this datetime is earlier than or equal to the
|
||||
\a other datetime; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bool QDateTime::operator>(const QDateTime &other) const
|
||||
|
||||
Returns true if this datetime is later than the \a other datetime;
|
||||
otherwise returns false.
|
||||
Returns \c true if this datetime is later than the \a other datetime;
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bool QDateTime::operator>=(const QDateTime &other) const
|
||||
|
||||
Returns true if this datetime is later than or equal to the
|
||||
\a other datetime; otherwise returns false.
|
||||
Returns \c true if this datetime is later than or equal to the
|
||||
\a other datetime; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
|
@ -340,8 +340,8 @@ static QString unquote(const QString &str)
|
||||
/*!
|
||||
\internal
|
||||
|
||||
Parses the format \a newFormat. If successful, returns true and
|
||||
sets up the format. Else keeps the old format and returns false.
|
||||
Parses the format \a newFormat. If successful, returns \c true and
|
||||
sets up the format. Else keeps the old format and returns \c false.
|
||||
|
||||
*/
|
||||
|
||||
@ -1587,7 +1587,7 @@ QString QDateTimeParser::sectionFormat(Section s, int count) const
|
||||
/*!
|
||||
\internal
|
||||
|
||||
Returns true if str can be modified to represent a
|
||||
Returns \c true if str can be modified to represent a
|
||||
number that is within min and max.
|
||||
*/
|
||||
|
||||
|
@ -1123,7 +1123,7 @@ QEasingCurve::~QEasingCurve()
|
||||
*/
|
||||
|
||||
/*!
|
||||
Compare this easing curve with \a other and returns true if they are
|
||||
Compare this easing curve with \a other and returns \c true if they are
|
||||
equal. It will also compare the properties of a curve.
|
||||
*/
|
||||
bool QEasingCurve::operator==(const QEasingCurve &other) const
|
||||
@ -1147,7 +1147,7 @@ bool QEasingCurve::operator==(const QEasingCurve &other) const
|
||||
|
||||
/*!
|
||||
\fn bool QEasingCurve::operator!=(const QEasingCurve &other) const
|
||||
Compare this easing curve with \a other and returns true if they are not equal.
|
||||
Compare this easing curve with \a other and returns \c true if they are not equal.
|
||||
It will also compare the properties of a curve.
|
||||
|
||||
\sa operator==()
|
||||
|
@ -204,13 +204,13 @@ QT_BEGIN_NAMESPACE
|
||||
/*!
|
||||
\fn bool QElapsedTimer::operator ==(const QElapsedTimer &other) const
|
||||
|
||||
Returns true if this object and \a other contain the same time.
|
||||
Returns \c true if this object and \a other contain the same time.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bool QElapsedTimer::operator !=(const QElapsedTimer &other) const
|
||||
|
||||
Returns true if this object and \a other contain different times.
|
||||
Returns \c true if this object and \a other contain different times.
|
||||
*/
|
||||
|
||||
static const qint64 invalidData = Q_INT64_C(0x8000000000000000);
|
||||
@ -230,7 +230,7 @@ void QElapsedTimer::invalidate() Q_DECL_NOTHROW
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns false if this object was invalidated by a call to invalidate() and
|
||||
Returns \c false if this object was invalidated by a call to invalidate() and
|
||||
has not been restarted since.
|
||||
|
||||
\sa invalidate(), start(), restart()
|
||||
@ -241,7 +241,7 @@ bool QElapsedTimer::isValid() const Q_DECL_NOTHROW
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if this QElapsedTimer has already expired by \a timeout
|
||||
Returns \c true if this QElapsedTimer has already expired by \a timeout
|
||||
milliseconds (that is, more than \a timeout milliseconds have elapsed).
|
||||
The value of \a timeout can be -1 to indicate that this timer does not
|
||||
expire, in which case this function will always return false.
|
||||
|
@ -55,7 +55,7 @@ QElapsedTimer::ClockType QElapsedTimer::clockType() Q_DECL_NOTHROW
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns true if this is a monotonic clock, false otherwise. See the
|
||||
Returns \c true if this is a monotonic clock, false otherwise. See the
|
||||
information on the different clock types to understand which ones are
|
||||
monotonic.
|
||||
|
||||
@ -180,7 +180,7 @@ qint64 QElapsedTimer::secsTo(const QElapsedTimer &other) const Q_DECL_NOTHROW
|
||||
/*!
|
||||
\relates QElapsedTimer
|
||||
|
||||
Returns true if \a v1 was started before \a v2, false otherwise.
|
||||
Returns \c true if \a v1 was started before \a v2, false otherwise.
|
||||
|
||||
The returned value is undefined if one of the two parameters is invalid
|
||||
and the other isn't. However, two invalid timers are equal and thus this
|
||||
|
@ -1007,7 +1007,7 @@ void QHashData::checkSanity()
|
||||
|
||||
/*! \fn bool QHash::operator==(const QHash<Key, T> &other) const
|
||||
|
||||
Returns true if \a other is equal to this hash; otherwise returns
|
||||
Returns \c true if \a other is equal to this hash; otherwise returns
|
||||
false.
|
||||
|
||||
Two hashes are considered equal if they contain the same (key,
|
||||
@ -1020,8 +1020,8 @@ void QHashData::checkSanity()
|
||||
|
||||
/*! \fn bool QHash::operator!=(const QHash<Key, T> &other) const
|
||||
|
||||
Returns true if \a other is not equal to this hash; otherwise
|
||||
returns false.
|
||||
Returns \c true if \a other is not equal to this hash; otherwise
|
||||
returns \c false.
|
||||
|
||||
Two hashes are considered equal if they contain the same (key,
|
||||
value) pairs.
|
||||
@ -1040,7 +1040,7 @@ void QHashData::checkSanity()
|
||||
|
||||
/*! \fn bool QHash::isEmpty() const
|
||||
|
||||
Returns true if the hash contains no items; otherwise returns
|
||||
Returns \c true if the hash contains no items; otherwise returns
|
||||
false.
|
||||
|
||||
\sa size()
|
||||
@ -1107,8 +1107,8 @@ void QHashData::checkSanity()
|
||||
|
||||
\internal
|
||||
|
||||
Returns true if the hash's internal data isn't shared with any
|
||||
other hash object; otherwise returns false.
|
||||
Returns \c true if the hash's internal data isn't shared with any
|
||||
other hash object; otherwise returns \c false.
|
||||
|
||||
\sa detach()
|
||||
*/
|
||||
@ -1157,8 +1157,8 @@ void QHashData::checkSanity()
|
||||
|
||||
/*! \fn bool QHash::contains(const Key &key) const
|
||||
|
||||
Returns true if the hash contains an item with the \a key;
|
||||
otherwise returns false.
|
||||
Returns \c true if the hash contains an item with the \a key;
|
||||
otherwise returns \c false.
|
||||
|
||||
\sa count(), QMultiHash::contains()
|
||||
*/
|
||||
@ -1453,7 +1453,7 @@ void QHashData::checkSanity()
|
||||
|
||||
This function is provided for STL compatibility. It is equivalent
|
||||
to isEmpty(), returning true if the hash is empty; otherwise
|
||||
returns false.
|
||||
returns \c false.
|
||||
*/
|
||||
|
||||
/*! \typedef QHash::ConstIterator
|
||||
@ -1656,8 +1656,8 @@ void QHashData::checkSanity()
|
||||
\fn bool QHash::iterator::operator==(const iterator &other) const
|
||||
\fn bool QHash::iterator::operator==(const const_iterator &other) const
|
||||
|
||||
Returns true if \a other points to the same item as this
|
||||
iterator; otherwise returns false.
|
||||
Returns \c true if \a other points to the same item as this
|
||||
iterator; otherwise returns \c false.
|
||||
|
||||
\sa operator!=()
|
||||
*/
|
||||
@ -1666,8 +1666,8 @@ void QHashData::checkSanity()
|
||||
\fn bool QHash::iterator::operator!=(const iterator &other) const
|
||||
\fn bool QHash::iterator::operator!=(const const_iterator &other) const
|
||||
|
||||
Returns true if \a other points to a different item than this
|
||||
iterator; otherwise returns false.
|
||||
Returns \c true if \a other points to a different item than this
|
||||
iterator; otherwise returns \c false.
|
||||
|
||||
\sa operator==()
|
||||
*/
|
||||
@ -1847,16 +1847,16 @@ void QHashData::checkSanity()
|
||||
|
||||
/*! \fn bool QHash::const_iterator::operator==(const const_iterator &other) const
|
||||
|
||||
Returns true if \a other points to the same item as this
|
||||
iterator; otherwise returns false.
|
||||
Returns \c true if \a other points to the same item as this
|
||||
iterator; otherwise returns \c false.
|
||||
|
||||
\sa operator!=()
|
||||
*/
|
||||
|
||||
/*! \fn bool QHash::const_iterator::operator!=(const const_iterator &other) const
|
||||
|
||||
Returns true if \a other points to a different item than this
|
||||
iterator; otherwise returns false.
|
||||
Returns \c true if \a other points to a different item than this
|
||||
iterator; otherwise returns \c false.
|
||||
|
||||
\sa operator==()
|
||||
*/
|
||||
@ -2089,8 +2089,8 @@ void QHashData::checkSanity()
|
||||
\fn bool QMultiHash::contains(const Key &key, const T &value) const
|
||||
\since 4.3
|
||||
|
||||
Returns true if the hash contains an item with the \a key and
|
||||
\a value; otherwise returns false.
|
||||
Returns \c true if the hash contains an item with the \a key and
|
||||
\a value; otherwise returns \c false.
|
||||
|
||||
\sa QHash::contains()
|
||||
*/
|
||||
|
@ -580,9 +580,9 @@
|
||||
\fn bool QMutableVectorIterator::hasNext() const
|
||||
\fn bool QMutableSetIterator::hasNext() const
|
||||
|
||||
Returns true if there is at least one item ahead of the iterator,
|
||||
Returns \c true if there is at least one item ahead of the iterator,
|
||||
i.e. the iterator is \e not at the back of the container;
|
||||
otherwise returns false.
|
||||
otherwise returns \c false.
|
||||
|
||||
\sa hasPrevious(), next()
|
||||
*/
|
||||
@ -649,9 +649,9 @@
|
||||
\fn bool QMutableVectorIterator::hasPrevious() const
|
||||
\fn bool QMutableSetIterator::hasPrevious() const
|
||||
|
||||
Returns true if there is at least one item behind the iterator,
|
||||
Returns \c true if there is at least one item behind the iterator,
|
||||
i.e. the iterator is \e not at the front of the container;
|
||||
otherwise returns false.
|
||||
otherwise returns \c false.
|
||||
|
||||
\sa hasNext(), previous()
|
||||
*/
|
||||
@ -720,7 +720,7 @@
|
||||
\fn bool QMutableSetIterator::findNext(const T &value)
|
||||
|
||||
Searches for \a value starting from the current iterator position
|
||||
forward. Returns true if \a value is found; otherwise returns false.
|
||||
forward. Returns \c true if \a value is found; otherwise returns \c false.
|
||||
|
||||
After the call, if \a value was found, the iterator is positioned
|
||||
just after the matching item; otherwise, the iterator is
|
||||
@ -739,7 +739,7 @@
|
||||
\fn bool QMutableSetIterator::findPrevious(const T &value)
|
||||
|
||||
Searches for \a value starting from the current iterator position
|
||||
backward. Returns true if \a value is found; otherwise returns
|
||||
backward. Returns \c true if \a value is found; otherwise returns
|
||||
false.
|
||||
|
||||
After the call, if \a value was found, the iterator is positioned
|
||||
@ -1175,9 +1175,9 @@
|
||||
\fn bool QMutableMapIterator::hasNext() const
|
||||
\fn bool QMutableHashIterator::hasNext() const
|
||||
|
||||
Returns true if there is at least one item ahead of the iterator,
|
||||
Returns \c true if there is at least one item ahead of the iterator,
|
||||
i.e. the iterator is \e not at the back of the container;
|
||||
otherwise returns false.
|
||||
otherwise returns \c false.
|
||||
|
||||
\sa hasPrevious(), next()
|
||||
*/
|
||||
@ -1243,9 +1243,9 @@
|
||||
\fn bool QMutableMapIterator::hasPrevious() const
|
||||
\fn bool QMutableHashIterator::hasPrevious() const
|
||||
|
||||
Returns true if there is at least one item behind the iterator,
|
||||
Returns \c true if there is at least one item behind the iterator,
|
||||
i.e. the iterator is \e not at the front of the container;
|
||||
otherwise returns false.
|
||||
otherwise returns \c false.
|
||||
|
||||
\sa hasNext(), previous()
|
||||
*/
|
||||
@ -1369,8 +1369,8 @@
|
||||
\fn bool QMutableHashIterator::findNext(const T &value)
|
||||
|
||||
Searches for \a value starting from the current iterator position
|
||||
forward. Returns true if a (key, value) pair with value \a value
|
||||
is found; otherwise returns false.
|
||||
forward. Returns \c true if a (key, value) pair with value \a value
|
||||
is found; otherwise returns \c false.
|
||||
|
||||
After the call, if \a value was found, the iterator is positioned
|
||||
just after the matching item; otherwise, the iterator is
|
||||
@ -1385,8 +1385,8 @@
|
||||
\fn bool QMutableHashIterator::findPrevious(const T &value)
|
||||
|
||||
Searches for \a value starting from the current iterator position
|
||||
backward. Returns true if a (key, value) pair with value \a value
|
||||
is found; otherwise returns false.
|
||||
backward. Returns \c true if a (key, value) pair with value \a value
|
||||
is found; otherwise returns \c false.
|
||||
|
||||
After the call, if \a value was found, the iterator is positioned
|
||||
just before the matching item; otherwise, the iterator is
|
||||
|
@ -101,8 +101,8 @@ QT_BEGIN_NAMESPACE
|
||||
/*!
|
||||
\fn bool QLine::isNull() const
|
||||
|
||||
Returns true if the line is not set up with valid start and end point;
|
||||
otherwise returns false.
|
||||
Returns \c true if the line is not set up with valid start and end point;
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
@ -172,7 +172,7 @@ QT_BEGIN_NAMESPACE
|
||||
/*!
|
||||
\fn bool QLine::operator!=(const QLine &line) const
|
||||
|
||||
Returns true if the given \a line is not the same as \e this line.
|
||||
Returns \c true if the given \a line is not the same as \e this line.
|
||||
|
||||
A line is different from another line if any of their start or
|
||||
end points differ, or the internal order of the points is different.
|
||||
@ -181,7 +181,7 @@ QT_BEGIN_NAMESPACE
|
||||
/*!
|
||||
\fn bool QLine::operator==(const QLine &line) const
|
||||
|
||||
Returns true if the given \a line is the same as \e this line.
|
||||
Returns \c true if the given \a line is the same as \e this line.
|
||||
|
||||
A line is identical to another line if the start and end points
|
||||
are identical, and the internal order of the points is the same.
|
||||
@ -416,8 +416,8 @@ QDataStream &operator>>(QDataStream &stream, QLine &line)
|
||||
/*!
|
||||
\fn bool QLineF::isNull() const
|
||||
|
||||
Returns true if the line is not set up with valid start and end point;
|
||||
otherwise returns false.
|
||||
Returns \c true if the line is not set up with valid start and end point;
|
||||
otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
@ -520,7 +520,7 @@ QDataStream &operator>>(QDataStream &stream, QLine &line)
|
||||
/*!
|
||||
\fn bool QLineF::operator!=(const QLineF &line) const
|
||||
|
||||
Returns true if the given \a line is not the same as \e this line.
|
||||
Returns \c true if the given \a line is not the same as \e this line.
|
||||
|
||||
A line is different from another line if their start or end points
|
||||
differ, or the internal order of the points is different.
|
||||
@ -529,7 +529,7 @@ QDataStream &operator>>(QDataStream &stream, QLine &line)
|
||||
/*!
|
||||
\fn bool QLineF::operator==(const QLineF &line) const
|
||||
|
||||
Returns true if the given \a line is the same as this line.
|
||||
Returns \c true if the given \a line is the same as this line.
|
||||
|
||||
A line is identical to another line if the start and end points
|
||||
are identical, and the internal order of the points is the same.
|
||||
|
@ -176,7 +176,7 @@ const QLinkedListData QLinkedListData::shared_null = {
|
||||
|
||||
/*! \fn bool QLinkedList::operator==(const QLinkedList<T> &other) const
|
||||
|
||||
Returns true if \a other is equal to this list; otherwise returns
|
||||
Returns \c true if \a other is equal to this list; otherwise returns
|
||||
false.
|
||||
|
||||
Two lists are considered equal if they contain the same values in
|
||||
@ -190,8 +190,8 @@ const QLinkedListData QLinkedListData::shared_null = {
|
||||
|
||||
/*! \fn bool QLinkedList::operator!=(const QLinkedList<T> &other) const
|
||||
|
||||
Returns true if \a other is not equal to this list; otherwise
|
||||
returns false.
|
||||
Returns \c true if \a other is not equal to this list; otherwise
|
||||
returns \c false.
|
||||
|
||||
Two lists are considered equal if they contain the same values in
|
||||
the same order.
|
||||
@ -231,7 +231,7 @@ const QLinkedListData QLinkedListData::shared_null = {
|
||||
|
||||
/*! \fn bool QLinkedList::isEmpty() const
|
||||
|
||||
Returns true if the list contains no items; otherwise returns
|
||||
Returns \c true if the list contains no items; otherwise returns
|
||||
false.
|
||||
|
||||
\sa size()
|
||||
@ -285,8 +285,8 @@ const QLinkedListData QLinkedListData::shared_null = {
|
||||
\fn bool QLinkedList::removeOne(const T &value)
|
||||
\since 4.4
|
||||
|
||||
Removes the first occurrences of \a value in the list. Returns true on
|
||||
success; otherwise returns false.
|
||||
Removes the first occurrences of \a value in the list. Returns \c true on
|
||||
success; otherwise returns \c false.
|
||||
|
||||
Example:
|
||||
\snippet code/src_corelib_tools_qlinkedlist.cpp 6
|
||||
@ -299,8 +299,8 @@ const QLinkedListData QLinkedListData::shared_null = {
|
||||
|
||||
/*! \fn bool QLinkedList::contains(const T &value) const
|
||||
|
||||
Returns true if the list contains an occurrence of \a value;
|
||||
otherwise returns false.
|
||||
Returns \c true if the list contains an occurrence of \a value;
|
||||
otherwise returns \c false.
|
||||
|
||||
This function requires the value type to have an implementation of
|
||||
\c operator==().
|
||||
@ -321,8 +321,8 @@ const QLinkedListData QLinkedListData::shared_null = {
|
||||
/*! \fn bool QLinkedList::startsWith(const T &value) const
|
||||
\since 4.5
|
||||
|
||||
Returns true if the list is not empty and its first
|
||||
item is equal to \a value; otherwise returns false.
|
||||
Returns \c true if the list is not empty and its first
|
||||
item is equal to \a value; otherwise returns \c false.
|
||||
|
||||
\sa isEmpty(), first()
|
||||
*/
|
||||
@ -330,8 +330,8 @@ const QLinkedListData QLinkedListData::shared_null = {
|
||||
/*! \fn bool QLinkedList::endsWith(const T &value) const
|
||||
\since 4.5
|
||||
|
||||
Returns true if the list is not empty and its last
|
||||
item is equal to \a value; otherwise returns false.
|
||||
Returns \c true if the list is not empty and its last
|
||||
item is equal to \a value; otherwise returns \c false.
|
||||
|
||||
\sa isEmpty(), last()
|
||||
*/
|
||||
@ -589,7 +589,7 @@ const QLinkedListData QLinkedListData::shared_null = {
|
||||
/*! \fn bool QLinkedList::empty() const
|
||||
|
||||
This function is provided for STL compatibility. It is equivalent
|
||||
to isEmpty() and returns true if the list is empty.
|
||||
to isEmpty() and returns \c true if the list is empty.
|
||||
*/
|
||||
|
||||
/*! \fn QLinkedList<T> &QLinkedList::operator+=(const QLinkedList<T> &other)
|
||||
@ -780,8 +780,8 @@ const QLinkedListData QLinkedListData::shared_null = {
|
||||
\fn bool QLinkedList::iterator::operator==(const iterator &other) const
|
||||
\fn bool QLinkedList::iterator::operator==(const const_iterator &other) const
|
||||
|
||||
Returns true if \a other points to the same item as this
|
||||
iterator; otherwise returns false.
|
||||
Returns \c true if \a other points to the same item as this
|
||||
iterator; otherwise returns \c false.
|
||||
|
||||
\sa operator!=()
|
||||
*/
|
||||
@ -790,8 +790,8 @@ const QLinkedListData QLinkedListData::shared_null = {
|
||||
\fn bool QLinkedList::iterator::operator!=(const iterator &other) const
|
||||
\fn bool QLinkedList::iterator::operator!=(const const_iterator &other) const
|
||||
|
||||
Returns true if \a other points to a different item than this
|
||||
iterator; otherwise returns false.
|
||||
Returns \c true if \a other points to a different item than this
|
||||
iterator; otherwise returns \c false.
|
||||
|
||||
\sa operator==()
|
||||
*/
|
||||
@ -986,16 +986,16 @@ const QLinkedListData QLinkedListData::shared_null = {
|
||||
|
||||
/*! \fn bool QLinkedList::const_iterator::operator==(const const_iterator &other) const
|
||||
|
||||
Returns true if \a other points to the same item as this
|
||||
iterator; otherwise returns false.
|
||||
Returns \c true if \a other points to the same item as this
|
||||
iterator; otherwise returns \c false.
|
||||
|
||||
\sa operator!=()
|
||||
*/
|
||||
|
||||
/*! \fn bool QLinkedList::const_iterator::operator!=(const const_iterator &other) const
|
||||
|
||||
Returns true if \a other points to a different item than this
|
||||
iterator; otherwise returns false.
|
||||
Returns \c true if \a other points to a different item than this
|
||||
iterator; otherwise returns \c false.
|
||||
|
||||
\sa operator==()
|
||||
*/
|
||||
|
@ -553,7 +553,7 @@ void **QListData::erase(void **xi)
|
||||
|
||||
/*! \fn bool QList::operator==(const QList<T> &other) const
|
||||
|
||||
Returns true if \a other is equal to this list; otherwise returns
|
||||
Returns \c true if \a other is equal to this list; otherwise returns
|
||||
false.
|
||||
|
||||
Two lists are considered equal if they contain the same values in
|
||||
@ -567,8 +567,8 @@ void **QListData::erase(void **xi)
|
||||
|
||||
/*! \fn bool QList::operator!=(const QList<T> &other) const
|
||||
|
||||
Returns true if \a other is not equal to this list; otherwise
|
||||
returns false.
|
||||
Returns \c true if \a other is not equal to this list; otherwise
|
||||
returns \c false.
|
||||
|
||||
Two lists are considered equal if they contain the same values in
|
||||
the same order.
|
||||
@ -618,7 +618,7 @@ void **QListData::erase(void **xi)
|
||||
|
||||
/*! \fn bool QList::isEmpty() const
|
||||
|
||||
Returns true if the list contains no items; otherwise returns
|
||||
Returns \c true if the list contains no items; otherwise returns
|
||||
false.
|
||||
|
||||
\sa size()
|
||||
@ -767,7 +767,7 @@ void **QListData::erase(void **xi)
|
||||
\since 4.4
|
||||
|
||||
Removes the first occurrence of \a value in the list and returns
|
||||
true on success; otherwise returns false.
|
||||
true on success; otherwise returns \c false.
|
||||
|
||||
Example:
|
||||
\snippet code/src_corelib_tools_qlistdata.cpp 10
|
||||
@ -894,8 +894,8 @@ void **QListData::erase(void **xi)
|
||||
|
||||
/*! \fn bool QList::contains(const T &value) const
|
||||
|
||||
Returns true if the list contains an occurrence of \a value;
|
||||
otherwise returns false.
|
||||
Returns \c true if the list contains an occurrence of \a value;
|
||||
otherwise returns \c false.
|
||||
|
||||
This function requires the value type to have an implementation of
|
||||
\c operator==().
|
||||
@ -916,8 +916,8 @@ void **QListData::erase(void **xi)
|
||||
/*! \fn bool QList::startsWith(const T &value) const
|
||||
\since 4.5
|
||||
|
||||
Returns true if this list is not empty and its first
|
||||
item is equal to \a value; otherwise returns false.
|
||||
Returns \c true if this list is not empty and its first
|
||||
item is equal to \a value; otherwise returns \c false.
|
||||
|
||||
\sa isEmpty(), contains()
|
||||
*/
|
||||
@ -925,8 +925,8 @@ void **QListData::erase(void **xi)
|
||||
/*! \fn bool QList::endsWith(const T &value) const
|
||||
\since 4.5
|
||||
|
||||
Returns true if this list is not empty and its last
|
||||
item is equal to \a value; otherwise returns false.
|
||||
Returns \c true if this list is not empty and its last
|
||||
item is equal to \a value; otherwise returns \c false.
|
||||
|
||||
\sa isEmpty(), contains()
|
||||
*/
|
||||
@ -1196,7 +1196,7 @@ void **QListData::erase(void **xi)
|
||||
/*! \fn bool QList::empty() const
|
||||
|
||||
This function is provided for STL compatibility. It is equivalent
|
||||
to isEmpty() and returns true if the list is empty.
|
||||
to isEmpty() and returns \c true if the list is empty.
|
||||
*/
|
||||
|
||||
/*! \fn QList<T> &QList::operator+=(const QList<T> &other)
|
||||
@ -1372,8 +1372,8 @@ void **QListData::erase(void **xi)
|
||||
\fn bool QList::iterator::operator==(const iterator &other) const
|
||||
\fn bool QList::iterator::operator==(const const_iterator &other) const
|
||||
|
||||
Returns true if \a other points to the same item as this
|
||||
iterator; otherwise returns false.
|
||||
Returns \c true if \a other points to the same item as this
|
||||
iterator; otherwise returns \c false.
|
||||
|
||||
\sa operator!=()
|
||||
*/
|
||||
@ -1382,8 +1382,8 @@ void **QListData::erase(void **xi)
|
||||
\fn bool QList::iterator::operator!=(const iterator &other) const
|
||||
\fn bool QList::iterator::operator!=(const const_iterator &other) const
|
||||
|
||||
Returns true if \a other points to a different item than this
|
||||
iterator; otherwise returns false.
|
||||
Returns \c true if \a other points to a different item than this
|
||||
iterator; otherwise returns \c false.
|
||||
|
||||
\sa operator==()
|
||||
*/
|
||||
@ -1392,7 +1392,7 @@ void **QListData::erase(void **xi)
|
||||
\fn bool QList::iterator::operator<(const iterator& other) const
|
||||
\fn bool QList::iterator::operator<(const const_iterator& other) const
|
||||
|
||||
Returns true if the item pointed to by this iterator is less than
|
||||
Returns \c true if the item pointed to by this iterator is less than
|
||||
the item pointed to by the \a other iterator.
|
||||
*/
|
||||
|
||||
@ -1400,7 +1400,7 @@ void **QListData::erase(void **xi)
|
||||
\fn bool QList::iterator::operator<=(const iterator& other) const
|
||||
\fn bool QList::iterator::operator<=(const const_iterator& other) const
|
||||
|
||||
Returns true if the item pointed to by this iterator is less than
|
||||
Returns \c true if the item pointed to by this iterator is less than
|
||||
or equal to the item pointed to by the \a other iterator.
|
||||
*/
|
||||
|
||||
@ -1408,7 +1408,7 @@ void **QListData::erase(void **xi)
|
||||
\fn bool QList::iterator::operator>(const iterator& other) const
|
||||
\fn bool QList::iterator::operator>(const const_iterator& other) const
|
||||
|
||||
Returns true if the item pointed to by this iterator is greater
|
||||
Returns \c true if the item pointed to by this iterator is greater
|
||||
than the item pointed to by the \a other iterator.
|
||||
*/
|
||||
|
||||
@ -1416,7 +1416,7 @@ void **QListData::erase(void **xi)
|
||||
\fn bool QList::iterator::operator>=(const iterator& other) const
|
||||
\fn bool QList::iterator::operator>=(const const_iterator& other) const
|
||||
|
||||
Returns true if the item pointed to by this iterator is greater
|
||||
Returns \c true if the item pointed to by this iterator is greater
|
||||
than or equal to the item pointed to by the \a other iterator.
|
||||
*/
|
||||
|
||||
@ -1619,16 +1619,16 @@ void **QListData::erase(void **xi)
|
||||
|
||||
/*! \fn bool QList::const_iterator::operator==(const const_iterator &other) const
|
||||
|
||||
Returns true if \a other points to the same item as this
|
||||
iterator; otherwise returns false.
|
||||
Returns \c true if \a other points to the same item as this
|
||||
iterator; otherwise returns \c false.
|
||||
|
||||
\sa operator!=()
|
||||
*/
|
||||
|
||||
/*! \fn bool QList::const_iterator::operator!=(const const_iterator &other) const
|
||||
|
||||
Returns true if \a other points to a different item than this
|
||||
iterator; otherwise returns false.
|
||||
Returns \c true if \a other points to a different item than this
|
||||
iterator; otherwise returns \c false.
|
||||
|
||||
\sa operator==()
|
||||
*/
|
||||
@ -1636,28 +1636,28 @@ void **QListData::erase(void **xi)
|
||||
/*!
|
||||
\fn bool QList::const_iterator::operator<(const const_iterator& other) const
|
||||
|
||||
Returns true if the item pointed to by this iterator is less than
|
||||
Returns \c true if the item pointed to by this iterator is less than
|
||||
the item pointed to by the \a other iterator.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bool QList::const_iterator::operator<=(const const_iterator& other) const
|
||||
|
||||
Returns true if the item pointed to by this iterator is less than
|
||||
Returns \c true if the item pointed to by this iterator is less than
|
||||
or equal to the item pointed to by the \a other iterator.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bool QList::const_iterator::operator>(const const_iterator& other) const
|
||||
|
||||
Returns true if the item pointed to by this iterator is greater
|
||||
Returns \c true if the item pointed to by this iterator is greater
|
||||
than the item pointed to by the \a other iterator.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bool QList::const_iterator::operator>=(const const_iterator& other) const
|
||||
|
||||
Returns true if the item pointed to by this iterator is greater
|
||||
Returns \c true if the item pointed to by this iterator is greater
|
||||
than or equal to the item pointed to by the \a other iterator.
|
||||
*/
|
||||
|
||||
|
@ -907,15 +907,15 @@
|
||||
/*!
|
||||
\fn bool QLocale::operator==(const QLocale &other) const
|
||||
|
||||
Returns true if the QLocale object is the same as the \a other
|
||||
locale specified; otherwise returns false.
|
||||
Returns \c true if the QLocale object is the same as the \a other
|
||||
locale specified; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bool QLocale::operator!=(const QLocale &other) const
|
||||
|
||||
Returns true if the QLocale object is not the same as the \a other
|
||||
locale specified; otherwise returns false.
|
||||
Returns \c true if the QLocale object is not the same as the \a other
|
||||
locale specified; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
|
@ -600,7 +600,7 @@ void QMapDataBase::freeData(QMapDataBase *d)
|
||||
|
||||
/*! \fn bool QMap::operator==(const QMap<Key, T> &other) const
|
||||
|
||||
Returns true if \a other is equal to this map; otherwise returns
|
||||
Returns \c true if \a other is equal to this map; otherwise returns
|
||||
false.
|
||||
|
||||
Two maps are considered equal if they contain the same (key,
|
||||
@ -614,8 +614,8 @@ void QMapDataBase::freeData(QMapDataBase *d)
|
||||
|
||||
/*! \fn bool QMap::operator!=(const QMap<Key, T> &other) const
|
||||
|
||||
Returns true if \a other is not equal to this map; otherwise
|
||||
returns false.
|
||||
Returns \c true if \a other is not equal to this map; otherwise
|
||||
returns \c false.
|
||||
|
||||
Two maps are considered equal if they contain the same (key,
|
||||
value) pairs.
|
||||
@ -636,7 +636,7 @@ void QMapDataBase::freeData(QMapDataBase *d)
|
||||
/*!
|
||||
\fn bool QMap::isEmpty() const
|
||||
|
||||
Returns true if the map contains no items; otherwise returns
|
||||
Returns \c true if the map contains no items; otherwise returns
|
||||
false.
|
||||
|
||||
\sa size()
|
||||
@ -656,8 +656,8 @@ void QMapDataBase::freeData(QMapDataBase *d)
|
||||
|
||||
\internal
|
||||
|
||||
Returns true if the map's internal data isn't shared with any
|
||||
other map object; otherwise returns false.
|
||||
Returns \c true if the map's internal data isn't shared with any
|
||||
other map object; otherwise returns \c false.
|
||||
|
||||
\sa detach()
|
||||
*/
|
||||
@ -706,8 +706,8 @@ void QMapDataBase::freeData(QMapDataBase *d)
|
||||
|
||||
/*! \fn bool QMap::contains(const Key &key) const
|
||||
|
||||
Returns true if the map contains an item with key \a key;
|
||||
otherwise returns false.
|
||||
Returns \c true if the map contains an item with key \a key;
|
||||
otherwise returns \c false.
|
||||
|
||||
\sa count(), QMultiMap::contains()
|
||||
*/
|
||||
@ -1303,8 +1303,8 @@ void QMapDataBase::freeData(QMapDataBase *d)
|
||||
\fn bool QMap::iterator::operator==(const iterator &other) const
|
||||
\fn bool QMap::iterator::operator==(const const_iterator &other) const
|
||||
|
||||
Returns true if \a other points to the same item as this
|
||||
iterator; otherwise returns false.
|
||||
Returns \c true if \a other points to the same item as this
|
||||
iterator; otherwise returns \c false.
|
||||
|
||||
\sa operator!=()
|
||||
*/
|
||||
@ -1313,8 +1313,8 @@ void QMapDataBase::freeData(QMapDataBase *d)
|
||||
\fn bool QMap::iterator::operator!=(const iterator &other) const
|
||||
\fn bool QMap::iterator::operator!=(const const_iterator &other) const
|
||||
|
||||
Returns true if \a other points to a different item than this
|
||||
iterator; otherwise returns false.
|
||||
Returns \c true if \a other points to a different item than this
|
||||
iterator; otherwise returns \c false.
|
||||
|
||||
\sa operator==()
|
||||
*/
|
||||
@ -1515,16 +1515,16 @@ void QMapDataBase::freeData(QMapDataBase *d)
|
||||
|
||||
/*! \fn bool QMap::const_iterator::operator==(const const_iterator &other) const
|
||||
|
||||
Returns true if \a other points to the same item as this
|
||||
iterator; otherwise returns false.
|
||||
Returns \c true if \a other points to the same item as this
|
||||
iterator; otherwise returns \c false.
|
||||
|
||||
\sa operator!=()
|
||||
*/
|
||||
|
||||
/*! \fn bool QMap::const_iterator::operator!=(const const_iterator &other) const
|
||||
|
||||
Returns true if \a other points to a different item than this
|
||||
iterator; otherwise returns false.
|
||||
Returns \c true if \a other points to a different item than this
|
||||
iterator; otherwise returns \c false.
|
||||
|
||||
\sa operator==()
|
||||
*/
|
||||
@ -1772,8 +1772,8 @@ void QMapDataBase::freeData(QMapDataBase *d)
|
||||
\fn bool QMultiMap::contains(const Key &key, const T &value) const
|
||||
\since 4.3
|
||||
|
||||
Returns true if the map contains an item with key \a key and
|
||||
value \a value; otherwise returns false.
|
||||
Returns \c true if the map contains an item with key \a key and
|
||||
value \a value; otherwise returns \c false.
|
||||
|
||||
\sa QMap::contains()
|
||||
*/
|
||||
|
@ -56,7 +56,7 @@ QT_BEGIN_NAMESPACE
|
||||
QMargin defines a set of four margins; left, top, right and bottom,
|
||||
that describe the size of the borders surrounding a rectangle.
|
||||
|
||||
The isNull() function returns true only if all margins are set to zero.
|
||||
The isNull() function returns \c true only if all margins are set to zero.
|
||||
|
||||
QMargin objects can be streamed as well as compared.
|
||||
*/
|
||||
@ -85,7 +85,7 @@ QT_BEGIN_NAMESPACE
|
||||
/*!
|
||||
\fn bool QMargins::isNull() const
|
||||
|
||||
Returns true if all margins are is 0; otherwise returns
|
||||
Returns \c true if all margins are is 0; otherwise returns
|
||||
false.
|
||||
*/
|
||||
|
||||
@ -147,14 +147,14 @@ QT_BEGIN_NAMESPACE
|
||||
\fn bool operator==(const QMargins &m1, const QMargins &m2)
|
||||
\relates QMargins
|
||||
|
||||
Returns true if \a m1 and \a m2 are equal; otherwise returns false.
|
||||
Returns \c true if \a m1 and \a m2 are equal; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bool operator!=(const QMargins &m1, const QMargins &m2)
|
||||
\relates QMargins
|
||||
|
||||
Returns true if \a m1 and \a m2 are different; otherwise returns false.
|
||||
Returns \c true if \a m1 and \a m2 are different; otherwise returns \c false.
|
||||
*/
|
||||
|
||||
/*!
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user