From d982376fc4a1a98f01ad3665ade218f947bc66a6 Mon Sep 17 00:00:00 2001 From: Kevin Sawicki Date: Wed, 26 Oct 2016 09:47:22 +0900 Subject: [PATCH] filename -> displayName --- atom/browser/api/atom_api_window.cc | 8 ++++---- atom/browser/native_window.cc | 2 +- atom/browser/native_window.h | 2 +- atom/browser/native_window_mac.h | 2 +- atom/browser/native_window_mac.mm | 14 +++++++------- docs/api/browser-window.md | 13 +++++++++---- 6 files changed, 23 insertions(+), 18 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index a039198..ae37f50 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -730,11 +730,11 @@ void Window::SetAspectRatio(double aspect_ratio, mate::Arguments* args) { } void Window::PreviewFile(const std::string& path, mate::Arguments* args) { - std::string fileName; - if (!args->GetNext(&fileName)) { - fileName = path; + std::string display_name; + if (!args->GetNext(&display_name)) { + display_name = path; } - window_->PreviewFile(path, fileName); + window_->PreviewFile(path, display_name); } void Window::SetParentWindow(v8::Local value, diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 9d56615..6c32e79 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -375,7 +375,7 @@ void NativeWindow::SetAspectRatio(double aspect_ratio, } void NativeWindow::PreviewFile(const std::string& path, - const std::string& fileName) { + const std::string& display_name) { } void NativeWindow::RequestToClosePage() { diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index e3d1558..3d190ba 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -177,7 +177,7 @@ class NativeWindow : public base::SupportsUserData, gfx::Size GetAspectRatioExtraSize(); virtual void SetAspectRatio(double aspect_ratio, const gfx::Size& extra_size); virtual void PreviewFile(const std::string& path, - const std::string& fileName); + const std::string& display_name); base::WeakPtr GetWeakPtr() { return weak_factory_.GetWeakPtr(); diff --git a/atom/browser/native_window_mac.h b/atom/browser/native_window_mac.h index 1a6d2d3..979d69d 100644 --- a/atom/browser/native_window_mac.h +++ b/atom/browser/native_window_mac.h @@ -55,7 +55,7 @@ class NativeWindowMac : public NativeWindow, void SetMovable(bool movable) override; void SetAspectRatio(double aspect_ratio, const gfx::Size& extra_size) override; - void PreviewFile(const std::string& path, const std::string& fileName) + void PreviewFile(const std::string& path, const std::string& display_name) override; bool IsMovable() override; void SetMinimizable(bool minimizable) override; diff --git a/atom/browser/native_window_mac.mm b/atom/browser/native_window_mac.mm index 98fc2c8..d9de9bd 100644 --- a/atom/browser/native_window_mac.mm +++ b/atom/browser/native_window_mac.mm @@ -290,11 +290,11 @@ bool ScopedDisableResize::disable_resize_ = false; @implementation AtomPreviewItem - (id)initWithURL:(NSURL*)url title:(NSString*)title { - self = [super init]; + self = [super init]; if (self) { self.previewItemURL = url; self.previewItemTitle = title; - } + } return self; } @@ -953,11 +953,11 @@ void NativeWindowMac::SetAspectRatio(double aspect_ratio, [window_ setResizeIncrements:NSMakeSize(1.0, 1.0)]; } -void NativeWindowMac::PreviewFile(const std::string& path, const std::string& fileName) { - NSString* pathStr = [NSString stringWithUTF8String:path.c_str()]; - NSString* nameStr = [NSString stringWithUTF8String:fileName.c_str()]; - - [window_ previewFileAtPath:pathStr withName:nameStr]; +void NativeWindowMac::PreviewFile(const std::string& path, + const std::string& display_name) { + NSString* path_ns = [NSString stringWithUTF8String:path.c_str()]; + NSString* name_ns = [NSString stringWithUTF8String:display_name.c_str()]; + [window_ previewFileAtPath:path_ns withName:name_ns]; } void NativeWindowMac::SetMovable(bool movable) { diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index fccedae..b891396 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -664,12 +664,16 @@ the player itself we would call this function with arguments of 16/9 and are within the content view--only that they exist. Just sum any extra width and height areas you have within the overall content view. -#### `win.previewFile(pathname[, filename])` _macOS_ +#### `win.previewFile(pathname[, displayName])` _macOS_ -* `pathname` String - The absolute path to the file to preview with QuickLook. This is important as Quicklook uses the file name and file extension on the path to determine the content_type of the file to open. -* `filename` String (Optional) - The name of the file to display on the QuickLook modal view. This is purely visual and does not affect the content_type of the file. Defaults to filepath. +* `path` String - The absolute path to the file to preview with QuickLook. This + is important as Quick Look uses the file name and file extension on the path to + determine the content type of the file to open. +* `displayName` String (Optional) - The name of the file to display on the + Quick Look modal view. This is purely visual and does not affect the content + type of the file. Defaults to `path`. -Uses QuickLook to preview a file at a given path. +Uses [Quick Look][quick-look] to preview a file at a given path. #### `win.setBounds(bounds[, animate])` @@ -1189,3 +1193,4 @@ Returns `BrowserWindow` - The parent window. Returns `BrowserWindow[]` - All child windows. [window-levels]: https://developer.apple.com/reference/appkit/nswindow/1664726-window_levels +[quick-look]: https://en.wikipedia.org/wiki/Quick_Look -- 2.7.4