manage keep screen always on

Author: merlos

Diff for: OpenGpxTracker/Preferences.swift

@@ -40,6 +40,8 @@ let kDefaultsKeyDateFormatUseEN: String = "DateFormatPresetUseEN"
 /// Key on Defaults for the folder where GPX files are store, `nil` means default folder
 let kDefaultsKeyGPXFilesFolder: String = "GPXFilesFolder"
 
+let kDefaultsKeyKeepScreenAlwaysOn: String = "KeepScreenAlwaysOn"
+
 /// A class to handle app preferences in one single place.
 /// When the app starts for the first time the following preferences are set:
 ///
@@ -86,6 +88,9 @@ class Preferences: NSObject {
     ///
     private var _gpxFilesFolderBookmark: Data?
 
+    ///
+    private var _keepScreenAlwaysOn: Bool = false
+    
     /// UserDefaults.standard shortcut
     private let defaults = UserDefaults.standard
 
@@ -160,6 +165,13 @@ class Preferences: NSObject {
             _gpxFilesFolderBookmark = gpxFilesFolderBookmark
             print("** Preferences:: loaded preference from defaults gpxFilesFolderBookmark \(gpxFilesFolderBookmark)")
         }
+        
+        // load previous date format, to use EN locale instead of local locale
+        if let keepScreenAlwaysOnBool = defaults.object(forKey: kDefaultsKeyKeepScreenAlwaysOn) as? Bool {
+            _keepScreenAlwaysOn = keepScreenAlwaysOnBool
+            print("** Preferences:: loaded preference from defaults keepScreenAlwaysOn \(keepScreenAlwaysOnBool)")
+        }
+        
     }
 
     /// If true, user prefers to display imperial units (miles, feets). Otherwise metric units
@@ -293,6 +305,18 @@ class Preferences: NSObject {
         }
     }
 
+    /// Get and sets whether to set the screen always On or not
+    var keepScreenAlwaysOn: Bool {
+        get {
+            return _keepScreenAlwaysOn
+        }
+        set {
+            _keepScreenAlwaysOn = newValue
+            defaults.set(newValue, forKey: kDefaultsKeyKeepScreenAlwaysOn)
+            print("** Preferences:: setting keepScreenAlwaysOn: \(newValue)")
+        }
+    }
+    
     var gpxFilesFolderURL: URL? {
         get {
             guard let bookmarkData = self._gpxFilesFolderBookmark else {

Diff for: OpenGpxTracker/PreferencesTableViewController.swift

@@ -16,24 +16,33 @@ import CoreServices
 /// Units Section Id in PreferencesTableViewController
 let kUnitsSection = 0
 
+/// Screen always on section id
+let kScreenSection = 1
+
 /// Cache Section Id in PreferencesTableViewController
-let kCacheSection = 1
+let kCacheSection = 2
 
 /// Map Source Section Id in PreferencesTableViewController
-let kMapSourceSection = 2
+let kMapSourceSection = 3
 
 /// Activity Type Section Id in PreferencesTableViewController
-let kActivityTypeSection = 3
+let kActivityTypeSection = 4
 
 /// Default Name Section Id in PreferencesTableViewController
-let kDefaultNameSection = 4
+let kDefaultNameSection = 5
 
 /// GPX Files Location Section Id in PreferencesTableViewController
-let kGPXFilesLocationSection = 5
+let kGPXFilesLocationSection = 6
 
 /// Cell Id of the Use Imperial units in UnitsSection
 let kUseImperialUnitsCell = 0
 
+
+/// Cell Id of the keepScreenAlwaysOnl units in ScreenSection
+let kKeepScreenAlwaysOnCell = 0
+
+
+
 /// Cell Id for Use offline cache in CacheSection of PreferencesTableViewController
 let kUseOfflineCacheCell = 0
 
@@ -119,6 +128,7 @@ class PreferencesTableViewController: UITableViewController, UINavigationBarDele
         case kActivityTypeSection: return NSLocalizedString("ACTIVITY_TYPE", comment: "no comment")
         case kDefaultNameSection: return NSLocalizedString("DEFAULT_NAME_SECTION", comment: "no comment")
         case kGPXFilesLocationSection: return NSLocalizedString("GPX_FILES_FOLDER", comment: "no comment")
+        case kScreenSection: return NSLocalizedString("SCREEN", comment: "no comment")
         default: fatalError("Unknown section")
         }
     }
@@ -134,6 +144,7 @@ class PreferencesTableViewController: UITableViewController, UINavigationBarDele
         case kActivityTypeSection: return CLActivityType.count
         case kDefaultNameSection: return 1
         case kGPXFilesLocationSection: return 1
+        case kScreenSection: return 1
         default: fatalError("Unknown section")
         }
     }
@@ -166,6 +177,19 @@ class PreferencesTableViewController: UITableViewController, UINavigationBarDele
             }
         }
 
+        // Units section
+        if indexPath.section == kScreenSection {
+             switch indexPath.row {
+             case kKeepScreenAlwaysOnCell:
+                 cell = UITableViewCell(style: .value1, reuseIdentifier: "CacheCell")
+                 cell.textLabel?.text = NSLocalizedString("KEEP_SCREEN_ALWAYS_ON", comment: "no comment")
+                 if preferences.keepScreenAlwaysOn {
+                    cell.accessoryType = .checkmark
+                 }
+             default: fatalError("Unknown section")
+            }
+        }
+        
         // Cache Section
         if indexPath.section == kCacheSection {
             switch indexPath.row {
@@ -264,6 +288,22 @@ class PreferencesTableViewController: UITableViewController, UINavigationBarDele
             }
         }
 
+        if indexPath.section == kScreenSection {
+            switch indexPath.row {
+            case kKeepScreenAlwaysOnCell:
+                let newKeepScreenAlwaysOn = !preferences.keepScreenAlwaysOn
+                preferences.keepScreenAlwaysOn = newKeepScreenAlwaysOn
+                print("PreferencesTableViewController: toggle keep screen always on to \(newKeepScreenAlwaysOn)")
+                // Update cell UI
+                tableView.cellForRow(at: indexPath)?.accessoryType = newKeepScreenAlwaysOn ? .checkmark : .none
+                // Notify the map
+                self.delegate?.didUpdateKeepScreenAlwaysOn(newKeepScreenAlwaysOn)
+            default:
+                fatalError("didSelectRowAt: Unknown cell")
+            }
+        }
+        
+        
         if indexPath.section == kCacheSection {  // 0 -> sets and unsets cache
             switch indexPath.row {
             case kUseOfflineCacheCell:

Diff for: OpenGpxTracker/PreferencesTableViewControllerDelegate.swift

@@ -22,6 +22,9 @@ protocol PreferencesTableViewControllerDelegate: AnyObject {
     /// User updated the usage of imperial units
     func didUpdateUseImperial(_ newUseImperial: Bool)
 
+    /// User updated the keep screen always on option
+    func didUpdateKeepScreenAlwaysOn(_ newKeepScreenAlwaysOn: Bool)
+  
     /// User updated the activity type
     func didUpdateActivityType(_ newActivityType: Int)
 

Diff for: OpenGpxTracker/ViewController.swift

@@ -1313,6 +1313,7 @@ extension ViewController: StopWatchDelegate {
 
 extension ViewController: PreferencesTableViewControllerDelegate {
 
+    
     /// Update the activity type that the location manager is using.
     ///
     /// When user changes the activity type in preferences, this function is invoked to update the activity type of the location manager.
@@ -1356,7 +1357,14 @@ extension ViewController: PreferencesTableViewControllerDelegate {
         // In regular circunstances it will go to the new units relatively fast.
         speedLabel.text = kUnknownSpeedText
         signalAccuracyLabel.text = kUnknownAccuracyText
-    }}
+    }
+    
+    // User changed the setting of use imperial units.
+    func didUpdateKeepScreenAlwaysOn(_ newKeepScreenAlwaysOn: Bool) {
+        print("PreferencesTableViewControllerDelegate:: didUpdateKeepScreenAlwaysOn: \(newKeepScreenAlwaysOn)")
+        UIApplication.shared.isIdleTimerDisabled = newKeepScreenAlwaysOn
+    }
+}
 
 /// Extends `ViewController`` to support `GPXFilesTableViewControllerDelegate` function
 /// that loads into the map a the file selected by the user.

Diff for: OpenGpxTracker/en.lproj/Localizable.strings

@@ -33,8 +33,12 @@
 "SHARE" = "Share";
 "LOADING_FILE" = "Loading GPX File...";
 "ABOUT" = "About";
+
+// Preferences
 "PREFERENCES" = "Preferences";
 "UNITS" = "Units";
+"SCREEN" = "Screen";
+"KEEP_SCREEN_ALWAYS_ON" = "Keep Screen always on?";
 "CACHE" = "Cache";
 "MAP_SOURCE" = "Map Source";
 "ACTIVITY_TYPE" = "Activity Type";