The \c main() function initialises the \e{textfinder.qrc} resource file
and instantiates as well as displays \c TextFinder.
- \sa{Calculator Builder Example}, {World Time Clock Builder Example}
+ \sa {Calculator Builder Example}, {World Time Clock Builder Example}
*/
uninitialized iterartor. Use operator=() to assign a value to it before
using it.
- \sa QFuture::constBegin() QFuture::constEnd()
+ \sa QFuture::constBegin(), QFuture::constEnd()
*/
/*! \fn QFuture::const_iterator::const_iterator(QFuture const * const future, int index)
Removes all managed futures from this QFutureSynchronizer.
- \sa addFuture(), setFuture()
+ \sa addFuture(), setFuture()
*/
/*!
qSetMessagePattern() has no effect if a custom message handler is installed.
- \sa qInstallMessageHandler, Debugging Techniques
+ \sa qInstallMessageHandler, {Debugging Techniques}
*/
QtMessageHandler qInstallMessageHandler(QtMessageHandler h)
The function returns true on success and false on failure.
- \sa installTranslator() translate(), QObject::tr()
+ \sa installTranslator(), translate(), QObject::tr()
*/
bool QCoreApplication::removeTranslator(QTranslator *translationFile)
This class should never be used directly. Please use the \l Q_ARG()
macro instead.
- \sa Q_ARG(), QMetaObject::invokeMethod(), QGenericReturnArgument
+ \sa Q_ARG(), QMetaObject::invokeMethod(), QGenericReturnArgument
*/
/*!
Sets the y coordinate of this point to the given \a y coordinate.
- \sa y(), setX()
+ \sa y(), setX()
*/
/*!
Returns the x-coordinate of the rectangle's left edge. Equivalent
to x().
- \sa setLeft(), topLeft(), bottomLeft()
+ \sa setLeft(), topLeft(), bottomLeft()
*/
/*!
Returns the width of the rectangle.
- \sa setWidth(), height(), size()
+ \sa setWidth(), height(), size()
*/
/*!
The intersection rectangle can be retrieved using the intersected()
function.
- \sa contains()
+ \sa contains()
*/
bool QRect::intersects(const QRect &r) const
Use the normalized() function to retrieve a rectangle where the
corners are swapped.
- \sa isNull(), isValid(), normalized()
+ \sa isNull(), isValid(), normalized()
*/
/*!
Returns the y-coordinate of the rectangle's top edge. Equivalent
to top().
- \sa setY(), x(), topLeft()
+ \sa setY(), x(), topLeft()
*/
relative to the current position. Positive values move the rectangle to the
right and downwards.
- \sa moveTopLeft(), moveTo(), translated()
+ \sa moveTopLeft(), moveTo(), translated()
*/
Returns the position of the rectangle's bottom-left corner.
- \sa setBottomLeft(), bottom(), left()
+ \sa setBottomLeft(), bottom(), left()
*/
/*!
This constructor is only available if Qt is configured with STL
compatibility enabled.
- \sa fromLatin1(), fromLocal8Bit(), fromUtf8()
+ \sa fromLatin1(), fromLocal8Bit(), fromUtf8()
*/
/*! \fn QString QString::fromStdWString(const std::wstring &str)
implicit data sharing. For more information, see the \l {Implicit
Data Sharing} documentation.
- \sa QPixmap, QImage, QImageReader, QImageWriter
+ \sa QPixmap, QImage, QImageReader, QImageWriter
*/
/*! \typedef QBitmap::DataPtr
fileName, or 0 if the file cannot be read or if the format is not
recognized.
- \sa load() save()
+ \sa load(), save()
*/
const char* QPicture::pictureFormat(const QString &fileName)
Returns a list of picture formats that are supported for picture
input.
- \sa outputFormats() inputFormatList() QPictureIO
+ \sa outputFormats(), inputFormatList(), QPictureIO
*/
QList<QByteArray> QPicture::inputFormats()
{
over a copy, e.g.
\snippet picture/picture.cpp 2
- \sa outputFormatList() inputFormats() QPictureIO
+ \sa outputFormatList(), inputFormats(), QPictureIO
*/
QStringList QPicture::inputFormatList()
{
over a copy, e.g.
\snippet picture/picture.cpp 3
- \sa inputFormatList() outputFormats() QPictureIO
+ \sa inputFormatList(), outputFormats(), QPictureIO
*/
QStringList QPicture::outputFormatList()
{
Returns a list of picture formats that are supported for picture
output.
- \sa inputFormats() outputFormatList() QPictureIO
+ \sa inputFormats(), outputFormatList(), QPictureIO
*/
QList<QByteArray> QPicture::outputFormats()
{
You don't normally need to use this class; QPicture::load(),
QPicture::save().
- \sa QPicture QPixmap QFile
+ \sa QPicture, QPixmap, QFile
*/
struct QPictureIOData
reading it. If a format is set the picture will only be read if it
has that format.
- \sa read() write() format()
+ \sa read(), write(), format()
*/
void QPictureIO::setFormat(const char *format)
{
Returns the quality of the written picture, related to the
compression ratio.
- \sa setQuality() QPicture::save()
+ \sa setQuality(), QPicture::save()
*/
int QPictureIO::quality() const
{
compressed files, 100 for large uncompressed files. (-1 signifies
the default compression.)
- \sa quality() QPicture::save()
+ \sa quality(), QPicture::save()
*/
void QPictureIO::setQuality(int q)
\snippet picture/picture.cpp 4
- \sa setIODevice() setFileName() setFormat() write() QPixmap::load()
+ \sa setIODevice(), setFileName(), setFormat(), write(), QPixmap::load()
*/
bool QPictureIO::read()
{
Example:
\snippet picture/picture.cpp 5
- \sa setIODevice() setFileName() setFormat() read() QPixmap::save()
+ \sa setIODevice(), setFileName(), setFormat(), read(), QPixmap::save()
*/
bool QPictureIO::write()
{
QClipboard::Selection, the image is retrieved from the global
mouse selection.
- \sa setImage() pixmap() mimeData(), QImage::isNull()
+ \sa setImage(), pixmap(), mimeData(), QImage::isNull()
*/
QImage QClipboard::image(Mode mode) const
{
\snippet code/src_gui_kernel_qclipboard.cpp 1
- \sa image(), setPixmap() setMimeData()
+ \sa image(), setPixmap(), setMimeData()
*/
void QClipboard::setImage(const QImage &image, Mode mode)
{
QClipboard::Selection, the pixmap is retrieved from the global
mouse selection.
- \sa setPixmap() image() mimeData() QPixmap::convertFromImage()
+ \sa setPixmap(), image(), mimeData(), QPixmap::convertFromImage()
*/
QPixmap QClipboard::pixmap(Mode mode) const
{
QClipboard::Selection, the pixmap is stored in the global
mouse selection.
- \sa pixmap() setImage() setMimeData()
+ \sa pixmap(), setImage(), setMimeData()
*/
void QClipboard::setPixmap(const QPixmap &pixmap, Mode mode)
{
and QWidget::mouseMoveEvent() to receive mouse events in your own
widgets.
- \sa QWidget::setMouseTracking() QWidget::grabMouse()
+ \sa QWidget::setMouseTracking(), QWidget::grabMouse(),
QCursor::pos()
*/
screen position returned by screenPos() to avoid a shaking
motion.
- \sa x() y() windowPos() screenPos()
+ \sa x(), y(), windowPos(), screenPos()
*/
/*!
global position returned by globalPos() to avoid a shaking
motion.
- \sa x() y() pos() localPos() screenPos()
+ \sa x(), y(), pos(), localPos(), screenPos()
*/
/*!
Returns the position of the mouse cursor as a QPointF, relative to the
screen that received the event.
- \sa x() y() pos() localPos() screenPos()
+ \sa x(), y(), pos(), localPos(), screenPos()
*/
/*!
global position returned by globalPos() to avoid a shaking
motion.
- \sa x() y() globalPos()
+ \sa x(), y(), globalPos()
*/
/*!
pointer position QCursor::pos(), and from
QWidget::mapToGlobal(pos()).
- \sa globalX() globalY()
+ \sa globalX(), globalY()
*/
/*!
Returns the x position of the mouse cursor, relative to the
widget that received the event.
- \sa y() pos()
+ \sa y(), pos()
*/
/*!
Returns the y position of the mouse cursor, relative to the
widget that received the event.
- \sa x() pos()
+ \sa x(), pos()
*/
/*!
Returns the global x position of the mouse cursor at the time of
the event.
- \sa globalY() globalPos()
+ \sa globalY(), globalPos()
*/
/*!
Returns the global y position of the mouse cursor at the time of
the event.
- \sa globalX() globalPos()
+ \sa globalX(), globalPos()
*/
/*!
Note that the returned value is always Qt::NoButton for mouse
move events.
- \sa buttons() Qt::MouseButton
+ \sa buttons(), Qt::MouseButton
*/
/*!
event. For mouse release events this excludes the button that
caused the event.
- \sa button() Qt::MouseButton
+ \sa button(), Qt::MouseButton
*/
/*!
The event handler QWidget::wheelEvent() receives wheel events.
- \sa QMouseEvent QWidget::grabMouse()
+ \sa QMouseEvent, QWidget::grabMouse()
*/
/*!
\a modifiers holds the keyboard modifier flags at the time of the
event, and \a orient holds the wheel's orientation.
- \sa pos() pixelDelta() angleDelta() state()
+ \sa pos(), pixelDelta(), angleDelta(), state()
*/
#ifndef QT_NO_WHEELEVENT
QWheelEvent::QWheelEvent(const QPointF &pos, int delta,
\a orient holds the wheel's orientation.
- \sa pos() pixelDelta() angleDelta() state()
+ \sa pos(), pixelDelta(), angleDelta(), state()
*/
QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos, int delta,
Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers,
\a angleDelta contains the rotation distance, and
\a orient holds the wheel's orientation.
- \sa pos() globalPos() delta() state()
+ \sa pos(), globalPos(), delta(), state()
*/
QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos,
If you move your widgets around in response to mouse events,
use globalPos() instead of this function.
- \sa x() y() globalPos()
+ \sa x(), y(), globalPos()
*/
/*!
Returns the x position of the mouse cursor, relative to the
widget that received the event.
- \sa y() pos()
+ \sa y(), pos()
*/
/*!
Returns the y position of the mouse cursor, relative to the
widget that received the event.
- \sa x() pos()
+ \sa x(), pos()
*/
mouse events, globalPos() can differ a lot from the current
cursor position returned by QCursor::pos().
- \sa globalX() globalY()
+ \sa globalX(), globalY()
*/
/*!
Returns the global x position of the mouse cursor at the time of
the event.
- \sa globalY() globalPos()
+ \sa globalY(), globalPos()
*/
/*!
Returns the global y position of the mouse cursor at the time of
the event.
- \sa globalX() globalPos()
+ \sa globalX(), globalPos()
*/
/*!
Returns the rectangle that needs to be updated.
- \sa region() QPainter::setClipRect()
+ \sa region(), QPainter::setClipRect()
*/
/*!
Returns the region that needs to be updated.
- \sa rect() QPainter::setClipRegion()
+ \sa rect(), QPainter::setClipRegion()
*/
The event handler QWidget::resizeEvent() receives resize events.
- \sa QWidget::resize() QWidget::setGeometry()
+ \sa QWidget::resize(), QWidget::setGeometry()
*/
/*!
\a rotation contains the device's rotation in degrees. 4D mice support
rotation. If the device does not support rotation, pass 0 here.
- \sa pos() globalPos() device() pressure() xTilt() yTilt() uniqueId(), rotation(), tangentialPressure(), z()
+ \sa pos(), globalPos(), device(), pressure(), xTilt(), yTilt(), uniqueId(), rotation(),
+ tangentialPressure(), z()
*/
QTabletEvent::QTabletEvent(Type type, const QPointF &pos, const QPointF &globalPos,
If you move widgets around in response to mouse events, use
globalPos() instead of this function.
- \sa x() y() globalPos()
+ \sa x(), y(), globalPos()
*/
/*!
Returns the x position of the device, relative to the widget that
received the event.
- \sa y() pos()
+ \sa y(), pos()
*/
/*!
Returns the y position of the device, relative to the widget that
received the event.
- \sa x() pos()
+ \sa x(), pos()
*/
/*!
globalPos() can differ significantly from the current position
QCursor::pos().
- \sa globalX() globalY() hiResGlobalPos()
+ \sa globalX(), globalY(), hiResGlobalPos()
*/
/*!
Returns the global x position of the mouse pointer at the time of
the event.
- \sa globalY() globalPos() hiResGlobalX()
+ \sa globalY(), globalPos(), hiResGlobalX()
*/
/*!
Returns the global y position of the tablet device at the time of
the event.
- \sa globalX() globalPos() hiResGlobalY()
+ \sa globalX(), globalPos(), hiResGlobalY()
*/
/*!
The high precision coordinates delivered from the tablet expressed.
Sub pixeling information is in the fractional part of the QPointF.
- \sa globalPos() hiResGlobalX() hiResGlobalY()
+ \sa globalPos(), hiResGlobalX(), hiResGlobalY()
*/
/*!
This function is useful in some circumstances, for example
if you want to use QKeySequence objects as keys in a QMap.
- \sa operator==() operator!=() operator>() operator<=() operator>=()
+ \sa operator==(), operator!=(), operator>(), operator<=(), operator>=()
*/
bool QKeySequence::operator< (const QKeySequence &other) const
{
Returns true if this key sequence is larger than the \a other key
sequence; otherwise returns false.
- \sa operator==() operator!=() operator<() operator<=() operator>=()
+ \sa operator==(), operator!=(), operator<(), operator<=(), operator>=()
*/
/*!
Returns true if this key sequence is smaller or equal to the
\a other key sequence; otherwise returns false.
- \sa operator==() operator!=() operator<() operator>() operator>=()
+ \sa operator==(), operator!=(), operator<(), operator>(), operator>=()
*/
/*!
Returns true if this key sequence is larger or equal to the
\a other key sequence; otherwise returns false.
- \sa operator==() operator!=() operator<() operator>() operator<=()
+ \sa operator==(), operator!=(), operator<(), operator>(), operator<=()
*/
/*!
Returns the color that has been set for the given color \a role in
the current ColorGroup.
- \sa brush() ColorRole
+ \sa brush(), ColorRole
*/
/*!
Returns the brush that has been set for the given color \a role in
the current ColorGroup.
- \sa color() setBrush() ColorRole
+ \sa color(), setBrush(), ColorRole
*/
/*!
Sets the color used for the given color \a role, in all color
groups, to the specified solid \a color.
- \sa brush() setColor() ColorRole
+ \sa brush(), setColor(), ColorRole
*/
/*!
Sets the brush for the given color \a role to the specified \a
brush for all groups in the palette.
- \sa brush() setColor() ColorRole
+ \sa brush(), setColor(), ColorRole
*/
/*!
Returns the window text (general foreground) brush of the
current color group.
- \sa ColorRole brush()
+ \sa ColorRole, brush()
*/
/*!
Returns the button brush of the current color group.
- \sa ColorRole brush()
+ \sa ColorRole, brush()
*/
/*!
Returns the light brush of the current color group.
- \sa ColorRole brush()
+ \sa ColorRole, brush()
*/
/*!
Returns the midlight brush of the current color group.
- \sa ColorRole brush()
+ \sa ColorRole, brush()
*/
/*!
Returns the dark brush of the current color group.
- \sa ColorRole brush()
+ \sa ColorRole, brush()
*/
/*!
Returns the mid brush of the current color group.
- \sa ColorRole brush()
+ \sa ColorRole, brush()
*/
/*!
Returns the text foreground brush of the current color group.
- \sa ColorRole brush()
+ \sa ColorRole, brush()
*/
/*!
Returns the bright text foreground brush of the current color group.
- \sa ColorRole brush()
+ \sa ColorRole, brush()
*/
/*!
Returns the button text foreground brush of the current color group.
- \sa ColorRole brush()
+ \sa ColorRole, brush()
*/
/*!
Returns the base brush of the current color group.
- \sa ColorRole brush()
+ \sa ColorRole, brush()
*/
/*!
Returns the alternate base brush of the current color group.
- \sa ColorRole brush()
+ \sa ColorRole, brush()
*/
/*!
\note Tool tips use the Inactive color group of QPalette, because tool
tips are not active windows.
- \sa ColorRole brush()
+ \sa ColorRole, brush()
*/
/*!
\note Tool tips use the Inactive color group of QPalette, because tool
tips are not active windows.
- \sa ColorRole brush()
+ \sa ColorRole, brush()
*/
/*!
Returns the window (general background) brush of the current
color group.
- \sa ColorRole brush()
+ \sa ColorRole, brush()
*/
/*!
Returns the shadow brush of the current color group.
- \sa ColorRole brush()
+ \sa ColorRole, brush()
*/
/*!
Returns the highlight brush of the current color group.
- \sa ColorRole brush()
+ \sa ColorRole, brush()
*/
/*!
Returns the highlighted text brush of the current color group.
- \sa ColorRole brush()
+ \sa ColorRole, brush()
*/
/*!
Returns the unvisited link text brush of the current color group.
- \sa ColorRole brush()
+ \sa ColorRole, brush()
*/
/*!
Returns the visited link text brush of the current color group.
- \sa ColorRole brush()
+ \sa ColorRole, brush()
*/
/*!
Returns the color in the specified color \a group, used for the
given color \a role.
- \sa brush() setColor() ColorRole
+ \sa brush(), setColor(), ColorRole
*/
/*!
Returns the brush in the specified color \a group, used for the
given color \a role.
- \sa color() setBrush() ColorRole
+ \sa color(), setBrush(), ColorRole
*/
const QBrush &QPalette::brush(ColorGroup gr, ColorRole cr) const
{
Sets the color in the specified color \a group, used for the given
color \a role, to the specified solid \a color.
- \sa setBrush() color() ColorRole
+ \sa setBrush(), color(), ColorRole
*/
/*!
Sets the brush in the specified color \a group, used for the given
color \a role, to \a brush.
- \sa brush() setColor() ColorRole
+ \sa brush(), setColor(), ColorRole
*/
void QPalette::setBrush(ColorGroup cg, ColorRole cr, const QBrush &b)
{
was subsequently modified; otherwise returns false. This is much
stricter than equality.
- \sa operator=() operator==()
+ \sa operator=(), operator==()
*/
bool QPalette::isCopyOf(const QPalette &p) const
or QWindow::setWindowState(), respectively.
\sa QPlatformWindow, QPlatformWindowFormat
- \sa createPlatformBackingStore(QWindow *window) const
+ \sa createPlatformBackingStore()
*/
/*!
before the QPlatformBackingStore for tlw where the widget also requires a backing store.
\sa QBackingStore
- \sa createPlatformWindow(QWindow *window, WId winId = 0) const
+ \sa createPlatformWindow()
*/
/*!
Uses ShortcutOverride event to see if any widgets want to override
the event. If not, uses nextState(QKeyEvent) to check for a grabbed
Shortcut, and dispatchEvent() is found an identical.
- \sa nextState dispatchEvent
+ \sa nextState, dispatchEvent
*/
bool QShortcutMap::tryShortcutEvent(QObject *o, QKeyEvent *e)
{
These components can be retrieved individually using the hueF(),
saturationF(), valueF() and alphaF() functions.
- \sa setHsv() {QColor#The HSV Color Model}{The HSV Color Model}
+ \sa setHsv(), {QColor#The HSV Color Model}{The HSV Color Model}
*/
void QColor::getHsvF(qreal *h, qreal *s, qreal *v, qreal *a) const
{
All the values must be in the range 0.0-1.0.
- \sa getHsvF(), setHsv(), {QColor#The HSV Color Model}{The HSV
- Color Model}
+ \sa getHsvF(), setHsv(), {QColor#The HSV Color Model}{The HSV Color Model}
*/
void QColor::setHsvF(qreal h, qreal s, qreal v, qreal a)
{
The saturation, value and alpha-channel values must be in the range 0-255,
and the hue value must be greater than -1.
- \sa getHsv(), setHsvF(), {QColor#The HSV Color Model}{The HSV
- Color Model}
+ \sa getHsv(), setHsvF(), {QColor#The HSV Color Model}{The HSV Color Model}
*/
void QColor::setHsv(int h, int s, int v, int a)
{
/*!
Returns the alpha color component of this color.
- \sa setAlpha(), alphaF(), {QColor#Alpha-Blended
- Drawing}{Alpha-Blended Drawing}
+ \sa setAlpha(), alphaF(), {QColor#Alpha-Blended Drawing}{Alpha-Blended Drawing}
*/
int QColor::alpha() const
{ return ct.argb.alpha >> 8; }
Sets the alpha of this color to \a alpha. Integer alpha is specified in the
range 0-255.
- \sa alpha(), alphaF(), {QColor#Alpha-Blended
- Drawing}{Alpha-Blended Drawing}
+ \sa alpha(), alphaF(), {QColor#Alpha-Blended Drawing}{Alpha-Blended Drawing}
*/
void QColor::setAlpha(int alpha)
/*!
Returns the alpha color component of this color.
- \sa setAlphaF(), alpha(), {QColor#Alpha-Blended
- Drawing}{Alpha-Blended Drawing}
+ \sa setAlphaF(), alpha(), {QColor#Alpha-Blended Drawing}{Alpha-Blended Drawing}
*/
qreal QColor::alphaF() const
{ return ct.argb.alpha / qreal(USHRT_MAX); }
Sets the alpha of this color to \a alpha. qreal alpha is specified in the
range 0.0-1.0.
- \sa alphaF(), alpha(), {QColor#Alpha-Blended
- Drawing}{Alpha-Blended Drawing}
+ \sa alphaF(), alpha(), {QColor#Alpha-Blended Drawing}{Alpha-Blended Drawing}
*/
void QColor::setAlphaF(qreal alpha)
Sets the green color component of this color to \a green. Integer
components are specified in the range 0-255.
- \sa green(), greenF(), setRgb()
+ \sa green(), greenF(), setRgb()
*/
void QColor::setGreen(int green)
{
The color is implicitly converted to HSV.
- \sa hsvHue(), hueF(), getHsv(), {QColor#The HSV Color Model}{The HSV Color
- Model}
+ \sa hsvHue(), hueF(), getHsv(), {QColor#The HSV Color Model}{The HSV Color Model}
*/
int QColor::hue() const
/*!
Returns the hue color component of this color.
- \sa hueF(), getHsv(), {QColor#The HSV Color Model}{The HSV Color
- Model}
+ \sa hueF(), getHsv(), {QColor#The HSV Color Model}{The HSV Color Model}
*/
int QColor::hsvHue() const
{
/*!
Returns the saturation color component of this color.
- \sa saturationF(), getHsv(), {QColor#The HSV Color Model}{The HSV Color
- Model}
+ \sa saturationF(), getHsv(), {QColor#The HSV Color Model}{The HSV Color Model}
*/
int QColor::hsvSaturation() const
{
/*!
Returns the value color component of this color.
- \sa valueF(), getHsv(), {QColor#The HSV Color Model}{The HSV Color
- Model}
+ \sa valueF(), getHsv(), {QColor#The HSV Color Model}{The HSV Color Model}
*/
int QColor::value() const
{
The color is implicitly converted to HSV.
- \sa hsvHueF(), hue(), getHsvF(), {QColor#The HSV Color Model}{The HSV Color
- Model}
+ \sa hsvHueF(), hue(), getHsvF(), {QColor#The HSV Color Model}{The HSV Color Model}
*/
qreal QColor::hueF() const
{
The color is implicitly converted to HSV.
- \sa hsvSaturationF(), saturation() getHsvF(), {QColor#The HSV Color Model}{The HSV Color
+ \sa hsvSaturationF(), saturation(), getHsvF(), {QColor#The HSV Color Model}{The HSV Color
Model}
*/
qreal QColor::saturationF() const
/*!
Returns the saturation color component of this color.
- \sa saturation() getHsvF(), {QColor#The HSV Color Model}{The HSV Color
- Model}
+ \sa saturation(), getHsvF(), {QColor#The HSV Color Model}{The HSV Color Model}
*/
qreal QColor::hsvSaturationF() const
{
/*!
Returns the value color component of this color.
- \sa value() getHsvF(), {QColor#The HSV Color Model}{The HSV Color
- Model}
+ \sa value(), getHsvF(), {QColor#The HSV Color Model}{The HSV Color Model}
*/
qreal QColor::valueF() const
{
Returns the saturation color component of this color.
- \sa saturationF(), getHsv(), {QColor#The HSV Color Model}{The HSV Color
- Model}
+ \sa saturationF(), getHsv(), {QColor#The HSV Color Model}{The HSV Color Model}
*/
int QColor::hslSaturation() const
{
Returns the saturation color component of this color.
- \sa saturationF() getHslF()
+ \sa saturationF(), getHslF()
*/
qreal QColor::hslSaturationF() const
{
Returns the lightness color component of this color.
- \sa value() getHslF()
+ \sa value(), getHslF()
*/
qreal QColor::lightnessF() const
{
/*!
Returns the cyan color component of this color.
- \sa cyanF(), getCmyk(), {QColor#The CMYK Color Model}{The CMYK
- Color Model}
+ \sa cyanF(), getCmyk(), {QColor#The CMYK Color Model}{The CMYK Color Model}
*/
int QColor::cyan() const
{
/*!
Returns the magenta color component of this color.
- \sa magentaF(), getCmyk(), {QColor#The CMYK Color Model}{The CMYK
- Color Model}
+ \sa magentaF(), getCmyk(), {QColor#The CMYK Color Model}{The CMYK Color Model}
*/
int QColor::magenta() const
{
/*!
Returns the yellow color component of this color.
- \sa yellowF(), getCmyk(), {QColor#The CMYK Color Model}{The CMYK
- Color Model}
+ \sa yellowF(), getCmyk(), {QColor#The CMYK Color Model}{The CMYK Color Model}
*/
int QColor::yellow() const
{
/*!
Returns the black color component of this color.
- \sa blackF(), getCmyk(), {QColor#The CMYK Color Model}{The CMYK
- Color Model}
+ \sa blackF(), getCmyk(), {QColor#The CMYK Color Model}{The CMYK Color Model}
*/
int QColor::black() const
/*!
Returns the cyan color component of this color.
- \sa cyan(), getCmykF(), {QColor#The CMYK Color Model}{The CMYK
- Color Model}
+ \sa cyan(), getCmykF(), {QColor#The CMYK Color Model}{The CMYK Color Model}
*/
qreal QColor::cyanF() const
{
/*!
Returns the magenta color component of this color.
- \sa magenta(), getCmykF(), {QColor#The CMYK Color Model}{The CMYK
- Color Model}
+ \sa magenta(), getCmykF(), {QColor#The CMYK Color Model}{The CMYK Color Model}
*/
qreal QColor::magentaF() const
{
/*!
Returns the yellow color component of this color.
- \sa yellow(), getCmykF(), {QColor#The CMYK Color Model}{The CMYK
- Color Model}
+ \sa yellow(), getCmykF(), {QColor#The CMYK Color Model}{The CMYK Color Model}
*/
qreal QColor::yellowF() const
{
/*!
Returns the black color component of this color.
- \sa black(), getCmykF(), {QColor#The CMYK Color Model}{The CMYK
- Color Model}
+ \sa black(), getCmykF(), {QColor#The CMYK Color Model}{The CMYK Color Model}
*/
qreal QColor::blackF() const
{
/*!
Creates and returns an HSV QColor based on this color.
- \sa fromHsv(), convertTo(), isValid(), {QColor#The HSV Color
- Model}{The HSV Color Model}
+ \sa fromHsv(), convertTo(), isValid(), {QColor#The HSV Color Model}{The HSV Color Model}
*/
QColor QColor::toHsv() const
{
/*!
Creates and returns a CMYK QColor based on this color.
- \sa fromCmyk(), convertTo(), isValid(), {QColor#The CMYK Color
- Model}{The CMYK Color Model}
+ \sa fromCmyk(), convertTo(), isValid(), {QColor#The CMYK Color Model}{The CMYK Color Model}
*/
QColor QColor::toCmyk() const
{
The value of \a s, \a v, and \a a must all be in the range 0-255; the value
of \a h must be in the range 0-359.
- \sa toHsv(), fromHsvF(), isValid(), {QColor#The HSV Color
- Model}{The HSV Color Model}
+ \sa toHsv(), fromHsvF(), isValid(), {QColor#The HSV Color Model}{The HSV Color Model}
*/
QColor QColor::fromHsv(int h, int s, int v, int a)
{
All the values must be in the range 0.0-1.0.
- \sa toHsv(), fromHsv(), isValid(), {QColor#The HSV Color
- Model}{The HSV Color Model}
+ \sa toHsv(), fromHsv(), isValid(), {QColor#The HSV Color Model}{The HSV Color Model}
*/
QColor QColor::fromHsvF(qreal h, qreal s, qreal v, qreal a)
{
All the values must be in the range 0-255.
- \sa getCmyk(), setCmykF(), {QColor#The CMYK Color Model}{The
- CMYK Color Model}
+ \sa getCmyk(), setCmykF(), {QColor#The CMYK Color Model}{The CMYK Color Model}
*/
void QColor::setCmyk(int c, int m, int y, int k, int a)
{
All the values must be in the range 0.0-1.0.
- \sa getCmykF() setCmyk(), {QColor#The CMYK Color Model}{The CMYK
- Color Model}
+ \sa getCmykF(), setCmyk(), {QColor#The CMYK Color Model}{The CMYK Color Model}
*/
void QColor::setCmykF(qreal c, qreal m, qreal y, qreal k, qreal a)
{
All the values must be in the range 0-255.
- \sa toCmyk(), fromCmykF(), isValid(), {QColor#The CMYK Color Model}{The CMYK
- Color Model}
+ \sa toCmyk(), fromCmykF(), isValid(), {QColor#The CMYK Color Model}{The CMYK Color Model}
*/
QColor QColor::fromCmyk(int c, int m, int y, int k, int a)
{
All the values must be in the range 0.0-1.0.
- \sa toCmyk(), fromCmyk(), isValid(), {QColor#The CMYK Color
- Model}{The CMYK Color Model}
+ \sa toCmyk(), fromCmyk(), isValid(), {QColor#The CMYK Color Model}{The CMYK Color Model}
*/
QColor QColor::fromCmykF(qreal c, qreal m, qreal y, qreal k, qreal a)
{
\snippet matrix/matrix.cpp 2
\endtable
- \sa QPainter, QTransform, {Coordinate System},
- {painting/affine}{Affine Transformations Example}, {Transformations Example}
+ \sa QPainter, QTransform, {Coordinate System},
+ {painting/affine}{Affine Transformations Example}, {Transformations Example}
*/
\brief The qFuzzyCompare function is for comparing two matrices
using a fuzziness factor.
-
+
Returns true if \a m1 and \a m2 are equal, allowing for a small
fuzziness factor for floating-point comparisons; false otherwise.
*/
Note that if the logicalDpiY() doesn't equal the physicalDpiY(),
the corresponding QPaintEngine must handle the resolution mapping.
- \sa logicalDpiX(), physicalDpiY()
+ \sa logicalDpiX(), physicalDpiY()
*/
/*!
Note that if the physicalDpiX() doesn't equal the logicalDpiX(),
the corresponding QPaintEngine must handle the resolution mapping.
- \sa physicalDpiY(), logicalDpiX()
+ \sa physicalDpiY(), logicalDpiX()
*/
/*!
Note that if the physicalDpiY() doesn't equal the logicalDpiY(),
the corresponding QPaintEngine must handle the resolution mapping.
- \sa physicalDpiX(), logicalDpiY()
+ \sa physicalDpiX(), logicalDpiY()
*/
painting is to start on the paint device \a pdev. Return true if
the initialization was successful; otherwise return false.
- \sa end() isActive()
+ \sa end(), isActive()
*/
/*!
device. Return true if painting was finished successfully;
otherwise return false.
- \sa begin() isActive()
+ \sa begin(), isActive()
*/
/*!
Scales the coordinate system by (\a{sx}, \a{sy}).
- \sa setWorldTransform() {QPainter#Coordinate Transformations}{Coordinate
- Transformations}
+ \sa setWorldTransform(), {QPainter#Coordinate Transformations}{Coordinate Transformations}
*/
void QPainter::scale(qreal sx, qreal sy)
/*!
Shears the coordinate system by (\a{sh}, \a{sv}).
- \sa setWorldTransform(), {QPainter#Coordinate Transformations}{Coordinate
- Transformations}
+ \sa setWorldTransform(), {QPainter#Coordinate Transformations}{Coordinate Transformations}
*/
void QPainter::shear(qreal sh, qreal sv)
Rotates the coordinate system the given \a angle clockwise.
- \sa setWorldTransform(), {QPainter#Coordinate Transformations}{Coordinate
- Transformations}
+ \sa setWorldTransform(), {QPainter#Coordinate Transformations}{Coordinate Transformations}
*/
void QPainter::rotate(qreal a)
Translates the coordinate system by the given \a offset; i.e. the
given \a offset is added to points.
- \sa setWorldTransform(), {QPainter#Coordinate Transformations}{Coordinate
- Transformations}
+ \sa setWorldTransform(), {QPainter#Coordinate Transformations}{Coordinate Transformations}
*/
void QPainter::translate(const QPointF &offset)
{
\l{Qt::FillRule} for a more detailed description of these fill
rules.
- \sa drawConvexPolygon(), drawPolyline(), {Coordinate System}
+ \sa drawConvexPolygon(), drawPolyline(), {Coordinate System}
*/
void QPainter::drawPolygon(const QPointF *points, int pointCount, Qt::FillRule fillRule)
{
The default viewport rectangle is the same as the device's
rectangle.
- \sa viewport(), viewTransformEnabled() {Coordinate
+ \sa viewport(), viewTransformEnabled(), {Coordinate
System#Window-Viewport Conversion}{Window-Viewport Conversion}
*/
If \a combine is true, the specified \a transform is combined with
the current matrix; otherwise it replaces the current matrix.
- \sa transform() setWorldTransform()
+ \sa transform(), setWorldTransform()
*/
void QPainter::setTransform(const QTransform &transform, bool combine )
\value CurveToDataElement The extra data required to describe a curve in
a CurveToElement element.
- \sa elementAt(), elementCount()
+ \sa elementAt(), elementCount()
*/
/*!
Constructs a pen with the specified \a brush, \a width, pen \a style,
\a cap style and \a join style.
- \sa setBrush(), setWidth(), setStyle(), setCapStyle(), setJoinStyle()
+ \sa setBrush(), setWidth(), setStyle(), setCapStyle(), setJoinStyle()
*/
QPen::QPen(const QBrush &brush, qreal width, Qt::PenStyle s, Qt::PenCapStyle c, Qt::PenJoinStyle j)
Returns the miter limit of the pen. The miter limit is only
relevant when the join style is set to Qt::MiterJoin.
- \sa setMiterLimit(), {QPen#Join Style}{Join Style}
+ \sa setMiterLimit(), {QPen#Join Style}{Join Style}
*/
qreal QPen::miterLimit() const
{
Returns the pen width with floating point precision.
- \sa setWidthF() width()
+ \sa setWidthF(), width()
*/
qreal QPen::widthF() const
{
Setting a pen width with a negative value is not supported.
- \sa setWidth() widthF()
+ \sa setWidth(), widthF()
*/
void QPen::setWidthF(qreal width)
/*!
Returns the pen's join style.
- \sa setJoinStyle(), {QPen#Join Style}{Join Style}
+ \sa setJoinStyle(), {QPen#Join Style}{Join Style}
*/
Qt::PenJoinStyle QPen::joinStyle() const
{
\snippet polygon/polygon.cpp 2
- \sa setPoint() putPoints()
+ \sa setPoint(), putPoints()
*/
void QPolygon::setPoints(int nPoints, const int *points)
Returns the family name that corresponds to the current style
hint.
- \sa StyleHint styleHint() setStyleHint()
+ \sa StyleHint, styleHint(), setStyleHint()
*/
/*!
happens. Please \link bughowto.html report it as a bug\endlink if
it does, preferably with a list of the fonts you have installed.
- \sa lastResortFamily() rawName()
+ \sa lastResortFamily(), rawName()
*/
/*!
algorithm.
\sa Weight, setFamily(), setPointSize(), setWeight(), setItalic(),
- setStyleHint() QGuiApplication::font()
+ setStyleHint(), QGuiApplication::font()
*/
QFont::QFont(const QString &family, int pointSize, int weight, bool italic)
: d(new QFontPrivate()), resolve_mask(QFont::FamilyResolved)
Returns the requested font family name, i.e. the name set in the
constructor or the last setFont() call.
- \sa setFamily() substitutes() substitute()
+ \sa setFamily(), substitutes(), substitute()
*/
QString QFont::family() const
{
Mac OS X and X11 so far. On Windows irregular styles will be added
as separate font families so there is no need for this.
- \sa setFamily() setStyle()
+ \sa setFamily(), setStyle()
*/
QString QFont::styleName() const
{
Returns the point size of the font. Returns -1 if the font size
was specified in pixels.
- \sa setPointSize() pointSizeF()
+ \sa setPointSize(), pointSizeF()
*/
int QFont::pointSize() const
{
Sets the point size to \a pointSize. The point size must be
greater than zero.
- \sa pointSize() setPointSizeF()
+ \sa pointSize(), setPointSizeF()
*/
void QFont::setPointSize(int pointSize)
{
greater than zero. The requested precision may not be achieved on
all platforms.
- \sa pointSizeF() setPointSize() setPixelSize()
+ \sa pointSizeF(), setPointSize(), setPixelSize()
*/
void QFont::setPointSizeF(qreal pointSize)
{
Returns the point size of the font. Returns -1 if the font size was
specified in pixels.
- \sa pointSize() setPointSizeF() pixelSize() QFontInfo::pointSize() QFontInfo::pixelSize()
+ \sa pointSize(), setPointSizeF(), pixelSize(), QFontInfo::pointSize(), QFontInfo::pixelSize()
*/
qreal QFont::pointSizeF() const
{
setPixelSize(). Returns -1 if the size was set with setPointSize()
or setPointSizeF().
- \sa setPixelSize() pointSize() QFontInfo::pointSize() QFontInfo::pixelSize()
+ \sa setPixelSize(), pointSize(), QFontInfo::pointSize(), QFontInfo::pixelSize()
*/
int QFont::pixelSize() const
{
Returns true if the style() of the font is not QFont::StyleNormal
- \sa setItalic() style()
+ \sa setItalic(), style()
*/
/*!
Sets the style() of the font to QFont::StyleItalic if \a enable is true;
otherwise the style is set to QFont::StyleNormal.
- \sa italic() QFontInfo
+ \sa italic(), QFontInfo
*/
/*!
The style strategy affects the \l{QFont}{font matching} algorithm.
See \l QFont::StyleStrategy for the list of available strategies.
- \sa setStyleHint() QFont::StyleHint
+ \sa setStyleHint(), QFont::StyleHint
*/
QFont::StyleStrategy QFont::styleStrategy() const
{
The style hint affects the \l{QFont}{font matching} algorithm.
See \l QFont::StyleHint for the list of available hints.
- \sa setStyleHint(), QFont::StyleStrategy QFontInfo::styleHint()
+ \sa setStyleHint(), QFont::StyleStrategy, QFontInfo::styleHint()
*/
QFont::StyleHint QFont::styleHint() const
{
\value ExtraExpanded 150
\value UltraExpanded 200
- \sa setStretch() stretch()
+ \sa setStretch(), stretch()
*/
/*!
X11, the stretch factor is matched against a predefined set of
values for the SETWIDTH_NAME field of the XLFD.
- \sa stretch() QFont::Stretch
+ \sa stretch(), QFont::Stretch
*/
void QFont::setStretch(int factor)
{
equal. If rawMode() is enabled for both fonts, only the family
fields are compared.
- \sa operator!=() isCopyOf()
+ \sa operator!=(), isCopyOf()
*/
bool QFont::operator==(const QFont &f) const
{
This function is useful in some circumstances, for example if you
want to use QFont objects as keys in a QMap.
- \sa operator==() operator!=() isCopyOf()
+ \sa operator==(), operator!=(), isCopyOf()
*/
bool QFont::operator<(const QFont &f) const
{
one of them was created as a copy of the other and neither has
been modified since. This is much stricter than equality.
- \sa operator=() operator==()
+ \sa operator=(), operator==()
*/
bool QFont::isCopyOf(const QFont & f) const
{
Returns true if raw mode is used for font name matching; otherwise
returns false.
- \sa setRawMode() rawName()
+ \sa setRawMode(), rawName()
*/
bool QFont::rawMode() const
{
To obtain a list of substitutions use substitutes().
- \sa setFamily() insertSubstitutions() insertSubstitution() removeSubstitutions()
+ \sa setFamily(), insertSubstitutions(), insertSubstitution(), removeSubstitutions()
*/
QString QFont::substitute(const QString &familyName)
{
If there is no substitution for \a familyName, an empty list is
returned.
- \sa substitute() insertSubstitutions() insertSubstitution() removeSubstitutions()
+ \sa substitute(), insertSubstitutions(), insertSubstitution(), removeSubstitutions()
*/
QStringList QFont::substitutes(const QString &familyName)
{
Inserts \a substituteName into the substitution
table for the family \a familyName.
- \sa insertSubstitutions() removeSubstitutions() substitutions() substitute() substitutes()
+ \sa insertSubstitutions(), removeSubstitutions(), substitutions(), substitute(), substitutes()
*/
void QFont::insertSubstitution(const QString &familyName,
const QString &substituteName)
info object is \e not updated.
\endlist
- \sa QFont QFontMetrics QFontDatabase
+ \sa QFont, QFontMetrics, QFontDatabase
*/
/*!
/*!
Returns the point size of the matched window system font.
- \sa pointSizeF() QFont::pointSize()
+ \sa pointSizeF(), QFont::pointSize()
*/
int QFontInfo::pointSize() const
{
Currently only returns the style hint set in QFont.
- \sa QFont::styleHint() QFont::StyleHint
+ \sa QFont::styleHint(), QFont::StyleHint
*/
QFont::StyleHint QFontInfo::styleHint() const
{
Example:
\snippet code/src_gui_text_qfontmetrics.cpp 1
- \sa QFont QFontInfo QFontDatabase
+ \sa QFont, QFontInfo, QFontDatabase
*/
/*!
\a pos using a \c MoveMode specified by \a m. The cursor is positioned
between characters.
- \sa position() movePosition() anchor()
+ \sa position(), movePosition(), anchor()
*/
void QTextCursor::setPosition(int pos, MoveMode m)
{
Returns the absolute position of the cursor within the document.
The cursor is positioned between characters.
- \sa setPosition() movePosition() anchor() positionInBlock()
+ \sa setPosition(), movePosition(), anchor(), positionInBlock()
*/
int QTextCursor::position() const
{
selection and anchor() marks the other end. Just like the cursor
position, the anchor position is between characters.
- \sa position() setPosition() movePosition() selectionStart() selectionEnd()
+ \sa position(), setPosition(), movePosition(), selectionStart(), selectionEnd()
*/
int QTextCursor::anchor() const
{
Any ASCII linefeed characters (\\n) in the inserted text are transformed
into unicode block separators, corresponding to insertBlock() calls.
- \sa charFormat() hasSelection()
+ \sa charFormat(), hasSelection()
*/
void QTextCursor::insertText(const QString &text)
{
If there is no selected text, deletes the character \e at the
current cursor position; otherwise deletes the selected text.
- \sa deletePreviousChar() hasSelection() clearSelection()
+ \sa deletePreviousChar(), hasSelection(), clearSelection()
*/
void QTextCursor::deleteChar()
{
If there is no selected text, deletes the character \e before the
current cursor position; otherwise deletes the selected text.
- \sa deleteChar() hasSelection() clearSelection()
+ \sa deleteChar(), hasSelection(), clearSelection()
*/
void QTextCursor::deletePreviousChar()
{
Note that it does \b{not} delete the text of the selection.
- \sa removeSelectedText() hasSelection()
+ \sa removeSelectedText(), hasSelection()
*/
void QTextCursor::clearSelection()
{
Returns the start of the selection or position() if the
cursor doesn't have a selection.
- \sa selectionEnd() position() anchor()
+ \sa selectionEnd(), position(), anchor()
*/
int QTextCursor::selectionStart() const
{
Returns the end of the selection or position() if the cursor
doesn't have a selection.
- \sa selectionStart() position() anchor()
+ \sa selectionStart(), position(), anchor()
*/
int QTextCursor::selectionEnd() const
{
/*!
Returns the block format of the block the cursor is in.
- \sa setBlockFormat() charFormat()
+ \sa setBlockFormat(), charFormat()
*/
QTextBlockFormat QTextCursor::blockFormat() const
{
list item of a newly created list with the given \a format. Returns
the created list.
- \sa currentList() createList() insertBlock()
+ \sa currentList(), createList(), insertBlock()
*/
QTextList *QTextCursor::insertList(const QTextListFormat &format)
{
Creates and returns a new list with the given \a format, and makes the
current paragraph the cursor is in the first list item.
- \sa insertList() currentList()
+ \sa insertList(), currentList()
*/
QTextList *QTextCursor::createList(const QTextListFormat &format)
{
The style to be used is defined by the QTextListFormat::Style enum.
- \sa insertList() currentList()
+ \sa insertList(), currentList()
*/
QTextList *QTextCursor::createList(QTextListFormat::Style style)
{
Returns the current list if the cursor position() is inside a
block that is part of a list; otherwise returns 0.
- \sa insertList() createList()
+ \sa insertList(), createList()
*/
QTextList *QTextCursor::currentList() const
{
one of them was created as a copy of the other and neither has moved since.
This is much stricter than equality.
- \sa operator=() operator==()
+ \sa operator=(), operator==()
*/
bool QTextCursor::isCopyOf(const QTextCursor &other) const
{
\li Text block group format changes.
\endlist
- \sa QTextCursor, QTextEdit, \link richtext.html Rich Text Processing\endlink , {Text Object Example}
+ \sa QTextCursor, QTextEdit, {Rich Text Processing}, {Text Object Example}
*/
/*!
signals are emitted, QTextDocument::undoAvailable() or
QTextDocument::redoAvailable().
- \sa QTextDocument::undoAvailable() QTextDocument::redoAvailable()
+ \sa QTextDocument::undoAvailable(), QTextDocument::redoAvailable()
*/
void QTextDocument::clearUndoRedoStacks(Stacks stacksToClear)
{
Creates a QTextDocumentFragment from the \a{cursor}'s selection.
If the cursor doesn't have a selection, the created fragment is empty.
- \sa isEmpty() QTextCursor::selection()
+ \sa isEmpty(), QTextCursor::selection()
*/
QTextDocumentFragment::QTextDocumentFragment(const QTextCursor &cursor)
: d(0)
Returns the value of the property specified by \a propertyId. If the
property isn't of QTextFormat::Bool type, false is returned instead.
- \sa setProperty() intProperty() doubleProperty() stringProperty() colorProperty() lengthProperty() lengthVectorProperty() Property
+ \sa setProperty(), intProperty(), doubleProperty(), stringProperty(), colorProperty(),
+ lengthProperty(), lengthVectorProperty(), Property
*/
bool QTextFormat::boolProperty(int propertyId) const
{
Returns the value of the property specified by \a propertyId. If the
property is not of QTextFormat::Integer type, 0 is returned instead.
- \sa setProperty() boolProperty() doubleProperty() stringProperty() colorProperty() lengthProperty() lengthVectorProperty() Property
+ \sa setProperty(), boolProperty(), doubleProperty(), stringProperty(), colorProperty(),
+ lengthProperty(), lengthVectorProperty(), Property
*/
int QTextFormat::intProperty(int propertyId) const
{
property isn't of QVariant::Double or QMetaType::Float type, 0 is
returned instead.
- \sa setProperty() boolProperty() intProperty() stringProperty() colorProperty() lengthProperty() lengthVectorProperty() Property
+ \sa setProperty(), boolProperty(), intProperty(), stringProperty(), colorProperty(),
+ lengthProperty(), lengthVectorProperty(), Property
*/
qreal QTextFormat::doubleProperty(int propertyId) const
{
property isn't of QVariant::String type, an empty string is
returned instead.
- \sa setProperty() boolProperty() intProperty() doubleProperty() colorProperty() lengthProperty() lengthVectorProperty() Property
+ \sa setProperty(), boolProperty(), intProperty(), doubleProperty(), colorProperty(),
+ lengthProperty(), lengthVectorProperty(), Property
*/
QString QTextFormat::stringProperty(int propertyId) const
{
property isn't of QVariant::Pen type, Qt::NoPen is
returned instead.
- \sa setProperty() boolProperty() intProperty() doubleProperty() stringProperty() lengthProperty() lengthVectorProperty() Property
+ \sa setProperty(), boolProperty(), intProperty(), doubleProperty(), stringProperty(),
+ lengthProperty(), lengthVectorProperty(), Property
*/
QPen QTextFormat::penProperty(int propertyId) const
{
property isn't of QVariant::Brush type, Qt::NoBrush is
returned instead.
- \sa setProperty() boolProperty() intProperty() doubleProperty() stringProperty() lengthProperty() lengthVectorProperty() Property
+ \sa setProperty(), boolProperty(), intProperty(), doubleProperty(), stringProperty(),
+ lengthProperty(), lengthVectorProperty(), Property
*/
QBrush QTextFormat::brushProperty(int propertyId) const
{
/*!
Returns the value of the property given by \a propertyId.
- \sa setProperty() boolProperty() intProperty() doubleProperty() stringProperty() colorProperty() lengthVectorProperty() Property
+ \sa setProperty(), boolProperty(), intProperty(), doubleProperty(), stringProperty(),
+ colorProperty(), lengthVectorProperty(), Property
*/
QTextLength QTextFormat::lengthProperty(int propertyId) const
{
property isn't of QTextFormat::LengthVector type, an empty length
vector is returned instead.
- \sa setProperty() boolProperty() intProperty() doubleProperty() stringProperty() colorProperty() lengthProperty() Property
+ \sa setProperty(), boolProperty(), intProperty(), doubleProperty(), stringProperty(),
+ colorProperty(), lengthProperty(), Property
*/
QVector<QTextLength> QTextFormat::lengthVectorProperty(int propertyId) const
{
/*!
Sets the value of the property given by \a propertyId to \a value.
- \sa lengthVectorProperty() Property
+ \sa lengthVectorProperty(), Property
*/
void QTextFormat::setProperty(int propertyId, const QVector<QTextLength> &value)
{
Returns true if the text format has a property with the given \a
propertyId; otherwise returns false.
- \sa properties() Property
+ \sa properties(), Property
*/
bool QTextFormat::hasProperty(int propertyId) const
{
/*
Returns the property type for the given \a propertyId.
- \sa hasProperty() allPropertyIds() Property
+ \sa hasProperty(), allPropertyIds(), Property
*/
/*!
setAnchorHref() and setAnchorNames() functions are used to specify the
information about the hyperlink's destination and the anchor's name.
- \sa QTextFormat QTextBlockFormat QTextTableFormat QTextListFormat
+ \sa QTextFormat, QTextBlockFormat, QTextTableFormat, QTextListFormat
*/
/*!
Sets the foreground brush to the specified \a brush. The foreground
brush is mostly used to render text.
- \sa foreground() clearForeground() setBackground()
+ \sa foreground(), clearForeground(), setBackground()
*/
Returns the brush used to render foreground details, such as text,
frame outlines, and table borders.
- \sa setForeground() clearForeground() background()
+ \sa setForeground(), clearForeground(), background()
*/
/*!
Clears the brush used to paint the document's foreground. The default
brush will be used.
- \sa foreground() setForeground() clearBackground()
+ \sa foreground(), setForeground(), clearBackground()
*/
Returns true if the text is formatted as an anchor; otherwise
returns false.
- \sa setAnchor() setAnchorHref() setAnchorNames()
+ \sa setAnchor(), setAnchorHref(), setAnchorNames()
*/
Sets the paragraph's top \a margin.
- \sa topMargin() setBottomMargin() setLeftMargin() setRightMargin()
+ \sa topMargin(), setBottomMargin(), setLeftMargin(), setRightMargin()
*/
Returns the paragraph's top margin.
- \sa setTopMargin() bottomMargin()
+ \sa setTopMargin(), bottomMargin()
*/
Sets the paragraph's bottom \a margin.
- \sa bottomMargin() setTopMargin() setLeftMargin() setRightMargin()
+ \sa bottomMargin(), setTopMargin(), setLeftMargin(), setRightMargin()
*/
Returns the paragraph's bottom margin.
- \sa setBottomMargin() topMargin()
+ \sa setBottomMargin(), topMargin()
*/
Sets the paragraph's left \a margin. Indentation can be applied separately
with setIndent().
- \sa leftMargin() setRightMargin() setTopMargin() setBottomMargin()
+ \sa leftMargin(), setRightMargin(), setTopMargin(), setBottomMargin()
*/
Returns the paragraph's left margin.
- \sa setLeftMargin() rightMargin() indent()
+ \sa setLeftMargin(), rightMargin(), indent()
*/
Sets the paragraph's right \a margin.
- \sa rightMargin() setLeftMargin() setTopMargin() setBottomMargin()
+ \sa rightMargin(), setLeftMargin(), setTopMargin(), setBottomMargin()
*/
Returns the paragraph's right margin.
- \sa setRightMargin() leftMargin()
+ \sa setRightMargin(), leftMargin()
*/
line of a paragraph to be indented differently to the other lines,
enhancing the readability of the text.
- \sa textIndent() setLeftMargin() setRightMargin() setTopMargin() setBottomMargin()
+ \sa textIndent(), setLeftMargin(), setRightMargin(), setTopMargin(), setBottomMargin()
*/
The \a indentation is an integer that is multiplied with the document-wide
standard indent, resulting in the actual indent of the paragraph.
- \sa indent() QTextDocument::indentWidth()
+ \sa indent(), QTextDocument::indentWidth()
*/
Sets the list format's \a style.
- \sa style() Style
+ \sa style(), Style
*/
/*!
Returns the list format's style.
- \sa setStyle() Style
+ \sa setStyle(), Style
*/
The validity of a QTextFrameFormat object can be determined with the
isValid() function.
- \sa QTextFrame QTextBlockFormat
+ \sa QTextFrame, QTextBlockFormat
*/
/*!
\value FloatLeft
\value FloatRight
- \sa position() CssFloat
+ \sa position(), CssFloat
*/
/*!
\value BorderStyle_Inset
\value BorderStyle_Outset
- \sa borderStyle() FrameBorderStyle
+ \sa borderStyle(), FrameBorderStyle
*/
/*!
with a vector containing new constraints. If no constraints are
required, clearColumnWidthConstraints() can be used to remove them.
- \sa QTextTable QTextTableCell QTextLength
+ \sa QTextTable, QTextTableCell, QTextLength
*/
/*!
Clears the column width constraints for the table.
- \sa columnWidthConstraints() setColumnWidthConstraints()
+ \sa columnWidthConstraints(), setColumnWidthConstraints()
*/
/*!
Sets the column width \a constraints for the table.
- \sa columnWidthConstraints() clearColumnWidthConstraints()
+ \sa columnWidthConstraints(), clearColumnWidthConstraints()
*/
/*!
Sets the brush use to paint the document's background to the
\a brush specified.
- \sa background() clearBackground() setForeground()
+ \sa background(), clearBackground(), setForeground()
*/
/*!
Returns the brush used to paint the document's background.
- \sa setBackground() clearBackground() foreground()
+ \sa setBackground(), clearBackground(), foreground()
*/
/*!
Clears the brush used to paint the document's background. The default
brush will be used.
- \sa background() setBackground() clearForeground()
+ \sa background(), setBackground(), clearForeground()
*/
Sets the \a width of the rectangle occupied by the image.
- \sa width() setHeight()
+ \sa width(), setHeight()
*/
Returns the width of the rectangle occupied by the image.
- \sa height() setWidth()
+ \sa height(), setWidth()
*/
Sets the \a height of the rectangle occupied by the image.
- \sa height() setWidth()
+ \sa height(), setWidth()
*/
Returns the height of the rectangle occupied by the image.
- \sa width() setHeight()
+ \sa width(), setHeight()
*/
/*!
setRightPadding(), setTopPadding(), and setBottomPadding(). All the paddings
can be set at once using setPadding().
- \sa QTextFormat QTextBlockFormat QTextTableFormat QTextCharFormat
+ \sa QTextFormat, QTextBlockFormat, QTextTableFormat, QTextCharFormat
*/
// ------------------------------------------------------
/*!
Returns the \a{i}-th text block in the list.
- \sa count() itemText()
+ \sa count(), itemText()
*/
QTextBlock QTextList::item(int i) const
{
/*!
Returns the text object's format.
- \sa setFormat() document()
+ \sa setFormat(), document()
*/
QTextFormat QTextObject::format() const
{
for example, the top-level items in a multi-level list will be separated
by the items in lower levels of the list.
- \sa QTextBlock QTextDocument
+ \sa QTextBlock, QTextDocument
*/
void QTextBlockGroupPrivate::markBlocksDirty()
QTextFrame::iterator class: this provides read-only access to its
internal list of text blocks and child frames.
- \sa QTextCursor QTextDocument
+ \sa QTextCursor, QTextDocument
*/
/*!
Returns the parent frame of the current frame.
- \sa currentFrame() QTextFrame::parentFrame()
+ \sa currentFrame(), QTextFrame::parentFrame()
*/
/*!
Returns the frame's parent frame. If the frame is the root frame of a
document, this will return 0.
- \sa childFrames() QTextDocument::rootFrame()
+ \sa childFrames(), QTextDocument::rootFrame()
*/
QTextFrame *QTextFrame::parentFrame() const
{
/*!
Returns the first cursor position inside the frame.
- \sa lastCursorPosition() firstPosition() lastPosition()
+ \sa lastCursorPosition(), firstPosition(), lastPosition()
*/
QTextCursor QTextFrame::firstCursorPosition() const
{
/*!
Returns the last cursor position inside the frame.
- \sa firstCursorPosition() firstPosition() lastPosition()
+ \sa firstCursorPosition(), firstPosition(), lastPosition()
*/
QTextCursor QTextFrame::lastCursorPosition() const
{
/*!
Returns the first document position inside the frame.
- \sa lastPosition() firstCursorPosition() lastCursorPosition()
+ \sa lastPosition(), firstCursorPosition(), lastCursorPosition()
*/
int QTextFrame::firstPosition() const
{
/*!
Returns the last document position inside the frame.
- \sa firstPosition() firstCursorPosition() lastCursorPosition()
+ \sa firstPosition(), firstCursorPosition(), lastCursorPosition()
*/
int QTextFrame::lastPosition() const
{
/*!
Moves the iterator to the next frame or block.
- \sa currentBlock() currentFrame()
+ \sa currentBlock(), currentFrame()
*/
QTextFrame::iterator &QTextFrame::iterator::operator++()
{
/*!
Moves the iterator to the previous frame or block.
- \sa currentBlock() currentFrame()
+ \sa currentBlock(), currentFrame()
*/
QTextFrame::iterator &QTextFrame::iterator::operator--()
{
\img qtextblock-sequence.png
- \sa QTextBlockFormat QTextCharFormat QTextFragment
+ \sa QTextBlockFormat, QTextCharFormat, QTextFragment
*/
/*!
\note The length returned includes all formatting characters,
for example, newline.
- \sa text() charFormat() blockFormat()
+ \sa text(), charFormat(), blockFormat()
*/
int QTextBlock::length() const
{
/*!
Returns the block's contents as plain text.
- \sa length() charFormat() blockFormat()
+ \sa length(), charFormat(), blockFormat()
*/
QString QTextBlock::text() const
{
Returns a text block iterator pointing to the end of the text
block.
- \sa begin() next() previous()
+ \sa begin(), next(), previous()
*/
QTextBlock::iterator QTextBlock::end() const
{
Note that the next block may be in a different frame or table to this block.
- \sa previous() begin() end()
+ \sa previous(), begin(), end()
*/
QTextBlock QTextBlock::next() const
{
Note that the next block may be in a different frame or table to this block.
- \sa next() begin() end()
+ \sa next(), begin(), end()
*/
QTextBlock QTextBlock::previous() const
{
contents. The firstCursorPosition() and lastCursorPosition() functions
are used to obtain the extent of the cell in the document.
- \sa QTextTable QTextTableFormat
+ \sa QTextTable, QTextTableFormat
*/
/*!
Returns the table cell at the given \a row and \a column in the table.
- \sa columns() rows()
+ \sa columns(), rows()
*/
QTextTableCell QTextTable::cellAt(int row, int col) const
{
Resizes the table to contain the required number of \a rows and \a columns.
- \sa insertRows() insertColumns() removeRows() removeColumns()
+ \sa insertRows(), insertColumns(), removeRows(), removeColumns()
*/
void QTextTable::resize(int rows, int cols)
{
Inserts a number of \a rows before the row with the specified \a index.
- \sa resize() insertColumns() removeRows() removeColumns() appendRows() appendColumns()
+ \sa resize(), insertColumns(), removeRows(), removeColumns(), appendRows(), appendColumns()
*/
void QTextTable::insertRows(int pos, int num)
{
Inserts a number of \a columns before the column with the specified \a index.
- \sa insertRows() resize() removeRows() removeColumns() appendRows() appendColumns()
+ \sa insertRows(), resize(), removeRows(), removeColumns(), appendRows(), appendColumns()
*/
void QTextTable::insertColumns(int pos, int num)
{
\since 4.5
Appends \a count rows at the bottom of the table.
- \sa insertColumns() insertRows() resize() removeRows() removeColumns() appendColumns()
+ \sa insertColumns(), insertRows(), resize(), removeRows(), removeColumns(), appendColumns()
*/
void QTextTable::appendRows(int count)
{
\since 4.5
Appends \a count columns at the right side of the table.
- \sa insertColumns() insertRows() resize() removeRows() removeColumns() appendRows()
+ \sa insertColumns(), insertRows(), resize(), removeRows(), removeColumns(), appendRows()
*/
void QTextTable::appendColumns(int count)
{
Removes a number of \a rows starting with the row at the specified \a index.
- \sa insertRows(), insertColumns(), resize(), removeColumns() appendRows() appendColumns()
+ \sa insertRows(), insertColumns(), resize(), removeColumns(), appendRows(), appendColumns()
*/
void QTextTable::removeRows(int pos, int num)
{
Removes a number of \a columns starting with the column at the specified
\a index.
- \sa insertRows() insertColumns() removeRows() resize() appendRows() appendColumns()
+ \sa insertRows(), insertColumns(), removeRows(), resize(), appendRows(), appendColumns()
*/
void QTextTable::removeColumns(int pos, int num)
{
\value CacheLocation Returns a directory location where user-specific
non-essential (cached) data should be written.
- \sa storageLocation() displayName()
+ \sa storageLocation(), displayName()
*/
/*!
locale set with QLocale::setDefault(). If a default locale has not
been set, it is the operating system's locale.
- \sa locale() QLocale::setDefault()
+ \sa locale(), QLocale::setDefault()
*/
void QValidator::setLocale(const QLocale &locale)
{
there is new data available for reading; otherwise it returns false
(if an error occurred or the operation timed out).
- \sa waitForBytesWritten()
+ \sa waitForBytesWritten()
*/
bool QAbstractSocket::waitForReadyRead(int msecs)
{
\snippet code/src_network_ssl_qsslconfiguration.cpp 0
- \sa QSsl::SslProtocol, QSslCertificate, QSslCipher, QSslKey
+ \sa QSsl::SslProtocol, QSslCertificate, QSslCipher, QSslKey,
QSslSocket, QNetworkAccessManager,
QSslSocket::sslConfiguration(), QSslSocket::setSslConfiguration()
*/
to and including the item with index \a child. Returns true if a
selection was made or extended; otherwise returns false.
- \sa selection() clearSelection()
+ \sa selection(), clearSelection()
*/
bool QAccessibleTabBar::setSelected(int child, bool on, bool extend)
{
Returns a (possibly empty) list of indexes of the items selected
in the list box.
- \sa setSelected() clearSelection()
+ \sa setSelected(), clearSelection()
*/
QVector<int> QAccessibleTabBar::selection() const
{
Note that changing the engines will reset the printer state and
all its properties.
- \sa printEngine() paintEngine() setOutputFormat()
+ \sa printEngine(), paintEngine(), setOutputFormat()
\since 4.1
*/
Mac OS X can generate PDF's from its print engine, set the output format
back to NativeFormat.
- \sa outputFileName() setOutputToFile() setOutputFormat()
+ \sa outputFileName(), setOutputToFile(), setOutputFormat()
*/
void QPrinter::setOutputFileName(const QString &fileName)
\since 4.4
Returns the printer paper size. The default value is driver-dependent.
- \sa setPaperSize() pageRect() paperRect()
+ \sa setPaperSize(), pageRect(), paperRect()
*/
QPrinter::PaperSize QPrinter::paperSize() const
This function is useful mostly for setting a default value that
the user can override in the print dialog.
- \sa paperSize() PaperSize setFullPage() setResolution() pageRect() paperRect()
+ \sa paperSize(), PaperSize, setFullPage(), setResolution(), pageRect(), paperRect()
*/
void QPrinter::setPaperSize(PaperSize newPaperSize)
{
See setFullPage() for details and caveats.
- \sa setFullPage() PaperSize
+ \sa setFullPage(), PaperSize
*/
bool QPrinter::fullPage() const
This function must be called before QPainter::begin() to have an effect on
all platforms.
- \sa resolution() setPaperSize()
+ \sa resolution(), setPaperSize()
*/
void QPrinter::setResolution(int dpi)
doesn't affect any currently active queries.
\sa QSql::NumericalPrecisionPolicy, numericalPrecisionPolicy(),
- QSqlQuery::setNumericalPrecisionPolicy(), QSqlQuery::numericalPrecisionPolicy()
+ QSqlQuery::setNumericalPrecisionPolicy(), QSqlQuery::numericalPrecisionPolicy()
*/
void QSqlDatabase::setNumericalPrecisionPolicy(QSql::NumericalPrecisionPolicy precisionPolicy)
{
Returns the current default precision policy for the database connection.
- \sa QSql::NumericalPrecisionPolicy, setNumericalPrecisionPolicy(),
- QSqlQuery::numericalPrecisionPolicy(), QSqlQuery::setNumericalPrecisionPolicy()
+ \sa QSql::NumericalPrecisionPolicy, setNumericalPrecisionPolicy(),
+ QSqlQuery::numericalPrecisionPolicy(), QSqlQuery::setNumericalPrecisionPolicy()
*/
QSql::NumericalPrecisionPolicy QSqlDatabase::numericalPrecisionPolicy() const
{
Note: Setting the default precision policy to \a precisionPolicy
doesn't affect any currently active queries.
- \sa QSql::NumericalPrecisionPolicy, numericalPrecisionPolicy(),
+ \sa QSql::NumericalPrecisionPolicy, numericalPrecisionPolicy(),
QSqlQuery::setNumericalPrecisionPolicy(), QSqlQuery::numericalPrecisionPolicy()
*/
void QSqlDriver::setNumericalPrecisionPolicy(QSql::NumericalPrecisionPolicy precisionPolicy)
Returns the current default precision policy for the database connection.
- \sa QSql::NumericalPrecisionPolicy, setNumericalPrecisionPolicy(),
+ \sa QSql::NumericalPrecisionPolicy, setNumericalPrecisionPolicy(),
QSqlQuery::numericalPrecisionPolicy(), QSqlQuery::setNumericalPrecisionPolicy()
*/
QSql::NumericalPrecisionPolicy QSqlDriver::numericalPrecisionPolicy() const
should be set at application startup, before any non-GUI
threads are created.
- \sa system() c()
+ \sa system(), c()
* /
void QLocale::setDefault(const QLocale &locale)
{
/*!
Hides the modal dialog and sets the result code to \c Accepted.
- \sa reject() done()
+ \sa reject(), done()
*/
void QDialog::accept()
/*!
Hides the modal dialog and sets the result code to \c Rejected.
- \sa accept() done()
+ \sa accept(), done()
*/
void QDialog::reject()
/*!
The following path changed data update our copy of that data
- \sa layoutChanged() dataChanged()
+ \sa layoutChanged(), dataChanged()
*/
void QUrlModel::changed(const QString &path)
{
This function always returns false for items not in a scene.
- \sa panelModality() setPanelModality() PanelModality
+ \sa panelModality(), setPanelModality(), PanelModality
*/
bool QGraphicsItem::isBlockedByModalPanel(QGraphicsItem **blockingPanel) const
{
key sequence, so are much easier to use than this low-level
function.
- \sa releaseShortcut() setShortcutEnabled() QWidget::grabShortcut()
+ \sa releaseShortcut(), setShortcutEnabled(), QWidget::grabShortcut()
*/
int QGraphicsWidget::grabShortcut(const QKeySequence &sequence, Qt::ShortcutContext context)
{
this low-level function. Note also that this is an expensive
operation.
- \sa grabShortcut() setShortcutEnabled() , QWidget::releaseShortcut()
+ \sa grabShortcut(), setShortcutEnabled(), QWidget::releaseShortcut()
*/
void QGraphicsWidget::releaseShortcut(int id)
{
to use QAction or QShortcut to handle shortcuts, since they are
easier to use than this low-level function.
- \sa grabShortcut() releaseShortcut(), QWidget::setShortcutEnabled()
+ \sa grabShortcut(), releaseShortcut(), QWidget::setShortcutEnabled()
*/
void QGraphicsWidget::setShortcutEnabled(int id, bool enabled)
{
If \a enabled is true, auto repeat of the shortcut with the
given \a id is enabled; otherwise it is disabled.
- \sa grabShortcut() releaseShortcut() QWidget::setShortcutAutoRepeat()
+ \sa grabShortcut(), releaseShortcut(), QWidget::setShortcutAutoRepeat()
*/
void QGraphicsWidget::setShortcutAutoRepeat(int id, bool enabled)
{
editor paints its own background (e.g., with
\l{QWidget::}{setAutoFillBackground()}).
- \sa destroyEditor() setModelData() setEditorData()
+ \sa destroyEditor(), setModelData(), setEditorData()
*/
QWidget *QAbstractItemDelegate::createEditor(QWidget *,
const QStyleOptionViewItem &,
and, in many-item selections, whether the selection must be a
continuous range of items.
- \sa SelectionMode SelectionBehavior
+ \sa SelectionMode, SelectionBehavior
*/
void QAbstractItemView::setSelectionMode(SelectionMode mode)
{
This property holds whether selections are done
in terms of single items, rows or columns.
- \sa SelectionMode SelectionBehavior
+ \sa SelectionMode, SelectionBehavior
*/
void QAbstractItemView::setSelectionBehavior(QAbstractItemView::SelectionBehavior behavior)
\property QAbstractItemView::showDropIndicator
\brief whether the drop indicator is shown when dragging items and dropping.
- \sa dragEnabled DragDropMode dragDropOverwriteMode acceptDrops
+ \sa dragEnabled, DragDropMode, dragDropOverwriteMode, acceptDrops
*/
void QAbstractItemView::setDropIndicatorShown(bool enable)
\property QAbstractItemView::dragEnabled
\brief whether the view supports dragging of its own items
- \sa showDropIndicator DragDropMode dragDropOverwriteMode acceptDrops
+ \sa showDropIndicator, DragDropMode, dragDropOverwriteMode, acceptDrops
*/
void QAbstractItemView::setDragEnabled(bool enable)
Note that the model used needs to provide support for drag and drop operations.
- \sa setDragDropMode() {Using drag and drop with item views}
+ \sa setDragDropMode(), {Using drag and drop with item views}
*/
/*!
\brief the drag and drop event the view will act upon
\since 4.2
- \sa showDropIndicator dragDropOverwriteMode
+ \sa showDropIndicator, dragDropOverwriteMode
*/
void QAbstractItemView::setDragDropMode(DragDropMode behavior)
{
actions support CopyAction.
\since 4.6
- \sa showDropIndicator dragDropOverwriteMode
+ \sa showDropIndicator, dragDropOverwriteMode
*/
void QAbstractItemView::setDefaultDropAction(Qt::DropAction dropAction)
{
the widget. If the drag is over a valid dropping place (e.g. over an item that
accepts drops), the event is accepted; otherwise it is ignored.
- \sa dropEvent() startDrag()
+ \sa dropEvent(), startDrag()
*/
void QAbstractItemView::dragEnterEvent(QDragEnterEvent *event)
{
the user drags a selection to view's right or bottom edge. In this case, the
event will be accepted; otherwise it will be ignored.
- \sa dropEvent() startDrag()
+ \sa dropEvent(), startDrag()
*/
void QAbstractItemView::dragMoveEvent(QDragMoveEvent *event)
{
Note that if the view has a horizontal header, the item steps
will be ignored and the header section size will be used instead.
- \sa horizontalStepsPerItem() setVerticalStepsPerItem()
+ \sa horizontalStepsPerItem(), setVerticalStepsPerItem()
*/
void QAbstractItemView::setHorizontalStepsPerItem(int steps)
{
\obsolete
Returns the horizontal scroll bar's steps per item.
- \sa setHorizontalStepsPerItem() verticalStepsPerItem()
+ \sa setHorizontalStepsPerItem(), verticalStepsPerItem()
*/
int QAbstractItemView::horizontalStepsPerItem() const
{
Note that if the view has a vertical header, the item steps
will be ignored and the header section size will be used instead.
- \sa verticalStepsPerItem() setHorizontalStepsPerItem()
+ \sa verticalStepsPerItem(), setHorizontalStepsPerItem()
*/
void QAbstractItemView::setVerticalStepsPerItem(int steps)
{
\obsolete
Returns the vertical scroll bar's steps per item.
- \sa setVerticalStepsPerItem() horizontalStepsPerItem()
+ \sa setVerticalStepsPerItem(), horizontalStepsPerItem()
*/
int QAbstractItemView::verticalStepsPerItem() const
{
Return the new view
- \sa createColumn() setPreviewWidget()
+ \sa createColumn(), setPreviewWidget()
\sa doLayout()
*/
QAbstractItemView *QColumnViewPrivate::createColumn(const QModelIndex &index, bool show)
/*!
Returns the sorting method used for the directory model.
- \sa QDir::SortFlags */
+ \sa QDir::SortFlags
+*/
QDir::SortFlags QDirModel::sorting() const
{
The following values are obsolete:
\value Custom Use Fixed instead.
- \sa setResizeMode() setSectionResizeMode() stretchLastSection minimumSectionSize
+ \sa setResizeMode(), setSectionResizeMode(), stretchLastSection, minimumSectionSize
*/
/*!
/*!
Returns the number of sections in the header.
- \sa sectionCountChanged(), length()
+ \sa sectionCountChanged(), length()
*/
int QHeaderView::count() const
and the model will return to its natural, unsorted order. Note that not
all models support this and may even crash in this case.
- \sa sortIndicatorSection() sortIndicatorOrder()
+ \sa sortIndicatorSection(), sortIndicatorOrder()
*/
void QHeaderView::setSortIndicator(int logicalIndex, Qt::SortOrder order)
Returns the logical index of the section that has a sort indicator.
By default this is section 0.
- \sa setSortIndicator() sortIndicatorOrder() setSortIndicatorShown()
+ \sa setSortIndicator(), sortIndicatorOrder(), setSortIndicatorShown()
*/
int QHeaderView::sortIndicatorSection() const
Returns the order for the sort indicator. If no section has a sort
indicator the return value of this function is undefined.
- \sa setSortIndicator() sortIndicatorSection()
+ \sa setSortIndicator(), sortIndicatorSection()
*/
Qt::SortOrder QHeaderView::sortIndicatorOrder() const
This property only affects sections that have \l Interactive or \l Fixed
as their resize mode.
- \sa setSectionResizeMode() minimumSectionSize
+ \sa setSectionResizeMode(), minimumSectionSize
*/
int QHeaderView::defaultSectionSize() const
{
This property is honored by all \l{ResizeMode}{resize modes}.
- \sa setSectionResizeMode() defaultSectionSize
+ \sa setSectionResizeMode(), defaultSectionSize
*/
int QHeaderView::minimumSectionSize() const
{
Returns the list item's tooltip.
- \sa setToolTip() statusTip() whatsThis()
+ \sa setToolTip(), statusTip(), whatsThis()
*/
/*!
Returns the list item's "What's This?" help text.
- \sa setWhatsThis() statusTip() toolTip()
+ \sa setWhatsThis(), statusTip(), toolTip()
*/
/*!
Returns the brush used to display the list item's background.
- \sa setBackground() foreground()
+ \sa setBackground(), foreground()
*/
/*!
Returns the brush used to display the list item's foreground (e.g. text).
- \sa setForeground() background()
+ \sa setForeground(), background()
*/
/*!
Sets the background brush of the list item to the given \a brush.
- \sa background() setForeground()
+ \sa background(), setForeground()
*/
/*!
Sets the foreground brush of the list item to the given \a brush.
- \sa foreground() setBackground()
+ \sa foreground(), setBackground()
*/
/*!
representation, proxy models must create their own model indexes instead of
supplying model indexes from their underlying models.
- \sa \link model-view-programming.html Model/View Programming\endlink QAbstractItemModel
+ \sa {Model/View Programming}, QAbstractItemModel
*/
The base class implementation returns false. This function and
data() must be reimplemented for editable models.
- \sa data() itemData() QAbstractItemModel::setData()
+ \sa data(), itemData(), QAbstractItemModel::setData()
*/
bool QProxyModel::setData(const QModelIndex &index, const QVariant &value, int role)
{
Returns true if the rows were successfully inserted; otherwise
returns false.
- \sa QAbstractItemModel::insertRows()*/
+ \sa QAbstractItemModel::insertRows()
+*/
bool QProxyModel::insertRows(int row, int count, const QModelIndex &parent)
{
Q_D(const QProxyModel);
Sets the font used to display the item's text to the given \a font.
- \sa font() setText() setForeground()
+ \sa font(), setText(), setForeground()
*/
/*!
Returns the brush used to render the item's background.
- \sa foreground() setBackground()
+ \sa foreground(), setBackground()
*/
/*!
Sets the item's background brush to the specified \a brush.
- \sa background() setForeground()
+ \sa background(), setForeground()
*/
/*!
Returns the brush used to render the item's foreground (e.g. text).
- \sa setForeground() background()
+ \sa setForeground(), background()
*/
/*!
Sets the brush used to display the item's foreground (e.g. text) to the
given \a brush.
- \sa foreground() setBackground() setFont()
+ \sa foreground(), setBackground(), setFont()
*/
/*!
/*!
Sets the widget to use for the horizontal header to \a header.
- \sa horizontalHeader() setVerticalHeader()
+ \sa horizontalHeader(), setVerticalHeader()
*/
void QTableView::setHorizontalHeader(QHeaderView *header)
{
/*!
Sets the widget to use for the vertical header to \a header.
- \sa verticalHeader() setHorizontalHeader()
+ \sa verticalHeader(), setHorizontalHeader()
*/
void QTableView::setVerticalHeader(QHeaderView *header)
{
/*!
Hide the given \a row.
- \sa showRow() hideColumn()
+ \sa showRow(), hideColumn()
*/
void QTableView::hideRow(int row)
{
/*!
Hide the given \a column.
- \sa showColumn() hideRow()
+ \sa showColumn(), hideRow()
*/
void QTableView::hideColumn(int column)
{
/*!
Show the given \a row.
- \sa hideRow() showColumn()
+ \sa hideRow(), showColumn()
*/
void QTableView::showRow(int row)
{
/*!
Show the given \a column.
- \sa hideColumn() showRow()
+ \sa hideColumn(), showRow()
*/
void QTableView::showColumn(int column)
{
Sets the item's text to the \a text specified.
- \sa text() setFont() setForeground()
+ \sa text(), setFont(), setForeground()
*/
/*!
\a statusTip. QTableWidget mouse tracking needs to be enabled for this
feature to work.
- \sa statusTip() setToolTip() setWhatsThis()
+ \sa statusTip(), setToolTip(), setWhatsThis()
*/
/*!
Sets the item's tooltip to the string specified by \a toolTip.
- \sa toolTip() setStatusTip() setWhatsThis()
+ \sa toolTip(), setStatusTip(), setWhatsThis()
*/
/*!
Sets the item's "What's This?" help to the string specified by \a whatsThis.
- \sa whatsThis() setStatusTip() setToolTip()
+ \sa whatsThis(), setStatusTip(), setToolTip()
*/
/*!
Sets the font used to display the item's text to the given \a font.
- \sa font() setText() setForeground()
+ \sa font(), setText(), setForeground()
*/
/*!
This signal is emitted whenever the selection changes.
- \sa selectedItems() QTableWidgetItem::isSelected()
+ \sa selectedItems(), QTableWidgetItem::isSelected()
*/
you to use the same \a row argument for all items in the same row
(i.e. setItem() will not move the row).
- \sa item() takeItem()
+ \sa item(), takeItem()
*/
void QTableWidget::setItem(int row, int column, QTableWidgetItem *item)
{
Warning: if the model contains a large number of items,
this function will take some time to execute.
- \sa collapseAll() expand() collapse() setExpanded()
+ \sa collapseAll(), expand(), collapse(), setExpanded()
*/
void QTreeView::expandAll()
{
Collapses all expanded items.
- \sa expandAll() expand() collapse() setExpanded()
+ \sa expandAll(), expand(), collapse(), setExpanded()
*/
void QTreeView::collapseAll()
{
\since 4.3
Expands all expandable items to the given \a depth.
- \sa expandAll() collapseAll() expand() collapse() setExpanded()
+ \sa expandAll(), collapseAll(), expand(), collapse(), setExpanded()
*/
void QTreeView::expandToDepth(int depth)
{
Sets the text to be displayed in the given \a column to the given \a text.
- \sa text() setFont() setForeground()
+ \sa text(), setFont(), setForeground()
*/
/*!
Sets the status tip for the given \a column to the given \a statusTip.
QTreeWidget mouse tracking needs to be enabled for this feature to work.
- \sa statusTip() setToolTip() setWhatsThis()
+ \sa statusTip(), setToolTip(), setWhatsThis()
*/
/*!
Sets the tooltip for the given \a column to \a toolTip.
- \sa toolTip() setStatusTip() setWhatsThis()
+ \sa toolTip(), setStatusTip(), setWhatsThis()
*/
/*!
Sets the "What's This?" help for the given \a column to \a whatsThis.
- \sa whatsThis() setStatusTip() setToolTip()
+ \sa whatsThis(), setStatusTip(), setToolTip()
*/
/*!
Sets the font used to display the text in the given \a column to the given
\a font.
- \sa font() setText() setForeground()
+ \sa font(), setText(), setForeground()
*/
/*!
/*!
Appends the \a child item to the list of children.
- \sa insertChild() takeChild()
+ \sa insertChild(), takeChild()
*/
void QTreeWidgetItem::addChild(QTreeWidgetItem *child)
{
Appends the given list of \a children to the item.
- \sa insertChildren() takeChildren()
+ \sa insertChildren(), takeChildren()
*/
void QTreeWidgetItem::addChildren(const QList<QTreeWidgetItem*> &children)
{
By default, this property contains the application's default font.
- \sa QAction::setText() QStyle
+ \sa QAction::setText(), QStyle
*/
void QAction::setFont(const QFont &font)
{
By default, this property contains the action's text.
- \sa setStatusTip() setShortcut()
+ \sa setStatusTip(), setShortcut()
*/
void QAction::setToolTip(const QString &tooltip)
{
By default, this property contains an empty string.
- \sa setToolTip() showStatusText()
+ \sa setToolTip(), showStatusText()
*/
void QAction::setStatusTip(const QString &statustip)
{
For example:
\snippet code/src_gui_kernel_qaction.cpp 0
- \sa QAction::icon QApplication::setAttribute()
+ \sa QAction::icon, QApplication::setAttribute()
*/
void QAction::setIconVisibleInMenu(bool visible)
{
The default value is 4 pixels.
- \sa startDragTime() QPoint::manhattanLength() {Drag and Drop}
+ \sa startDragTime(), QPoint::manhattanLength(), {Drag and Drop}
*/
int QApplication::startDragDistance()
Returns the direction of the box. addWidget() and addSpacing()
work in this direction; the stretch stretches in this direction.
- \sa QBoxLayout::Direction addWidget() addSpacing()
+ \sa QBoxLayout::Direction, addWidget(), addSpacing()
*/
QBoxLayout::Direction QBoxLayout::direction() const
When entering "What's This?" mode, a QEvent of type
Qt::EnterWhatsThisMode is sent to all toplevel widgets.
- \sa inWhatsThisMode() leaveWhatsThisMode()
+ \sa inWhatsThisMode(), leaveWhatsThisMode()
*/
void QWhatsThis::enterWhatsThisMode()
{
When leaving "What's This?" mode, a QEvent of type
Qt::LeaveWhatsThisMode is sent to all toplevel widgets.
- \sa enterWhatsThisMode() inWhatsThisMode()
+ \sa enterWhatsThisMode(), inWhatsThisMode()
*/
void QWhatsThis::leaveWhatsThisMode()
{
combination of Qt::WindowState: Qt::WindowMinimized,
Qt::WindowMaximized, Qt::WindowFullScreen, and Qt::WindowActive.
- \sa Qt::WindowState setWindowState()
+ \sa Qt::WindowState, setWindowState()
*/
Qt::WindowStates QWidget::windowState() const
{
When the window state changes, the widget receives a changeEvent()
of type QEvent::WindowStateChange.
- \sa Qt::WindowState windowState()
+ \sa Qt::WindowState, windowState()
*/
/*!
isEnabledTo(0) is equivalent to isEnabled().
- \sa setEnabled() enabled
+ \sa setEnabled(), enabled
*/
bool QWidget::isEnabledTo(const QWidget *ancestor) const
By default, this property contains a value that depends on the user's
platform and screen geometry.
- \sa geometry() x() y() pos()
+ \sa geometry(), x(), y(), pos()
*/
QRect QWidget::frameGeometry() const
{
See the \l{Window Geometry} documentation for an overview of geometry
issues with windows.
- \sa frameGeometry, size x(), y()
+ \sa frameGeometry, size, x(), y()
*/
QPoint QWidget::pos() const
{
By default, for a widget with no children, this property contains a
rectangle with zero width and height located at the origin.
- \sa childrenRegion() geometry()
+ \sa childrenRegion(), geometry()
*/
QRect QWidget::childrenRect() const
By default, for a widget with no children, this property contains an
empty region.
- \sa childrenRect() geometry() mask()
+ \sa childrenRect(), geometry(), mask()
*/
QRegion QWidget::childrenRegion() const
Sets both the minimum and maximum width of the widget to \a w
without changing the heights. Provided for convenience.
- \sa sizeHint() minimumSize() maximumSize() setFixedSize()
+ \sa sizeHint(), minimumSize(), maximumSize(), setFixedSize()
*/
void QWidget::setFixedWidth(int w)
Sets both the minimum and maximum heights of the widget to \a h
without changing the widths. Provided for convenience.
- \sa sizeHint() minimumSize() maximumSize() setFixedSize()
+ \sa sizeHint(), minimumSize(), maximumSize(), setFixedSize()
*/
void QWidget::setFixedHeight(int h)
of \a parent. The \a parent must not be 0 and must be a parent
of the calling widget.
- \sa mapFrom() mapToParent() mapToGlobal() underMouse()
+ \sa mapFrom(), mapToParent(), mapToGlobal(), underMouse()
*/
QPoint QWidget::mapTo(const QWidget * parent, const QPoint & pos) const
of \a parent to this widget's coordinate system. The \a parent
must not be 0 and must be a parent of the calling widget.
- \sa mapTo() mapFromParent() mapFromGlobal() underMouse()
+ \sa mapTo(), mapFromParent(), mapFromGlobal(), underMouse()
*/
QPoint QWidget::mapFrom(const QWidget * parent, const QPoint & pos) const
Same as mapToGlobal() if the widget has no parent.
- \sa mapFromParent() mapTo() mapToGlobal() underMouse()
+ \sa mapFromParent(), mapTo(), mapToGlobal(), underMouse()
*/
QPoint QWidget::mapToParent(const QPoint &pos) const
Same as mapFromGlobal() if the widget has no parent.
- \sa mapToParent() mapFrom() mapFromGlobal() underMouse()
+ \sa mapToParent(), mapFrom(), mapFromGlobal(), underMouse()
*/
QPoint QWidget::mapFromParent(const QPoint &pos) const
If the widget displays dates or numbers, these should be formatted
using the widget's locale.
- \sa QLocale QLocale::setDefault()
+ \sa QLocale, QLocale::setDefault()
*/
void QWidgetPrivate::setLocale_helper(const QLocale &loc, bool forceUpdate)
\link QAbstractScrollArea::viewport() viewport() \endlink .
- \sa mapToGlobal() QMenu contextMenuPolicy
+ \sa mapToGlobal(), QMenu, contextMenuPolicy
*/
isVisibleTo(0) is identical to isVisible().
- \sa show() hide() isVisible()
+ \sa show(), hide(), isVisible()
*/
bool QWidget::isVisibleTo(const QWidget *ancestor) const
developer to ensure that the application interprets these events
correctly.
- \sa mousePressEvent(), mouseReleaseEvent() mouseMoveEvent(),
+ \sa mousePressEvent(), mouseReleaseEvent(), mouseMoveEvent(),
event(), QMouseEvent
*/
The default implementation ignores the context event.
See the \l QContextMenuEvent documentation for more details.
- \sa event(), QContextMenuEvent customContextMenuRequested()
+ \sa event(), QContextMenuEvent, customContextMenuRequested()
*/
void QWidget::contextMenuEvent(QContextMenuEvent *event)
use additional space, and that they can make do with less than
sizeHint().
- \sa sizeHint() QLayout QSizePolicy updateGeometry()
+ \sa sizeHint(), QLayout, QSizePolicy, updateGeometry()
*/
QSizePolicy QWidget::sizePolicy() const
{
If the Qt::WA_OpaquePaintEvent widget attribute is set, the widget is
responsible for painting all its pixels with an opaque color.
- \sa repaint() paintEvent(), setUpdatesEnabled(), {Analog Clock Example}
+ \sa repaint(), paintEvent(), setUpdatesEnabled(), {Analog Clock Example}
*/
void QWidget::update()
{
By default, this property contains an empty string.
- \sa QToolTip statusTip whatsThis
+ \sa QToolTip, statusTip, whatsThis
*/
void QWidget::setToolTip(const QString &s)
{
By default, this property contains an empty string.
- \sa toolTip whatsThis
+ \sa toolTip, whatsThis
*/
void QWidget::setStatusTip(const QString &s)
{
By default, this property contains an empty string.
- \sa QWhatsThis QWidget::toolTip QWidget::statusTip
+ \sa QWhatsThis, QWidget::toolTip, QWidget::statusTip
*/
void QWidget::setWhatsThis(const QString &s)
{
key sequence, so are much easier to use than this low-level
function.
- \sa releaseShortcut() setShortcutEnabled()
+ \sa releaseShortcut(), setShortcutEnabled()
*/
int QWidget::grabShortcut(const QKeySequence &key, Qt::ShortcutContext context)
{
this low-level function. Note also that this is an expensive
operation.
- \sa grabShortcut() setShortcutEnabled()
+ \sa grabShortcut(), setShortcutEnabled()
*/
void QWidget::releaseShortcut(int id)
{
to use QAction or QShortcut to handle shortcuts, since they are
easier to use than this low-level function.
- \sa grabShortcut() releaseShortcut()
+ \sa grabShortcut(), releaseShortcut()
*/
void QWidget::setShortcutEnabled(int id, bool enable)
{
If \a enable is true, auto repeat of the shortcut with the
given \a id is enabled; otherwise it is disabled.
- \sa grabShortcut() releaseShortcut()
+ \sa grabShortcut(), releaseShortcut()
*/
void QWidget::setShortcutAutoRepeat(int id, bool enable)
{
coordinates. For example, \c{mapToGlobal(QPoint(0,0))} would give
the global coordinates of the top-left pixel of the widget.
- \sa mapFromGlobal() mapTo() mapToParent()
+ \sa mapFromGlobal(), mapTo(), mapToParent()
*/
/*!
Translates the global screen coordinate \a pos to widget
coordinates.
- \sa mapToGlobal() mapFrom() mapFromParent()
+ \sa mapToGlobal(), mapFrom(), mapFromParent()
*/
/*!
frame of that widget. For \e Carbon, it works outside the widget's
frame as well, like for Windows and X11.
- \sa releaseMouse() grabKeyboard() releaseKeyboard()
+ \sa releaseMouse(), grabKeyboard(), releaseKeyboard()
*/
/*!
If a different widget is currently grabbing keyboard input, that
widget's grab is released first.
- \sa releaseKeyboard() grabMouse() releaseMouse() focusWidget()
+ \sa releaseKeyboard(), grabMouse(), releaseMouse(), focusWidget()
*/
/*!
to its default value, you must save the old value of the attribute before
you change it.
- \sa focusRectPolicy() QWidget::setAttribute()
+ \sa focusRectPolicy(), QWidget::setAttribute()
*/
/*! \fn QMacStyle::FocusRectPolicy QMacStyle::focusRectPolicy(const QWidget *w)
\value CC_CustomBase Base value for custom complex controls. Custom
values must be greater than this value.
- \sa SubControl drawComplexControl()
+ \sa SubControl, drawComplexControl()
*/
/*!
\row \li \l CT_MenuItem \li \l QStyleOptionMenuItem
\endtable
- \sa ContentsType QStyleOption
+ \sa ContentsType, QStyleOption
*/
/*!
The default value is 0.
- \sa QAbstractSlider::tracking sliderPosition
+ \sa QAbstractSlider::tracking, sliderPosition
*/
/*!
On Mac OS X, the Growl notification system must be installed for this function to
display messages.
- \sa show() supportsMessages()
+ \sa show(), supportsMessages()
*/
void QSystemTrayIcon::showMessage(const QString& title, const QString& msg,
QSystemTrayIcon::MessageIcon icon, int msecs)
QObject in QUndoStack::QUndoStack(). In this case, the stack is deleted when the
group is deleted, in the usual manner of QObjects.
- \sa removeStack() stacks() QUndoStack::QUndoStack()
+ \sa removeStack(), stacks(), QUndoStack::QUndoStack()
*/
void QUndoGroup::addStack(QUndoStack *stack)
Removes \a stack from this group. If the stack was the active stack in the group,
the active stack becomes 0.
- \sa addStack() stacks() QUndoStack::~QUndoStack()
+ \sa addStack(), stacks(), QUndoStack::~QUndoStack()
*/
void QUndoGroup::removeStack(QUndoStack *stack)
/*!
Returns a list of stacks in this group.
- \sa addStack() removeStack()
+ \sa addStack(), removeStack()
*/
QList<QUndoStack*> QUndoGroup::stacks() const
in the same way as those returned by \a stack's QUndoStack::createUndoAction()
and QUndoStack::createRedoAction().
- \sa QUndoStack::setActive() activeStack()
+ \sa QUndoStack::setActive(), activeStack()
*/
void QUndoGroup::setActiveStack(QUndoStack *stack)
If none of the stacks are active, or if the group is empty, this function
returns 0.
- \sa setActiveStack() QUndoStack::setActive()
+ \sa setActiveStack(), QUndoStack::setActive()
*/
QUndoStack *QUndoGroup::activeStack() const
If none of the stacks are active, or if the group is empty, this function
does nothing.
- \sa redo() canUndo() setActiveStack()
+ \sa redo(), canUndo(), setActiveStack()
*/
void QUndoGroup::undo()
If none of the stacks are active, or if the group is empty, this function
does nothing.
- \sa undo() canRedo() setActiveStack()
+ \sa undo(), canRedo(), setActiveStack()
*/
If none of the stacks are active, or if the group is empty, this function
returns false.
- \sa canRedo() setActiveStack()
+ \sa canRedo(), setActiveStack()
*/
bool QUndoGroup::canUndo() const
If none of the stacks are active, or if the group is empty, this function
returns false.
- \sa canUndo() setActiveStack()
+ \sa canUndo(), setActiveStack()
*/
bool QUndoGroup::canRedo() const
If none of the stacks are active, or if the group is empty, this function
returns an empty string.
- \sa redoText() setActiveStack()
+ \sa redoText(), setActiveStack()
*/
QString QUndoGroup::undoText() const
If none of the stacks are active, or if the group is empty, this function
returns an empty string.
- \sa undoText() setActiveStack()
+ \sa undoText(), setActiveStack()
*/
QString QUndoGroup::redoText() const
If \a prefix is empty, the default template "Undo %1" is used instead of prefix.
Before Qt 4.8, the prefix "Undo" was used by default.
- \sa createRedoAction() canUndo() QUndoCommand::text()
+ \sa createRedoAction(), canUndo(), QUndoCommand::text()
*/
QAction *QUndoGroup::createUndoAction(QObject *parent, const QString &prefix) const
If \a prefix is empty, the default template "Redo %1" is used instead of prefix.
Before Qt 4.8, the prefix "Redo" was used by default.
- \sa createUndoAction() canRedo() QUndoCommand::text()
+ \sa createUndoAction(), canRedo(), QUndoCommand::text()
*/
QAction *QUndoGroup::createRedoAction(QObject *parent, const QString &prefix) const
is removed form the group. \a stack is the new active stack. If no stack is active,
\a stack is 0.
- \sa setActiveStack() QUndoStack::setActive()
+ \sa setActiveStack(), QUndoStack::setActive()
*/
/*! \fn void QUndoGroup::indexChanged(int idx)
\a idx is the new current index, or 0 if the active stack is 0.
- \sa QUndoStack::indexChanged() setActiveStack()
+ \sa QUndoStack::indexChanged(), setActiveStack()
*/
/*! \fn void QUndoGroup::cleanChanged(bool clean)
\a clean is the new state, or true if the active stack is 0.
- \sa QUndoStack::cleanChanged() setActiveStack()
+ \sa QUndoStack::cleanChanged(), setActiveStack()
*/
/*! \fn void QUndoGroup::canUndoChanged(bool canUndo)
\a canUndo is the new state, or false if the active stack is 0.
- \sa QUndoStack::canUndoChanged() setActiveStack()
+ \sa QUndoStack::canUndoChanged(), setActiveStack()
*/
/*! \fn void QUndoGroup::canRedoChanged(bool canRedo)
\a canRedo is the new state, or false if the active stack is 0.
- \sa QUndoStack::canRedoChanged() setActiveStack()
+ \sa QUndoStack::canRedoChanged(), setActiveStack()
*/
/*! \fn void QUndoGroup::undoTextChanged(const QString &undoText)
\a undoText is the new state, or an empty string if the active stack is 0.
- \sa QUndoStack::undoTextChanged() setActiveStack()
+ \sa QUndoStack::undoTextChanged(), setActiveStack()
*/
/*! \fn void QUndoGroup::redoTextChanged(const QString &redoText)
\a redoText is the new state, or an empty string if the active stack is 0.
- \sa QUndoStack::redoTextChanged() setActiveStack()
+ \sa QUndoStack::redoTextChanged(), setActiveStack()
*/
QT_END_NAMESPACE
\snippet code/src_gui_util_qundostack.cpp 3
- \sa id() QUndoStack::push()
+ \sa id(), QUndoStack::push()
*/
bool QUndoCommand::mergeWith(const QUndoCommand *command)
different strings in order to match specific languages' needs.
The described feature and the function actionText() are available since Qt 4.8.
- \sa text() actionText() QUndoStack::createUndoAction() QUndoStack::createRedoAction()
+ \sa text(), actionText(), QUndoStack::createUndoAction(), QUndoStack::createRedoAction()
*/
void QUndoCommand::setText(const QString &text)
been executed will almost always lead to corruption of the document's
state.
- \sa QUndoCommand::id() QUndoCommand::mergeWith()
+ \sa QUndoCommand::id(), QUndoCommand::mergeWith()
*/
void QUndoStack::push(QUndoCommand *cmd)
/*!
If the stack is in the clean state, returns true; otherwise returns false.
- \sa setClean() cleanIndex()
+ \sa setClean(), cleanIndex()
*/
bool QUndoStack::isClean() const
push() deletes all the undone commands before pushing the new command, the stack
can't return to the clean state again. In this case, this function returns -1.
- \sa isClean() setClean()
+ \sa isClean(), setClean()
*/
int QUndoStack::cleanIndex() const
If the stack is empty, or if the bottom command on the stack has already been
undone, this function does nothing.
- \sa redo() index()
+ \sa redo(), index()
*/
void QUndoStack::undo()
If the stack is empty, or if the top command on the stack has already been
redone, this function does nothing.
- \sa undo() index()
+ \sa undo(), index()
*/
void QUndoStack::redo()
Returns the number of commands on the stack. Macro commands are counted as
one command.
- \sa index() setIndex() command()
+ \sa index(), setIndex(), command()
*/
int QUndoStack::count() const
executed on the next call to redo(). It is not always the top-most command
on the stack, since a number of commands may have been undone.
- \sa undo() redo() count()
+ \sa undo(), redo(), count()
*/
int QUndoStack::index() const
\a idx. This function can be used to roll the state of the document forwards
of backwards. indexChanged() is emitted only once.
- \sa index() count() undo() redo()
+ \sa index(), count(), undo(), redo()
*/
void QUndoStack::setIndex(int idx)
Synonymous with index() == 0.
- \sa index() canRedo()
+ \sa index(), canRedo()
*/
bool QUndoStack::canUndo() const
Synonymous with index() == count().
- \sa index() canUndo()
+ \sa index(), canUndo()
*/
bool QUndoStack::canRedo() const
/*!
Returns the text of the command which will be undone in the next call to undo().
- \sa QUndoCommand::actionText() redoText()
+ \sa QUndoCommand::actionText(), redoText()
*/
QString QUndoStack::undoText() const
/*!
Returns the text of the command which will be redone in the next call to redo().
- \sa QUndoCommand::actionText() undoText()
+ \sa QUndoCommand::actionText(), undoText()
*/
QString QUndoStack::redoText() const
\a idx specifies the index of the current command, ie. the command which will be
executed on the next call to redo().
- \sa index() setIndex()
+ \sa index(), setIndex()
*/
/*!
If \a clean is true, the stack is in a clean state; otherwise this signal
indicates that it has left the clean state.
- \sa isClean() setClean()
+ \sa isClean(), setClean()
*/
/*!
Returns the stack currently displayed by this view. If the view is looking at a
QUndoGroup, this the group's active stack.
- \sa setStack() setGroup()
+ \sa setStack(), setGroup()
*/
QUndoStack *QUndoView::stack() const
If the view was previously looking at a QUndoGroup, the group is set to 0.
- \sa stack() setGroup()
+ \sa stack(), setGroup()
*/
void QUndoView::setStack(QUndoStack *stack)
The view will update itself autmiatically whenever the active stack of the group changes.
- \sa group() setStack()
+ \sa group(), setStack()
*/
void QUndoView::setGroup(QUndoGroup *group)
If the view is not looking at group, this function returns 0.
- \sa setGroup() setStack()
+ \sa setGroup(), setStack()
*/
QUndoGroup *QUndoView::group() const
This signal is emitted when the user releases the slider with the
mouse, or programmatically when setSliderDown(false) is called.
- \sa sliderPressed() sliderMoved() sliderDown
+ \sa sliderPressed(), sliderMoved(), sliderDown
*/
/*!
If \a max is smaller than \a min, \a min becomes the only legal
value.
- \sa minimum maximum
+ \sa minimum, maximum
*/
void QAbstractSlider::setRange(int min, int max)
{
of the mapping mechanism is to simplify the representation of enum
values in a user interface.
- \sa QGroupBox QPushButton, QCheckBox, QRadioButton
+ \sa QGroupBox, QPushButton, QCheckBox, QRadioButton
*/
/*!
Constructs a new, empty button group with the given \a parent.
- \sa addButton() setExclusive()
+ \sa addButton(), setExclusive()
*/
/*!
starting with -2. If you are assigning your own ids, use
positive values to avoid conflicts.
- \sa removeButton() buttons()
+ \sa removeButton(), buttons()
*/
/*!
Removes the given \a button from the button group.
- \sa addButton() buttons()
+ \sa addButton(), buttons()
*/
/*!
Returns the check box's check state. If you do not need tristate support,
you can also use \l QAbstractButton::isChecked() which returns a boolean.
- \sa setCheckState() Qt::CheckState
+ \sa setCheckState(), Qt::CheckState
*/
Qt::CheckState QCheckBox::checkState() const
{
support, you can also use \l QAbstractButton::setChecked() which takes a
boolean.
- \sa checkState() Qt::CheckState
+ \sa checkState(), Qt::CheckState
*/
void QCheckBox::setCheckState(Qt::CheckState state)
{
By default it will also carry an arrow icon, indicating that pressing the
control will open another window or page.
- \sa QPushButton QRadioButton
+ \sa QPushButton, QRadioButton
*/
/*!
This signal is emitted when a button inside the button box is clicked, as long
as it was defined with the \l AcceptRole or \l YesRole.
- \sa rejected(), clicked() helpRequested()
+ \sa rejected(), clicked(), helpRequested()
*/
/*!
This signal is emitted when a button inside the button box is clicked, as long
as it was defined with the \l RejectRole or \l NoRole.
- \sa accepted() helpRequested() clicked()
+ \sa accepted(), helpRequested(), clicked()
*/
/*!
This signal is emitted when a button inside the button box is clicked, as long
as it was defined with the \l HelpRole.
- \sa accepted() rejected() clicked()
+ \sa accepted(), rejected(), clicked()
*/
/*!
The action's text is set to the dock widget's window title.
- \sa QAction::text QWidget::windowTitle
+ \sa QAction::text, QWidget::windowTitle
*/
QAction * QDockWidget::toggleViewAction() const
{
to its parent QDockWidget. Hence it can perform such operations as docking
and hiding in response to user actions.
- \sa titleBarWidget() DockWidgetVerticalTitleBar
+ \sa titleBarWidget(), DockWidgetVerticalTitleBar
*/
void QDockWidget::setTitleBarWidget(QWidget *widget)
the lineWidth() and the midLineWidth() to create the total result.
See the picture of the frames in the main class documentation.
- \sa QFrame::Shadow QFrame::style() QStyle::drawPrimitive()
+ \sa QFrame::Shadow, QFrame::style(), QStyle::drawPrimitive()
*/
midLineWidth(). See the picture of the frames in the main class
documentation.
- \sa QFrame::Shape lineWidth() midLineWidth()
+ \sa QFrame::Shape, lineWidth(), midLineWidth()
*/
/*!
By default, this property contains an empty string.
- \sa setEchoMode() text() EchoMode
+ \sa setEchoMode(), text(), EchoMode
*/
QString QLineEdit::displayText() const
\value PasswordEchoOnEdit Display characters as they are entered
while editing otherwise display asterisks.
- \sa setEchoMode() echoMode()
+ \sa setEchoMode(), echoMode()
*/
By default, this property is set to \l Normal.
- \sa EchoMode displayText()
+ \sa EchoMode, displayText()
*/
QLineEdit::EchoMode QLineEdit::echoMode() const
The initial setting is to have no input validator (i.e. any input
is accepted up to maxLength()).
- \sa validator() QIntValidator QDoubleValidator QRegExpValidator
+ \sa validator(), QIntValidator, QDoubleValidator, QRegExpValidator
*/
void QLineEdit::setValidator(const QValidator *v)
Selects text from position \a start and for \a length characters.
Negative lengths are allowed.
- \sa deselect() selectAll() selectedText()
+ \sa deselect(), selectAll(), selectedText()
*/
void QLineEdit::setSelection(int start, int length)
because if the user types before clicking on the widget, the
selected text will be deleted.
- \sa setSelection() deselect()
+ \sa setSelection(), deselect()
*/
void QLineEdit::selectAll()
/*!
Deselects any selected text.
- \sa setSelection() selectAll()
+ \sa setSelection(), selectAll()
*/
void QLineEdit::deselect()
If the current validator disallows deleting the selected text,
cut() will copy without deleting.
- \sa copy() paste() setValidator()
+ \sa copy(), paste(), setValidator()
*/
void QLineEdit::cut()
Copies the selected text to the clipboard, if there is any, and if
echoMode() is \l Normal.
- \sa cut() paste()
+ \sa cut(), paste()
*/
void QLineEdit::copy() const
If the end result would not be acceptable to the current
\link setValidator() validator\endlink, nothing happens.
- \sa copy() cut()
+ \sa copy(), cut()
*/
void QLineEdit::paste()
bar block (i.e. line). If the main window already manages \a toolbar
then it will only move the toolbar to \a area.
- \sa insertToolBar() addToolBarBreak() insertToolBarBreak()
+ \sa insertToolBar(), addToolBarBreak(), insertToolBarBreak()
*/
void QMainWindow::addToolBar(Qt::ToolBarArea area, QToolBar *toolbar)
{
layout operation, this means that \a toolbar will appear to the left
of the toolbar specified by \a before in a horizontal toolbar area.
- \sa insertToolBarBreak() addToolBar() addToolBarBreak()
+ \sa insertToolBarBreak(), addToolBar(), addToolBarBreak()
*/
void QMainWindow::insertToolBar(QToolBar *before, QToolBar *toolbar)
{
been added to the main window, this function returns \c
Qt::NoToolBarArea.
- \sa addToolBar() addToolBarBreak() Qt::ToolBarArea
+ \sa addToolBar(), addToolBarBreak(), Qt::ToolBarArea
*/
Qt::ToolBarArea QMainWindow::toolBarArea(QToolBar *toolbar) const
{ return d_func()->layout->toolBarArea(toolbar); }
Returns whether there is a toolbar
break before the \a toolbar.
- \sa addToolBarBreak(), insertToolBarBreak()
+ \sa addToolBarBreak(), insertToolBarBreak()
*/
bool QMainWindow::toolBarBreak(QToolBar *toolbar) const
{
has not been added to the main window, this function returns \c
Qt::NoDockWidgetArea.
- \sa addDockWidget() splitDockWidget() Qt::DockWidgetArea
+ \sa addDockWidget(), splitDockWidget(), Qt::DockWidgetArea
*/
Qt::DockWidgetArea QMainWindow::dockWidgetArea(QDockWidget *dockwidget) const
{ return d_func()->layout->dockWidgetArea(dockwidget); }
is useful for subclasses when they need a QStyleOptionMenuItem, but don't want
to fill in all the information themselves.
- \sa QStyleOption::initFrom() QMenuBar::initStyleOption()
+ \sa QStyleOption::initFrom(), QMenuBar::initStyleOption()
*/
void QMenu::initStyleOption(QStyleOptionMenuItem *option, const QAction *action) const
{
It returns \a menu's menuAction(). This menu does not take
ownership of \a menu.
- \sa QWidget::addAction() QMenu::menuAction()
+ \sa QWidget::addAction(), QMenu::menuAction()
*/
QAction *QMenu::addMenu(QMenu *menu)
{
Appends a new QMenu with \a title to the menu. The menu
takes ownership of the menu. Returns the new menu.
- \sa QWidget::addAction() QMenu::menuAction()
+ \sa QWidget::addAction(), QMenu::menuAction()
*/
QMenu *QMenu::addMenu(const QString &title)
{
Appends a new QMenu with \a icon and \a title to the menu. The menu
takes ownership of the menu. Returns the new menu.
- \sa QWidget::addAction() QMenu::menuAction()
+ \sa QWidget::addAction(), QMenu::menuAction()
*/
QMenu *QMenu::addMenu(const QIcon &icon, const QString &title)
{
contents in a new window. When the menu is in this mode and the menu
is visible returns true; otherwise false.
- \sa hideTearOffMenu() isTearOffEnabled()
+ \sa hideTearOffMenu(), isTearOffEnabled()
*/
bool QMenu::isTearOffMenuVisible() const
{
This function will forcibly hide the torn off menu making it
disappear from the users desktop.
- \sa isTearOffMenuVisible() isTearOffEnabled()
+ \sa isTearOffMenuVisible(), isTearOffEnabled()
*/
void QMenu::hideTearOffMenu()
{
is useful for subclasses when they need a QStyleOptionMenuItem, but don't want
to fill in all the information themselves.
- \sa QStyleOption::initFrom() QMenu::initStyleOption()
+ \sa QStyleOption::initFrom(), QMenu::initStyleOption()
*/
void QMenuBar::initStyleOption(QStyleOptionMenuItem *option, const QAction *action) const
{
Appends a new QMenu with \a title to the menu bar. The menu bar
takes ownership of the menu. Returns the new menu.
- \sa QWidget::addAction() QMenu::menuAction()
+ \sa QWidget::addAction(), QMenu::menuAction()
*/
QMenu *QMenuBar::addMenu(const QString &title)
{
Appends a new QMenu with \a icon and \a title to the menu bar. The menu bar
takes ownership of the menu. Returns the new menu.
- \sa QWidget::addAction() QMenu::menuAction()
+ \sa QWidget::addAction(), QMenu::menuAction()
*/
QMenu *QMenuBar::addMenu(const QIcon &icon, const QString &title)
{
\note The returned QAction object can be used to hide the corresponding
menu.
- \sa QWidget::addAction() QMenu::menuAction()
+ \sa QWidget::addAction(), QMenu::menuAction()
*/
QAction *QMenuBar::addMenu(QMenu *menu)
{
This convenience function inserts \a menu before action \a before
and returns the menus menuAction().
- \sa QWidget::insertAction() addMenu()
+ \sa QWidget::insertAction(), addMenu()
*/
QAction *QMenuBar::insertMenu(QAction *before, QMenu *menu)
{
If there is no selected text nothing happens.
- \sa copy() paste()
+ \sa copy(), paste()
*/
void QPlainTextEdit::cut()
virtual canInsertFromMimeData() and insertFromMimeData()
functions.
- \sa cut() copy()
+ \sa cut(), copy()
*/
void QPlainTextEdit::paste()
Note that the undo/redo history is cleared by this function.
- \sa cut() setPlainText()
+ \sa cut(), setPlainText()
*/
void QPlainTextEdit::clear()
{
/*!
Selects all text.
- \sa copy() cut() textCursor()
+ \sa copy(), cut(), textCursor()
*/
void QPlainTextEdit::selectAll()
{
If the current value falls outside the new range, the progress bar is reset
with reset().
- \sa minimum maximum
+ \sa minimum, maximum
*/
void QProgressBar::setRange(int minimum, int maximum)
{
{QWidget::paintEvent()}{paintEvent()} function to render the
size grip widget.
- \sa QStatusBar QWidget::windowState()
+ \sa QStatusBar, QWidget::windowState()
*/
The default minimum value is 0.
- \sa setRange() specialValueText
+ \sa setRange(), specialValueText
*/
int QSpinBox::minimum() const
The default maximum value is 99.
- \sa setRange() specialValueText
+ \sa setRange(), specialValueText
*/
is equivalent to:
\snippet code/src_gui_widgets_qspinbox.cpp 3
- \sa minimum maximum
+ \sa minimum, maximum
*/
void QSpinBox::setRange(int minimum, int maximum)
Note: The minimum value will be rounded to match the decimals
property.
- \sa decimals, setRange() specialValueText
+ \sa decimals, setRange(), specialValueText
*/
double QDoubleSpinBox::minimum() const
is equivalent to:
\snippet code/src_gui_widgets_qspinbox.cpp 7
- \sa minimum maximum
+ \sa minimum, maximum
*/
void QDoubleSpinBox::setRange(double minimum, double maximum)
right-to-left languages. This function will map \a pos to the
appropriate position before calling QSplitter::moveSplitter().
- \sa QSplitter::moveSplitter() closestLegalPosition()
+ \sa QSplitter::moveSplitter(), closestLegalPosition()
*/
void QSplitterHandle::moveSplitter(int pos)
{
If \a widget is already in the splitter, it will be moved to the new position.
- \sa insertWidget() widget() indexOf()
+ \sa insertWidget(), widget(), indexOf()
*/
void QSplitter::addWidget(QWidget *widget)
{
if \a index is an invalid index, then the widget will be inserted at the end.
- \sa addWidget() indexOf() widget()
+ \sa addWidget(), indexOf(), widget()
*/
void QSplitter::insertWidget(int index, QWidget *widget)
{
putting widgets into a splitter in new code. Please use insertWidget() or
addWidget() in new code.
- \sa addWidget() insertWidget()
+ \sa addWidget(), insertWidget()
*/
void QSplitter::childEvent(QChildEvent *c)
This function will check the version of the QStyleOptionTab and fill in the
additional values for a QStyleOptionTabV2 and QStyleOptionTabV3.
- \sa QStyleOption::initFrom() QTabWidget::initStyleOption()
+ \sa QStyleOption::initFrom(), QTabWidget::initStyleOption()
*/
void QTabBar::initStyleOption(QStyleOptionTab *option, int tabIndex) const
{
If true then QTabBar draws a base in relation to the styles overlab.
Otherwise only the tabs are drawn.
- \sa QStyle::pixelMetric() QStyle::PM_TabBarBaseOverlap QStyleOptionTabBarBaseV2
+ \sa QStyle::pixelMetric(), QStyle::PM_TabBarBaseOverlap, QStyleOptionTabBarBaseV2
*/
void QTabBar::setDrawBase(bool drawBase)
By default the value is style dependent.
- \sa QTabWidget::elideMode usesScrollButtons QStyle::SH_TabBar_ElideMode
+ \sa QTabWidget::elideMode, usesScrollButtons, QStyle::SH_TabBar_ElideMode
*/
Qt::TextElideMode QTabBar::elideMode() const
By default the value is style dependant.
- \sa elideMode QTabWidget::usesScrollButtons QStyle::SH_TabBar_PreferNoArrows
+ \sa elideMode, QTabWidget::usesScrollButtons, QStyle::SH_TabBar_PreferNoArrows
*/
bool QTabBar::usesScrollButtons() const
{
if there isn't a new one (for example, if there are no widgets
in the QTabWidget)
- \sa currentWidget() currentIndex
+ \sa currentWidget(), currentIndex
*/
/*!
for subclasses when they need a QStyleOptionTabWidgetFrame, but don't want to fill
in all the information themselves.
- \sa QStyleOption::initFrom() QTabBar::initStyleOption()
+ \sa QStyleOption::initFrom(), QTabBar::initStyleOption()
*/
void QTabWidget::initStyleOption(QStyleOptionTabWidgetFrame *option) const
{
/*!
Sets the tab tool tip for the page at position \a index to \a tip.
- \sa tabToolTip()
+ \sa tabToolTip()
*/
void QTabWidget::setTabToolTip(int index, const QString & tip)
{
By default the value is style dependant.
- \sa QTabBar::elideMode usesScrollButtons QStyle::SH_TabBar_ElideMode
+ \sa QTabBar::elideMode, usesScrollButtons, QStyle::SH_TabBar_ElideMode
*/
Qt::TextElideMode QTabWidget::elideMode() const
{
By default the value is style dependant.
- \sa elideMode QTabBar::usesScrollButtons QStyle::SH_TabBar_PreferNoArrows
+ \sa elideMode, QTabBar::usesScrollButtons, QStyle::SH_TabBar_PreferNoArrows
*/
bool QTabWidget::usesScrollButtons() const
{
/*!
Returns the point size of the font of the current format.
- \sa setFontFamily() setCurrentFont() setFontPointSize()
+ \sa setFontFamily(), setCurrentFont(), setFontPointSize()
*/
qreal QTextEdit::fontPointSize() const
{
/*!
Returns the font family of the current format.
- \sa setFontFamily() setCurrentFont() setFontPointSize()
+ \sa setFontFamily(), setCurrentFont(), setFontPointSize()
*/
QString QTextEdit::fontFamily() const
{
/*!
Returns the font weight of the current format.
- \sa setFontWeight() setCurrentFont() setFontPointSize() QFont::Weight
+ \sa setFontWeight(), setCurrentFont(), setFontPointSize(), QFont::Weight
*/
int QTextEdit::fontWeight() const
{
/*!
Returns the font of the current format.
- \sa setCurrentFont() setFontFamily() setFontPointSize()
+ \sa setCurrentFont(), setFontFamily(), setFontPointSize()
*/
QFont QTextEdit::currentFont() const
{
/*!
Sets the font family of the current format to \a fontFamily.
- \sa fontFamily() setCurrentFont()
+ \sa fontFamily(), setCurrentFont()
*/
void QTextEdit::setFontFamily(const QString &fontFamily)
{
Note that if \a s is zero or negative, the behavior of this
function is not defined.
- \sa fontPointSize() setCurrentFont() setFontFamily()
+ \sa fontPointSize(), setCurrentFont(), setFontFamily()
*/
void QTextEdit::setFontPointSize(qreal s)
{
/*!
Sets the font of the current format to \a f.
- \sa currentFont() setFontPointSize() setFontFamily()
+ \sa currentFont(), setFontPointSize(), setFontFamily()
*/
void QTextEdit::setCurrentFont(const QFont &f)
{
If there is no selected text nothing happens.
- \sa copy() paste()
+ \sa copy(), paste()
*/
void QTextEdit::cut()
virtual canInsertFromMimeData() and insertFromMimeData()
functions.
- \sa cut() copy()
+ \sa cut(), copy()
*/
void QTextEdit::paste()
Note that the undo/redo history is cleared by this function.
- \sa cut() setPlainText() setHtml()
+ \sa cut(), setPlainText(), setHtml()
*/
void QTextEdit::clear()
{
/*!
Selects all text.
- \sa copy() cut() textCursor()
+ \sa copy(), cut(), textCursor()
*/
void QTextEdit::selectAll()
{
This signal is emitted when the icon size is changed. The \a
iconSize parameter holds the toolbar's new icon size.
- \sa iconSize QMainWindow::iconSize
+ \sa iconSize, QMainWindow::iconSize
*/
/*!
\a toolButtonStyle parameter holds the toolbar's new tool button
style.
- \sa toolButtonStyle QMainWindow::toolButtonStyle
+ \sa toolButtonStyle, QMainWindow::toolButtonStyle
*/
/*!
The action's text is set to the toolbar's window title.
- \sa QAction::text QWidget::windowTitle
+ \sa QAction::text, QWidget::windowTitle
*/
QAction *QToolBar::toggleViewAction() const
{ Q_D(const QToolBar); return d->toggleViewAction; }
projects / profile / ivi / qtbase.git / commitdiff