From 8dac37211187a6fd7291d625b94e4910478765a9 Mon Sep 17 00:00:00 2001 From: Liang Qi Date: Wed, 19 Dec 2012 14:27:23 +0100 Subject: Add dummy docs for qtdesktop and styles Change-Id: Ibf752d64399c6bd4bf5519aab330a9eacf6bb91b Reviewed-by: Jerome Pasion Reviewed-by: J-P Nurmi --- src/qtdesktop/ApplicationWindow.qml | 6 +++ src/qtdesktop/Button.qml | 6 +++ src/qtdesktop/ButtonColumn.qml | 11 ++-- src/qtdesktop/ButtonRow.qml | 11 ++-- src/qtdesktop/CheckBox.qml | 5 ++ src/qtdesktop/ComboBox.qml | 99 +++++++++++++++++++----------------- src/qtdesktop/ContextMenu.qml | 6 +++ src/qtdesktop/Dial.qml | 6 +++ src/qtdesktop/Dialog.qml | 6 +++ src/qtdesktop/Frame.qml | 6 +++ src/qtdesktop/GroupBox.qml | 6 +++ src/qtdesktop/Label.qml | 6 +++ src/qtdesktop/ProgressBar.qml | 6 +++ src/qtdesktop/RadioButton.qml | 6 +++ src/qtdesktop/ScrollArea.qml | 6 +++ src/qtdesktop/ScrollBar.qml | 6 +++ src/qtdesktop/Slider.qml | 6 +++ src/qtdesktop/SpinBox.qml | 6 +++ src/qtdesktop/SplitterColumn.qml | 6 +++ src/qtdesktop/SplitterRow.qml | 6 +++ src/qtdesktop/StatusBar.qml | 6 +++ src/qtdesktop/Tab.qml | 6 +++ src/qtdesktop/TabBar.qml | 6 +++ src/qtdesktop/TabFrame.qml | 6 +++ src/qtdesktop/TableColumn.qml | 6 +++ src/qtdesktop/TableView.qml | 6 +++ src/qtdesktop/TextArea.qml | 7 +++ src/qtdesktop/TextField.qml | 6 +++ src/qtdesktop/ToolBar.qml | 6 +++ src/qtdesktop/ToolButton.qml | 6 +++ src/qtdesktop/qfiledialogitem.cpp | 5 +- src/qtdesktop/qquicklayout.cpp | 1 - src/qtdesktop/qquicklinearlayout.cpp | 14 +++++ src/qtdesktop/qrangemodel.cpp | 8 +-- src/qtdesktop/qtmenu.cpp | 7 +++ src/qtdesktop/qtmenubar.cpp | 7 +++ src/qtdesktop/qtmenuitem.cpp | 14 +++++ src/qtdesktop/qtsplitterbase.cpp | 7 +++ src/qtdesktop/qwheelarea.cpp | 6 +++ src/styles/ButtonStyle.qml | 6 +++ src/styles/CheckBoxStyle.qml | 6 +++ src/styles/ComboBoxStyle.qml | 6 +++ src/styles/FrameStyle.qml | 6 +++ src/styles/GroupBoxStyle.qml | 6 +++ src/styles/ProgressBarStyle.qml | 7 +++ src/styles/RadioButtonStyle.qml | 6 +++ src/styles/ScrollAreaStyle.qml | 6 +++ src/styles/ScrollBarStyle.qml | 6 +++ src/styles/SliderStyle.qml | 6 +++ src/styles/SpinBoxStyle.qml | 6 +++ src/styles/TabBarStyle.qml | 6 +++ src/styles/TabFrameStyle.qml | 6 +++ src/styles/TextFieldStyle.qml | 6 +++ src/styles/ToolBarStyle.qml | 6 +++ src/styles/ToolButtonStyle.qml | 6 +++ 55 files changed, 384 insertions(+), 65 deletions(-) diff --git a/src/qtdesktop/ApplicationWindow.qml b/src/qtdesktop/ApplicationWindow.qml index fe35b6c8..fe53d82f 100644 --- a/src/qtdesktop/ApplicationWindow.qml +++ b/src/qtdesktop/ApplicationWindow.qml @@ -41,6 +41,12 @@ import QtQuick 2.0 import QtDesktop 1.0 +/*! + \qmltype ApplicationWindow + \inqmlmodule QtDesktop 1.0 + \brief ApplicationWindow is doing bla...bla... +*/ + Window { id: root width: 320 diff --git a/src/qtdesktop/Button.qml b/src/qtdesktop/Button.qml index b82e0ebd..ca679066 100644 --- a/src/qtdesktop/Button.qml +++ b/src/qtdesktop/Button.qml @@ -43,6 +43,12 @@ import QtDesktop 1.0 import "private" import "Styles/Settings.js" as Settings +/*! + \qmltype Button + \inqmlmodule QtDesktop 1.0 + \brief Button is doing bla...bla... +*/ + BasicButton { id: button diff --git a/src/qtdesktop/ButtonColumn.qml b/src/qtdesktop/ButtonColumn.qml index 50410a32..a1662992 100644 --- a/src/qtdesktop/ButtonColumn.qml +++ b/src/qtdesktop/ButtonColumn.qml @@ -41,19 +41,20 @@ import QtQuick 2.0 import "private/ButtonGroup.js" as Behavior -/* - Class: ButtonColumn - A ButtonColumn allows you to group Buttons in a column. It provides a selection-behavior as well. +/*! + \qmltype ButtonColumn + \inqmlmodule QtDesktop 1.0 + \brief ButtonColumn allows you to group Buttons in a column. It provides a selection-behavior as well. Note: This component don't support the enabled property. If you need to disable it you should disable all the buttons inside it. - + \qml ButtonColumn { Button { text: "Top" } Button { text: "Bottom" } } - + \endqml */ Column { id: root diff --git a/src/qtdesktop/ButtonRow.qml b/src/qtdesktop/ButtonRow.qml index 9c3c2c16..6a019af6 100644 --- a/src/qtdesktop/ButtonRow.qml +++ b/src/qtdesktop/ButtonRow.qml @@ -41,19 +41,20 @@ import QtQuick 2.0 import "private/ButtonGroup.js" as Behavior -/* - Class: ButtonRow - A ButtonRow allows you to group Buttons in a row. It provides a selection-behavior as well. +/*! + \qmltype ButtonRow + \inqmlmodule QtDesktop 1.0 + \brief ButtonRow allows you to group Buttons in a row. It provides a selection-behavior as well. Note: This component don't support the enabled property. If you need to disable it you should disable all the buttons inside it. - + \qml ButtonRow { Button { text: "Left" } Button { text: "Right" } } - + \endqml */ Row { id: root diff --git a/src/qtdesktop/CheckBox.qml b/src/qtdesktop/CheckBox.qml index 88f19869..cd747bac 100644 --- a/src/qtdesktop/CheckBox.qml +++ b/src/qtdesktop/CheckBox.qml @@ -43,6 +43,11 @@ import QtDesktop 1.0 import "Styles/Settings.js" as Settings import "private" ++/*! + \qmltype CheckBox + \inqmlmodule QtDesktop 1.0 + \brief CheckBox is doing bla...bla... +*/ FocusScope { id: checkBox diff --git a/src/qtdesktop/ComboBox.qml b/src/qtdesktop/ComboBox.qml index 2b50880f..c2a795fb 100644 --- a/src/qtdesktop/ComboBox.qml +++ b/src/qtdesktop/ComboBox.qml @@ -43,54 +43,57 @@ import QtDesktop 1.0 import "private" as Private import "Styles/Settings.js" as Settings -/* -* -* ComboBox (inherits BasicButton) -* -* The ComboBox component is a combined button and popup list. The popup menu itself is platform -* native, and cannot by styled from QML code. -* Add menu items to the comboBox by either adding MenuItem children inside the popup, or -* assign it a ListModel (or both). -* -* The ComboBox contains the following API (in addition to the BasicButton API): -* -* ListModel model - this model will be used, in addition to MenuItem children, to -* create items inside the popup menu -* bool popupOpen - setting this property to 'true' will open the popup. -* int selectedIndex - the index of the selected item in the popup menu. -* int hoveredIndex - the index of the highlighted item in the popup menu. -* string selectedText - the text of the selected menu item. -* string hoveredText - the text of the highlighted menu item. -* -* Example 1: -* -* ListModel { -* id: menuItems -* ListElement { text: "Banana"; color: "Yellow" } -* ListElement { text: "Apple"; color: "Green" } -* ListElement { text: "Coconut"; color: "Brown" } -* } -* ComboBox { -* model: menuItems -* width: 200 -* onSelectedIndexChanged: console.debug(selectedText + ", " + menuItems.get(selectedIndex).color) -* } -* -* Example 2: -* -* ComboBox { -* width: 200 -* MenuItem { -* text: "Pineapple" -* onSelected: console.debug(text) -* -* } -* MenuItem { -* text: "Grape" -* onSelected: console.debug(text) -* } -* } -* +/*! + \qmltype ComboBox + \inqmlmodule QtDesktop 1.0 + \brief ComboBox is a combined button and popup list. The popup menu itself is platform + native, and cannot by styled from QML code. + + Add menu items to the comboBox by either adding MenuItem children inside the popup, or + assign it a ListModel (or both). + + The ComboBox contains the following API (in addition to the BasicButton API): + + ListModel model - this model will be used, in addition to MenuItem children, to + create items inside the popup menu + bool popupOpen - setting this property to 'true' will open the popup. + int selectedIndex - the index of the selected item in the popup menu. + int hoveredIndex - the index of the highlighted item in the popup menu. + string selectedText - the text of the selected menu item. + string hoveredText - the text of the highlighted menu item. + + Example 1: + + \qml + ListModel { + id: menuItems + ListElement { text: "Banana"; color: "Yellow" } + ListElement { text: "Apple"; color: "Green" } + ListElement { text: "Coconut"; color: "Brown" } + } + ComboBox { + model: menuItems + width: 200 + onSelectedIndexChanged: console.debug(selectedText + ", " + menuItems.get(selectedIndex).color) + } + \endqml + + Example 2: + + \qml + ComboBox { + width: 200 + MenuItem { + text: "Pineapple" + onSelected: console.debug(text) + + } + MenuItem { + text: "Grape" + onSelected: console.debug(text) + } + } + \endqml */ Private.BasicButton { diff --git a/src/qtdesktop/ContextMenu.qml b/src/qtdesktop/ContextMenu.qml index 0ba2a920..a97867e3 100644 --- a/src/qtdesktop/ContextMenu.qml +++ b/src/qtdesktop/ContextMenu.qml @@ -41,6 +41,12 @@ import QtQuick 2.0 import QtDesktop 1.0 +/*! + \qmltype ContextMenu + \inqmlmodule QtDesktop 1.0 + \brief ContextMenu is doing bla...bla... +*/ + Menu { id: root property string selectedText: itemTextAt(selectedIndex) diff --git a/src/qtdesktop/Dial.qml b/src/qtdesktop/Dial.qml index e235963d..fa0df6df 100644 --- a/src/qtdesktop/Dial.qml +++ b/src/qtdesktop/Dial.qml @@ -43,6 +43,12 @@ import QtDesktop 1.0 // jens: ContainsMouse breaks drag functionality +/*! + \qmltype Dial + \inqmlmodule QtDesktop 1.0 + \brief Dial is doing bla...bla... +*/ + Item { id: dial diff --git a/src/qtdesktop/Dialog.qml b/src/qtdesktop/Dialog.qml index 2cf0e9ad..248f33e3 100644 --- a/src/qtdesktop/Dialog.qml +++ b/src/qtdesktop/Dialog.qml @@ -41,6 +41,12 @@ import QtQuick 2.0 import QtQuick.Window 2.0 +/*! + \qmltype Dialog + \inqmlmodule QtDesktop 1.0 + \brief Dialog is doing bla...bla... +*/ + Window { id: dialog diff --git a/src/qtdesktop/Frame.qml b/src/qtdesktop/Frame.qml index 36627176..f34c7b16 100644 --- a/src/qtdesktop/Frame.qml +++ b/src/qtdesktop/Frame.qml @@ -42,6 +42,12 @@ import QtQuick 2.0 import QtDesktop 1.0 import "Styles/Settings.js" as Settings +/*! + \qmltype Frame + \inqmlmodule QtDesktop 1.0 + \brief Frame is doing bla...bla... +*/ + Item { id: frame default property alias data: content.data diff --git a/src/qtdesktop/GroupBox.qml b/src/qtdesktop/GroupBox.qml index dc2e8ccf..f5f89f23 100644 --- a/src/qtdesktop/GroupBox.qml +++ b/src/qtdesktop/GroupBox.qml @@ -42,6 +42,12 @@ import QtQuick 2.0 import QtDesktop 1.0 import "Styles/Settings.js" as Settings +/*! + \qmltype GroupBox + \inqmlmodule QtDesktop 1.0 + \brief GroupBox is doing bla...bla... +*/ + Item { id: groupbox implicitWidth: Math.max(200, contentWidth + (loader.item ? loader.item.implicitWidth: 0) ) diff --git a/src/qtdesktop/Label.qml b/src/qtdesktop/Label.qml index 99d3ac71..6f2076ea 100644 --- a/src/qtdesktop/Label.qml +++ b/src/qtdesktop/Label.qml @@ -40,6 +40,12 @@ import QtQuick 2.0 +/*! + \qmltype Label + \inqmlmodule QtDesktop 1.0 + \brief Label is doing bla...bla... +*/ + Text { id: label font.pixelSize: 11 diff --git a/src/qtdesktop/ProgressBar.qml b/src/qtdesktop/ProgressBar.qml index b9b7fafb..190a6bc3 100644 --- a/src/qtdesktop/ProgressBar.qml +++ b/src/qtdesktop/ProgressBar.qml @@ -42,6 +42,12 @@ import QtQuick 2.0 import QtDesktop 1.0 import "Styles/Settings.js" as Settings +/*! + \qmltype ProgressBar + \inqmlmodule QtDesktop 1.0 + \brief ProgressBar is doing bla...bla... +*/ + Item { id: progressbar diff --git a/src/qtdesktop/RadioButton.qml b/src/qtdesktop/RadioButton.qml index f5945535..aa5774dc 100644 --- a/src/qtdesktop/RadioButton.qml +++ b/src/qtdesktop/RadioButton.qml @@ -44,6 +44,12 @@ import "Styles/Settings.js" as Settings // jb : Size should not depend on background, we should make it consistent +/*! + \qmltype RadioButton + \inqmlmodule QtDesktop 1.0 + \brief RadioButton is doing bla...bla... +*/ + CheckBox { id: radiobutton diff --git a/src/qtdesktop/ScrollArea.qml b/src/qtdesktop/ScrollArea.qml index 9415797a..67571518 100644 --- a/src/qtdesktop/ScrollArea.qml +++ b/src/qtdesktop/ScrollArea.qml @@ -42,6 +42,12 @@ import QtQuick 2.0 import QtDesktop 1.0 import "private" as Private +/*! + \qmltype ScrollArea + \inqmlmodule QtDesktop 1.0 + \brief ScrollArea is doing bla...bla... +*/ + FocusScope { id: root width: 100 diff --git a/src/qtdesktop/ScrollBar.qml b/src/qtdesktop/ScrollBar.qml index 5e20190c..1201a646 100644 --- a/src/qtdesktop/ScrollBar.qml +++ b/src/qtdesktop/ScrollBar.qml @@ -42,6 +42,12 @@ import QtQuick 2.0 import QtDesktop 1.0 import "Styles/Settings.js" as Settings +/*! + \qmltype ScrollBar + \inqmlmodule QtDesktop 1.0 + \brief ScrollBar is doing bla...bla... +*/ + Item { id: scrollbar diff --git a/src/qtdesktop/Slider.qml b/src/qtdesktop/Slider.qml index 4e00c156..fb53b7bb 100644 --- a/src/qtdesktop/Slider.qml +++ b/src/qtdesktop/Slider.qml @@ -44,6 +44,12 @@ import "Styles/Settings.js" as Settings // jens: ContainsMouse breaks drag functionality +/*! + \qmltype Slider + \inqmlmodule QtDesktop 1.0 + \brief Slider is doing bla...bla... +*/ + Item { id: slider diff --git a/src/qtdesktop/SpinBox.qml b/src/qtdesktop/SpinBox.qml index 1ddbc9f6..1c52c926 100644 --- a/src/qtdesktop/SpinBox.qml +++ b/src/qtdesktop/SpinBox.qml @@ -42,6 +42,12 @@ import QtQuick 2.0 import QtDesktop 1.0 import "Styles/Settings.js" as Settings +/*! + \qmltype SpinBox + \inqmlmodule QtDesktop 1.0 + \brief SpinBox is doing bla...bla... +*/ + FocusScope { id: spinbox diff --git a/src/qtdesktop/SplitterColumn.qml b/src/qtdesktop/SplitterColumn.qml index 1ff35afe..3de5f9c4 100644 --- a/src/qtdesktop/SplitterColumn.qml +++ b/src/qtdesktop/SplitterColumn.qml @@ -42,6 +42,12 @@ import QtQuick 2.0 import "private" as Private import QtDesktop 1.0 +/*! + \qmltype SplitterColumn + \inqmlmodule QtDesktop 1.0 + \brief SplitterColumn is doing bla...bla... +*/ + /* * * SplitterColumn diff --git a/src/qtdesktop/SplitterRow.qml b/src/qtdesktop/SplitterRow.qml index 14c2ea56..6f970723 100644 --- a/src/qtdesktop/SplitterRow.qml +++ b/src/qtdesktop/SplitterRow.qml @@ -42,6 +42,12 @@ import QtQuick 2.0 import "private" as Private import QtDesktop 1.0 +/*! + \qmltype SplitterRow + \inqmlmodule QtDesktop 1.0 + \brief SplitterRow is doing bla...bla... +*/ + /* * * SplitterRow diff --git a/src/qtdesktop/StatusBar.qml b/src/qtdesktop/StatusBar.qml index 46641411..f668150a 100644 --- a/src/qtdesktop/StatusBar.qml +++ b/src/qtdesktop/StatusBar.qml @@ -41,6 +41,12 @@ import QtQuick 2.0 import QtDesktop 1.0 +/*! + \qmltype StatusBar + \inqmlmodule QtDesktop 1.0 + \brief StatusBar is doing bla...bla... +*/ + Item { width: parent ? parent.width : 200 height: 24 diff --git a/src/qtdesktop/Tab.qml b/src/qtdesktop/Tab.qml index 133c3715..b27a29f5 100644 --- a/src/qtdesktop/Tab.qml +++ b/src/qtdesktop/Tab.qml @@ -40,6 +40,12 @@ import QtQuick 2.0 +/*! + \qmltype Tab + \inqmlmodule QtDesktop 1.0 + \brief Tab is doing bla...bla... +*/ + Item { id:tab anchors.fill: parent diff --git a/src/qtdesktop/TabBar.qml b/src/qtdesktop/TabBar.qml index 0ad47520..e4bf77f5 100644 --- a/src/qtdesktop/TabBar.qml +++ b/src/qtdesktop/TabBar.qml @@ -42,6 +42,12 @@ import QtQuick 2.0 import QtDesktop 1.0 import "Styles/Settings.js" as Settings +/*! + \qmltype TabBar + \inqmlmodule QtDesktop 1.0 + \brief TabBar is doing bla...bla... +*/ + Item { id: tabbar property int tabHeight: tabrow.height diff --git a/src/qtdesktop/TabFrame.qml b/src/qtdesktop/TabFrame.qml index 533bdb19..8792ba64 100644 --- a/src/qtdesktop/TabFrame.qml +++ b/src/qtdesktop/TabFrame.qml @@ -42,6 +42,12 @@ import QtQuick 2.0 import QtDesktop 1.0 import "Styles/Settings.js" as Settings +/*! + \qmltype TabFrame + \inqmlmodule QtDesktop 1.0 + \brief TabFrame is doing bla...bla... +*/ + Item { id: tabWidget width: 100 diff --git a/src/qtdesktop/TableColumn.qml b/src/qtdesktop/TableColumn.qml index 53207070..9bf95bf2 100644 --- a/src/qtdesktop/TableColumn.qml +++ b/src/qtdesktop/TableColumn.qml @@ -40,6 +40,12 @@ import QtQuick 2.0 +/*! + \qmltype TableColumn + \inqmlmodule QtDesktop 1.0 + \brief TableColumn is doing bla...bla... +*/ + QtObject { property string title property string role diff --git a/src/qtdesktop/TableView.qml b/src/qtdesktop/TableView.qml index 5c093502..90dbee3b 100644 --- a/src/qtdesktop/TableView.qml +++ b/src/qtdesktop/TableView.qml @@ -42,6 +42,12 @@ import QtQuick 2.0 import QtDesktop 1.0 import "private" as Private +/*! + \qmltype TableView + \inqmlmodule QtDesktop 1.0 + \brief TableView is doing bla...bla... +*/ + /* * * TableView diff --git a/src/qtdesktop/TextArea.qml b/src/qtdesktop/TextArea.qml index c7f9f81a..254aae4a 100644 --- a/src/qtdesktop/TextArea.qml +++ b/src/qtdesktop/TextArea.qml @@ -40,6 +40,13 @@ import QtQuick 2.0 import QtDesktop 1.0 + +/*! + \qmltype TextArea + \inqmlmodule QtDesktop 1.0 + \brief TextArea is doing bla...bla... +*/ + ScrollArea { id: area color: "white" diff --git a/src/qtdesktop/TextField.qml b/src/qtdesktop/TextField.qml index 7005c7b9..05a39494 100644 --- a/src/qtdesktop/TextField.qml +++ b/src/qtdesktop/TextField.qml @@ -43,6 +43,12 @@ import QtDesktop 1.0 import "Styles" import "Styles/Settings.js" as Settings +/*! + \qmltype TextField + \inqmlmodule QtDesktop 1.0 + \brief TextField is doing bla...bla... +*/ + FocusScope { id: textfield property alias text: textInput.text diff --git a/src/qtdesktop/ToolBar.qml b/src/qtdesktop/ToolBar.qml index d1aeffab..d27a20f2 100644 --- a/src/qtdesktop/ToolBar.qml +++ b/src/qtdesktop/ToolBar.qml @@ -41,6 +41,12 @@ import QtQuick 2.0 import QtDesktop 1.0 +/*! + \qmltype ToolBar + \inqmlmodule QtDesktop 1.0 + \brief ToolBar is doing bla...bla... +*/ + StyleItem { id: toolbar width: parent ? parent.width : 200 diff --git a/src/qtdesktop/ToolButton.qml b/src/qtdesktop/ToolButton.qml index 1cfe087b..ece223b1 100644 --- a/src/qtdesktop/ToolButton.qml +++ b/src/qtdesktop/ToolButton.qml @@ -43,6 +43,12 @@ import QtDesktop 1.0 import "private" as Private import "Styles/Settings.js" as Settings +/*! + \qmltype ToolButton + \inqmlmodule QtDesktop 1.0 + \brief ToolButton is doing bla...bla... +*/ + Private.BasicButton { id: button diff --git a/src/qtdesktop/qfiledialogitem.cpp b/src/qtdesktop/qfiledialogitem.cpp index f32c77f5..91f83c93 100644 --- a/src/qtdesktop/qfiledialogitem.cpp +++ b/src/qtdesktop/qfiledialogitem.cpp @@ -39,8 +39,9 @@ ****************************************************************************/ /*! - \qmlclass FileDialog QFileDialogItem - \ingroup qt-components + \qmltype FileDialog + \instantiates QFileDialogItem + \inqmlmodule QtDesktop 1.0 \brief Dialog component for choosing files from a local filesystem. FileDialog implements a basic file chooser: it allows the user to select diff --git a/src/qtdesktop/qquicklayout.cpp b/src/qtdesktop/qquicklayout.cpp index 36619359..3c081446 100644 --- a/src/qtdesktop/qquicklayout.cpp +++ b/src/qtdesktop/qquicklayout.cpp @@ -43,7 +43,6 @@ #include #include - static const qreal q_declarativeLayoutMaxSize = 10e8; diff --git a/src/qtdesktop/qquicklinearlayout.cpp b/src/qtdesktop/qquicklinearlayout.cpp index 995551d1..82b70b6c 100644 --- a/src/qtdesktop/qquicklinearlayout.cpp +++ b/src/qtdesktop/qquicklinearlayout.cpp @@ -42,6 +42,20 @@ #include "qquicklayoutengine_p.h" #include +/*! + \qmltype RowLayout + \instantiates QQuickComponentsRowLayout + \inqmlmodule QtDesktop 1.0 + \brief RowLayout is doing bla...bla... +*/ + +/*! + \qmltype ColumnLayout + \instantiates QQuickComponentsColumnLayout + \inqmlmodule QtDesktop 1.0 + \brief ColumnLayout is doing bla...bla... +*/ + static const qreal q_declarativeLayoutDefaultSpacing = 4.0; diff --git a/src/qtdesktop/qrangemodel.cpp b/src/qtdesktop/qrangemodel.cpp index ac876824..d4c2d2e8 100644 --- a/src/qtdesktop/qrangemodel.cpp +++ b/src/qtdesktop/qrangemodel.cpp @@ -39,8 +39,10 @@ ****************************************************************************/ /*! - \class QRangeModel - \brief The QRangeModel class, helps users to build components that depend + \qmltype RangeModel + \instantiates QRangeModel + \inqmlmodule QtDesktop 1.0 + \brief RangeModel helps users to build components that depend on some value and/or position to be in a certain range previously defined With this class, the user sets a value range and a position range, which @@ -51,8 +53,6 @@ to 80, the equivalent position would be 90. After that, if the user decides to resize the slider, the value would be the same, but the knob position would be updated due to the new position range. - - \ingroup qt-components */ #include diff --git a/src/qtdesktop/qtmenu.cpp b/src/qtdesktop/qtmenu.cpp index 34710293..f897e446 100644 --- a/src/qtdesktop/qtmenu.cpp +++ b/src/qtdesktop/qtmenu.cpp @@ -44,6 +44,13 @@ #include #include +/*! + \qmltype Menu + \instantiates QtMenu + \inqmlmodule QtDesktop 1.0 + \brief Menu is doing bla...bla... +*/ + QtMenu::QtMenu(QQuickItem *parent) : QtMenuBase(parent), dummy(0), diff --git a/src/qtdesktop/qtmenubar.cpp b/src/qtdesktop/qtmenubar.cpp index f63f5562..76f31bc1 100644 --- a/src/qtdesktop/qtmenubar.cpp +++ b/src/qtdesktop/qtmenubar.cpp @@ -43,6 +43,13 @@ #include #include +/*! + \qmltype MenuBar + \instantiates QtMenuBar + \inqmlmodule QtDesktop 1.0 + \brief MenuBar is doing bla...bla... +*/ + QtMenuBar::QtMenuBar(QQuickItem *parent) : QQuickItem(parent) { diff --git a/src/qtdesktop/qtmenuitem.cpp b/src/qtdesktop/qtmenuitem.cpp index 9dc58af7..d814157e 100644 --- a/src/qtdesktop/qtmenuitem.cpp +++ b/src/qtdesktop/qtmenuitem.cpp @@ -69,6 +69,13 @@ QString QtMenuBase::iconName() const return _iconName; } +/*! + \qmltype MenuItem + \instantiates QtMenuSeparator + \inqmlmodule QtDesktop 1.0 + \brief MenuItem is doing bla...bla... +*/ + QtMenuSeparator::QtMenuSeparator(QQuickItem *parent) : QtMenuBase(parent), _action(new QAction(this)) { @@ -84,6 +91,13 @@ QAction * QtMenuSeparator::action() return _action; } +/*! + \qmltype MenuItem + \instantiates QtMenuItem + \inqmlmodule QtDesktop 1.0 + \brief MenuItem is doing bla...bla... +*/ + QtMenuItem::QtMenuItem(QQuickItem *parent) : QtMenuBase(parent), _action(new QAction(this)) { diff --git a/src/qtdesktop/qtsplitterbase.cpp b/src/qtdesktop/qtsplitterbase.cpp index c2a26fbf..2b3a7b26 100644 --- a/src/qtdesktop/qtsplitterbase.cpp +++ b/src/qtdesktop/qtsplitterbase.cpp @@ -40,6 +40,13 @@ #include "qtsplitterbase.h" +/*! + \qmltype Splitter + \instantiates QtSplitterBase + \inqmlmodule QtDesktop 1.0 + \brief Splitter is doing bla...bla... +*/ + QtSplitterBase::QtSplitterBase(QQuickItem *parent) : QQuickItem(parent) { diff --git a/src/qtdesktop/qwheelarea.cpp b/src/qtdesktop/qwheelarea.cpp index 97aac522..c5180d2a 100644 --- a/src/qtdesktop/qwheelarea.cpp +++ b/src/qtdesktop/qwheelarea.cpp @@ -40,6 +40,12 @@ #include "qwheelarea.h" +/*! + \qmltype WheelArea + \instantiates QWheelArea + \inqmlmodule QtDesktop 1.0 + \brief WheelArea is doing bla...bla... +*/ QWheelArea::QWheelArea(QQuickItem *parent) : QQuickItem(parent), diff --git a/src/styles/ButtonStyle.qml b/src/styles/ButtonStyle.qml index b37fbba8..07a3c56c 100644 --- a/src/styles/ButtonStyle.qml +++ b/src/styles/ButtonStyle.qml @@ -40,6 +40,12 @@ import QtQuick 2.0 import QtDesktop 1.0 +/*! + \qmltype ButtonStyle + \inqmlmodule QtDesktop.Styles 1.0 + \brief ButtonStyle is doing bla...bla... +*/ + Item { implicitWidth: backgroundLoader.implicitWidth implicitHeight: backgroundLoader.implicitHeight diff --git a/src/styles/CheckBoxStyle.qml b/src/styles/CheckBoxStyle.qml index efb3a4ef..03833a2a 100644 --- a/src/styles/CheckBoxStyle.qml +++ b/src/styles/CheckBoxStyle.qml @@ -40,6 +40,12 @@ import QtQuick 2.0 import QtDesktop 1.0 +/*! + \qmltype CheckBoxStyle + \inqmlmodule QtDesktop.Styles 1.0 + \brief CheckBoxStyle is doing bla...bla... +*/ + Item { implicitWidth: 100 implicitHeight: 20 diff --git a/src/styles/ComboBoxStyle.qml b/src/styles/ComboBoxStyle.qml index 2333dcc0..2c4239a6 100644 --- a/src/styles/ComboBoxStyle.qml +++ b/src/styles/ComboBoxStyle.qml @@ -40,6 +40,12 @@ import QtQuick 2.0 import QtDesktop 1.0 +/*! + \qmltype ComboBoxStyle + \inqmlmodule QtDesktop.Styles 1.0 + \brief ComboBoxStyle is doing bla...bla... +*/ + Rectangle { id: styleitem implicitWidth: 200 diff --git a/src/styles/FrameStyle.qml b/src/styles/FrameStyle.qml index 88cb80b2..740ddbb2 100644 --- a/src/styles/FrameStyle.qml +++ b/src/styles/FrameStyle.qml @@ -40,6 +40,12 @@ import QtQuick 2.0 import QtDesktop 1.0 +/*! + \qmltype FrameStyle + \inqmlmodule QtDesktop.Styles 1.0 + \brief FrameStyle is doing bla...bla... +*/ + Rectangle { height:20 width: 20 diff --git a/src/styles/GroupBoxStyle.qml b/src/styles/GroupBoxStyle.qml index a37782bf..7be74b61 100644 --- a/src/styles/GroupBoxStyle.qml +++ b/src/styles/GroupBoxStyle.qml @@ -40,6 +40,12 @@ import QtQuick 2.0 import QtDesktop 1.0 +/*! + \qmltype GroupBoxStyle + \inqmlmodule QtDesktop.Styles 1.0 + \brief GroupBoxStyle is doing bla...bla... +*/ + Item { implicitWidth: Math.max(200, contentWidth + 30) implicitHeight: contentHeight diff --git a/src/styles/ProgressBarStyle.qml b/src/styles/ProgressBarStyle.qml index d379347e..ecd70f54 100644 --- a/src/styles/ProgressBarStyle.qml +++ b/src/styles/ProgressBarStyle.qml @@ -40,6 +40,13 @@ import QtQuick 2.0 import QtDesktop 1.0 + +/*! + \qmltype ProgressBarStyle + \inqmlmodule QtDesktop.Styles 1.0 + \brief ProgressBarStyle is doing bla...bla... +*/ + Item { anchors.fill: parent implicitWidth: 200 diff --git a/src/styles/RadioButtonStyle.qml b/src/styles/RadioButtonStyle.qml index 4c1f4c43..bdad3d1b 100644 --- a/src/styles/RadioButtonStyle.qml +++ b/src/styles/RadioButtonStyle.qml @@ -40,6 +40,12 @@ import QtQuick 2.0 import QtDesktop 1.0 +/*! + \qmltype RadioButtonStyle + \inqmlmodule QtDesktop.Styles 1.0 + \brief RadioButtonStyle is doing bla...bla... +*/ + Item { implicitWidth: 100 implicitHeight: 20 diff --git a/src/styles/ScrollAreaStyle.qml b/src/styles/ScrollAreaStyle.qml index 0fff6a41..81da80a7 100644 --- a/src/styles/ScrollAreaStyle.qml +++ b/src/styles/ScrollAreaStyle.qml @@ -40,6 +40,12 @@ import QtQuick 2.0 import QtDesktop 1.0 +/*! + \qmltype ScrollAreaStyle + \inqmlmodule QtDesktop.Styles 1.0 + \brief ScrollAreaStyle is doing bla...bla... +*/ + Rectangle { height:20 width: 20 diff --git a/src/styles/ScrollBarStyle.qml b/src/styles/ScrollBarStyle.qml index b60c2fa5..0e8f23f6 100644 --- a/src/styles/ScrollBarStyle.qml +++ b/src/styles/ScrollBarStyle.qml @@ -41,6 +41,12 @@ import QtQuick 2.0 import QtDesktop 1.0 +/*! + \qmltype ScrollBarStyle + \inqmlmodule QtDesktop.Styles 1.0 + \brief ScrollBarStyle is doing bla...bla... +*/ + Rectangle { id: styleitem diff --git a/src/styles/SliderStyle.qml b/src/styles/SliderStyle.qml index 7066f44b..e82b307e 100644 --- a/src/styles/SliderStyle.qml +++ b/src/styles/SliderStyle.qml @@ -40,6 +40,12 @@ import QtQuick 2.0 import QtDesktop 1.0 +/*! + \qmltype SliderStyle + \inqmlmodule QtDesktop.Styles 1.0 + \brief SliderStyle is doing bla...bla... +*/ + Item { id: styleitem diff --git a/src/styles/SpinBoxStyle.qml b/src/styles/SpinBoxStyle.qml index 6c8af767..03f5d48b 100644 --- a/src/styles/SpinBoxStyle.qml +++ b/src/styles/SpinBoxStyle.qml @@ -40,6 +40,12 @@ import QtQuick 2.0 import QtDesktop 1.0 +/*! + \qmltype SpinBoxStyle + \inqmlmodule QtDesktop.Styles 1.0 + \brief SpinBoxStyle is doing bla...bla... +*/ + Item { id: styleitem implicitWidth: 100 diff --git a/src/styles/TabBarStyle.qml b/src/styles/TabBarStyle.qml index a05345f8..644a2730 100644 --- a/src/styles/TabBarStyle.qml +++ b/src/styles/TabBarStyle.qml @@ -40,6 +40,12 @@ import QtQuick 2.0 import QtDesktop 1.0 +/*! + \qmltype TabBarStyle + \inqmlmodule QtDesktop.Styles 1.0 + \brief TabBarStyle is doing bla...bla... +*/ + Item { width: textitem.implicitWidth + 20 height: textitem.implicitHeight + 4 diff --git a/src/styles/TabFrameStyle.qml b/src/styles/TabFrameStyle.qml index 0b329502..84d55f1a 100644 --- a/src/styles/TabFrameStyle.qml +++ b/src/styles/TabFrameStyle.qml @@ -39,6 +39,12 @@ ****************************************************************************/ import QtQuick 2.0 +/*! + \qmltype TabFrameStyle + \inqmlmodule QtDesktop.Styles 1.0 + \brief TabFrameStyle is doing bla...bla... +*/ + Item { property rect contentRect diff --git a/src/styles/TextFieldStyle.qml b/src/styles/TextFieldStyle.qml index da4bb454..4cdeef5f 100644 --- a/src/styles/TextFieldStyle.qml +++ b/src/styles/TextFieldStyle.qml @@ -40,6 +40,12 @@ import QtQuick 2.0 import QtDesktop 1.0 +/*! + \qmltype TextFieldStyle + \inqmlmodule QtDesktop.Styles 1.0 + \brief TextFieldStyle is doing bla...bla... +*/ + Item { id: style anchors.fill: parent diff --git a/src/styles/ToolBarStyle.qml b/src/styles/ToolBarStyle.qml index 504d68ee..b4928186 100644 --- a/src/styles/ToolBarStyle.qml +++ b/src/styles/ToolBarStyle.qml @@ -40,6 +40,12 @@ import QtQuick 2.0 import QtDesktop 1.0 +/*! + \qmltype ToolBarStyle + \inqmlmodule QtDesktop.Styles 1.0 + \brief ToolBarStyle is doing bla...bla... +*/ + Item { property int __overlap : 1 diff --git a/src/styles/ToolButtonStyle.qml b/src/styles/ToolButtonStyle.qml index 1c2a6894..3e7dd589 100644 --- a/src/styles/ToolButtonStyle.qml +++ b/src/styles/ToolButtonStyle.qml @@ -40,6 +40,12 @@ import QtQuick 2.0 import QtDesktop 1.0 +/*! + \qmltype ToolButtonStyle + \inqmlmodule QtDesktop.Styles 1.0 + \brief ToolButtonStyle is doing bla...bla... +*/ + Rectangle { id: styleitem implicitWidth: 32 -- cgit v1.2.1