From 3b103ec9a15710c9d82a4d164a497fcd2cb29ffb Mon Sep 17 00:00:00 2001 From: Yann Bodson Date: Mon, 17 Aug 2009 10:13:33 +1000 Subject: Doc cleanup. --- src/declarative/fx/qfxwebview.cpp | 86 ++++----------------------------------- src/declarative/fx/qfxwebview.h | 5 ++- 2 files changed, 11 insertions(+), 80 deletions(-) diff --git a/src/declarative/fx/qfxwebview.cpp b/src/declarative/fx/qfxwebview.cpp index 797e6cb..868e009 100644 --- a/src/declarative/fx/qfxwebview.cpp +++ b/src/declarative/fx/qfxwebview.cpp @@ -165,8 +165,8 @@ public: public: WindowObjectList(QFxWebViewPrivate *p) : priv(p) {} - virtual void append(QObject *v) { - QmlConcreteList::append(v); + virtual void append(QObject *v) { + QmlConcreteList::append(v); priv->updateWindowObjects(); } private: @@ -279,10 +279,6 @@ void QFxWebView::componentComplete() \qmlproperty real WebView::progress This property holds the progress of loading the current URL, from 0 to 1. */ -/*! - \property QFxWebView::progress - \brief the progress of loading the current URL, from 0 to 1. -*/ qreal QFxWebView::progress() const { Q_D(const QFxWebView); @@ -320,18 +316,6 @@ void QFxWebView::doLoadFinished(bool ok) before the change is notified, as this only happens when loading of the URL successfully starts. */ -/*! - \property QFxWebView::url - \brief the URL to the page displayed in this item. - - \sa urlChanged() -*/ -/*! - \fn void QFxWebView::urlChanged() - - Emitted when loading of the URL successfully starts after - setUrl() is called. -*/ QUrl QFxWebView::url() const { return page()->mainFrame()->url(); @@ -363,10 +347,6 @@ void QFxWebView::setUrl(const QUrl &url) \qmlproperty int WebView::idealWidth This property holds the ideal width for displaying the current URL. */ -/*! - \property QFxWebView::idealWidth - \brief the ideal width for displaying the current URL. -*/ int QFxWebView::idealWidth() const { Q_D(const QFxWebView); @@ -386,10 +366,6 @@ void QFxWebView::setIdealWidth(int iw) \qmlproperty int WebView::idealHeight This property holds the ideal height for displaying the current URL. */ -/*! - \property QFxWebView::idealHeight - \brief the ideal height for displaying the current URL. -*/ int QFxWebView::idealHeight() const { Q_D(const QFxWebView); @@ -408,15 +384,9 @@ void QFxWebView::setIdealHeight(int ih) /*! \qmlproperty bool WebView::interactive - This property holds controls whether the item responds to mouse and + This property controls whether the item responds to mouse and key events. */ - -/*! - \property QFxWebView::interactive - - \brief controls whether the item responds to mouse and key events. -*/ bool QFxWebView::interactive() const { Q_D(const QFxWebView); @@ -431,10 +401,10 @@ void QFxWebView::setInteractive(bool i) emit interactiveChanged(); } -/*! - Evaluates the \a scriptSource JavaScript inside the main frame +/*! + Evaluates the \a scriptSource JavaScript inside the main frame context and returns the result of the last executed statement. -*/ +*/ QVariant QFxWebView::evaluateJavaScript(const QString &scriptSource) { return this->page()->mainFrame()->evaluateJavaScript(scriptSource); @@ -460,7 +430,7 @@ void QFxWebView::expandToWebPage() } } -void QFxWebView::geometryChanged(const QRectF &newGeometry, +void QFxWebView::geometryChanged(const QRectF &newGeometry, const QRectF &oldGeometry) { if (newGeometry.size() != oldGeometry.size()) @@ -484,14 +454,6 @@ void QFxWebView::paintPage(const QRect& r) allow. The default is 0.1 megapixels. The cache will not be larger than the (unscaled) size of the WebView. */ - -/*! - \property QFxWebView::cacheSize - - The maximum number of pixels of image cache to allow. The default - is 0.1 megapixels. The cache will not be larger than the (unscaled) - size of the QFxWebView. -*/ int QFxWebView::cacheSize() const { Q_D(const QFxWebView); @@ -535,7 +497,7 @@ void QFxWebView::setCacheSize(int pixels) \qml WebView { - javaScriptWindowObjects: Object { + javaScriptWindowObjects: Object { WebView.windowObjectName: "coordinates" } } @@ -546,15 +508,6 @@ void QFxWebView::setCacheSize(int pixels) If Javascript is not enabled for this page, then this property does nothing. */ - -/*! - \property QFxWebView::javaScriptWindowObjects - - The list of object that are available from within - the webview's JavaScript context. - - \sa QWebFrame::addToJavaScriptWindowObject -*/ QmlList *QFxWebView::javaScriptWindowObjects() { Q_D(QFxWebView); @@ -862,14 +815,6 @@ QAction *QFxWebView::stopAction() const By default, this property contains an empty string. */ -/*! - \property QFxWebView::title - This property holds the title of the web page currently viewed - - By default, this property contains an empty string. - - \sa titleChanged() -*/ QString QFxWebView::title() const { return page()->mainFrame()->title(); @@ -881,14 +826,6 @@ QString QFxWebView::title() const \qmlproperty pixmap WebView::icon This property holds the icon associated with the web page currently viewed */ -/*! - \property QFxWebView::icon - \brief the icon associated with the web page currently viewed - - By default, this property contains a null icon. - - \sa iconChanged(), QWebSettings::iconForUrl() -*/ QPixmap QFxWebView::icon() const { return page()->mainFrame()->icon().pixmap(QSize(256,256)); @@ -899,18 +836,11 @@ QPixmap QFxWebView::icon() const \qmlproperty real WebView::textSizeMultiplier This property holds the multiplier used to scale the text in a Web page */ -/*! - Sets the value of the multiplier used to scale the text in a Web page to - the \a factor specified. -*/ void QFxWebView::setTextSizeMultiplier(qreal factor) { page()->mainFrame()->setTextSizeMultiplier(factor); } -/*! - Returns the value of the multiplier used to scale the text in a Web page. -*/ qreal QFxWebView::textSizeMultiplier() const { return page()->mainFrame()->textSizeMultiplier(); diff --git a/src/declarative/fx/qfxwebview.h b/src/declarative/fx/qfxwebview.h index 9003377..ef5a395 100644 --- a/src/declarative/fx/qfxwebview.h +++ b/src/declarative/fx/qfxwebview.h @@ -92,6 +92,7 @@ class Q_DECLARATIVE_EXPORT QFxWebView : public QFxPaintedItem Q_PROPERTY(int idealWidth READ idealWidth WRITE setIdealWidth NOTIFY idealWidthChanged) Q_PROPERTY(int idealHeight READ idealHeight WRITE setIdealHeight NOTIFY idealHeightChanged) + Q_PROPERTY(int cacheSize READ cacheSize WRITE setCacheSize) Q_PROPERTY(QUrl url READ url WRITE setUrl NOTIFY urlChanged) Q_PROPERTY(qreal progress READ progress NOTIFY progressChanged) @@ -186,7 +187,7 @@ Q_SIGNALS: void doubleClick(); public Q_SLOTS: - QVariant evaluateJavaScript (const QString&); + QVariant evaluateJavaScript (const QString&); private Q_SLOTS: void expandToWebPage(); @@ -209,7 +210,7 @@ protected: void keyPressEvent(QKeyEvent* event); void keyReleaseEvent(QKeyEvent* event); void timerEvent(QTimerEvent *event); - virtual void geometryChanged(const QRectF &newGeometry, + virtual void geometryChanged(const QRectF &newGeometry, const QRectF &oldGeometry); private: -- cgit v0.12 From 5872a38a2f2ccc67b590d580a258e110ee2d80dc Mon Sep 17 00:00:00 2001 From: Yann Bodson Date: Mon, 17 Aug 2009 13:49:10 +1000 Subject: Doc cleanup. --- src/declarative/fx/qfxanchors.cpp | 22 ++----- src/declarative/fx/qfxflickable.cpp | 70 +--------------------- src/declarative/fx/qfxflipable.cpp | 2 +- src/declarative/fx/qfxgridview.cpp | 9 --- src/declarative/fx/qfximage.cpp | 8 --- src/declarative/fx/qfximagebase.cpp | 8 --- src/declarative/fx/qfxlineedit.cpp | 24 +++----- src/declarative/fx/qfxlistview.cpp | 9 --- src/declarative/fx/qfxmouseregion.cpp | 28 --------- src/declarative/fx/qfxpositioners.cpp | 107 ++-------------------------------- src/declarative/fx/qfxrect.cpp | 39 ------------- src/declarative/fx/qfxscalegrid.cpp | 43 -------------- src/declarative/fx/qfxtextedit.cpp | 90 +++------------------------- 13 files changed, 26 insertions(+), 433 deletions(-) diff --git a/src/declarative/fx/qfxanchors.cpp b/src/declarative/fx/qfxanchors.cpp index b60990c..64eaaaf 100644 --- a/src/declarative/fx/qfxanchors.cpp +++ b/src/declarative/fx/qfxanchors.cpp @@ -181,7 +181,7 @@ void QFxAnchorsPrivate::centerInChanged() void QFxAnchorsPrivate::clearItem(QFxItem *item) { - if (fill == item) + if (fill == item) fill = 0; if (centerIn == item) centerIn = 0; @@ -220,7 +220,7 @@ void QFxAnchorsPrivate::addDepend(QFxItem *item) Q_Q(QFxAnchors); if (!item) return; - QFxItemPrivate *p = + QFxItemPrivate *p = static_cast(QGraphicsItemPrivate::get(item)); p->dependantAnchors.append(q); } @@ -230,7 +230,7 @@ void QFxAnchorsPrivate::remDepend(QFxItem *item) Q_Q(QFxAnchors); if (!item) return; - QFxItemPrivate *p = + QFxItemPrivate *p = static_cast(QGraphicsItemPrivate::get(item)); p->dependantAnchors.removeAll(q); } @@ -319,13 +319,6 @@ void QFxAnchorsPrivate::update(QFxItem *, const QRectF &newG, const QRectF &oldG updateVerticalAnchors(); } -/*! - \property QFxAnchors::fill - \brief which item the item should fill. - - This is a convenience property. It is the same as anchoring the left, right, top, and bottom - to another item's left, right, top, and bottom. -*/ QFxItem *QFxAnchors::fill() const { Q_D(const QFxAnchors); @@ -348,16 +341,9 @@ void QFxAnchors::setFill(QFxItem *f) d->fill = f; d->addDepend(d->fill); - d->fillChanged(); + d->fillChanged(); } -/*! - \property QFxAnchors::centerIn - \brief which item the item should stay centered in. - - This is a convenience property. It is the same as anchoring the horizontalCenter - and verticalCenter to another item's horizontalCenter and verticalCenter. -*/ QFxItem *QFxAnchors::centerIn() const { Q_D(const QFxAnchors); diff --git a/src/declarative/fx/qfxflickable.cpp b/src/declarative/fx/qfxflickable.cpp index d413e42..1cb8336 100644 --- a/src/declarative/fx/qfxflickable.cpp +++ b/src/declarative/fx/qfxflickable.cpp @@ -264,7 +264,7 @@ QML_DEFINE_TYPE(Qt,4,6,(QT_VERSION&0x00ff00)>>8,Flickable,QFxFlickable) \ingroup group_widgets QFxFlickable allows its children to be dragged and flicked. - + \code Flickable { width: 320; height: 480; viewportWidth: image.width; viewportHeight: image.height @@ -304,13 +304,6 @@ QFxFlickable::~QFxFlickable() corner of the Flickable. For example, if you flick an image up 100 pixels, \c yPosition will be 100. */ - -/*! - \property QFxFlickable::xPosition - \brief the x position of the view. - - The xPosition represents the left-most visible coordinate in the view. -*/ qreal QFxFlickable::xPosition() const { Q_D(const QFxFlickable); @@ -328,12 +321,6 @@ void QFxFlickable::setXPosition(qreal pos) } } -/*! - \property QFxFlickable::yPosition - \brief the y position of the view. - - The yPosition represents the top-most visible coordinate in the view. -*/ qreal QFxFlickable::yPosition() const { Q_D(const QFxFlickable); @@ -357,16 +344,9 @@ void QFxFlickable::setYPosition(qreal pos) A user cannot drag or flick a Flickable that is locked. This property is useful for temporarily disabling flicking. This allows - special interaction with Flickable's children: for example, you might want to + special interaction with Flickable's children: for example, you might want to freeze a flickable map while viewing detailed information on a location popup that is a child of the Flickable. */ - -/*! - \property QFxFlickable::locked - \brief determines whether the user can move the view. - - If the Flickable is locked, the user cannot move the view. -*/ bool QFxFlickable::isLocked() const { Q_D(const QFxFlickable); @@ -384,17 +364,6 @@ void QFxFlickable::setLocked(bool lock) This property contains the kind of 'physics' applied when dragging the surface. Two modes are supported: - \list - \i Hard - the view follows the user's input exactly. - \i Elastic - the view moves elastically in response to the user's input. - \endlist -*/ - -/*! - \property QFxFlickable::dragMode - \brief sets the kind of 'physics' applied when dragging the view. - - Two modes are supported: \list \i Hard - the view follows the user's input exactly. \i Elastic - the view moves elastically in response to the user's input. @@ -418,21 +387,12 @@ void QFxFlickable::setDragMode(DragMode mode) The instantaneous velocity of movement along the x and y axes, in pixels/sec. */ - -/*! - \property QFxFlickable::xVelocity - \brief provides the instantaneous velocity of movement in the x-axis (pixels/sec). -*/ qreal QFxFlickable::xVelocity() const { Q_D(const QFxFlickable); return d->xVelocity.value(); } -/*! - \property QFxFlickable::yVelocity - \brief provides the instantaneous velocity of movement in the y-axis (pixels/sec). -*/ qreal QFxFlickable::yVelocity() const { Q_D(const QFxFlickable); @@ -868,16 +828,6 @@ QmlList *QFxFlickable::flickableChildren() the feeling that the edges of the view are soft, rather than a hard physical boundary. */ - -/*! - \property QFxFlickable::overShoot - \brief the number of pixels the view may overshoot the boundaries when flicked. - - If overShoot is non-zero the contents can be flicked beyond the boundary - of the view before being moved back to the boundary. This provides - the feeling that the edges of the view are soft, rather than a hard - physical boundary. -*/ bool QFxFlickable::overShoot() const { Q_D(const QFxFlickable); @@ -904,11 +854,6 @@ void QFxFlickable::setOverShoot(bool o) } \endcode */ - -/*! - \property QFxFlickable::viewportWidth - \brief the width of the view. -*/ int QFxFlickable::viewportWidth() const { Q_D(const QFxFlickable); @@ -957,10 +902,6 @@ void QFxFlickable::heightChange() } } -/*! - \property QFxFlickable::viewportHeight - \brief the height of the view. -*/ int QFxFlickable::viewportHeight() const { Q_D(const QFxFlickable); @@ -1069,7 +1010,7 @@ bool QFxFlickable::sceneEventFilter(QGraphicsItem *i, QEvent *e) switch (e->type()) { case QEvent::GraphicsSceneMousePress: case QEvent::GraphicsSceneMouseMove: - case QEvent::GraphicsSceneMouseRelease: + case QEvent::GraphicsSceneMouseRelease: return sendMouseEvent(static_cast(e)); default: break; @@ -1082,11 +1023,6 @@ bool QFxFlickable::sceneEventFilter(QGraphicsItem *i, QEvent *e) \qmlproperty int Flickable::maximumFlickVelocity This property holds the maximum velocity that the user can flick the view. */ - -/*! - \property QFxFlickable::maximumFlickVelocity - \brief the maximum velocity that the user can flick the view. -*/ int QFxFlickable::maximumFlickVelocity() const { Q_D(const QFxFlickable); diff --git a/src/declarative/fx/qfxflipable.cpp b/src/declarative/fx/qfxflipable.cpp index 228d938..8e56e43 100644 --- a/src/declarative/fx/qfxflipable.cpp +++ b/src/declarative/fx/qfxflipable.cpp @@ -69,7 +69,7 @@ public: Flipable allows you to specify a front and a back and then flip between those sides. \qml -Flipable { + Flipable { id: flipable width: 40 height: 40 diff --git a/src/declarative/fx/qfxgridview.cpp b/src/declarative/fx/qfxgridview.cpp index 7e755fb..448a41a 100644 --- a/src/declarative/fx/qfxgridview.cpp +++ b/src/declarative/fx/qfxgridview.cpp @@ -961,15 +961,6 @@ void QFxGridView::setWrapEnabled(bool wrap) and below the bottom of the view to cache. Setting this value can make scrolling the view smoother at the expense of additional memory usage. */ - -/*! - \property QFxGridView::cacheBuffer - \brief sets the number of off-screen pixels to cache. - - This property determines the number of pixels above the top of the view - and below the bottom of the view to cache. Setting this value can make - scrolling the view smoother at the expense of additional memory usage. -*/ int QFxGridView::cacheBuffer() const { Q_D(const QFxGridView); diff --git a/src/declarative/fx/qfximage.cpp b/src/declarative/fx/qfximage.cpp index ec3fdab..6e24fdf 100644 --- a/src/declarative/fx/qfximage.cpp +++ b/src/declarative/fx/qfximage.cpp @@ -141,14 +141,6 @@ QFxImage::~QFxImage() { } -/*! - \property QFxImage::pixmap - \brief the image displayed in this item. - - This property contains the pixmap currently being displayed by this item, - which may be empty if nothing is currently displayed. Setting the source - property overrides any setting of this property. -*/ QPixmap QFxImage::pixmap() const { Q_D(const QFxImage); diff --git a/src/declarative/fx/qfximagebase.cpp b/src/declarative/fx/qfximagebase.cpp index e3760f3..5aa87db 100644 --- a/src/declarative/fx/qfximagebase.cpp +++ b/src/declarative/fx/qfximagebase.cpp @@ -81,14 +81,6 @@ qreal QFxImageBase::progress() const return d->progress; } - -/*! - \property QFxImage::source - \brief the url of the image to be displayed in this item. - - The content specified can be of any image type loadable by QImage. Alternatively, - you can specify an sci format file, which specifies both an image and it's scale grid. -*/ QUrl QFxImageBase::source() const { Q_D(const QFxImageBase); diff --git a/src/declarative/fx/qfxlineedit.cpp b/src/declarative/fx/qfxlineedit.cpp index de850f8..6e93782 100644 --- a/src/declarative/fx/qfxlineedit.cpp +++ b/src/declarative/fx/qfxlineedit.cpp @@ -52,7 +52,7 @@ QML_DEFINE_TYPE(Qt,4,6,(QT_VERSION&0x00ff00)>>8,QIntValidator,QIntValidator); /*! \qmlclass LineEdit - \brief The LineEdit item allows you to add an editable line of text to a scene. + The LineEdit item allows you to add an editable line of text to a scene. */ QFxLineEdit::QFxLineEdit(QFxItem* parent) : QFxPaintedItem(*(new QFxLineEditPrivate), parent) @@ -145,11 +145,6 @@ void QFxLineEdit::setColor(const QColor &c) The text highlight color, used behind selections. */ - -/*! - \property QFxLineEdit::highlightColor - \brief the line edit's default text highlight color -*/ QColor QFxLineEdit::highlightColor() const { Q_D(const QFxLineEdit); @@ -171,11 +166,6 @@ void QFxLineEdit::setHighlightColor(const QColor &color) The highlighted text color, used in selections. */ - -/*! - \property QFxLineEdit::highlightedTextColor - \brief the line edit's default highlighted text color -*/ QColor QFxLineEdit::highlightedTextColor() const { Q_D(const QFxLineEdit); @@ -229,8 +219,8 @@ void QFxLineEdit::setMaxLength(int ml) } /*! - \qmlproperty LineEdit::cursorVisible - \brief If true the text edit shows a cursor. + \qmlproperty bool LineEdit::cursorVisible + If true the text edit shows a cursor. This property is set and unset when the line edit gets focus, but it can also be set directly (useful, for example, if a KeyProxy might forward keys to it). @@ -252,8 +242,8 @@ void QFxLineEdit::setCursorVisible(bool on) } /*! - \qmlproperty LineEdit::cursorPosition - \brief The position of the cursor in the LineEdit. + \qmlproperty int LineEdit::cursorPosition + The position of the cursor in the LineEdit. */ int QFxLineEdit::cursorPosition() const { @@ -380,8 +370,8 @@ void QFxLineEdit::setEchoMode(uint echo) } /*! - \qmlproperty LineEdit::cursorDelegate - \brief The delegate for the cursor in the LineEdit. + \qmlproperty Component LineEdit::cursorDelegate + The delegate for the cursor in the LineEdit. If you set a cursorDelegate for a LineEdit, this delegate will be used for drawing the cursor instead of the standard cursor. An instance of the diff --git a/src/declarative/fx/qfxlistview.cpp b/src/declarative/fx/qfxlistview.cpp index 9e08b69..cb74910 100644 --- a/src/declarative/fx/qfxlistview.cpp +++ b/src/declarative/fx/qfxlistview.cpp @@ -1194,15 +1194,6 @@ void QFxListView::setWrapEnabled(bool wrap) and below the bottom of the list to cache. Setting this value can make scrolling the list smoother at the expense of additional memory usage. */ - -/*! - \property QFxListView::cacheBuffer - \brief sets the number of off-screen pixels to cache. - - This property determines the number of pixels above the top of the list - and below the bottom of the list to cache. Setting this value can make - scrolling the list smoother at the expense of additional memory usage. -*/ int QFxListView::cacheBuffer() const { Q_D(const QFxListView); diff --git a/src/declarative/fx/qfxmouseregion.cpp b/src/declarative/fx/qfxmouseregion.cpp index 42e024d..e3eec04 100644 --- a/src/declarative/fx/qfxmouseregion.cpp +++ b/src/declarative/fx/qfxmouseregion.cpp @@ -79,12 +79,6 @@ void QFxDrag::setAxis(const QString &a) _axis = a; } -/*! - \property QFxDrag::xmin - \brief the minimum x position for the target - - If x-axis dragging is enabled, xmin limits how far to the left the target can be dragged. If x-axis dragging is not enabled, this property has no effect. -*/ qreal QFxDrag::xmin() const { return _xmin; @@ -95,12 +89,6 @@ void QFxDrag::setXmin(qreal m) _xmin = m; } -/*! - \property QFxDrag::xmax - \brief the maximum x position for the target - - If x-axis dragging is enabled, xmax limits how far to the right the target can be dragged. If x-axis dragging is not enabled, this property has no effect. -*/ qreal QFxDrag::xmax() const { return _xmax; @@ -111,12 +99,6 @@ void QFxDrag::setXmax(qreal m) _xmax = m; } -/*! - \property QFxDrag::ymin - \brief the minimum y position for the target - - If y-axis dragging is enabled, ymin limits how far up the target can be dragged. If y-axis dragging is not enabled, this property has no effect. -*/ qreal QFxDrag::ymin() const { return _ymin; @@ -127,12 +109,6 @@ void QFxDrag::setYmin(qreal m) _ymin = m; } -/*! - \property QFxDrag::ymax - \brief the maximum y position for the target - - If y-axis dragging is enabled, ymax limits how far down the target can be dragged. If y-axis dragging is not enabled, this property has no effect. -*/ qreal QFxDrag::ymax() const { return _ymax; @@ -520,10 +496,6 @@ void QFxMouseRegion::setPressed(bool p) } } -/*! - \property QFxMouseRegion::drag - \brief The current drag being performed on the Mouse Region. -*/ QFxDrag *QFxMouseRegion::drag() { Q_D(QFxMouseRegion); diff --git a/src/declarative/fx/qfxpositioners.cpp b/src/declarative/fx/qfxpositioners.cpp index 270524d..df733b4 100644 --- a/src/declarative/fx/qfxpositioners.cpp +++ b/src/declarative/fx/qfxpositioners.cpp @@ -55,16 +55,6 @@ QT_BEGIN_NAMESPACE /*! \internal \class QFxBasePositioner - \brief The QFxBasePositioner class provides a base for QFx layouts. - - To create a QFx Layout, simple subclass QFxBasePositioner and implement - doLayout(), which is automatically called when the layout might need - updating. - - It is strongly recommended that in your implementation of doLayout() - that you use the move, remove and add transitions when those conditions - arise. - \ingroup group_layouts */ QFxBasePositioner::QFxBasePositioner(AutoUpdateType at, QFxItem *parent) @@ -81,12 +71,6 @@ QFxBasePositioner::QFxBasePositioner(QFxBasePositionerPrivate &dd, AutoUpdateTyp d->init(at); } -/*! - \property QFxBasePositioner::spacing - \brief the amount of spacing between items (in px) - - Note that the subclass is repsonsible for ensuring this. -*/ int QFxBasePositioner::spacing() const { Q_D(const QFxBasePositioner); @@ -102,11 +86,6 @@ void QFxBasePositioner::setSpacing(int s) preLayout(); } -/*! - \property QFxBasePositioner::margin - \brief the size of the margin around all items (in px) - -*/ int QFxBasePositioner::margin() const { Q_D(const QFxBasePositioner); @@ -122,24 +101,6 @@ void QFxBasePositioner::setMargin(int s) preLayout(); } - -/*! - \property QFxBasePositioner::move - \brief the transition when moving an item. - - \qml -BaseLayout { - id: layout - y: 0 - move: Transition { - NumberAnimation { - properties: "y" - ease: "easeOutBounce" - } - } -} - \endqml -*/ QmlTransition *QFxBasePositioner::move() const { Q_D(const QFxBasePositioner); @@ -152,26 +113,6 @@ void QFxBasePositioner::setMove(QmlTransition *mt) d->moveTransition = mt; } -/*! - \property QFxBasePositioner::add - \brief the transition when adding an item. - - \qml -BaseLayout { - id: layout - y: 0 - add: Transition { - NumberAnimation { - target: layout.item - properties: "opacity" - from: 0 - to: 1 - duration: 500 - } - } -} - \endqml -*/ QmlTransition *QFxBasePositioner::add() const { Q_D(const QFxBasePositioner); @@ -184,29 +125,6 @@ void QFxBasePositioner::setAdd(QmlTransition *add) d->addTransition = add; } - -/*! - \property QFxBasePositioner::remove - \brief the transition when removing an item. - - Note that the item may be 'removed' because its opacity is zero. This can make certain - transitions difficult to see. - \qml -BaseLayout { - id: layout - y: 0 - remove: Transition { - NumberAnimation { - target: layout.item - properties: "opacity" - from: 1 - to: 0 - duration: 500 - } - } -} - \endqml -*/ QmlTransition *QFxBasePositioner::remove() const { Q_D(const QFxBasePositioner); @@ -219,13 +137,6 @@ void QFxBasePositioner::setRemove(QmlTransition *remove) d->removeTransition = remove; } -/*! - \property QFxBasePositioner::item - - The item that is currently being laid out. Used to target transitions that apply - only to the item being laid out, such as in the add transition. -*/ - QFxItem *QFxBasePositioner::layoutItem() const { Q_D(const QFxBasePositioner); @@ -475,7 +386,7 @@ void QFxBasePositioner::applyRemove(const QList >& chan QML_DEFINE_TYPE(Qt,4,6,(QT_VERSION&0x00ff00)>>8,VerticalPositioner,QFxVerticalPositioner) /*! \qmlclass VerticalPositioner - \brief The VerticalPositioner item arranges its children in a vertical layout. + \brief The VerticalPositioner item lines up its children vertically. \inherits Item The VerticalPositioner item arranges its child items so that they are vertically @@ -678,7 +589,7 @@ void QFxVerticalPositioner::doLayout() QML_DEFINE_TYPE(Qt,4,6,(QT_VERSION&0x00ff00)>>8,HorizontalPositioner,QFxHorizontalPositioner) /*! \qmlclass HorizontalPositioner - \brief The HorizontalPositioner item arranges its children in a horizontal layout. + \brief The HorizontalPositioner item lines up its children horizontally. \inherits Item The HorizontalPositioner item arranges its child items so that they are horizontally aligned and not overlapping. Spacing can be added between the items, and a margin around all items can also be added. It also provides for transitions to be set when items are added, moved, or removed in the layout. Adding and removing apply both to items which are deleted or have their position in the document changed so as to no longer be children of the layout, as well as to items which have their opacity set to or from zero so as to appear or disappear. @@ -844,7 +755,7 @@ QML_DEFINE_TYPE(Qt,4,6,(QT_VERSION&0x00ff00)>>8,GridPositioner,QFxGridPositioner /*! \qmlclass GridPositioner QFxGridPositioner - \brief The GridPositioner item arranges its children in a grid layout. + \brief The GridPositioner item positions its children in a grid. \inherits Item The GridPositioner item arranges its child items so that they are @@ -867,7 +778,7 @@ QML_DEFINE_TYPE(Qt,4,6,(QT_VERSION&0x00ff00)>>8,GridPositioner,QFxGridPositioner example demonstrates this. \table - \row + \row \o \image gridLayout_example.png \o \qml @@ -1018,16 +929,6 @@ QFxGridPositioner::QFxGridPositioner(QFxItem *parent) : many rows some rows will be of zero width. */ -/*! - \property QFxGridPositioner::columns - \brief the number of columns in the grid. -*/ - -/*! - \property QFxGridPositioner::rows - \brief the number of rows in the grid. -*/ - void QFxGridPositioner::doLayout() { int c=_columns,r=_rows;//Actual number of rows/columns diff --git a/src/declarative/fx/qfxrect.cpp b/src/declarative/fx/qfxrect.cpp index 0bd240e..3a7e350 100644 --- a/src/declarative/fx/qfxrect.cpp +++ b/src/declarative/fx/qfxrect.cpp @@ -65,32 +65,6 @@ QML_DEFINE_TYPE(Qt,4,6,(QT_VERSION&0x00ff00)>>8,Gradient,QFxGradient) \endqml */ -/*! \property QFxPen::width - \brief the width of the border. - - A width of 1 is a single-pixel line on the border of the item being painted. - - If the width is less than 1 the pen is considered invalid and won't be used. -*/ - -/*! - \property QFxPen::color - \brief the color of the border. - - color is most commonly specified in hexidecimal notation (#RRGGBB) - or as an \l {http://www.w3.org/TR/SVG/types.html#ColorKeywords}{SVG color keyword name} - (as defined by the World Wide Web Consortium). For example: - \qml - // rect with green border using hexidecimal notation - Rect { border.color: "#00FF00" } - - // rect with steelblue border using SVG color name - Rect { border.color: "steelblue" } - \endqml - - For the full set of ways to specify color, see Qt's QColor::setNamedColor documentation. -*/ - void QFxPen::setColor(const QColor &c) { _color = c; @@ -98,19 +72,6 @@ void QFxPen::setColor(const QColor &c) emit updated(); } -/*! - \property QFxPen::width - \brief the width of the border. - - \qml - Rect { border.width: 4 } - \endqml - - A width of 1 creates a thin line. For no line, use a width of 0 or a transparent color. - - To keep the border smooth (rather than blurry), odd pen widths cause the rect to be painted at - a half-pixel offset; -*/ void QFxPen::setWidth(int w) { _width = w; diff --git a/src/declarative/fx/qfxscalegrid.cpp b/src/declarative/fx/qfxscalegrid.cpp index 53c63a5..f0c5758 100644 --- a/src/declarative/fx/qfxscalegrid.cpp +++ b/src/declarative/fx/qfxscalegrid.cpp @@ -50,27 +50,6 @@ QT_BEGIN_NAMESPACE \internal \class QFxScaleGrid \brief The QFxScaleGrid class allows you to specify a 3x3 grid to use in scaling an image. - - A scale grid uses 4 grid lines (2 horizontal and 2 vertical) to break an image into 9 sections, as shown below: - \image scalegrid.png - - When the image is scaled: - \list - \i the corners (sections 1, 3, 7, and 9) are not scaled at all - \i the middle (section 5) is scaled both horizontally and vertically - \i sections 2 and 8 are scaled horizontally - \i sections 4 and 6 are scaled vertically - \endlist - - A common way of specifying a scale grid is to create an sci file. An sci file uses a simple - text-based format that specifies each grid line, as well as the associated image file. An example of an sci file's contents: - \code - gridLeft: 10 - gridTop: 10 - gridBottom: 10 - gridRight: 10 - imageFile: picture.png - \endcode */ QML_DEFINE_NOCREATE_TYPE(QFxScaleGrid) @@ -87,10 +66,6 @@ bool QFxScaleGrid::isNull() const return !_left && !_top && !_right && !_bottom; } -/*! - \property QFxScaleGrid::left - \brief the position of the left grid line as an offset from the left side of the image. -*/ void QFxScaleGrid::setLeft(int pos) { if (_left != pos) { @@ -99,10 +74,6 @@ void QFxScaleGrid::setLeft(int pos) } } -/*! - \property QFxScaleGrid::top - \brief the position of the top grid line as an offset from the top of the image. -*/ void QFxScaleGrid::setTop(int pos) { if (_top != pos) { @@ -111,10 +82,6 @@ void QFxScaleGrid::setTop(int pos) } } -/*! - \property QFxScaleGrid::right - \brief the position of the right grid line as an offset from the right side of the image. -*/ void QFxScaleGrid::setRight(int pos) { if (_right != pos) { @@ -123,10 +90,6 @@ void QFxScaleGrid::setRight(int pos) } } -/*! - \property QFxScaleGrid::bottom - \brief the position of the bottom grid line as an offset from the bottom of the image. -*/ void QFxScaleGrid::setBottom(int pos) { if (_bottom != pos) { @@ -135,12 +98,6 @@ void QFxScaleGrid::setBottom(int pos) } } -/*! - \fn void QFxScaleGrid::borderChanged() - - This signal is emitted when one of the border properties is changed. -*/ - QFxGridScaledImage::QFxGridScaledImage() : _l(-1), _r(-1), _t(-1), _b(-1), _h(QFxBorderImage::Stretch), _v(QFxBorderImage::Stretch) diff --git a/src/declarative/fx/qfxtextedit.cpp b/src/declarative/fx/qfxtextedit.cpp index 628d49b..5014185 100644 --- a/src/declarative/fx/qfxtextedit.cpp +++ b/src/declarative/fx/qfxtextedit.cpp @@ -136,18 +136,6 @@ QString QFxTextEdit::text() const automatically determine whether the text should be treated as rich text. This determination is made using Qt::mightBeRichText(). */ - -/*! - \property QFxTextEdit::text - \brief the text edit's text - - If the text format is set to AutoText the text edit will try to - automatically determine whether the text should be treated as - rich text. This determination is made using Qt::mightBeRichText(). - - \sa textFormat -*/ - void QFxTextEdit::setText(const QString &text) { Q_D(QFxTextEdit); @@ -199,20 +187,6 @@ VerticalPositioner { \o \image declarative-textformat.png \endtable */ - -/*! - \property QFxTextEdit::textFormat - \brief this property describes how the text set on the text edit - should be interpreted. - - Valid values are \c AutoText, \c PlainText and \c RichText. The - default value is \c AutoText, meaning the text edit will attempt - to guess how the text should be interpreted using the - Qt::mightBeRichText() function. - - \sa text -*/ - QFxTextEdit::TextFormat QFxTextEdit::textFormat() const { Q_D(const QFxTextEdit); @@ -237,11 +211,6 @@ void QFxTextEdit::setTextFormat(TextFormat format) d->format = format; } -/*! - \property QFxTextEdit::font - \brief the text edit's default font -*/ - QFont QFxTextEdit::font() const { Q_D(const QFxTextEdit); @@ -276,11 +245,6 @@ TextEdit { color: "#00FF00"; ... } TextEdit { color: "steelblue"; ... } \endqml */ - -/*! - \property QFxTextEdit::color - \brief the text edit's default text color -*/ QColor QFxTextEdit::color() const { Q_D(const QFxTextEdit); @@ -306,11 +270,6 @@ void QFxTextEdit::setColor(const QColor &color) The text highlight color, used behind selections. */ - -/*! - \property QFxTextEdit::highlightColor - \brief the text edit's default text highlight color -*/ QColor QFxTextEdit::highlightColor() const { Q_D(const QFxTextEdit); @@ -336,11 +295,6 @@ void QFxTextEdit::setHighlightColor(const QColor &color) The highlighted text color, used in selections. */ - -/*! - \property QFxTextEdit::highlightedTextColor - \brief the text edit's default highlighted text color -*/ QColor QFxTextEdit::highlightedTextColor() const { Q_D(const QFxTextEdit); @@ -372,13 +326,6 @@ void QFxTextEdit::setHighlightedTextColor(const QColor &color) \c AlignHCenter. The valid values for \c vAlign are \c AlignTop, \c AlignBottom and \c AlignVCenter. */ - -/*! - \property QFxTextEdit::hAlign - \brief the horizontal alignment of the text. - - Valid values are \c AlignLeft, \c AlignRight, and \c AlignHCenter. The default value is \c AlignLeft. -*/ QFxTextEdit::HAlignment QFxTextEdit::hAlign() const { Q_D(const QFxTextEdit); @@ -395,12 +342,6 @@ void QFxTextEdit::setHAlign(QFxTextEdit::HAlignment alignment) updateSize(); } -/*! - \property QFxTextEdit::vAlign - \brief the vertical alignment of the text. - - Valid values are \c AlignTop, \c AlignBottom, and \c AlignVCenter. The default value is \c AlignTop. -*/ QFxTextEdit::VAlignment QFxTextEdit::vAlign() const { Q_D(const QFxTextEdit); @@ -431,12 +372,6 @@ bool QFxTextEdit::wrap() const Wrapping is done on word boundaries (i.e. it is a "word-wrap"). Wrapping is off by default. */ - -/*! - \property QFxTextEdit::wrap - \brief If true the text edit wraps text based on the width of the - text edit. -*/ void QFxTextEdit::setWrap(bool w) { Q_D(QFxTextEdit); @@ -448,8 +383,8 @@ void QFxTextEdit::setWrap(bool w) } /*! - \qmlproperty TextEdit::cursorVisible - \brief If true the text edit shows a cursor. + \qmlproperty bool TextEdit::cursorVisible + If true the text edit shows a cursor. This property is set and unset when the text edit gets focus, but it can also be set directly (useful, for example, if a KeyProxy might forward keys to it). @@ -473,8 +408,8 @@ void QFxTextEdit::setCursorVisible(bool on) } /*! - \qmlproperty TextEdit::cursorPosition - \brief The position of the cursor in the TextEdit. + \qmlproperty int TextEdit::cursorPosition + The position of the cursor in the TextEdit. */ int QFxTextEdit::cursorPosition() const { @@ -493,8 +428,8 @@ void QFxTextEdit::setCursorPosition(int pos) } /*! - \qmlproperty TextEdit::cursorDelegate - \brief The delegate for the cursor in the TextEdit. + \qmlproperty Component TextEdit::cursorDelegate + The delegate for the cursor in the TextEdit. If you set a cursorDelegate for a TextEdit, this delegate will be used for drawing the cursor instead of the standard cursor. An instance of the @@ -710,22 +645,11 @@ void QFxTextEdit::componentComplete() /*! \qmlproperty bool TextEdit::readOnly - Whether the user an interact with the TextEdit item. If this + Whether the user an interact with the TextEdit item. If this property is set to true the text cannot be edited by user interaction. By default this property is false. */ - -/*! - \property QFxTextEdit::readOnly - \brief If this property is true the text can not be edited by user interaction. - - Changing this property will modify the text interaction flags. If - you require more specific control about how user interaction - with the text edit is handled, use setTextInteractionFlags() instead. - - \sa setTextInteractionFlags() -*/ void QFxTextEdit::setReadOnly(bool r) { Q_D(QFxTextEdit); -- cgit v0.12