88-Swift 之QLPreviewController 文件快速浏览

引言

iOS4.0 的时候,Apple 官方提出了一个 QLPreviewController 的在 App 内可以快速查看文件的类。该类支持查看的文档类型有如下几个:

  • iWork 类的文档。
  • 微软Office97以上版本的文档。
  • RTF 富文本文档。
  • PDF 格式的文件。
  • 图片格式文件。
  • CSV 格式文件和本地文件。

QLPreviewController 的使用说明

QLPreviewController 的使用非常简单。它的两个代理和 UITableVIew 的两个代理大致相同,其实它的使用和UIImagePickerController的使用基本像似只是作用不同。如果 App 内需要使用到 UIImagePickerController 类的时候需要引入 import QuickLook 库。

QLPreviewController 的使用

1、引入 QuickLook 库 。

// 引入必要的库
import QuickLook

2、 QLPreviewController 的两个代理

1> QLPreviewControllerDataSource

QLPreviewControllerDelegate 的该代理,主要是设置快速预览的文件个数和文件的路径。

// MARK: 文件的个数
@available(iOS 4.0, *)
public func numberOfPreviewItems(in controller: QLPreviewController) -> Int
// MARK: 文件地址路径
@available(iOS 4.0, *)
public func previewController(_ controller: QLPreviewController, previewItemAt index: Int) -> QLPreviewItem
2> QLPreviewControllerDelegate

QLPreviewControllerDelegate 的该代理,主要是用户对 QLPreviewController 控制器操作后触发的一些事件。

// MARK: 快速查看预览界面将要移除时调用该函数
@available(iOS 4.0, *)
optional public func previewControllerWillDismiss(_ controller: QLPreviewController)
// MARK: 快速查看预览界面移除后调用该函数
@available(iOS 4.0, *)
optional public func previewControllerDidDismiss(_ controller: QLPreviewController)
// MARK: 判断在打开预览文件里的URL是在预览控制器里打开(true)还是使用-[UIApplication openURL:]打开(false)。
@available(iOS 4.0, *)
optional public func previewController(_ controller: QLPreviewController, shouldOpen url: URL, for item: QLPreviewItem) -> Bool
// MARK: 预览界面全屏或者从全屏到消失时调用该函数,主要做预览视图的缩放效果。
@available(iOS 4.0, *)
optional public func previewController(_ controller: QLPreviewController, frameFor item: QLPreviewItem, inSourceView view: AutoreleasingUnsafeMutablePointer<UIView?>) -> CGRect
@available(iOS 4.0, *)
optional public func previewController(_ controller: QLPreviewController, transitionImageFor item: QLPreviewItem, contentRect: UnsafeMutablePointer<CGRect>) -> UIImage
// MARK: 预览界面展示前和清除后显示的一个View
@available(iOS 10.0, *)
optional public func previewController(_ controller: QLPreviewController, transitionViewFor item: QLPreviewItem) -> UIView?

3、 QLPreviewItem 的介绍

QLPreviewItem 继承 NSObjectProtocol 。同时 QLPreviewItem 使 NSURL 实例成为预览控制器的合适项目。 QLPreviewItem 有两个只读的变量分别是: previewItemURL \ previewItemTitle 。其中 previewItemTitle 是预览文档的Title 。 previewItemURL是预览文档的 URL。

4、QLPreviewController 的创建和参数介绍

// TODO: 初始化预览对象
let qlPreviewController = QLPreviewController.init()
// TODO: 判断文档否可以预览查看
let isQuickLook = QLPreviewController.canPreview(self.initializePreviewItem())
print(isQuickLook)
// TODO: 设置代理
qlPreviewController.delegate = self ;
qlPreviewController.dataSource = self ;
// TODO: 刷新文档预览全部数据
qlPreviewController.reloadData()
// TODO: 刷新当前预览的数据
qlPreviewController.refreshCurrentPreviewItem()
// TODO: 设置预览的当前索引值
qlPreviewController.currentPreviewItemIndex = 0
// TDOO: 获取当前预览的索引值
let index = qlPreviewController.currentPreviewItemIndex
print(index)
// TODO: 获取当前预览文档对象
let previewItem = qlPreviewController.currentPreviewItem! as QLPreviewItem
// TODO: 获取预览文档对象的标题
let preViewItemTitle =  previewItem.previewItemTitle
print(preViewItemTitle as Any)
// TODO: 获取快速浏览文档对象的URL
let previewItemURL = previewItem.previewItemURL
print(previewItemURL! as URL)
// TODO: 获取'QLPreviewControllerDelegate'协议对象
let pool =  qlPreviewController.delegate
print(pool!)
// TODO: 视图渲染
DispatchQueue.main.asyncAfter(deadline: DispatchTime.now() + 0.2) {
    self.present(qlPreviewController, animated: true, completion: nil)
}

self.initializePreviewItem() 方法的实现

// MARK: 查看快速对象
func initializePreviewItem() -> QLPreviewItem {
    // TODO: 获取预览对象的地址
    let path = Bundle.main.path(forResource: "xsbg", ofType: "doc")
    return  URL.init(fileURLWithPath: path!, isDirectory: true) as QLPreviewItem
}

5、 QLPreviewController 的协议实现

1> QLPreviewControllerDataSource 的协议
// MARK: QLPreviewControllerDataSource 的协议
// TODO: 返回快速查看的对象的个数
func numberOfPreviewItems(in controller: QLPreviewController) -> Int {
     return 1
}
// TODO: 设置快速查看对象的地址
func previewController(_ controller: QLPreviewController, previewItemAt index: Int) -> QLPreviewItem {
    // TODO: 获取预览对象的地址
    let path = Bundle.main.path(forResource: "we", ofType: "html")
    return URL.init(fileURLWithPath: path!) as QLPreviewItem
    // 注释: 如果是多个文件就是用 'index' 来返回预览对象
}
2、QLPreviewControllerDelegate 的协议
// MARK: QLPreviewControllerDelegate 的协议
// TODO: 判断预览文件中URL的是在预览控制器中打开还是调用-[UIApplication openURL:]打开。
func previewController(_ controller: QLPreviewController, shouldOpen url: URL, for item: QLPreviewItem) -> Bool {
    // TODO: 移除指定的快速查看文件
    if url == URL.init(string: "")! {
        return false
    }
    // TODO: 返回可快速浏览的文件结果
    return true
}

// TODO: 快速查看的控制器被清除后调用该函数
func previewControllerDidDismiss(_ controller: QLPreviewController) {
    // 在这里最后释放一些对象
}

// TODO: 快速查看控制器将要清楚时调用的该函数
func previewControllerWillDismiss(_ controller: QLPreviewController) {
    // 在这里预先处理一些逻辑问题
}

// TODO: 快速查看控制器的显示呈现全屏或者全屏移除时,提供缩放效果的函数
func previewController(_ controller: QLPreviewController, frameFor item: QLPreviewItem, inSourceView view: AutoreleasingUnsafeMutablePointer<UIView?>) -> CGRect {
    return CGRect.init()
}


func previewController(_ controller: QLPreviewController, transitionImageFor item: QLPreviewItem, contentRect: UnsafeMutablePointer<CGRect>) -> UIImage {
     return UIImage.init()
}

// TODO: 当快速浏览控制器将要展示和视图缩放的时候展示的View
func previewController(_ controller: QLPreviewController, transitionViewFor item: QLPreviewItem) -> UIView? {
    let uiv = UIView.init(frame: CGRect.init(x: 0, y: 0, width: 100, height: 300))
    uiv.backgroundColor = UIColor.red
    return uiv
}

QLPreviewController 的测试效果

6.gif
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,732评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,496评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,264评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,807评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,806评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,675评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,029评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,683评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,704评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,666评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,773评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,413评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,016评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,204评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,083评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,503评论 2 343

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,596评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,451评论 25 707
  • A组:Stork2-0,GuemCHi2-1,Light1-2,Shuttle0-2; B组:Best2-0,Je...
    _AshMessenger阅读 591评论 0 0
  • 有人要问了,活动现场那么大,涉及的内容也多,音响、LED背景板、主持人,参与嘉宾,这么多事项如何统筹起来? 一张表...
    宁小南阅读 4,404评论 0 3
  • 那片红得几欲燃起火焰的叶子,从我面前的那颗挺拔的树上坠落,脆生生的摔落在粗糙的水泥地上,发出清脆的响声,它分别以象...
    瞿庵雀阅读 188评论 0 0