complete qml doc

Author: Skycoder42

doc/Doxyfile

@@ -900,13 +900,14 @@ RECURSIVE              = YES
 EXCLUDE                = ../src/3rdparty \
 						 ../src/plugins \
 						 ../src/imports/mvvmquick/settingsuibuilder.h \
-						 ../src/imports/mvvmquick/TintIcon.qml \
 						 ../src/imports/mvvmquick/MsgBoxBase.qml \
 						 ../src/imports/mvvmquick/MsgBox.qml \
+						 ../src/imports/mvvmquick/ProgressDialog.qml \
 						 ../src/imports/mvvmquick/InputDialog.qml \
 						 ../src/imports/mvvmquick/ListSection.qml \
 						 ../src/imports/mvvmquick/OverviewListView.qml \
 						 ../src/imports/mvvmquick/SectionListView.qml \
+						 ../src/imports/mvvmquick/TimeTumbler.qml \
 						 ../src/imports/mvvmquick/AndroidFileDialog.qml \
 						 ../src/imports/mvvmquick/AndroidFolderDialog.qml \
 						 ../src/imports/mvvmdatasyncquick/SubButton.qml \
@@ -936,7 +937,8 @@ EXCLUDE_PATTERNS       = moc_* \
 						 *.cpp \
 						 */src/mvvmquick/*.qml \
 						 */src/mvvmdatasyncquick/*.qml \
-						 */imports/mvvmquick/*model.h
+						 */imports/mvvmquick/*model.h \
+						 */imports/mvvmquick/*10.qml
 
 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
 # (namespaces, classes, functions, etc.) that should be excluded from the
@@ -972,20 +974,25 @@ EXCLUDE_SYMBOLS        = QtMvvm::__helpertypes \
 						 QPaintEngineEx \
 						 QQmlExtensionInterface \
 						 QTechniqueFilter \
+						 QAbstractXmlReceiver \
 						 \
 						 ApplicationWindow \
+						 Control \
 						 Dialog \
 						 Drawer \
+						 GridLayout \
 						 Item \
+						 ItemDelegate \
 						 Label \
 						 ListView \
 						 Page \
 						 ProgressBar \
 						 QtObject \
 						 RoundButton \
+						 RowLayout \
 						 StackView \
 						 ToolBar \
-						 ToolButton
+						 ToolButton \
 
 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
 # that contain example code fragments that are included (see the \include

doc/qtmvvm.dox

@@ -49,7 +49,7 @@ The following list shows which classes belong to which Qt module, in alphabetica
 @brief The QML import for the QtMvvmCore QML module
 
 <b>Current Version</b><br/>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;1.0
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;1.1
 
 <b>Available Types</b>
 - @ref QtMvvm::MessageConfig "MessageConfig" (uncreatable)
@@ -68,12 +68,14 @@ The following list shows which classes belong to which Qt module, in alphabetica
 @brief The QML import for the QtMvvmQuick QML module
 
 <b>Current Version</b><br/>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;1.0
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;1.1
 
 <b>Available Types</b>
 - @ref QtMvvm::InputViewFactory "InputViewFactory" (uncreatable)
 - QuickPresenter (singleton)
 - FileChooser
+- ViewPlaceholder
+- ColorHelper
 - AlertDialog
 - ContrastToolBar
 - ToolBarLabel
@@ -82,6 +84,14 @@ The following list shows which classes belong to which Qt module, in alphabetica
 - MenuButton
 - FileDialog
 - FolderDialog
+- TintIcon
+- SearchBar
+- RoundMenuButton
+- DecorLabel
+- MsgDelegate
+- TimeEdit
+- DateEdit
+- ColorEdit
 - PresenterProgress
 - PresentingStackView
 - PopupPresenter
@@ -96,7 +106,7 @@ The following list shows which classes belong to which Qt module, in alphabetica
 @brief The QML import for the QtMvvmDataSyncCore QML module
 
 <b>Current Version</b><br/>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;1.0
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;1.1
 
 <b>Available Types</b>
 - @ref QtMvvm::AccountModel "AccountModel"
@@ -115,7 +125,7 @@ The following list shows which classes belong to which Qt module, in alphabetica
 @brief The QML import for the QtMvvmDataSyncQuick QML module
 
 <b>Current Version</b><br/>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;1.0
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;1.1
 
 <b>Available Types</b>
 - DataSyncView

src/imports/mvvmdatasyncquick/plugins.qmltypes

@@ -8,6 +8,7 @@ import QtQuick.tooling 1.2
 
 Module {
     dependencies: [
+        "Qt.labs.calendar 1.0",
         "Qt.labs.platform 1.0",
         "QtGraphicalEffects 1.0",
         "QtQml 2.2",

src/imports/mvvmquick/ColorEdit.qml

@@ -5,6 +5,14 @@ import QtQuick.Layouts 1.3
 import QtGraphicalEffects 1.0
 import de.skycoder42.QtMvvm.Quick 1.1
 
+/*! @brief A edit view to edit colors by using a color picker
+ *
+ * @extends QtQuick.Layouts.GridLayout
+ *
+ * You can use this edit if you want to let the user select a color. It is made out of three
+ * sliders to control hue, saturation and value and a TextField to enter a hex color code,
+ * next to a small box that previews the color
+ */
 GridLayout {
 	id: _colorPicker
 	columns: 2
@@ -14,7 +22,28 @@ GridLayout {
 		id: helper
 	}
 
+	/*! @brief Specifies whether the alpha channel can be edited
+	 *
+	 * @default{`false`}
+	 *
+	 * If set to true, the user can enter a hex color string with an additional alpha value.
+	 * The sliders are uneffected from this property
+	 *
+	 * @accessors{
+	 *	@memberAc{alpha}
+	 *  @notifyAc{alphaChanged()}
+	 * }
+	 */
 	property bool alpha: false
+	/*! @brief The color currently displayed and edited
+	 *
+	 * @default{`undefined`}
+	 *
+	 * @accessors{
+	 *	@memberAc{color}
+	 *  @notifyAc{colorChanged()}
+	 * }
+	 */
 	property color color
 	onColorChanged: {
 		if(!_p.changing){

src/imports/mvvmquick/ColorHelper.qml

@@ -4,10 +4,34 @@ import QtQuick.Controls.Material 2.3
 import QtQuick.Controls.Universal 2.3
 import de.skycoder42.QtMvvm.Quick 1.1
 
+/*! @brief A helper class to get style-dependant colors
+ *
+ * @extends QtQuick.Controls.Control
+ *
+ * Simply instanciate a helper within some control. It will pick up the style settings from
+ * what it is in and provide them via the properties
+ *
+ * @sa ContrastToolBar
+ */
 Control {
 	id: _colorHelper
 	visible: false
 
+	/*! @brief The color to use to highlight stuff
+	 *
+	 * @default{<i>style dependant</i>}
+	 *
+	 *  Style		| Value
+	 * -------------|-------
+	 *  Material	| Material.accent
+	 *  Universal	| Universal.accent
+	 *	Others		| palette.highlight
+	 *
+	 * @accessors{
+	 *	@memberAc{highlight}
+	 *  @notifyAc{highlightChanged()}
+	 * }
+	 */
 	readonly property color highlight: {
 		if(QuickPresenter.currentStyle === "Material")
 			return Material.accent;
@@ -17,6 +41,21 @@ Control {
 			return palette.highlight;
 	}
 
+	/*! @brief The color to use for text
+	 *
+	 * @default{<i>style dependant</i>}
+	 *
+	 *  Style		| Value
+	 * -------------|-------
+	 *  Material	| Material.foreground
+	 *  Universal	| Universal.foreground
+	 *	Others		| palette.windowText
+	 *
+	 * @accessors{
+	 *	@memberAc{text}
+	 *  @notifyAc{textChanged()}
+	 * }
+	 */
 	readonly property color text: {
 		if(QuickPresenter.currentStyle === "Material")
 			return Material.foreground;

src/imports/mvvmquick/ContrastToolBar.qml

@@ -17,7 +17,7 @@ ToolBar {
 
 	height: 56
 
-	// @copydoc QuickPresenter::accentTextColor
+	//! @copydoc QuickPresenter::accentTextColor
 	function accentTextColor(accentColor, baseColor) {
 		return QuickPresenter.accentTextColor(accentColor, baseColor);
 	}

src/imports/mvvmquick/DateEdit.qml

@@ -4,24 +4,67 @@ import QtQuick.Layouts 1.3
 import Qt.labs.calendar 1.0
 import de.skycoder42.QtMvvm.Quick 1.1
 
+/*! @brief A edit view to edit dates by using a calendar
+ *
+ * @extends QtQuick.ListView
+ *
+ * You can use this edit if you want to let the user select a date. You can use the properties
+ * to control wich tumblers are shown and which format they use.
+ *
+ * @note This edit currently uses Qt.labs.calendar - an experimental module, and thus might
+ * not always function perfectly or break after Qt updates
+ */
 ListView {
 	id: _calenderList
 
+	/*! @brief The smallest possible date the user can select
+	 *
+	 * @default{`new Date(1970, 0, 1)`}
+	 *
+	 * @note Only the date-componente of the date object is used.
+	 *
+	 * @accessors{
+	 *	@memberAc{firstDate}
+	 *  @notifyAc{firstDateChanged()}
+	 * }
+	 */
 	property date firstDate: new Date(1970, 0, 1)
+	/*! @brief The highest possible date the user can select
+	 *
+	 * @default{`new Date(9999, 11, 31)`}
+	 *
+	 * @note Only the date-componente of the date object is used.
+	 *
+	 * @accessors{
+	 *	@memberAc{lastDate}
+	 *  @notifyAc{lastDateChanged()}
+	 * }
+	 */
 	property date lastDate: new Date(9999, 11, 31)
-	property date date: today();
-
-	function today() {
-		var cDate = new Date();
-		cDate.setHours(0, 0, 0, 0, 0);
-		return cDate;
-	}
+	/*! @brief The date currently displayed and edited
+	 *
+	 * @default{`new Date()`}
+	 *
+	 * @note Only the date-componente of the date object is used.
+	 *
+	 * @accessors{
+	 *	@memberAc{date}
+	 *  @notifyAc{dateChanged()}
+	 * }
+	 */
+	property date date: _p.today();
 
 	QtObject {
 		id: _p
 
 		property bool _skipNextFocus: false
 
+		function today() {
+			var cDate = new Date();
+			cDate.setHours(0, 0, 0, 0, 0);
+			return cDate;
+		}
+
 		function focusDate() {
 			if(_skipNextFocus)
 				_skipNextFocus = false;

src/imports/mvvmquick/DecorLabel.qml

@@ -2,15 +2,46 @@ import QtQuick 2.10
 import QtQuick.Controls 2.3
 import de.skycoder42.QtMvvm.Quick 1.1
 
+/*! @brief An extension of the @ref QtQuick.Controls.Label "Label" for better appearance when
+ * used in FormLayouts
+ *
+ * @extends QtQuick.Controls.Label
+ *
+ * This label will automatically change it's color to the highlight color if the the edit
+ * it is connected to has input focus. This serves as a visual cue to the selected input
+ *
+ * @sa DecorLabel::edit
+ */
 Label {
 	id: _decorLabel
 
 	ColorHelper {
 		id: helper
 	}
 
+	/*! @brief The edit this label is connected to
+	 *
+	 * @default{`nextItemInFocusChain()`}
+	 *
+	 * If the edit gets the input focus, this label gets highlighted
+	 *
+	 * @accessors{
+	 *	@memberAc{edit}
+	 *  @notifyAc{editChanged()}
+	 * }
+	 */
 	property Item edit: _decorLabel.nextItemInFocusChain()
 
+	/*! @brief Checks if the connected edit currently has input focus
+	 *
+	 * @default{`false`}
+	 *
+	 * @accessors{
+	 *	@memberAc{editHasFocus}
+	 *  @notifyAc{editHasFocusChanged()}
+	 *	@readonlyAc
+	 * }
+	 */
 	readonly property bool editHasFocus: edit && edit.focus
 
 	color: editHasFocus ? helper.highlight : helper.text

src/imports/mvvmquick/FileDialog.qml

@@ -13,7 +13,8 @@ import de.skycoder42.QtMvvm.Quick 1.1
  * dialog message type
  *
  * @note On Android, the dialog extends the FileChooser. For all other platforms, it extends
- * the @ref Qt.labs.platform.FileDialog "Qt labs FileDialog"
+ * the @ref Qt.labs.platform.FileDialog "Qt labs FileDialog" - an experimental module, and
+ * thus might not always function perfectly or break after Qt updates
  */
 Labs.FileDialog {
 	id: _fileDialog
@@ -68,11 +69,11 @@ Labs.FileDialog {
 	modality: Qt.WindowModal
 	folder: msgConfig.defaultValue
 	fileMode: {
-		if(msgConfig.subType == "open")
+		if(msgConfig.subType === "open")
 			return Labs.FileDialog.OpenFile;
-		else if(msgConfig.subType == "files")
+		else if(msgConfig.subType === "files")
 			return Labs.FileDialog.OpenFiles;
-		else if(msgConfig.subType == "save")
+		else if(msgConfig.subType === "save")
 			return Labs.FileDialog.SaveFile;
 		else {
 			return Labs.FileDialog.OpenFile; //fallback
@@ -87,7 +88,7 @@ Labs.FileDialog {
 
 	onAccepted: {
 		if(msgResult) {
-			if(msgConfig.subType == "files")
+			if(msgConfig.subType === "files")
 				msgResult.result = _fileDialog.files;
 			else
 				msgResult.result = _fileDialog.file;

src/imports/mvvmquick/FolderDialog.qml

@@ -13,7 +13,8 @@ import de.skycoder42.QtMvvm.Quick 1.1
  * dialog message type
  *
  * @note On Android, the dialog extends the FileChooser. For all other platforms, it extends
- * the @ref Qt.labs.platform.FolderDialog "Qt labs FolderDialog"
+ * the @ref Qt.labs.platform.FolderDialog "Qt labs FolderDialog" - an experimental module, and
+ * thus might not always function perfectly or break after Qt updates
  */
 Labs.FolderDialog {
 	id: _folderDialog