summaryrefslogtreecommitdiffstats
path: root/src/declarative/graphicsitems
diff options
context:
space:
mode:
authorDavid Boddie <dboddie@trolltech.com>2010-09-01 17:00:45 (GMT)
committerDavid Boddie <dboddie@trolltech.com>2010-09-01 17:00:45 (GMT)
commitb38fa28a246bd039593bff732ea7c195dc7e5af9 (patch)
tree18bb19e73537885a8d2e58d7e446ebf778c081df /src/declarative/graphicsitems
parent431cde6aa40a017abc1bfd52b2340e5b1d62d36c (diff)
downloadQt-b38fa28a246bd039593bff732ea7c195dc7e5af9.zip
Qt-b38fa28a246bd039593bff732ea7c195dc7e5af9.tar.gz
Qt-b38fa28a246bd039593bff732ea7c195dc7e5af9.tar.bz2
Doc: Added types to method and signal documentation; other fixes.
Diffstat (limited to 'src/declarative/graphicsitems')
-rw-r--r--src/declarative/graphicsitems/qdeclarativeitem.cpp74
-rw-r--r--src/declarative/graphicsitems/qdeclarativemousearea.cpp10
-rw-r--r--src/declarative/graphicsitems/qdeclarativetext.cpp2
-rw-r--r--src/declarative/graphicsitems/qdeclarativetextedit.cpp4
4 files changed, 45 insertions, 45 deletions
diff --git a/src/declarative/graphicsitems/qdeclarativeitem.cpp b/src/declarative/graphicsitems/qdeclarativeitem.cpp
index aca2bb7..11f9179 100644
--- a/src/declarative/graphicsitems/qdeclarativeitem.cpp
+++ b/src/declarative/graphicsitems/qdeclarativeitem.cpp
@@ -830,259 +830,259 @@ void QDeclarativeKeyNavigationAttached::keyReleased(QKeyEvent *event, bool post)
*/
/*!
- \qmlsignal Keys::onPressed(event)
+ \qmlsignal Keys::onPressed(KeyEvent event)
This handler is called when a key has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onReleased(event)
+ \qmlsignal Keys::onReleased(KeyEvent event)
This handler is called when a key has been released. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onDigit0Pressed(event)
+ \qmlsignal Keys::onDigit0Pressed(KeyEvent event)
This handler is called when the digit '0' has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onDigit1Pressed(event)
+ \qmlsignal Keys::onDigit1Pressed(KeyEvent event)
This handler is called when the digit '1' has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onDigit2Pressed(event)
+ \qmlsignal Keys::onDigit2Pressed(KeyEvent event)
This handler is called when the digit '2' has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onDigit3Pressed(event)
+ \qmlsignal Keys::onDigit3Pressed(KeyEvent event)
This handler is called when the digit '3' has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onDigit4Pressed(event)
+ \qmlsignal Keys::onDigit4Pressed(KeyEvent event)
This handler is called when the digit '4' has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onDigit5Pressed(event)
+ \qmlsignal Keys::onDigit5Pressed(KeyEvent event)
This handler is called when the digit '5' has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onDigit6Pressed(event)
+ \qmlsignal Keys::onDigit6Pressed(KeyEvent event)
This handler is called when the digit '6' has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onDigit7Pressed(event)
+ \qmlsignal Keys::onDigit7Pressed(KeyEvent event)
This handler is called when the digit '7' has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onDigit8Pressed(event)
+ \qmlsignal Keys::onDigit8Pressed(KeyEvent event)
This handler is called when the digit '8' has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onDigit9Pressed(event)
+ \qmlsignal Keys::onDigit9Pressed(KeyEvent event)
This handler is called when the digit '9' has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onLeftPressed(event)
+ \qmlsignal Keys::onLeftPressed(KeyEvent event)
This handler is called when the Left arrow has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onRightPressed(event)
+ \qmlsignal Keys::onRightPressed(KeyEvent event)
This handler is called when the Right arrow has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onUpPressed(event)
+ \qmlsignal Keys::onUpPressed(KeyEvent event)
This handler is called when the Up arrow has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onDownPressed(event)
+ \qmlsignal Keys::onDownPressed(KeyEvent event)
This handler is called when the Down arrow has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onAsteriskPressed(event)
+ \qmlsignal Keys::onAsteriskPressed(KeyEvent event)
This handler is called when the Asterisk '*' has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onEscapePressed(event)
+ \qmlsignal Keys::onEscapePressed(KeyEvent event)
This handler is called when the Escape key has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onReturnPressed(event)
+ \qmlsignal Keys::onReturnPressed(KeyEvent event)
This handler is called when the Return key has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onEnterPressed(event)
+ \qmlsignal Keys::onEnterPressed(KeyEvent event)
This handler is called when the Enter key has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onDeletePressed(event)
+ \qmlsignal Keys::onDeletePressed(KeyEvent event)
This handler is called when the Delete key has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onSpacePressed(event)
+ \qmlsignal Keys::onSpacePressed(KeyEvent event)
This handler is called when the Space key has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onBackPressed(event)
+ \qmlsignal Keys::onBackPressed(KeyEvent event)
This handler is called when the Back key has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onCancelPressed(event)
+ \qmlsignal Keys::onCancelPressed(KeyEvent event)
This handler is called when the Cancel key has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onSelectPressed(event)
+ \qmlsignal Keys::onSelectPressed(KeyEvent event)
This handler is called when the Select key has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onYesPressed(event)
+ \qmlsignal Keys::onYesPressed(KeyEvent event)
This handler is called when the Yes key has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onNoPressed(event)
+ \qmlsignal Keys::onNoPressed(KeyEvent event)
This handler is called when the No key has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onContext1Pressed(event)
+ \qmlsignal Keys::onContext1Pressed(KeyEvent event)
This handler is called when the Context1 key has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onContext2Pressed(event)
+ \qmlsignal Keys::onContext2Pressed(KeyEvent event)
This handler is called when the Context2 key has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onContext3Pressed(event)
+ \qmlsignal Keys::onContext3Pressed(KeyEvent event)
This handler is called when the Context3 key has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onContext4Pressed(event)
+ \qmlsignal Keys::onContext4Pressed(KeyEvent event)
This handler is called when the Context4 key has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onCallPressed(event)
+ \qmlsignal Keys::onCallPressed(KeyEvent event)
This handler is called when the Call key has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onHangupPressed(event)
+ \qmlsignal Keys::onHangupPressed(KeyEvent event)
This handler is called when the Hangup key has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onFlipPressed(event)
+ \qmlsignal Keys::onFlipPressed(KeyEvent event)
This handler is called when the Flip key has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onMenuPressed(event)
+ \qmlsignal Keys::onMenuPressed(KeyEvent event)
This handler is called when the Menu key has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onVolumeUpPressed(event)
+ \qmlsignal Keys::onVolumeUpPressed(KeyEvent event)
This handler is called when the VolumeUp key has been pressed. The \a event
parameter provides information about the event.
*/
/*!
- \qmlsignal Keys::onVolumeDownPressed(event)
+ \qmlsignal Keys::onVolumeDownPressed(KeyEvent event)
This handler is called when the VolumeDown key has been pressed. The \a event
parameter provides information about the event.
diff --git a/src/declarative/graphicsitems/qdeclarativemousearea.cpp b/src/declarative/graphicsitems/qdeclarativemousearea.cpp
index ec01549..5516611 100644
--- a/src/declarative/graphicsitems/qdeclarativemousearea.cpp
+++ b/src/declarative/graphicsitems/qdeclarativemousearea.cpp
@@ -250,7 +250,7 @@ QDeclarativeMouseAreaPrivate::~QDeclarativeMouseAreaPrivate()
*/
/*!
- \qmlsignal MouseArea::onClicked(mouse)
+ \qmlsignal MouseArea::onClicked(MouseEvent mouse)
This handler is called when there is a click. A click is defined as a press followed by a release,
both inside the MouseArea (pressing, moving outside the MouseArea, and then moving back inside and
@@ -263,7 +263,7 @@ QDeclarativeMouseAreaPrivate::~QDeclarativeMouseAreaPrivate()
*/
/*!
- \qmlsignal MouseArea::onPressed(mouse)
+ \qmlsignal MouseArea::onPressed(MouseEvent mouse)
This handler is called when there is a press.
The \l {MouseEvent}{mouse} parameter provides information about the press, including the x and y
@@ -277,7 +277,7 @@ QDeclarativeMouseAreaPrivate::~QDeclarativeMouseAreaPrivate()
*/
/*!
- \qmlsignal MouseArea::onReleased(mouse)
+ \qmlsignal MouseArea::onReleased(MouseEvent mouse)
This handler is called when there is a release.
The \l {MouseEvent}{mouse} parameter provides information about the click, including the x and y
@@ -287,7 +287,7 @@ QDeclarativeMouseAreaPrivate::~QDeclarativeMouseAreaPrivate()
*/
/*!
- \qmlsignal MouseArea::onPressAndHold(mouse)
+ \qmlsignal MouseArea::onPressAndHold(MouseEvent mouse)
This handler is called when there is a long press (currently 800ms).
The \l {MouseEvent}{mouse} parameter provides information about the press, including the x and y
@@ -297,7 +297,7 @@ QDeclarativeMouseAreaPrivate::~QDeclarativeMouseAreaPrivate()
*/
/*!
- \qmlsignal MouseArea::onDoubleClicked(mouse)
+ \qmlsignal MouseArea::onDoubleClicked(MouseEvent mouse)
This handler is called when there is a double-click (a press followed by a release followed by a press).
The \l {MouseEvent}{mouse} parameter provides information about the click, including the x and y
diff --git a/src/declarative/graphicsitems/qdeclarativetext.cpp b/src/declarative/graphicsitems/qdeclarativetext.cpp
index f16af88..fd3a1f7 100644
--- a/src/declarative/graphicsitems/qdeclarativetext.cpp
+++ b/src/declarative/graphicsitems/qdeclarativetext.cpp
@@ -1205,7 +1205,7 @@ void QDeclarativeText::mousePressEvent(QGraphicsSceneMouseEvent *event)
}
/*!
- \qmlsignal Text::onLinkActivated(link)
+ \qmlsignal Text::onLinkActivated(string link)
This handler is called when the user clicks on a link embedded in the text.
*/
diff --git a/src/declarative/graphicsitems/qdeclarativetextedit.cpp b/src/declarative/graphicsitems/qdeclarativetextedit.cpp
index b1c0fcd..3ac095c 100644
--- a/src/declarative/graphicsitems/qdeclarativetextedit.cpp
+++ b/src/declarative/graphicsitems/qdeclarativetextedit.cpp
@@ -555,7 +555,7 @@ QRectF QDeclarativeTextEdit::positionToRectangle(int pos) const
}
/*!
- \qmlmethod int TextEdit::positionAt(x,y)
+ \qmlmethod int TextEdit::positionAt(int x, int y)
Returns the text position closest to pixel position (\a x, \a y).
@@ -1018,7 +1018,7 @@ void QDeclarativeTextEdit::selectWord()
}
/*!
- \qmlmethod void TextEdit::select(start,end)
+ \qmlmethod void TextEdit::select(int start, int end)
Causes the text from \a start to \a end to be selected.