summaryrefslogtreecommitdiffstats
path: root/src/gui
diff options
context:
space:
mode:
authoraavit <qt_aavit@ovi.com>2012-09-11 11:37:06 +0200
committerQt by Nokia <qt-info@nokia.com>2012-09-12 10:14:10 +0200
commit98e11700864e5a5b1566fd1736aae85551f2f00f (patch)
treebe1225d475c0852ec3cf7877fdcc25c7b47fb629 /src/gui
parent5704cbc462ad0b316a6b55a0f1dadc3c50762ef7 (diff)
Doc: Fix misc. doc errors and document undocumented functions
Change-Id: I0c1e0a36ee37d5a8f3741f0405f63f9b26967f32 Reviewed-by: Qt Doc Bot <qt_docbot@qt-project.org> Reviewed-by: Kim M. Kalland <kim.kalland@nokia.com>
Diffstat (limited to 'src/gui')
-rw-r--r--src/gui/kernel/qdrag.cpp13
-rw-r--r--src/gui/kernel/qevent.cpp232
-rw-r--r--src/gui/kernel/qevent.h12
-rw-r--r--src/gui/painting/qbackingstore.cpp2
4 files changed, 187 insertions, 72 deletions
diff --git a/src/gui/kernel/qdrag.cpp b/src/gui/kernel/qdrag.cpp
index fc534747f5..27609a230a 100644
--- a/src/gui/kernel/qdrag.cpp
+++ b/src/gui/kernel/qdrag.cpp
@@ -229,7 +229,7 @@ QObject *QDrag::target() const
can take some time, but this function does not block the event
loop. Other events are still delivered to the application while
the operation is performed. On Windows, the Qt event loop is
- blocked while during the operation.
+ blocked during the operation.
*/
Qt::DropAction QDrag::exec(Qt::DropActions supportedActions)
@@ -362,12 +362,23 @@ QPixmap QDrag::dragCursor(Qt::DropAction action) const
return QGuiApplicationPrivate::instance()->getPixmapCursor(shape);
}
+/*!
+ Returns the set of possible drop actions for this drag operation.
+
+ \sa exec(), defaultAction()
+*/
Qt::DropActions QDrag::supportedActions() const
{
Q_D(const QDrag);
return d->supported_actions;
}
+
+/*!
+ Returns the default proposed drop action for this drag operation.
+
+ \sa exec(), supportedActions()
+*/
Qt::DropAction QDrag::defaultAction() const
{
Q_D(const QDrag);
diff --git a/src/gui/kernel/qevent.cpp b/src/gui/kernel/qevent.cpp
index e7aabe8623..c5ce19737f 100644
--- a/src/gui/kernel/qevent.cpp
+++ b/src/gui/kernel/qevent.cpp
@@ -95,6 +95,19 @@ QInputEvent::~QInputEvent()
*/
/*!
+ \fn ulong QInputEvent::timestamp() const
+
+ Returns the window system's timestamp for this event.
+*/
+
+/*! \fn void QInputEvent::setTimestamp(ulong atimestamp)
+
+ \internal
+
+ Sets the timestamp for this event.
+*/
+
+/*!
\class QMouseEvent
\ingroup events
@@ -201,9 +214,11 @@ QMouseEvent::QMouseEvent(Type type, const QPointF &localPos, const QPointF &scre
QEvent::MouseButtonRelease, QEvent::MouseButtonDblClick,
or QEvent::MouseMove.
- The \a pos is the mouse cursor's position relative to the
- receiving widget. The cursor's position in global coordinates is
- specified by \a globalPos. The \a button that caused the event is
+ The points \a localPos, \a windowPos and \a screenPos specify the
+ mouse cursor's position relative to the receiving widget or item,
+ window, and screen, respectively.
+
+ The \a button that caused the event is
given as a value from the \l Qt::MouseButton enum. If the event \a
type is \l MouseMove, the appropriate button for this event is
Qt::NoButton. \a buttons is the state of all buttons at the
@@ -267,7 +282,7 @@ QMouseEvent::~QMouseEvent()
*/
/*!
- \fn const QPoint &QMouseEvent::pos() const
+ \fn QPoint QMouseEvent::pos() const
Returns the position of the mouse cursor, relative to the widget
that received the event.
@@ -280,7 +295,7 @@ QMouseEvent::~QMouseEvent()
*/
/*!
- \fn const QPoint &QMouseEvent::globalPos() const
+ \fn QPoint QMouseEvent::globalPos() const
Returns the global position of the mouse cursor \e{at the time
of the event}. This is important on asynchronous window systems
@@ -354,6 +369,13 @@ QMouseEvent::~QMouseEvent()
*/
/*!
+ \fn QPointF QMouseEvent::posF() const
+ \obsolete
+
+ Use localPos() instead.
+*/
+
+/*!
\class QHoverEvent
\ingroup events
@@ -401,7 +423,7 @@ QMouseEvent::~QMouseEvent()
*/
/*!
- \fn const QPoint &QHoverEvent::pos() const
+ \fn QPoint QHoverEvent::pos() const
Returns the position of the mouse cursor, relative to the widget
that received the event.
@@ -413,7 +435,7 @@ QMouseEvent::~QMouseEvent()
*/
/*!
- \fn const QPoint &QHoverEvent::oldPos() const
+ \fn QPoint QHoverEvent::oldPos() const
Returns the previous position of the mouse cursor, relative to the widget
that received the event. If there is no previous position, oldPos() will
@@ -426,14 +448,40 @@ QMouseEvent::~QMouseEvent()
*/
/*!
+ \fn const QPointF &QHoverEvent::posF() const
+
+ Returns the position of the mouse cursor, relative to the widget
+ that received the event.
+
+ On QEvent::HoverLeave events, this position will always be
+ QPointF(-1, -1).
+
+ \sa oldPosF()
+*/
+
+/*!
+ \fn const QPointF &QHoverEvent::oldPosF() const
+
+ Returns the previous position of the mouse cursor, relative to the widget
+ that received the event. If there is no previous position, oldPosF() will
+ return the same position as posF().
+
+ On QEvent::HoverEnter events, this position will always be
+ QPointF(-1, -1).
+
+ \sa posF()
+*/
+
+/*!
Constructs a hover event object.
The \a type parameter must be QEvent::HoverEnter,
QEvent::HoverLeave, or QEvent::HoverMove.
The \a pos is the current mouse cursor's position relative to the
- receiving widget, while \a oldPos is the previous mouse cursor's
- position relative to the receiving widget.
+ receiving widget, while \a oldPos is its previous such position.
+ \a modifiers hold the state of all keyboard modifiers at the time
+ of the event.
*/
QHoverEvent::QHoverEvent(Type type, const QPointF &pos, const QPointF &oldPos, Qt::KeyboardModifiers modifiers)
: QInputEvent(type, modifiers), p(pos), op(oldPos)
@@ -488,15 +536,18 @@ QHoverEvent::~QHoverEvent()
/*!
\fn Qt::Orientation QWheelEvent::orientation() const
+ \obsolete
Returns the wheel's orientation.
+
+ Use angleDelta() instead.
*/
/*!
\obsolete
Constructs a wheel event object.
- Use the QPoint-based constructor instead.
+ Use the constructor taking \e angleDelta and \e pixelDelta QPoints instead.
The position, \a pos, is the location of the mouse cursor within
the widget. The globalPos() is initialized to QCursor::pos()
@@ -531,7 +582,7 @@ QWheelEvent::~QWheelEvent()
\obsolete
Constructs a wheel event object.
- Use the QPoint-based constructor instead.
+ Use the constructor taking \e angleDelta and \e pixelDelta QPoints instead.
The \a pos provides the location of the mouse cursor
within the widget. The position in global coordinates is specified
@@ -553,17 +604,20 @@ QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos, int delta
The \a pos provides the location of the mouse cursor
within the window. The position in global coordinates is specified
- by \a globalPos. \a pixelDelta contains the scrolling distance
- in pixels on screen, \a angleDelta contains the wheel rotation distance.
- \a pixelDelta is optional and can be null.
+ by \a globalPos.
- \a modifiers holds the keyboard modifier flags at the time of the event.
+ \a pixelDelta contains the scrolling distance in pixels on screen, while
+ \a angleDelta contains the wheel rotation distance. \a pixelDelta is
+ optional and can be null.
- \a pixelDelta contains the scrolling delta in pixels,
- \a angleDelta contains the rotation distance, and
- \a orient holds the wheel's orientation.
+ The mouse and keyboard states at the time of the event are specified by
+ \a buttons and \a modifiers.
+
+ For backwards compatibility, the event can also hold monodirectional wheel
+ event data: \a qt4Delta specifies the rotation, and \a qt4Orientation the
+ direction.
- \sa pos(), globalPos(), delta(), state()
+ \sa posF(), globalPosF(), angleDelta(), pixelDelta()
*/
QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos,
@@ -613,12 +667,13 @@ QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos,
/*!
\fn int QWheelEvent::delta() const
+ \obsolete
This function has been deprecated, use pixelDelta() or angleDelta() instead.
*/
/*!
- \fn const QPoint &QWheelEvent::pos() const
+ \fn QPoint QWheelEvent::pos() const
Returns the position of the mouse cursor relative to the widget
that received the event.
@@ -649,7 +704,7 @@ QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos,
/*!
- \fn const QPoint &QWheelEvent::globalPos() const
+ \fn QPoint QWheelEvent::globalPos() const
Returns the global position of the mouse pointer \e{at the time
of the event}. This is important on asynchronous window systems
@@ -679,6 +734,31 @@ QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos,
*/
/*!
+ \fn const QPointF &QWheelEvent::posF() const
+
+ Returns the position of the mouse cursor relative to the widget
+ that received the event.
+
+ If you move your widgets around in response to mouse events,
+ use globalPosF() instead of this function.
+
+ \sa globalPosF()
+*/
+
+/*!
+ \fn const QPointF &QWheelEvent::globalPosF() const
+
+ Returns the global position of the mouse pointer \e{at the time
+ of the event}. This is important on asynchronous window systems
+ such as X11; whenever you move your widgets around in response to
+ mouse events, globalPosF() can differ a lot from the current
+ cursor position returned by QCursor::pos().
+
+ \sa posF()
+*/
+
+
+/*!
\class QKeyEvent
\brief The QKeyEvent class describes a key event.
@@ -1133,6 +1213,10 @@ QMoveEvent::~QMoveEvent()
The event handler QWindow::exposeEvent() receives expose events.
*/
+
+/*!
+ Constructs an expose event for the given \a exposeRegion.
+*/
QExposeEvent::QExposeEvent(const QRegion &exposeRegion)
: QEvent(Expose)
, rgn(exposeRegion)
@@ -1147,6 +1231,12 @@ QExposeEvent::~QExposeEvent()
}
/*!
+ \fn const QRegion &QExposeEvent::region() const
+
+ Returns the window area that has been exposed.
+*/
+
+/*!
\class QResizeEvent
\brief The QResizeEvent class contains event parameters for resize events.
\inmodule QtGui
@@ -1729,7 +1819,7 @@ void QInputMethodEvent::setCommitString(const QString &commitString, int replace
\since 5.0
\inmodule QtGui
- \brief This event is sent by the input context to input objects.
+ \brief The QInputMethodQueryEvent class provides an event sent by the input context to input objects.
It is used by the
input method to query a set of properties of the object to be
@@ -1765,7 +1855,7 @@ QInputMethodQueryEvent::~QInputMethodQueryEvent()
}
/*!
- Sets query property to given value.
+ Sets property \a query to \a value.
*/
void QInputMethodQueryEvent::setValue(Qt::InputMethodQuery query, const QVariant &value)
{
@@ -1780,7 +1870,7 @@ void QInputMethodQueryEvent::setValue(Qt::InputMethodQuery query, const QVariant
}
/*!
- Returns value of a query property.
+ Returns value of the property \a query.
*/
QVariant QInputMethodQueryEvent::value(Qt::InputMethodQuery query) const
{
@@ -1869,8 +1959,7 @@ QVariant QInputMethodQueryEvent::value(Qt::InputMethodQuery query) const
The \a pos parameter indicates where the event occurred in the
widget; \a globalPos is the corresponding position in absolute
- coordinates. The \a hiResGlobalPos contains a high resolution
- measurement of the position.
+ coordinates.
\a pressure contains the pressure exerted on the \a device.
@@ -1994,7 +2083,7 @@ QTabletEvent::~QTabletEvent()
*/
/*!
- \fn const QPoint &QTabletEvent::pos() const
+ \fn QPoint QTabletEvent::pos() const
Returns the position of the device, relative to the widget that
received the event.
@@ -2034,7 +2123,7 @@ QTabletEvent::~QTabletEvent()
*/
/*!
- \fn const QPoint &QTabletEvent::globalPos() const
+ \fn QPoint QTabletEvent::globalPos() const
Returns the global position of the device \e{at the time of the
event}. This is important on asynchronous windows systems like X11;
@@ -2107,6 +2196,30 @@ QTabletEvent::~QTabletEvent()
The high precision y position of the tablet device.
*/
+/*!
+ \fn const QPointF &QTabletEvent::posF() const
+
+ Returns the position of the device, relative to the widget that
+ received the event.
+
+ If you move widgets around in response to mouse events, use
+ globalPosF() instead of this function.
+
+ \sa globalPosF()
+*/
+
+/*!
+ \fn const QPointF &QTabletEvent::globalPosF() const
+
+ Returns the global position of the device \e{at the time of the
+ event}. This is important on asynchronous windows systems like X11;
+ whenever you move your widgets around in response to mouse events,
+ globalPosF() can differ significantly from the current position
+ QCursor::pos().
+
+ \sa posF()
+*/
+
#endif // QT_NO_TABLETEVENT
#ifndef QT_NO_DRAGANDDROP
@@ -2278,7 +2391,13 @@ void QDropEvent::setDropAction(Qt::DropAction action)
}
/*!
- \fn const QPoint& QDropEvent::pos() const
+ \fn QPoint QDropEvent::pos() const
+
+ Returns the position where the drop was made.
+*/
+
+/*!
+ \fn const QPointF& QDropEvent::posF() const
Returns the position where the drop was made.
*/
@@ -3400,30 +3519,21 @@ QWindowStateChangeEvent::~QWindowStateChangeEvent()
QGraphicsItem::acceptTouchEvents()
*/
-/*! \enum Qt::TouchPointState
- \since 4.6
-
- This enum represents the state of a touch point at the time the
- QTouchEvent occurred.
-
- \value TouchPointPressed The touch point is now pressed.
- \value TouchPointMoved The touch point moved.
- \value TouchPointStationary The touch point did not move.
- \value TouchPointReleased The touch point was released.
-*/
-
/*! \enum QTouchEvent::DeviceType
+ \obsolete
This enum represents the type of device that generated a QTouchEvent.
This enum has been deprecated. Use QTouchDevice::DeviceType instead.
+ \omitvalue TouchPad
+ \omitvalue TouchScreen
\sa QTouchDevice::DeviceType, QTouchDevice::type(), QTouchEvent::device()
*/
/*!
- Constructs a QTouchEvent with the given \a eventType, \a deviceType, \a
- touchPoints and \a device. The \a touchPointStates and \a modifiers
+ Constructs a QTouchEvent with the given \a eventType, \a device, and
+ \a touchPoints. The \a touchPointStates and \a modifiers
are the current touch point states and keyboard modifiers at the time of
the event.
*/
@@ -3461,6 +3571,7 @@ QTouchEvent::~QTouchEvent()
*/
/*! \fn QTouchEvent::DeviceType QTouchEvent::deviceType() const
+ \obsolete
Returns the touch device Type, which is of type \l {QTouchEvent::DeviceType} {DeviceType}.
@@ -3479,11 +3590,6 @@ QTouchEvent::~QTouchEvent()
Returns the list of touch points contained in the touch event.
*/
-/*! \fn QTouchEvent::DeviceType QTouchEvent::deviceType() const
-
- Returns the touch device Type, which is of type \l {QTouchEvent::DeviceType} {DeviceType}.
-*/
-
/*! \fn QTouchDevice* QTouchEvent::device() const
Returns the touch device from which this touch event originates.
@@ -3517,19 +3623,11 @@ QTouchEvent::~QTouchEvent()
Sets the list of touch points for this event.
*/
-/*! \fn void QTouchEvent::setDeviceType(DeviceType deviceType)
+/*! \fn void QTouchEvent::setDevice(QTouchDevice *adevice)
\internal
- Sets the device type to \a deviceType, which is of type \l {QTouchEvent::DeviceType}
- {DeviceType}.
-*/
-
-/*! \fn void QTouchEvent::setTouchDevice(QTouchDevice *device)
-
- \internal
-
- Sets the touch event's device to the given one.
+ Sets the device to \a adevice.
*/
/*! \class QTouchEvent::TouchPoint
@@ -3538,14 +3636,15 @@ QTouchEvent::~QTouchEvent()
\inmodule QtGui
*/
-/*! \enum QTouchEvent::TouchPoint::InfoFlags
+/*! \enum TouchPoint::InfoFlag
The values of this enum describe additional information about a touch point.
\value Pen Indicates that the contact has been made by a designated pointing device (e.g. a pen) instead of a finger.
*/
-/*! \internal
+/*!
+ \internal
Constructs a QTouchEvent::TouchPoint for use in a QTouchEvent.
*/
@@ -3553,7 +3652,9 @@ QTouchEvent::TouchPoint::TouchPoint(int id)
: d(new QTouchEventTouchPointPrivate(id))
{ }
-/*! \internal
+/*!
+ \fn TouchPoint::TouchPoint(const TouchPoint &other)
+ \internal
Constructs a copy of \a other.
*/
@@ -3563,7 +3664,8 @@ QTouchEvent::TouchPoint::TouchPoint(const QTouchEvent::TouchPoint &other)
d->ref.ref();
}
-/*! \internal
+/*!
+ \internal
Destroys the QTouchEvent::TouchPoint.
*/
@@ -3989,7 +4091,9 @@ void QTouchEvent::TouchPoint::setRawScreenPositions(const QVector<QPointF> &posi
d->rawScreenPositions = positions;
}
-/* \internal */
+/*!
+ \internal
+*/
void QTouchEvent::TouchPoint::setFlags(InfoFlags flags)
{
if (d->ref.load() != 1)
@@ -3998,7 +4102,7 @@ void QTouchEvent::TouchPoint::setFlags(InfoFlags flags)
}
/*!
- \fn QTouchEvent::TouchPoint &QTouchEvent::TouchPoint::operator=(const QTouchEvent::TouchPoint &other)
+ \fn TouchPoint &TouchPoint::operator=(const TouchPoint &other)
\internal
*/
diff --git a/src/gui/kernel/qevent.h b/src/gui/kernel/qevent.h
index bb3bd8f325..69187db4bb 100644
--- a/src/gui/kernel/qevent.h
+++ b/src/gui/kernel/qevent.h
@@ -86,12 +86,12 @@ protected:
class Q_GUI_EXPORT QMouseEvent : public QInputEvent
{
public:
- QMouseEvent(Type type, const QPointF &pos, Qt::MouseButton button,
+ QMouseEvent(Type type, const QPointF &localPos, Qt::MouseButton button,
Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers);
- QMouseEvent(Type type, const QPointF &pos, const QPointF &globalPos,
+ QMouseEvent(Type type, const QPointF &localPos, const QPointF &screenPos,
Qt::MouseButton button, Qt::MouseButtons buttons,
Qt::KeyboardModifiers modifiers);
- QMouseEvent(Type type, const QPointF &pos, const QPointF &windowPos, const QPointF &globalPos,
+ QMouseEvent(Type type, const QPointF &localPos, const QPointF &windowPos, const QPointF &screenPos,
Qt::MouseButton button, Qt::MouseButtons buttons,
Qt::KeyboardModifiers modifiers);
~QMouseEvent();
@@ -203,8 +203,8 @@ public:
Qt::KeyboardModifiers keyState, qint64 uniqueID);
~QTabletEvent();
- inline const QPoint pos() const { return mPos.toPoint(); }
- inline const QPoint globalPos() const { return mGPos.toPoint(); }
+ inline QPoint pos() const { return mPos.toPoint(); }
+ inline QPoint globalPos() const { return mGPos.toPoint(); }
#if QT_DEPRECATED_SINCE(5,0)
QT_DEPRECATED inline const QPointF &hiResGlobalPos() const { return mPos; }
#endif
@@ -500,7 +500,7 @@ public:
Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers, Type type = Drop);
~QDropEvent();
- inline const QPoint pos() const { return p.toPoint(); }
+ inline QPoint pos() const { return p.toPoint(); }
inline const QPointF &posF() const { return p; }
inline Qt::MouseButtons mouseButtons() const { return mouseState; }
inline Qt::KeyboardModifiers keyboardModifiers() const { return modState; }
diff --git a/src/gui/painting/qbackingstore.cpp b/src/gui/painting/qbackingstore.cpp
index ff181bac6b..625ed8f4df 100644
--- a/src/gui/painting/qbackingstore.cpp
+++ b/src/gui/painting/qbackingstore.cpp
@@ -87,7 +87,7 @@ public:
*/
/*!
- Flushes the given \a region from the specified \a window onto the
+ Flushes the given \a region from the specified window \a win onto the
screen.
Note that the \a offset parameter is currently unused.