From 1f78846481385fed5e65c982e771a5bc72421399 Mon Sep 17 00:00:00 2001
From: jan Iversen <jani@libreoffice.org>
Date: Sun, 29 Oct 2017 13:05:22 +0100
Subject: iOS, documented DocumentActions

Documented the popover menu
Corrected to reflect the current menu entries

Change-Id: I41283fe013cc2593e07f53e0e4fc779eff845a66
---
 .../LibreOfficeLight/DocumentActions.swift         | 62 ++++++++++++++--------
 1 file changed, 41 insertions(+), 21 deletions(-)

diff --git a/ios/LibreOfficeLight/LibreOfficeLight/DocumentActions.swift b/ios/LibreOfficeLight/LibreOfficeLight/DocumentActions.swift
index d3c41977f09b..96f9d3216633 100644
--- a/ios/LibreOfficeLight/LibreOfficeLight/DocumentActions.swift
+++ b/ios/LibreOfficeLight/LibreOfficeLight/DocumentActions.swift
@@ -9,45 +9,65 @@ import UIKit
 
 
 
-// Protocol for action popover callback
-protocol MenuDelegate
-{
-    func actionMenuSelected(_ tag : Int)
-}
-
-
-
+// DocumentActions is the main menu popover started from DocumentController
+// it allows the user to invoke global actions and delegates the processing
+// back to the DocumentController
 class DocumentActions: UITableViewController
 {
-    // Pointer to callback class
+    // Pointer to callback class (in reality instance of DocumentController)
     var delegate  : MenuDelegate?
+
+    // set by DocumentController before invoking the menu
+    // the variable is used to control which menu entries are active
     var isDocActive : Bool = false
 
-    // Calling class might enable/disable each button
-    @IBAction func actionMenuSelect(_ sender: UIButton)
-    {
-        dismiss(animated: false)
-        delegate?.actionMenuSelected(sender.tag)
-    }
 
-    @IBOutlet weak var buttonClose: UIButton!
-    @IBOutlet weak var buttonProperties: UIButton!
-    @IBOutlet weak var buttonNew: UIButton!
+
+    // Reference to instances of the buttons
     @IBOutlet weak var buttonOpen: UIButton!
+    @IBOutlet weak var buttonProperties: UIButton!
     @IBOutlet weak var buttonSave: UIButton!
+    @IBOutlet weak var buttonClose: UIButton!
     @IBOutlet weak var buttonSaveAs: UIButton!
     @IBOutlet weak var buttonSaveAsPDF: UIButton!
     @IBOutlet weak var buttonPrint: UIButton!
-    @IBOutlet weak var buttonCopy: UIButton!
-    @IBOutlet weak var buttonMove: UIButton!
-    @IBOutlet weak var buttonDelete: UIButton!
 
+
+
+    // called once controller is loaded
     override func viewDidLoad()
     {
         super.viewDidLoad()
+
+        // Some menu entries are only active when a document is loaded
         buttonSave.isEnabled = isDocActive
+        buttonProperties.isEnabled = isDocActive
+        buttonClose.isEnabled = isDocActive
         buttonSaveAs.isEnabled = isDocActive
         buttonSaveAsPDF.isEnabled = isDocActive
         buttonPrint.isEnabled = isDocActive
     }
+
+
+
+    // Called when user click on a menu entry (all entries goes here)
+    // see storyboard Document actions scene for details
+    @IBAction func actionMenuSelect(_ sender: UIButton)
+    {
+        // make popover go away, when this function returns
+        dismiss(animated: false)
+
+        // inform DocumentController about the selected entry
+        delegate?.actionMenuSelected(sender.tag)
+    }
+}
+
+
+
+// Protocol for action popover callback
+protocol MenuDelegate
+{
+    // inform delegate about selected menu entry
+    func actionMenuSelected(_ tag : Int)
 }
+
-- 
cgit