From c3049e1e991037ec9665d3fffb9bb65d31041c2d Mon Sep 17 00:00:00 2001 From: evgenyzinoviev Date: Tue, 19 Jan 2016 16:07:51 +0100 Subject: [PATCH] docs updated --- atom/browser/native_window_views.cc | 2 +- docs/api/browser-window.md | 47 ++++++++++++++++++++++++++--- 2 files changed, 44 insertions(+), 5 deletions(-) diff --git a/atom/browser/native_window_views.cc b/atom/browser/native_window_views.cc index 25e45ea6f1cf..d50b4cc2c845 100644 --- a/atom/browser/native_window_views.cc +++ b/atom/browser/native_window_views.cc @@ -789,7 +789,7 @@ bool NativeWindowViews::CanMaximize() const { } bool NativeWindowViews::CanMinimize() const { -#ifdef (OS_WIN) +#ifdef(OS_WIN) return minimizable_; #elif defined(USE_X11) return true; diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 17e598cb4660..820cf3e2b20b 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -47,13 +47,18 @@ It creates a new `BrowserWindow` with native properties as set by the `options`. * `maxWidth` Integer - Window's maximum width. Default is no limit. * `maxHeight` Integer - Window's maximum height. Default is no limit. * `resizable` Boolean - Whether window is resizable. Default is `true`. - * `movable` Boolean - Whether window is movable. This is only implemented - on OS X. Default is `true`. + * `movable` Boolean - Whether window is movable. This is not implemented + on Linux. Default is `true`. + * `minimizable` Boolean - Whether window is minimizable. This is not + implemented on Linux. Default is `true`. + * `closable` Boolean - Whether window is closable. This is not implemented + on Linux. Default is `true`. * `alwaysOnTop` Boolean - Whether the window should always stay on top of other windows. Default is `false`. * `fullscreen` Boolean - Whether the window should show in fullscreen. When - set to `false` the fullscreen button will be hidden or disabled on OS X. - Default is `false`. + explicity set to `false` the fullscreen button will be hidden or disabled + on OS X, or the maximize button will be disabled on Windows. Default is + `false`. * `skipTaskbar` Boolean - Whether to show the window in taskbar. Default is `false`. * `kiosk` Boolean - The kiosk mode. Default is `false`. @@ -523,6 +528,40 @@ Sets whether the window can be manually resized by user. Returns whether the window can be manually resized by user. +### `win.setMovable(movable)` _OS X_ _Windows_ + +* `movable` Boolean + +Sets whether the window can be moved by user. On Linux does nothing. + +### `win.isMovable()` _OS X_ _Windows_ + +Returns whether the window can be moved by user. On Linux always returns +`true`. + +### `win.setMinimizable(minimizable)` _OS X_ _Windows_ + +* `minimizable` Boolean + +Sets whether the window can be manually minimized by user. On Linux does +nothing. + +### `win.isMinimizable()` _OS X_ _Windows_ + +Returns whether the window can be manually minimized by user. On Linux always +returns `true`. + +### `win.setClosable(closable)` _OS X_ _Windows_ + +* `closable` Boolean + +Sets whether the window can be manually closed by user. On Linux does nothing. + +### `win.isClosable()` _OS X_ _Windows_ + +Returns whether the window can be manually closed by user. On Linux always +returns `true`. + ### `win.setAlwaysOnTop(flag)` * `flag` Boolean