From ccee3e1fc2d52cdc68fb2e4669a3e820facb35ee Mon Sep 17 00:00:00 2001 From: Kevin Sawicki Date: Thu, 14 Jul 2016 15:54:57 -0700 Subject: [PATCH] Document setThumbnailClip --- atom/browser/api/atom_api_window.h | 2 +- docs/api/browser-window.md | 7 +++++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index f681e1c036..7736f835f7 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -179,7 +179,7 @@ class Window : public mate::TrackableObject, bool IsWindowMessageHooked(UINT message); void UnhookWindowMessage(UINT message); void UnhookAllWindowMessages(); - bool SetThumbnailClip(const gfx::Rect& window_region); + bool SetThumbnailClip(const gfx::Rect& region); #endif #if defined(TOOLKIT_VIEWS) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index e8999e3451..c7ed4aa3d2 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -985,6 +985,13 @@ The `flags` is an array that can include following `String`s: button state is drawn. This value is intended for instances where the button is used in a notification. +#### `win.setThumbnailClip(region)` _Windows_ + +* `region` - Object with `x`, `y`, `width`, and `height` properties. + +Sets the region of the window to show as the thumbnail image displayed when +hovering over the window in the taskbar. + #### `win.showDefinitionForSelection()` _macOS_ Same as `webContents.showDefinitionForSelection()`.