Bug 1158509 - Reading List item does not announce if it is read/unread

with accessibility

We communicate that the item is read primarily by speaking it with lower
pitch. So a VoiceOver user immediately learns whether item is
read/unread by noting the pitch of the voice. As read/unread status is
not communicated by a word at the beginning of the accessibility label
and the label begins with the title of the webpage, the user will also
immediately learn the beginning words of the title of webpage. I.e., the
title of the webpage and read/unread status are learned simultaneously
and immediately by the VoiceOver user.

This allows for quick navigation through the items, as within first
fractions of a second VoiceOver user can identify both read/unread
status and the beginning of the title of the article.

"Read"/"Unread" is still announced after the title, in case the user is
using only braille display without speech, or the user has trouble
recognizing pitch changes, or the user is a Switch Control user (Switch
Control does not respect the UIAccessibilitySpeechAttribute* attributes
- <rdar://problem/20701917>).

Author: dusek

Client/Frontend/Home/ReaderPanel.swift

@@ -16,6 +16,7 @@ private struct ReadingListTableViewCellUX {
 
     static let ReadIndicatorWidth: CGFloat = 16 + 16 + 16 // padding + image width + padding
     static let ReadIndicatorHeight: CGFloat = 14 + 16 + 14 // padding + image height + padding
+    static let ReadAccessibilitySpeechPitch: Float = 0.7 // 1.0 default, 0.0 lowest, 2.0 highest
 
     static let TitleLabelFont = UIFont(name: UIAccessibilityIsBoldTextEnabled() ? "HelveticaNeue-Bold" : "HelveticaNeue-Medium", size: 15)
     static let TitleLabelTopOffset: CGFloat = 14 - 4
@@ -45,12 +46,14 @@ class ReadingListTableViewCell: SWTableViewCell {
     var title: String = "Example" {
         didSet {
             titleLabel.text = title
+            updateAccessibilityLabel()
         }
     }
 
     var url: NSURL = NSURL(string: "http://www.example.com")! {
         didSet {
             hostnameLabel.text = simplifiedHostnameFromURL(url)
+            updateAccessibilityLabel()
         }
     }
 
@@ -61,6 +64,7 @@ class ReadingListTableViewCell: SWTableViewCell {
             hostnameLabel.textColor = unread ? ReadingListTableViewCellUX.ActiveTextColor : ReadingListTableViewCellUX.DimmedTextColor
             markAsReadButton.setTitle(unread ? ReadingListTableViewCellUX.MarkAsReadButtonTitleText : ReadingListTableViewCellUX.MarkAsUnreadButtonTitleText, forState: UIControlState.Normal)
             markAsReadAction.name = markAsReadButton.titleLabel!.text
+            updateAccessibilityLabel()
         }
     }
 
@@ -169,6 +173,27 @@ class ReadingListTableViewCell: SWTableViewCell {
         self.delegate?.swipeableTableViewCell?(self, didTriggerRightUtilityButtonWithIndex: 0)
         return true
     }
+
+    private func updateAccessibilityLabel() {
+        if let hostname = hostnameLabel.text,
+                  title = titleLabel.text {
+            let unreadStatus = unread ? NSLocalizedString("unread", comment: "Accessibility label for unread article in reading list. It's a past participle - functions as an adjective.") : NSLocalizedString("read", comment: "Accessibility label for read article in reading list. It's a past participle - functions as an adjective.")
+            let string = "\(title), \(unreadStatus), \(hostname)"
+            var label: AnyObject
+            if !unread {
+                // mimic light gray visual dimming by "dimming" the speech by reducing pitch
+                let lowerPitchString = NSMutableAttributedString(string: string as String)
+                lowerPitchString.addAttribute(UIAccessibilitySpeechAttributePitch, value: NSNumber(float: ReadingListTableViewCellUX.ReadAccessibilitySpeechPitch), range: NSMakeRange(0, lowerPitchString.length))
+                label = NSAttributedString(attributedString: lowerPitchString)
+            } else {
+                label = string
+            }
+            // need to use KVC as accessibilityLabel is of type String! and cannot be set to NSAttributedString other way than this
+            // see bottom of page 121 of the PDF slides of WWDC 2012 "Accessibility for iOS" session for indication that this is OK by Apple
+            // also this combined with Swift's strictness is why we cannot simply override accessibilityLabel and return the label directly...
+            setValue(label, forKey: "accessibilityLabel")
+        }
+    }
 }
 
 class ReadingListPanel: UITableViewController, HomePanel, SWTableViewCellDelegate {