src/controls/RouterWindow.qml

0001 /*
0002  *  SPDX-FileCopyrightText: 2020 Carson Black <uhhadd@gmail.com>
0003  *
0004  *  SPDX-License-Identifier: LGPL-2.0-or-later
0005  */
0006
0007 import QtQuick 2.5
0008 import org.kde.kirigami 2.12 as Kirigami
0009
0010 //TODO KF6: this seems to have ended up barely used if at all. can be removed?
0011 // Investigate why almost identical api is used a lot on different frameworks
0012 // like Flutter but not in plamo apps.
0013
0014 /**
0015  * @brief An ApplicationWindow with a preconfigured PageRouter.
0016  *
0017  * In order to call functions on the PageRouter, use @link PageRouterAttached  the attached Kirigami.PageRouter object @endlink.
0018  *
0019  * @warning This might be removed in KF6 due to not being used a lot.
0020  * @inherit kirigami::ApplicationWindow
0021  */
0022 Kirigami.ApplicationWindow {
0023     id: __kirigamiApplicationWindow
0024
0025     /**
0026      * @see kirigami::PageRouter::routes
0027      * @property list<Kirigami.PageRoute> route
0028      */
0029     default property alias routes: __kirigamiPageRouter.routes
0030
0031     /**
0032      * @see kirigami::PageRouter::initialRoute
0033      * @property string initialRoute
0034      */
0035     property alias initialRoute: __kirigamiPageRouter.initialRoute
0036
0037     /**
0038      * @brief This property holds this window's PageRouter.
0039      * @property kirigami::PageRouter
0040      */
0041     property alias router: __kirigamiPageRouter
0042
0043     Kirigami.PageRouter {
0044         id: __kirigamiPageRouter
0045         pageStack: __kirigamiApplicationWindow.pageStack.columnView
0046     }
0047 }