Merge pull request #78 from OpenVR-Advanced-Settings/refactor-common-components

Refactor My* QML components into folder, move images to .qrc file, add .gitattributes file

.gitattributes

@@ -0,0 +1,95 @@
+# Common settings that generally should always be used with your language specific settings
+
+# Auto detect text files and perform LF normalization
+# http://davidlaing.com/2012/09/19/customise-your-gitattributes-to-become-a-git-ninja/
+* text=auto
+
+#
+# The above will handle all files NOT found below
+#
+
+# Documents
+*.doc	 diff=astextplain
+*.DOC	 diff=astextplain
+*.docx diff=astextplain
+*.DOCX diff=astextplain
+*.dot  diff=astextplain
+*.DOT  diff=astextplain
+*.pdf  diff=astextplain
+*.PDF	 diff=astextplain
+*.rtf	 diff=astextplain
+*.RTF	 diff=astextplain
+*.md text
+*.tex text
+*.adoc text
+*.textile text
+*.mustache text
+*.csv text
+*.tab text
+*.tsv text
+*.sql text
+
+# Graphics
+*.png binary
+*.jpg binary
+*.jpeg binary
+*.gif binary
+*.tif binary
+*.tiff binary
+*.ico binary
+# SVG treated as an asset (binary) by default. If you want to treat it as text,
+# comment-out the following line and uncomment the line after.
+*.svg binary
+#*.svg text
+*.eps binary
+
+#
+# Exclude files from exporting
+#
+
+.gitattributes export-ignore
+.gitignore export-ignore
+
+#sources
+*.c text diff=cpp
+*.cc text diff=cpp
+*.cxx text diff=cpp
+*.cpp text diff=cpp
+*.c++ text diff=cpp
+*.hpp text diff=cpp
+*.h text diff=cpp
+*.h++ text diff=cpp
+*.hh text diff=cpp
+
+# Compiled Object files
+*.slo binary
+*.lo binary
+*.o binary
+*.obj binary
+
+# Precompiled Headers
+*.gch binary
+*.pch binary
+
+# Compiled Dynamic libraries
+*.so binary
+*.dylib binary
+*.dll binary
+
+# Compiled Static libraries
+*.lai binary
+*.la binary
+*.a binary
+*.lib binary
+
+# Executables
+*.exe binary
+*.out binary
+*.app binary
+
+#Qt Specific
+*.qml text
+
+#Linux Shell Scripts
+#Windows Subsystem for Linux will not run CLRF files.
+*.sh text eof=lf

advancedSettings.pro

@@ -118,39 +118,16 @@ unix:DESTDIR = bin/linux/AdvancedSettings
 
 DISTFILES += \
     src/res/sounds/alarm01.wav \
-    src/res/qml/ptt_notification.png \
-    src/res/battery_0.png \
-    src/res/battery_1.png \
-    src/res/battery_2.png \
-    src/res/battery_3.png \
-    src/res/battery_4.png \
-    src/res/battery_5.png \
-    src/res/thumbicon.png \
-    src/res/qml/backarrow.svg \
-    src/res/qml/check.svg \
-    src/res/qml/mic_off.svg \
-    src/res/qml/mic_on.svg \
-    src/res/qml/ptt_notification.svg \
-    src/res/qml/speaker_off.svg \
-    src/res/qml/speaker_on.svg \
+    src/res/img/audio/microphone/ptt_notification.png \
+    src/res/img/audio/microphone/ptt_notification.svg \
+    src/res/img/battery/* \
+    src/res/img/icons/* \
     src/res/qml/qmldir \
     src/res/qml/AccessibilityPage.qml \
     src/res/qml/audio_page/* \
     src/res/qml/ChaperonePage.qml \
     src/res/qml/ChaperoneWarningsPage.qml \
     src/res/qml/FixFloorPage.qml \
-    src/res/qml/mainwidget.qml \
-    src/res/qml/MyComboBox.qml \
-    src/res/qml/MyDialogOkCancelPopup.qml \
-    src/res/qml/MyDialogOkPopup.qml \
-    src/res/qml/MyPushButton.qml \
-    src/res/qml/MyPushButton2.qml \
-    src/res/qml/MyResources.qml \
-    src/res/qml/MySlider.qml \
-    src/res/qml/MyStackViewPage.qml \
-    src/res/qml/MyText.qml \
-    src/res/qml/MyTextField.qml \
-    src/res/qml/MyToggleButton.qml \
     src/res/qml/PlayspacePage.qml \
     src/res/qml/PttControllerConfigDialog.qml \
     src/res/qml/RevivePage.qml \
@@ -160,7 +137,6 @@ DISTFILES += \
     src/res/qml/SteamVRPage.qml \
     src/res/qml/utilities_page/* \
     src/res/qml/utilities_page/media_keys/* \
-    src/res/qml/LineSeparator.qml \
     src/res/qml/utilities_page/keyboard_utils/* \
     src/res/qml/utilities_page/desktop_size/* \
     src/res/qml/utilities_page/alarm_clock/* \
@@ -169,3 +145,6 @@ DISTFILES += \
     src/res/qml/audio_page/proximity/* \
     src/res/qml/audio_page/push_to_talk/* \
     src/res/qml/audio_page/profiles/* \
+    src/res/qml/common/* \
+
+RESOURCES += src/res/resources.qrc

src/main.cpp

@@ -425,7 +425,7 @@ int main( int argc, char* argv[] )
 
         QString path = QStandardPaths::locate(
             QStandardPaths::AppDataLocation,
-            QStringLiteral( "res/qml/mainwidget.qml" ) );
+            QStringLiteral( "res/qml/common/mainwidget.qml" ) );
 
         QQmlComponent component( &qmlEngine, QUrl::fromLocalFile( path ) );
         auto errors = component.errors();

src/overlaycontroller.cpp

@@ -332,9 +332,9 @@ void OverlayController::SetWidget( QQuickItem* quickItem,
             m_ulOverlayHandle,
             vr::VROverlayFlags_SendVRSmoothScrollEvents,
             true );
-        QString thumbIconPath
-            = QStandardPaths::locate( QStandardPaths::AppDataLocation,
-                                      QStringLiteral( "res/thumbicon.png" ) );
+        QString thumbIconPath = QStandardPaths::locate(
+            QStandardPaths::AppDataLocation,
+            QStringLiteral( "res/img/icons/thumbicon.png" ) );
         if ( QFile::exists( thumbIconPath ) )
         {
             vr::VROverlay()->SetOverlayFromFile(

src/res/qml/AccessibilityPage.qml

@@ -2,7 +2,7 @@ import QtQuick 2.7
 import QtQuick.Controls 2.0
 import QtQuick.Layouts 1.3
 import matzman666.advsettings 1.0
-
+import "common"
 
 
 MyStackViewPage {

src/res/qml/ChaperonePage.qml

@@ -4,6 +4,7 @@ import QtQuick.Layouts 1.3
 import QtQuick.Dialogs 1.2
 import matzman666.advsettings 1.0
 import "." // QTBUG-34418, singletons require explicit import to load qmldir file
+import "common"
 
 MyStackViewPage {
     headerText: "Chaperone Settings"

src/res/qml/ChaperoneWarningsPage.qml

@@ -4,6 +4,7 @@ import QtQuick.Layouts 1.3
 import QtQuick.Dialogs 1.2
 import matzman666.advsettings 1.0
 import "." // QTBUG-34418, singletons require explicit import to load qmldir file
+import "common"
 
 MyStackViewPage {
     headerText: "Chaperone Proximity Warning Settings"

src/res/qml/FixFloorPage.qml

@@ -2,7 +2,7 @@ import QtQuick 2.7
 import QtQuick.Controls 2.0
 import QtQuick.Layouts 1.3
 import matzman666.advsettings 1.0
-
+import "common"
 
 
 MyStackViewPage {

src/res/qml/PlayspacePage.qml

@@ -2,7 +2,7 @@ import QtQuick 2.7
 import QtQuick.Controls 2.0
 import QtQuick.Layouts 1.3
 import matzman666.advsettings 1.0
-
+import "common"
 
 
 MyStackViewPage {

src/res/qml/RevivePage.qml

@@ -2,7 +2,7 @@ import QtQuick 2.7
 import QtQuick.Controls 2.0
 import QtQuick.Layouts 1.3
 import matzman666.advsettings 1.0
-
+import "common"
 
 MyStackViewPage {
     headerText: "Revive Settings"

src/res/qml/RootPage.qml

@@ -3,6 +3,7 @@ import QtQuick.Controls 2.0
 import QtQuick.Layouts 1.3
 import matzman666.advsettings 1.0
 import "." // QTBUG-34418, singletons require explicit import to load qmldir file
+import "common"
 import "utilities_page"
 import "audio_page"
 
@@ -343,7 +344,7 @@ MyStackViewPage {
                            Layout.leftMargin: 12
                            checkable: true
                            contentItem: Image {
-                               source: parent.checked ? "audio_page/mic_off.svg" : "audio_page/mic_on.svg"
+                               source: parent.checked ? "qrc:/microphone/off" : "qrc:/microphone/on"
                                sourceSize.width: 32
                                sourceSize.height: 32
                                anchors.fill: parent

src/res/qml/SettingsPage.qml

@@ -2,7 +2,7 @@ import QtQuick 2.7
 import QtQuick.Controls 2.0
 import QtQuick.Layouts 1.3
 import matzman666.advsettings 1.0
-
+import "common"
 
 MyStackViewPage {
     headerText: "Application Settings"

src/res/qml/StatisticsPage.qml

@@ -2,7 +2,7 @@ import QtQuick 2.7
 import QtQuick.Controls 2.0
 import QtQuick.Layouts 1.3
 import matzman666.advsettings 1.0
-
+import "common"
 
 
 MyStackViewPage {

src/res/qml/SteamVRPage.qml

@@ -2,6 +2,7 @@ import QtQuick 2.7
 import QtQuick.Controls 2.0
 import QtQuick.Layouts 1.3
 import matzman666.advsettings 1.0
+import "common"
 
 MyStackViewPage {
     id: myStackViewPage1

src/res/qml/audio_page/AudioPage.qml

@@ -2,7 +2,7 @@ import QtQuick 2.7
 import QtQuick.Controls 2.0
 import QtQuick.Layouts 1.3
 import matzman666.advsettings 1.0
-import ".." //common imports
+import "../common"
 import "device_selector"
 import "proximity"
 import "push_to_talk"

src/res/qml/audio_page/device_selector/AudioDeviceSelector.qml

@@ -2,7 +2,7 @@ import QtQuick 2.7
 import QtQuick.Controls 2.0
 import QtQuick.Layouts 1.3
 import matzman666.advsettings 1.0
-import "../.." // common imports
+import "../../common"
 
 RowLayout {
     id: audioPlaybackNameCombo

src/res/qml/audio_page/device_selector/MicDeviceSelector.qml

@@ -2,7 +2,7 @@ import QtQuick 2.7
 import QtQuick.Controls 2.0
 import QtQuick.Layouts 1.3
 import matzman666.advsettings 1.0
-import "../.." //common imports
+import "../../common"
 
 RowLayout {
     id: audioMicNameCombo

src/res/qml/audio_page/device_selector/MicVolumeSlider.qml

@@ -2,7 +2,7 @@ import QtQuick 2.7
 import QtQuick.Controls 2.0
 import QtQuick.Layouts 1.3
 import matzman666.advsettings 1.0
-import "../.." //common imports
+import "../../common"
 
 ColumnLayout {
     spacing: 18
@@ -61,7 +61,7 @@ ColumnLayout {
             Layout.leftMargin: 12
             checkable: true
             contentItem: Image {
-                source: parent.checked ? "../mic_off.svg" : "../mic_on.svg"
+                source: parent.checked ? "qrc:/microphone/off" : "qrc:/microphone/on"
                 sourceSize.width: 32
                 sourceSize.height: 32
                 anchors.fill: parent

src/res/qml/audio_page/device_selector/MirrorDeviceSelector.qml

@@ -2,7 +2,7 @@ import QtQuick 2.7
 import QtQuick.Controls 2.0
 import QtQuick.Layouts 1.3
 import matzman666.advsettings 1.0
-import "../.." //common imports
+import "../../common"
 
 RowLayout {
     id: audioMirrorNameCombo

src/res/qml/audio_page/device_selector/MirrorVolumeSlider.qml

@@ -2,7 +2,7 @@ import QtQuick 2.7
 import QtQuick.Controls 2.0
 import QtQuick.Layouts 1.3
 import matzman666.advsettings 1.0
-import "../.." //common imports
+import "../../common"
 import "."
 
 ColumnLayout {
@@ -62,7 +62,7 @@ ColumnLayout {
             Layout.leftMargin: 12
             checkable: true
             contentItem: Image {
-                source: parent.checked ? "../speaker_off.svg" : "../speaker_on.svg"
+                source: parent.checked ? "qrc:/speaker/off" : "qrc:/speaker/on"
                 sourceSize.width: 32
                 sourceSize.height: 32
                 anchors.fill: parent

src/res/qml/audio_page/dialog_boxes/AudioDeleteProfileDialog.qml

@@ -2,7 +2,7 @@ import QtQuick 2.7
 import QtQuick.Controls 2.0
 import QtQuick.Layouts 1.3
 import matzman666.advsettings 1.0
-import "../.." //common imports
+import "../../common"
 
 MyDialogOkCancelPopup {
     id: audioDeleteProfileDialog

src/res/qml/audio_page/dialog_boxes/AudioMessageDialog.qml

@@ -2,7 +2,7 @@ import QtQuick 2.7
 import QtQuick.Controls 2.0
 import QtQuick.Layouts 1.3
 import matzman666.advsettings 1.0
-import "../.." //common imports
+import "../../common"
 
 MyDialogOkPopup {
     id: audioMessageDialog

src/res/qml/audio_page/dialog_boxes/AudioNewProfileDialog.qml

@@ -2,7 +2,7 @@ import QtQuick 2.7
 import QtQuick.Controls 2.0
 import QtQuick.Layouts 1.3
 import matzman666.advsettings 1.0
-import "../.." //common imports
+import "../../common"
 
 MyDialogOkCancelPopup {
     id: audioNewProfileDialog

src/res/qml/audio_page/dialog_boxes/PttDeleteProfileDialog.qml

@@ -2,7 +2,7 @@ import QtQuick 2.7
 import QtQuick.Controls 2.0
 import QtQuick.Layouts 1.3
 import matzman666.advsettings 1.0
-import "../.." //common imports
+import "../../common"
 
 MyDialogOkCancelPopup {
     id: pttDeleteProfileDialog

src/res/qml/audio_page/dialog_boxes/PttNewProfileDialog.qml

@@ -2,7 +2,7 @@ import QtQuick 2.7
 import QtQuick.Controls 2.0
 import QtQuick.Layouts 1.3
 import matzman666.advsettings 1.0
-import "../.." //common imports
+import "../../common"
 
 MyDialogOkCancelPopup {
     id: pttNewProfileDialog

src/res/qml/audio_page/profiles/ProfileButtons.qml

@@ -2,7 +2,7 @@ import QtQuick 2.7
 import QtQuick.Controls 2.0
 import QtQuick.Layouts 1.3
 import matzman666.advsettings 1.0
-import "../.." //common imports
+import "../../common"
 import "../dialog_boxes"
 
 ColumnLayout {

src/res/qml/audio_page/proximity/ProximityToggle.qml

@@ -2,7 +2,7 @@ import QtQuick 2.7
 import QtQuick.Controls 2.0
 import QtQuick.Layouts 1.3
 import matzman666.advsettings 1.0
-import "../.." //common imports
+import "../../common"
 
 MyToggleButton {
     id: audioMuteProximitySensorToggle

src/res/qml/audio_page/push_to_talk/PttButtons.qml

@@ -2,7 +2,8 @@ import QtQuick 2.7
 import QtQuick.Controls 2.0
 import QtQuick.Layouts 1.3
 import matzman666.advsettings 1.0
-import "../.." //common imports
+import "../../common"
+
 ColumnLayout {
     RowLayout {
         PttControllerConfigDialog {

src/res/qml/common/MyStackViewPage.qml

@@ -2,6 +2,8 @@ import QtQuick 2.7
 import QtQuick.Controls 2.0
 import QtQuick.Layouts 1.2
 import "." // QTBUG-34418, singletons require explicit import to load qmldir file
+// Needed for MyResources in the default folder.
+import ".."
 
 Rectangle {
     color: "#1b2939"
@@ -24,7 +26,7 @@ Rectangle {
                 enabled: headerShowBackButton
                 opacity: headerShowBackButton ? 1.0 : 0.0
                 contentItem: Image {
-                    source: "backarrow.svg"
+                    source: "qrc:/common/backarrow"
                     sourceSize.width: 50
                     sourceSize.height: 50
                     anchors.fill: parent

src/res/qml/common/MyToggleButton.qml

@@ -1,7 +1,8 @@
 import QtQuick 2.7
 import QtQuick.Controls 2.0
 import "." // QTBUG-34418, singletons require explicit import to load qmldir file
-
+// Needed for MyResources in the default folder.
+import ".."
 
 CheckBox {
     checkState: Qt.Checked
@@ -30,7 +31,7 @@ CheckBox {
             height: 28
 			x: (parent.width - width) / 2
 			y: (parent.height - height) / 2
-            source: "check.svg"
+            source: "qrc:/common/box_checkmark"
 			sourceSize.width: width
 			sourceSize.height: height
 			visible: parent.parent.checked

src/res/qml/common/mainwidget.qml

@@ -1,8 +1,9 @@
 import QtQuick 2.7
 import QtQuick.Controls 2.0
 import QtQuick.Layouts 1.0
-import "utilities_page"
-import "audio_page"
+import ".."
+import "../utilities_page"
+import "../audio_page"
 
 Rectangle {
     id: root

src/res/qml/qmldir

@@ -1 +1 @@
-singleton MyResources 1.0 MyResources.qml
+singleton MyResources 1.0 common/MyResources.qml

src/res/qml/utilities_page/UtilitiesPage.qml

@@ -6,7 +6,7 @@ import "media_keys"
 import "alarm_clock"
 import "desktop_size"
 import "keyboard_utils"
-import ".."
+import "../common"
 
 MyStackViewPage {
     headerText: "Utilities"

src/res/qml/utilities_page/alarm_clock/AlarmGroupBox.qml

@@ -2,7 +2,7 @@ import QtQuick 2.7
 import QtQuick.Controls 2.0
 import QtQuick.Layouts 1.3
 import matzman666.advsettings 1.0
-import "../.."
+import "../../common"
 
 GroupBox {
     id: alarmGroupBox

src/res/qml/utilities_page/desktop_size/SteamDesktopGroupBox.qml

@@ -2,7 +2,7 @@ import QtQuick 2.7
 import QtQuick.Controls 2.0
 import QtQuick.Layouts 1.3
 import matzman666.advsettings 1.0
-import "../.."
+import "../../common"
 
 GroupBox {
     id: steamDesktopGroupBox

src/res/qml/utilities_page/keyboard_utils/KeyboardGroupBox.qml

@@ -2,7 +2,7 @@ import QtQuick 2.7
 import QtQuick.Controls 2.0
 import QtQuick.Layouts 1.3
 import matzman666.advsettings 1.0
-import "../.."
+import "../../common"
 
 GroupBox {
     id: keyboardGroupBox

src/res/qml/utilities_page/media_keys/MediaButton.qml

@@ -2,8 +2,7 @@ import QtQuick 2.7
 import QtQuick.Controls 2.0
 import QtQuick.Layouts 1.3
 import matzman666.advsettings 1.0
-// Necessary for the project specific Components.
-import "../.."
+import "../../common"
 
 MyPushButton2 {
     // Public properties

src/res/qml/utilities_page/media_keys/MediaControllerKeys.qml

@@ -2,8 +2,7 @@ import QtQuick 2.7
 import QtQuick.Controls 2.0
 import QtQuick.Layouts 1.3
 import matzman666.advsettings 1.0
-// Necessary for the project specific Components.
-import "../.."
+import "../../common"
 
 GroupBox {
     id: mediaKeysGroupBox
@@ -26,10 +25,10 @@ GroupBox {
         }
 
         RowLayout {
-            property string playPauseButtonPath: "outline_play_pause_white_24dp.svg"
-            property string stopButtonPath: "outline_stop_white_24dp.svg"
-            property string previousButtonPath: "outline_skip_previous_white_24dp.svg"
-            property string nextButtonPath: "outline_skip_next_white_24dp.svg"
+            property string playPauseButtonPath: "qrc:/media_keys/play_pause"
+            property string stopButtonPath: "qrc:/media_keys/stop"
+            property string previousButtonPath: "qrc:/media_keys/previous"
+            property string nextButtonPath: "qrc:/media_keys/next"
 
             MediaButton {
                 id: previousSongButton

src/res/resources.qrc

@@ -0,0 +1,20 @@
+<!DOCTYPE RCC><RCC version="1.0">
+<qresource prefix="/common">
+    <file alias="backarrow">img/common/backarrow.svg</file>
+    <file alias="box_checkmark">img/common/check.svg</file>
+</qresource>
+<qresource prefix="/microphone">
+    <file alias="on">img/audio/microphone/mic_on.svg</file>
+    <file alias="off">img/audio/microphone/mic_off.svg</file>
+</qresource>
+<qresource prefix="/speaker">
+    <file alias="on">img/audio/speaker/speaker_on.svg</file>
+    <file alias="off">img/audio/speaker/speaker_off.svg</file>
+</qresource>
+<qresource prefix="/media_keys">
+    <file alias="play_pause">img/audio/media_keys/outline_play_pause_white_24dp.svg</file>
+    <file alias="next">img/audio/media_keys/outline_skip_next_white_24dp.svg</file>
+    <file alias="previous">img/audio/media_keys/outline_skip_previous_white_24dp.svg</file>
+    <file alias="stop">img/audio/media_keys/outline_stop_white_24dp.svg</file>
+</qresource>
+</RCC>

src/tabcontrollers/AudioTabController.cpp

@@ -72,7 +72,8 @@ void AudioTabController::initStage2( OverlayController* var_parent,
     {
         QString notifIconPath = QStandardPaths::locate(
             QStandardPaths::AppDataLocation,
-            QStringLiteral( "/res/qml/ptt_notification.png" ) );
+            QStringLiteral(
+                "/res/img/audio/microphone/ptt_notification.png" ) );
         if ( QFile::exists( notifIconPath ) )
         {
             vr::VROverlay()->SetOverlayFromFile(

src/tabcontrollers/UtilitiesTabController.cpp

@@ -274,7 +274,7 @@ void UtilitiesTabController::modAlarmTimeMinute( int value, bool notify )
 
 QString getBatteryIconPath( int batteryState )
 {
-    QString batteryPrefix = "/res/battery_";
+    QString batteryPrefix = "/res/img/battery/battery_";
     return QStandardPaths::locate(
         QStandardPaths::AppDataLocation,
         batteryPrefix + QString::number( batteryState ) + ".png" );