summaryrefslogtreecommitdiffstats
path: root/src/gui/kernel
diff options
context:
space:
mode:
authorGunnar Sletta <gunnar.sletta@nokia.com>2012-06-13 21:45:44 +0200
committerQt by Nokia <qt-info@nokia.com>2012-06-28 06:21:46 +0200
commit50eed2d068138e30d508f8b230cfaaeb116e659c (patch)
tree766786bdcbfd024376f3b1c5594150b20e30d438 /src/gui/kernel
parent894e9ce66dcb85b9af4e5bded492fda33c59c435 (diff)
Get started with patching up the Qt GUI docs
Primary goal, make the front page of the Qt GUI module a bit more clarifying and avoid downstream references inside the Qt GUI docs. Change-Id: Icbcfbb64b93963add889bf83711daa9575885c02 Reviewed-by: Samuel Rødal <samuel.rodal@nokia.com>
Diffstat (limited to 'src/gui/kernel')
-rw-r--r--src/gui/kernel/qclipboard.cpp1
-rw-r--r--src/gui/kernel/qcursor.cpp1
-rw-r--r--src/gui/kernel/qdrag.cpp1
-rw-r--r--src/gui/kernel/qevent.cpp31
-rw-r--r--src/gui/kernel/qinputmethod.cpp1
-rw-r--r--src/gui/kernel/qkeysequence.cpp1
-rw-r--r--src/gui/kernel/qopenglcontext.cpp6
-rw-r--r--src/gui/kernel/qpalette.cpp3
-rw-r--r--src/gui/kernel/qscreen.cpp1
-rw-r--r--src/gui/kernel/qstylehints.cpp1
-rw-r--r--src/gui/kernel/qsurface.cpp1
-rw-r--r--src/gui/kernel/qsurfaceformat.cpp1
-rw-r--r--src/gui/kernel/qtouchdevice.cpp1
-rw-r--r--src/gui/kernel/qwindow.cpp1
14 files changed, 49 insertions, 2 deletions
diff --git a/src/gui/kernel/qclipboard.cpp b/src/gui/kernel/qclipboard.cpp
index 3ac7fbbd37..c551e98c82 100644
--- a/src/gui/kernel/qclipboard.cpp
+++ b/src/gui/kernel/qclipboard.cpp
@@ -55,6 +55,7 @@ QT_BEGIN_NAMESPACE
/*!
\class QClipboard
\brief The QClipboard class provides access to the window system clipboard.
+ \inmodule QtGui
The clipboard offers a simple mechanism to copy and paste data
between applications.
diff --git a/src/gui/kernel/qcursor.cpp b/src/gui/kernel/qcursor.cpp
index 26a36a6289..a52eb469b5 100644
--- a/src/gui/kernel/qcursor.cpp
+++ b/src/gui/kernel/qcursor.cpp
@@ -59,6 +59,7 @@ QT_BEGIN_NAMESPACE
\brief The QCursor class provides a mouse cursor with an arbitrary
shape.
+ \inmodule QtGui
\ingroup appearance
\ingroup shared
diff --git a/src/gui/kernel/qdrag.cpp b/src/gui/kernel/qdrag.cpp
index e20401c67b..fc534747f5 100644
--- a/src/gui/kernel/qdrag.cpp
+++ b/src/gui/kernel/qdrag.cpp
@@ -51,6 +51,7 @@ QT_BEGIN_NAMESPACE
/*!
\class QDrag
+ \inmodule QtGui
\brief The QDrag class provides support for MIME-based drag and drop data
transfer.
diff --git a/src/gui/kernel/qevent.cpp b/src/gui/kernel/qevent.cpp
index 0ea32f3127..abd6bafaf5 100644
--- a/src/gui/kernel/qevent.cpp
+++ b/src/gui/kernel/qevent.cpp
@@ -58,6 +58,7 @@ QT_BEGIN_NAMESPACE
/*!
\class QInputEvent
\ingroup events
+ \inmodule QtGui
\brief The QInputEvent class is the base class for events that
describe user input.
@@ -450,6 +451,7 @@ QHoverEvent::~QHoverEvent()
/*!
\class QWheelEvent
\brief The QWheelEvent class contains parameters that describe a wheel event.
+ \inmodule QtGui
\ingroup events
@@ -944,6 +946,7 @@ bool QKeyEvent::matches(QKeySequence::StandardKey matchKey) const
\class QFocusEvent
\brief The QFocusEvent class contains event parameters for widget focus
events.
+ \inmodule QtGui
\ingroup events
@@ -1005,6 +1008,7 @@ Qt::FocusReason QFocusEvent::reason() const
/*!
\class QPaintEvent
\brief The QPaintEvent class contains event parameters for paint events.
+ \inmodule QtGui
\ingroup events
@@ -1076,6 +1080,7 @@ QPaintEvent::~QPaintEvent()
/*!
\class QMoveEvent
\brief The QMoveEvent class contains event parameters for move events.
+ \inmodule QtGui
\ingroup events
@@ -1119,6 +1124,7 @@ QMoveEvent::~QMoveEvent()
\class QExposeEvent
\since 5.0
\brief The QExposeEvent class contains event parameters for expose events.
+ \inmodule QtGui
\ingroup events
@@ -1143,6 +1149,7 @@ QExposeEvent::~QExposeEvent()
/*!
\class QResizeEvent
\brief The QResizeEvent class contains event parameters for resize events.
+ \inmodule QtGui
\ingroup events
@@ -1187,6 +1194,7 @@ QResizeEvent::~QResizeEvent()
\brief The QCloseEvent class contains parameters that describe a close event.
\ingroup events
+ \inmodule QtGui
Close events are sent to widgets that the user wants to close,
usually by choosing "Close" from the window menu, or by clicking
@@ -1249,6 +1257,7 @@ QCloseEvent::~QCloseEvent()
/*!
\class QIconDragEvent
\brief The QIconDragEvent class indicates that a main icon drag has begun.
+ \inmodule QtGui
\ingroup events
@@ -1280,6 +1289,7 @@ QIconDragEvent::~QIconDragEvent()
/*!
\class QContextMenuEvent
\brief The QContextMenuEvent class contains parameters that describe a context menu event.
+ \inmodule QtGui
\ingroup events
@@ -1437,6 +1447,7 @@ QContextMenuEvent::QContextMenuEvent(Reason reason, const QPoint &pos)
/*!
\class QInputMethodEvent
\brief The QInputMethodEvent class provides parameters for input method events.
+ \inmodule QtGui
\ingroup events
@@ -1735,6 +1746,7 @@ void QInputMethodEvent::setCommitString(const QString &commitString, int replace
/*!
\class QInputMethodQueryEvent
\since 5.0
+ \inmodule QtGui
\brief This event is sent by the input context to input objects.
@@ -1802,6 +1814,7 @@ QVariant QInputMethodQueryEvent::value(Qt::InputMethodQuery query) const
/*!
\class QTabletEvent
\brief The QTabletEvent class contains parameters that describe a Tablet event.
+ \inmodule QtGui
\ingroup events
@@ -2191,6 +2204,7 @@ QDragMoveEvent::~QDragMoveEvent()
\class QDropEvent
\ingroup events
\ingroup draganddrop
+ \inmodule QtGui
\brief The QDropEvent class provides an event which is sent when a
drag and drop action is completed.
@@ -2357,6 +2371,7 @@ void QDropEvent::setDropAction(Qt::DropAction action)
\ingroup events
\ingroup draganddrop
+ \inmodule QtGui
A widget must accept this event in order to receive the \l
{QDragMoveEvent}{drag move events} that are sent while the drag
@@ -2399,6 +2414,7 @@ QDragEnterEvent::~QDragEnterEvent()
\ingroup events
\ingroup draganddrop
+ \inmodule QtGui
A widget will receive drag move events repeatedly while the drag
is within its boundaries, if it accepts
@@ -2426,6 +2442,7 @@ QDragEnterEvent::~QDragEnterEvent()
\ingroup events
\ingroup draganddrop
+ \inmodule QtGui
This event is always preceded by a QDragEnterEvent and a series
of \l{QDragMoveEvent}s. It is not sent if a QDropEvent is sent
@@ -2458,6 +2475,7 @@ QDragLeaveEvent::~QDragLeaveEvent()
\ingroup events
\ingroup helpsystem
+ \inmodule QtGui
This event can be intercepted in applications to provide tooltips
or "What's This?" help for custom widgets. The type() can be
@@ -2543,6 +2561,7 @@ QHelpEvent::~QHelpEvent()
\ingroup events
\ingroup helpsystem
+ \inmodule QtGui
Status tips can be set on a widget using the
QWidget::setStatusTip() function. They are shown in the status
@@ -2612,6 +2631,7 @@ QStatusTipEvent::~QStatusTipEvent()
\ingroup events
\ingroup helpsystem
+ \inmodule QtGui
\sa QWhatsThis, QHelpEvent, QStatusTipEvent
*/
@@ -2649,6 +2669,7 @@ QWhatsThisClickedEvent::~QWhatsThisClickedEvent()
when a QAction is added, removed, or changed.
\ingroup events
+ \inmodule QtGui
Actions can be added to widgets using QWidget::addAction(). This
generates an \l ActionAdded event, which you can handle to provide
@@ -2703,6 +2724,7 @@ QActionEvent::~QActionEvent()
\brief The QHideEvent class provides an event which is sent after a widget is hidden.
\ingroup events
+ \inmodule QtGui
This event is sent just before QWidget::hide() returns, and also
when a top-level window has been hidden (iconified) by the user.
@@ -2735,6 +2757,7 @@ QHideEvent::~QHideEvent()
\brief The QShowEvent class provides an event that is sent when a widget is shown.
\ingroup events
+ \inmodule QtGui
There are two kinds of show events: show events caused by the
window system (spontaneous), and internal show events. Spontaneous (QEvent::spontaneous())
@@ -2765,6 +2788,7 @@ QShowEvent::~QShowEvent()
sent when there is a request to open a file or a URL.
\ingroup events
+ \inmodule QtGui
File open events will be sent to the QApplication::instance()
when the operating system requests that a file or URL should be opened.
@@ -2844,6 +2868,7 @@ bool QFileOpenEvent::openFile(QFile &file, QIODevice::OpenMode flags) const
sent whenever a the toolbar button is clicked on Mac OS X.
\ingroup events
+ \inmodule QtGui
The QToolBarChangeEvent is sent when the toolbar button is clicked. On Mac
OS X, this is the long oblong button on the right side of the window
@@ -3199,6 +3224,7 @@ QDebug operator<<(QDebug dbg, const QEvent *e) {
the user presses a key combination.
\ingroup events
+ \inmodule QtGui
Normally you don't need to use this class directly; QShortcut
provides a higher-level interface to handle shortcut keys.
@@ -3233,6 +3259,7 @@ QDebug operator<<(QDebug dbg, const QEvent *e) {
/*!
\class QWindowStateChangeEvent
\ingroup events
+ \inmodule QtGui
\brief The QWindowStateChangeEvent class provides the window state before a
window state change.
@@ -3270,6 +3297,7 @@ QWindowStateChangeEvent::~QWindowStateChangeEvent()
\since 4.6
\ingroup events
\ingroup touch
+ \inmodule QtGui
\section1 Enabling Touch Events
@@ -3526,6 +3554,7 @@ QTouchEvent::~QTouchEvent()
/*! \class QTouchEvent::TouchPoint
\brief The TouchPoint class provides information about a touch point in a QTouchEvent.
\since 4.6
+ \inmodule QtGui
*/
/*! \enum QTouchEvent::TouchPoint::InfoFlags
@@ -4001,6 +4030,7 @@ void QTouchEvent::TouchPoint::setFlags(InfoFlags flags)
\class QScrollPrepareEvent
\since 4.8
\ingroup events
+ \inmodule QtGui
\brief The QScrollPrepareEvent class is send in preparation of a scrolling.
@@ -4100,6 +4130,7 @@ void QScrollPrepareEvent::setContentPos(const QPointF &pos)
\class QScrollEvent
\since 4.8
\ingroup events
+ \inmodule QtGui
\brief The QScrollEvent class is send when scrolling.
diff --git a/src/gui/kernel/qinputmethod.cpp b/src/gui/kernel/qinputmethod.cpp
index a699938dc6..87b94b0615 100644
--- a/src/gui/kernel/qinputmethod.cpp
+++ b/src/gui/kernel/qinputmethod.cpp
@@ -67,6 +67,7 @@ QInputMethod::~QInputMethod()
/*!
\class QInputMethod
\brief The QInputMethod class provides access to the active text input method.
+ \inmodule QtGui
QInputMethod is used by the text editors for integrating to the platform text input
methods and more commonly by application views for querying various text input method-related
diff --git a/src/gui/kernel/qkeysequence.cpp b/src/gui/kernel/qkeysequence.cpp
index b71a803867..e7534c787b 100644
--- a/src/gui/kernel/qkeysequence.cpp
+++ b/src/gui/kernel/qkeysequence.cpp
@@ -153,6 +153,7 @@ void Q_GUI_EXPORT qt_set_sequence_auto_mnemonic(bool b) { qt_sequence_no_mnemoni
by shortcuts.
\ingroup shared
+ \inmodule QtGui
In its most common form, a key sequence describes a combination of
diff --git a/src/gui/kernel/qopenglcontext.cpp b/src/gui/kernel/qopenglcontext.cpp
index b99a4dbd04..c8662ffac5 100644
--- a/src/gui/kernel/qopenglcontext.cpp
+++ b/src/gui/kernel/qopenglcontext.cpp
@@ -77,6 +77,7 @@ QMutex QOpenGLContextPrivate::makeCurrentTrackerMutex;
/*!
\class QOpenGLContext
+ \inmodule QtGui
\since 5.0
\brief The QOpenGLContext represents a native OpenGL context, enabling
OpenGL rendering on a QSurface.
@@ -632,6 +633,7 @@ void QOpenGLContext::deleteQGLContext()
\since 5.0
\brief The QOpenGLContextGroup represents a group of contexts sharing
OpenGL resources.
+ \inmodule QtGui
QOpenGLContextGroup is automatically created and managed by QOpenGLContext
instances. Its purpose is to identify all the contexts that are sharing
@@ -746,6 +748,7 @@ void QOpenGLContextGroupPrivate::deletePendingResources(QOpenGLContext *ctx)
that are shared between OpenGL contexts (like textures, framebuffer
objects, shader programs, etc), and clean them up in a safe way when
they're no longer needed.
+ \inmodule QtGui
The QOpenGLSharedResource instance should never be deleted, instead free()
should be called when it's no longer needed. Thus it will be put on a queue
@@ -799,6 +802,8 @@ void QOpenGLSharedResource::free()
QOpenGLSharedResource to be used to track a single OpenGL object with a
GLuint identifier. The constructor takes a function pointer to a function
that will be used to free the resource if and when necessary.
+ \inmodule QtGui
+
*/
void QOpenGLSharedResourceGuard::freeResource(QOpenGLContext *context)
{
@@ -820,6 +825,7 @@ void QOpenGLSharedResourceGuard::freeResource(QOpenGLContext *context)
QOpenGLContext *. To get an instance for a given context one calls
T *QOpenGLMultiGroupSharedResource::value<T>(context), where T is a sub-class
of QOpenGLSharedResource.
+ \inmodule QtGui
You should not call free() on QOpenGLSharedResources owned by a
QOpenGLMultiGroupSharedResource instance.
diff --git a/src/gui/kernel/qpalette.cpp b/src/gui/kernel/qpalette.cpp
index 73515f6f17..d8585711b5 100644
--- a/src/gui/kernel/qpalette.cpp
+++ b/src/gui/kernel/qpalette.cpp
@@ -326,10 +326,9 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button)
\brief The QPalette class contains color groups for each widget state.
+ \inmodule QtGui
\ingroup appearance
\ingroup shared
- \ingroup painting
-
A palette consists of three color groups: \e Active, \e Disabled,
and \e Inactive. All widgets in Qt contain a palette and
diff --git a/src/gui/kernel/qscreen.cpp b/src/gui/kernel/qscreen.cpp
index fe8b15e9a0..5d32a837f8 100644
--- a/src/gui/kernel/qscreen.cpp
+++ b/src/gui/kernel/qscreen.cpp
@@ -52,6 +52,7 @@ QT_BEGIN_NAMESPACE
\class QScreen
\since 5.0
\brief The QScreen class is used to query screen properties.
+ \inmodule QtGui
A note on logical vs physical dots per inch: physical DPI is based on the
actual physical pixel sizes when available, and is useful for print preview
diff --git a/src/gui/kernel/qstylehints.cpp b/src/gui/kernel/qstylehints.cpp
index 53c5a07f6b..194b5d3f71 100644
--- a/src/gui/kernel/qstylehints.cpp
+++ b/src/gui/kernel/qstylehints.cpp
@@ -54,6 +54,7 @@ static inline QVariant hint(QPlatformIntegration::StyleHint h)
\class QStyleHints
\since 5.0
\brief The QStyleHints contains platform specific hints and settings.
+ \inmodule QtGui
*/
QStyleHints::QStyleHints()
: QObject()
diff --git a/src/gui/kernel/qsurface.cpp b/src/gui/kernel/qsurface.cpp
index 8b71fc3536..1e58eb6e09 100644
--- a/src/gui/kernel/qsurface.cpp
+++ b/src/gui/kernel/qsurface.cpp
@@ -46,6 +46,7 @@ QT_BEGIN_NAMESPACE
/*!
\class QSurface
+ \inmodule QtGui
\since 5.0
\brief The QSurface class is an abstraction of renderable surfaces in Qt.
diff --git a/src/gui/kernel/qsurfaceformat.cpp b/src/gui/kernel/qsurfaceformat.cpp
index ecfeb80149..b410fc8874 100644
--- a/src/gui/kernel/qsurfaceformat.cpp
+++ b/src/gui/kernel/qsurfaceformat.cpp
@@ -113,6 +113,7 @@ public:
\class QSurfaceFormat
\since 5.0
\brief The QSurfaceFormat class represents the format of a QSurface.
+ \inmodule QtGui
The format includes the size of the color buffers, red, green, and blue;
the size of the alpha buffer; the size of the depth and stencil buffers;
diff --git a/src/gui/kernel/qtouchdevice.cpp b/src/gui/kernel/qtouchdevice.cpp
index b0543819df..590d17599c 100644
--- a/src/gui/kernel/qtouchdevice.cpp
+++ b/src/gui/kernel/qtouchdevice.cpp
@@ -52,6 +52,7 @@ QT_BEGIN_NAMESPACE
\brief The QTouchDevice class describes the device from with touch events originate.
\since 5.0
\ingroup touch
+ \inmodule QtGui
Each QTouchEvent contains a QTouchDevice pointer to allow accessing
device-specific properties like type and capabilities. It is the
diff --git a/src/gui/kernel/qwindow.cpp b/src/gui/kernel/qwindow.cpp
index 0316d22a1a..3c5d70d741 100644
--- a/src/gui/kernel/qwindow.cpp
+++ b/src/gui/kernel/qwindow.cpp
@@ -65,6 +65,7 @@ QT_BEGIN_NAMESPACE
/*!
\class QWindow
+ \inmodule QtGui
\since 5.0
\brief The QWindow class represents a window in the underlying windowing system.