Skip to content
GitLab
Select Git revision
  • dev default
  • 6.2
  • 6.2.2
  • 6.2.1
  • 6.1
  • 6.2.0
  • 5.12
  • 5.12.12
  • 6.1.3
  • wip/qtquickcontrols2
  • 6.0
  • 6.1.2
  • 6.1.1
  • 6.1.0
  • 5.12.11
  • wip/qquickdeliveryagent
  • 5.15
  • 6.0.0
  • 5.15.2
  • 5.12.10
  • v5.15.0-alpha1
  • v5.12.7
  • v5.14.1
  • v5.9.9
  • v5.14.0
  • v5.14.0-rc2
  • v5.14.0-rc1
  • v5.12.6
  • v5.14.0-beta3
  • v5.13.2
  • v5.14.0-beta2
  • v5.14.0-beta1
  • v5.14.0-alpha1
  • v5.12.5
  • v5.13.1
  • v5.13.0
  • v5.13.0-rc3
  • v5.12.4
  • v5.13.0-rc2
  • v5.13.0-rc1
Find file BlameHistoryPermalink
  • Bea Lam's avatar
    Fix doc snippets paths and parsing errors · 4c671c04
    Bea Lam authored 
    
qtqml.qdocconf and qtquick.qdocconf now refer to the correct
snippets and source directories.

Snippet paths in .qdoc and .cpp files have been updated to refer to
the new shortened path references, e.g. \snippet qml/file.cpp instead of
\snippet doc/src/snippets/qml/file.cpp.

This also deletes snippets from src/qml/doc/snippets that belonged under
src/quick/doc/snippets (and were already duplicated there anyway) and
restores some snippet files that shouldn't have been deleted.

Also fixes some inline snippets to use \code .. \endcode instead of
\qml .. \endqml as they contained javascript or partial QML
snippets that were causing parsing errors from qdoc.

There are still snippet errors arising from qmlintro.qdoc as the
qmlintro snippets directory that it refers to cannot be located.

There are also two references to a removed snippet identifier in
examples/qml/cppextensions/plugins/plugin.cpp that need to be fixed
in conjunction with the related docs in a later commit as the relevant
code has changed and the docs are now invalid.

Task-number: QTBUG-25721

Change-Id: I50c665245a74c140470c58a32546591d187dfe4b
Reviewed-by: default avatarChris Adams <christopher.adams@nokia.com>
    4c671c04
ScrollView.qml 11.24 KiB
1 
/****************************************************************************
2 
**
3 
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
4 
** Contact: http://www.qt-project.org/legal
5 
**
6 
** This file is part of the Qt Quick Controls module of the Qt Toolkit.
7 
**
8 
** $QT_BEGIN_LICENSE:BSD$
9 
** You may use this file under the terms of the BSD license as follows:
10 
**
11 
** "Redistribution and use in source and binary forms, with or without
12 
** modification, are permitted provided that the following conditions are
13 
** met:
14 
**   * Redistributions of source code must retain the above copyright
15 
**     notice, this list of conditions and the following disclaimer.
16 
**   * Redistributions in binary form must reproduce the above copyright
17 
**     notice, this list of conditions and the following disclaimer in
18 
**     the documentation and/or other materials provided with the
19 
**     distribution.
20 
**   * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names
21 
**     of its contributors may be used to endorse or promote products derived
22 
**     from this software without specific prior written permission.
23 
**
24 
**
25 
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 
** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
36 
**
37 
** $QT_END_LICENSE$
38 
**
39 
****************************************************************************/
40
41 
import QtQuick 2.1
42 
import QtQuick.Controls 1.0
43 
import QtQuick.Controls.Private 1.0
44 
import QtQuick.Controls.Styles 1.0
45
46 
/*!
47 
    \qmltype ScrollView
48 
    \inqmlmodule QtQuick.Controls 1.0
49 
    \since  QtQuick.Controls 1.0
50 
    \ingroup views
51 
    \brief Provides a scrolling view within another Item.
52
53 
    A ScrollView can be used either to replace a \l Flickable or decorate an
54 
    existing \l Flickable. Depending on the platform, it will add scroll bars and
55 
    a content frame.
56
57 
    Only one Item can be a direct child of the ScrollView and the child is implicitly anchored
58 
    to fill the scroll view.
59
60 
    Example:
61 
    \code
62 
    ScrollView {
63 
        Image { imageSource: "largeImage.png" }
64 
    }
65 
    \endcode
66
67 
    In the previous example the Image item will implicitly get scroll behavior as if it was
68 
    used within a \l Flickable. The width and height of the child item will be used to
69 
    define the size of the content area.
70
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
Example: \code ScrollView { ListView { ... } } \endcode In this case the content size of the ScrollView will simply mirror that of its contained \l flickableItem. You can create a custom appearance for a ScrollView by assigning a \l ScrollViewStyle. */ FocusScope { id: root implicitWidth: 240 implicitHeight: 150 /*! This property tells the ScrollView if it should render a frame around its content. The default value is \c false. */ property bool frameVisible: false /*! This property controls if there should be a highlight around the frame when the ScrollView has input focus. The default value is \c false. \note This property is only applicable on some platforms, such as Mac OS. */ property bool highlightOnFocus: false /*! \qmlproperty Item ScrollView::viewport The viewport determines the current "window" on the contentItem. In other words, it clips it and the size of the viewport tells you how much of the content area is visible. */ property alias viewport: viewportItem /*! \qmlproperty Item ScrollView::flickableItem The flickableItem of the ScrollView. If the contentItem provided to the ScrollView is a Flickable, it will be the \l contentItem. */ readonly property alias flickableItem: internal.flickableItem /*! The contentItem of the ScrollView. This is set by the user. Note that the definition of contentItem is somewhat different to that of a Flickable, where the contentItem is implicitly created. */ default property Item contentItem /*! \internal */ property Item __scroller: scroller /*! \internal */ property int __scrollBarTopMargin: 0
141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
/*! \internal */ property int __viewTopMargin: 0 /*! \internal */ property alias __horizontalScrollBar: scroller.horizontalScrollBar /*! \internal */ property alias __verticalScrollBar: scroller.verticalScrollBar /*! \internal */ property Component style: Qt.createComponent(Settings.style + "/ScrollViewStyle.qml", root) /*! \internal */ property Style __style: styleLoader.item activeFocusOnTab: true onContentItemChanged: { if (contentItem.hasOwnProperty("contentY") && // Check if flickable contentItem.hasOwnProperty("contentHeight")) { internal.flickableItem = contentItem // "Use content if it is a flickable internal.flickableItem.parent = viewportItem } else { internal.flickableItem = flickableComponent.createObject(viewportItem) contentItem.parent = internal.flickableItem.contentItem } internal.flickableItem.anchors.fill = viewportItem internal.flickableItem.interactive = false } children: Item { id: internal property Flickable flickableItem Loader { id: styleLoader sourceComponent: style onStatusChanged: { if (status === Loader.Error) console.error("Failed to load Style for", root) } property alias __control: root } Binding { target: flickableItem property: "contentHeight" when: contentItem !== flickableItem value: contentItem ? contentItem.height : 0 } Binding { target: flickableItem when: contentItem !== flickableItem property: "contentWidth" value: contentItem ? contentItem.width : 0 } Connections { target: flickableItem onContentYChanged: { scroller.blockUpdates = true scroller.verticalScrollBar.value = flickableItem.contentY scroller.blockUpdates = false } onContentXChanged: { scroller.blockUpdates = true scroller.horizontalScrollBar.value = flickableItem.contentX
211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
scroller.blockUpdates = false } } anchors.fill: parent Component { id: flickableComponent Flickable {} } WheelArea { id: wheelArea parent: flickableItem // ### Note this is needed due to broken mousewheel behavior in Flickable. anchors.fill: parent property int acceleration: 40 property int flickThreshold: 20 property real speedThreshold: 3 property real ignored: 0.001 // ## flick() does not work with 0 yVelocity property int maxFlick: 400 property bool horizontalRecursionGuard: false property bool verticalRecursionGuard: false horizontalMinimumValue: flickableItem ? flickableItem.originX : 0 horizontalMaximumValue: flickableItem ? flickableItem.originX + flickableItem.contentWidth - viewport.width : 0 verticalMinimumValue: flickableItem ? flickableItem.originY : 0 verticalMaximumValue: flickableItem ? flickableItem.originY + flickableItem.contentHeight - viewport.height + __viewTopMargin : 0 Connections { target: flickableItem onContentYChanged: { wheelArea.verticalRecursionGuard = true wheelArea.verticalValue = flickableItem.contentY wheelArea.verticalRecursionGuard = false } onContentXChanged: { wheelArea.horizontalRecursionGuard = true wheelArea.horizontalValue = flickableItem.contentX wheelArea.horizontalRecursionGuard = false } } onVerticalValueChanged: { if (!verticalRecursionGuard) { if (flickableItem.contentY < flickThreshold && verticalDelta > speedThreshold) { flickableItem.flick(ignored, Math.min(maxFlick, acceleration * verticalDelta)) } else if (flickableItem.contentY > flickableItem.contentHeight - flickThreshold - viewport.height && verticalDelta < -speedThreshold) { flickableItem.flick(ignored, Math.max(-maxFlick, acceleration * verticalDelta)) } else { flickableItem.contentY = verticalValue } } } onHorizontalValueChanged: { if (!horizontalRecursionGuard) flickableItem.contentX = horizontalValue } } ScrollViewHelper {
281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311
id: scroller anchors.fill: parent property bool outerFrame: !frameVisible || !(__style ? __style.__externalScrollBars : 0) property int scrollBarSpacing: outerFrame ? 0 : (__style ? __style.__scrollBarSpacing : 0) property int verticalScrollbarOffset: verticalScrollBar.visible && !verticalScrollBar.isTransient ? verticalScrollBar.width + scrollBarSpacing : 0 property int horizontalScrollbarOffset: horizontalScrollBar.visible && !horizontalScrollBar.isTransient ? horizontalScrollBar.height + scrollBarSpacing : 0 Loader { id: frameLoader sourceComponent: __style ? __style.frame : null anchors.fill: parent anchors.rightMargin: scroller.outerFrame ? 0 : scroller.verticalScrollbarOffset anchors.bottomMargin: scroller.outerFrame ? 0 : scroller.horizontalScrollbarOffset } Item { id: viewportItem anchors.fill: frameLoader anchors.topMargin: frameVisible ? __style.padding.top : 0 anchors.leftMargin: frameVisible ? __style.padding.left : 0 anchors.rightMargin: (frameVisible ? __style.padding.right : 0) + (scroller.outerFrame ? scroller.verticalScrollbarOffset : 0) anchors.bottomMargin: (frameVisible ? __style.padding.bottom : 0) + (scroller.outerFrame ? scroller.horizontalScrollbarOffset : 0) clip: true } } FocusFrame { visible: highlightOnFocus && root.activeFocus } } }