Skip to content

Give the viewer a back chevron and a pencil #156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andiwand merged 1 commit into from
Aug 15, 2026
+52 −10
Merged

Give the viewer a back chevron and a pencil #156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,13 @@ once the version tag exists.

## [Unreleased]

### Changed

- The way out of a document is a back chevron, not the words "Back to
documents".
- Documents that can be edited offer a pencil next to the search button.
Editing has left the menu, which is where it used to hide.

### Fixed

- The buttons above an open document no longer sit on the status bar, and the
Expand Down
44 changes: 35 additions & 9 deletions OpenDocumentReader/DocumentViewController.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,13 @@ class DocumentViewController: UIViewController, DocumentDelegate, UISearchBarDel
@IBOutlet weak var bannerSlotHeight: NSLayoutConstraint!
@IBOutlet weak var barButtonItem: UIBarButtonItem!
@IBOutlet weak var searchButton: UIBarButtonItem!
@IBOutlet weak var editButton: UIBarButtonItem!

/// The bar as the storyboard has it, and the same without the edit button.
/// Taken before anything is removed, since that is the only moment both are
/// there to be read.
private lazy var toolBarItems: [UIBarButtonItem] = toolBar.items ?? []
private lazy var toolBarItemsWithoutEdit: [UIBarButtonItem] = toolBarItems.filter { $0 !== editButton }

/// Fills the banner slot when no ad does. Sits on top of `bannerSlot` rather than in the
/// layout chain, so the slot keeps its height and nothing below it moves.
Expand Down Expand Up @@ -93,7 +100,13 @@ class DocumentViewController: UIViewController, DocumentDelegate, UISearchBarDel
setVCconstraints()
hideSearchBar()

barButtonItem.title = NSLocalizedString("back_to_documents", comment: "")
// the chevron says where it goes; the words are for VoiceOver, which is
// the one reader a glyph is no shorter for
barButtonItem.accessibilityLabel = NSLocalizedString("back_to_documents", comment: "")
editButton.accessibilityLabel = NSLocalizedString("menu_edit", comment: "")

// nothing is editable until a document says so
showEditButton(false)

setUpHouseAd()
}
Expand Down Expand Up @@ -323,6 +336,20 @@ class DocumentViewController: UIViewController, DocumentDelegate, UISearchBarDel
findAll(searchText: searchText)
}

@IBAction func editButton(_ sender: UIBarButtonItem) {
editDocument()
}

/// In the bar for the documents that can be edited, and only while they are
/// not being edited already. Every other document keeps the room for itself.
private func showEditButton(_ show: Bool) {
toolBar.items = show ? toolBarItems : toolBarItemsWithoutEdit
}

private func updateEditButton() {
showEditButton((document?.isEditable ?? false) && !(document?.edit ?? false))
}

@IBAction func searchButton(_ sender: UIBarButtonItem) {
AnalyticsManager.shared.report("menu_search")
AnalyticsManager.shared.report(AnalyticsConstants.eventSearch)
Expand Down Expand Up @@ -422,14 +449,7 @@ class DocumentViewController: UIViewController, DocumentDelegate, UISearchBarDel
@IBAction func showMenu(_ sender: Any) {
let alert = UIAlertController(title: nil, message: nil, preferredStyle: .actionSheet)

if (document?.isEditable ?? false) && !(document?.edit ?? false) {
alert.addAction(
UIAlertAction(
title: NSLocalizedString("menu_edit", comment: ""), style: .default,
handler: { (_) in
self.editDocument()
}))
}
// editing is not in here: it is the pencil in the bar

if document?.edit ?? false {
alert.addAction(
Expand Down Expand Up @@ -606,6 +626,7 @@ class DocumentViewController: UIViewController, DocumentDelegate, UISearchBarDel
self.webview.loadFileURL(doc.fileURL, allowingReadAccessTo: doc.fileURL)

searchButton.isEnabled = false
showEditButton(false)

AnalyticsManager.shared.report(
"load_success",
Expand Down Expand Up @@ -637,13 +658,18 @@ class DocumentViewController: UIViewController, DocumentDelegate, UISearchBarDel
// only what odrcore translated is searchable, and a later parse — after
// a password, say — may well get there
searchButton.isEnabled = true

// whether this one can be edited is not known until it is parsed
showEditButton(false)
}

func documentLoadingCompleted(_ doc: Document) {
AnalyticsManager.shared.report("load_odf_success")

progressBar.isHidden = true

updateEditButton()

let fileType = doc.fileURL.pathExtension.lowercased()

AnalyticsManager.shared.report(
Expand Down
11 changes: 10 additions & 1 deletion OpenDocumentReader/Main.storyboard
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,18 @@
<toolbar opaque="NO" clearsContextBeforeDrawing="NO" contentMode="scaleToFill" horizontalHuggingPriority="750" verticalHuggingPriority="750" translatesAutoresizingMaskIntoConstraints="NO" id="N1x-QM-Qks">
<rect key="frame" x="0.0" y="0.0" width="414" height="44"/>
<items>
<barButtonItem title="Back to documents" id="yhO-7V-lbn">
<barButtonItem image="chevron.backward" catalog="system" id="yhO-7V-lbn">
<connections>
<action selector="returnToDocuments:" destination="M2k-L8-Olo" id="ILH-TV-slT"/>
</connections>
</barButtonItem>
<barButtonItem style="plain" systemItem="flexibleSpace" id="lgr-dX-fUO"/>
<barButtonItem image="pencil" catalog="system" id="Ed1-tP-enc">
<connections>
<action selector="editButton:" destination="M2k-L8-Olo" id="Ed2-tP-enc"/>
</connections>
</barButtonItem>
<barButtonItem width="10" style="plain" systemItem="fixedSpace" id="Ed4-tP-enc"/>
<barButtonItem title="Search Button" image="magnifyingglass" catalog="system" id="fGi-i7-iOR">
<connections>
<action selector="searchButton:" destination="M2k-L8-Olo" id="6fS-of-qcB"/>
Expand Down Expand Up @@ -100,6 +106,7 @@
<outlet property="bannerSlot" destination="yut-lR-gq5" id="28Z-1b-NAN"/>
<outlet property="bannerSlotHeight" destination="eXE-Ks-sQc" id="yQ1-l7-wiV"/>
<outlet property="barButtonItem" destination="yhO-7V-lbn" id="ach-z7-H9P"/>
<outlet property="editButton" destination="Ed1-tP-enc" id="Ed3-tP-enc"/>
<outlet property="menuButton" destination="Vsd-IL-ujz" id="GoN-tp-egn"/>
<outlet property="pageTabBar" destination="sIx-zo-9kG" id="pCn-x0-Z01"/>
<outlet property="progressBar" destination="ePk-bQ-fV8" id="nz6-qw-ouf"/>
Expand Down Expand Up @@ -213,8 +220,10 @@
</scene>
</scenes>
<resources>
<image name="chevron.backward" catalog="system" width="76" height="128"/>
<image name="ellipsis" catalog="system" width="128" height="37"/>
<image name="magnifyingglass" catalog="system" width="128" height="115"/>
<image name="pencil" catalog="system" width="128" height="127"/>
<systemColor name="secondarySystemBackgroundColor">
<color red="0.94901960780000005" green="0.94901960780000005" blue="0.96862745100000003" alpha="1" colorSpace="custom" customColorSpace="sRGB"/>
</systemColor>
Expand Down
Loading