Uploaded image for project: 'Qt'
  1. Qt
  2. QTBUG-99124

Properly document ScrollBar in ScrollView

    XMLWordPrintable

Details

    • 9052e09a21 (qt/qtdeclarative/dev) f1bfe02ffe (qt/qtdeclarative/6.2) ab238e839f (qt/qtdeclarative/6.3) f1bfe02ffe (qt/tqtc-qtdeclarative/6.2) ab238e839f (qt/tqtc-qtdeclarative/6.3) 9052e09a21 (qt/tqtc-qtdeclarative/dev) f1bfe02ffe (qt/qtdeclarative/6.2.4)

    Description

      ScrollView (https://doc.qt.io/qt-6/qml-qtquick-controls2-scrollview.html) apparently has the ScrollBar (https://doc.qt.io/qt-6/qml-qtquick-controls2-scrollbar.html) as attached property. This is not documented at all besides some hints like:

      The horizontal and vertical scroll bars can be accessed and customized using the ScrollBar.horizontal and ScrollBar.vertical attached properties. The following example adjusts the scroll bar policies so that the horizontal scroll bar is always off, and the vertical scroll bar is always on.
      

      This is very bad documentation at best.

      In the past (say with the Layouts module) these things were documented quite well. Telling the user where the attached Layout property has an effect. With ScrollBar there is not even a single mention of ScrollBar being an attached property. You just need to make that up from the rest of the documentation.

      Also, ScrollBar itself does not mention ScrollView at all.

      Thus figuring out that you can change ScrollView behavior with this attached property is apparently left as a puzzle to the user.

      Please properly document this in, at the very least, ScrollView.

      Attachments

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

        Activity

          People

            docteam Qt Documentation Team
            markg85 Mark
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes