diff options
| author | Frederik Gladhorn <frederik.gladhorn@theqtcompany.com> | 2015-04-24 15:29:47 +0200 |
|---|---|---|
| committer | Frederik Gladhorn <frederik.gladhorn@theqtcompany.com> | 2015-04-24 17:19:12 +0000 |
| commit | 2f55a4926347a6f6b445efca7dfed792e1bacc57 (patch) | |
| tree | 543b63d12ca4ef868473c5448b9935549bc325fa /src | |
| parent | 61b338e8473ba24b5e5f79f64327cd27bd9c95f6 (diff) | |
Add basic ApplicationWindow docs
Change-Id: I943d7df19c50e1e02b38c0b8e337d9d6a5aa7fdb
Reviewed-by: J-P Nurmi <jpnurmi@theqtcompany.com>
Diffstat (limited to 'src')
| -rw-r--r-- | src/controls/qquickapplicationwindow.cpp | 29 |
1 files changed, 23 insertions, 6 deletions
diff --git a/src/controls/qquickapplicationwindow.cpp b/src/controls/qquickapplicationwindow.cpp index 7a4809ab..d8ad346a 100644 --- a/src/controls/qquickapplicationwindow.cpp +++ b/src/controls/qquickapplicationwindow.cpp @@ -47,9 +47,12 @@ QT_BEGIN_NAMESPACE \instantiates QQuickApplicationWindow \inqmlmodule QtQuick.Controls \ingroup application - \brief An application window. + \brief Provides a top-level application window. - TODO + ApplicationWindow is a \l Window which makes it convenient to add + a \l header and \l footer item to the window. + + \note By default, an ApplicationWindow is not visible. */ class QQuickApplicationWindowPrivate : public QQuickItemChangeListener @@ -117,7 +120,10 @@ QQuickApplicationWindow::~QQuickApplicationWindow() /*! \qmlproperty Item QtQuickControls2::ApplicationWindow::header - TODO + A header item for the window, for example a title bar, menu or tool-bar. + By default this property is empty, no header will be shown. + + \sa footer */ QQuickItem *QQuickApplicationWindow::header() const { @@ -145,7 +151,10 @@ void QQuickApplicationWindow::setHeader(QQuickItem *header) /*! \qmlproperty Item QtQuickControls2::ApplicationWindow::footer - TODO + A footer item for the window, for example a status bar or menu. + By default this property is empty, no footer will be shown. + + \sa header */ QQuickItem *QQuickApplicationWindow::footer() const { @@ -173,7 +182,11 @@ void QQuickApplicationWindow::setFooter(QQuickItem *footer) /*! \qmlproperty real QtQuickControls2::ApplicationWindow::contentWidth - TODO + This property is the width of the window content without header and footer. + Setting it will resize the window accordingly. + By default the implicit width of the child items is used. + + \sa contentHeight */ qreal QQuickApplicationWindow::contentWidth() const { @@ -193,7 +206,11 @@ void QQuickApplicationWindow::setContentWidth(qreal width) /*! \qmlproperty real QtQuickControls2::ApplicationWindow::contentHeight - TODO + This property is the height of the window content without header and footer. + Setting it will resize the window accordingly. + By default the implicit height of the child items is used. + + \sa contentWidth */ qreal QQuickApplicationWindow::contentHeight() const { |