Window

Native window.

Constructors

Window(const Window::Options& options)

Create a new window with options.

Parameters

• const Window::Options& options

Class properties

const char* kClassName

The class name of window.

Methods

void Close()

Request to close the window.

bool HasFrame() const

Return whether window has a native frame.

Return

bool IsTransparent() const

Return whether window is transparent.

Return

void SetHasShadow(bool has)

Set whether window should have shadow.

Depending on platform, this may not work.

Parameters

• bool has

bool HasShadow() const

Return whether window has shadow.

Return

void SetContentView(scoped_refptr<View> view)

Set the content view of the window.

The content view will always be resized to fill window's client area.

Parameters

• scoped_refptr<View> view

View* GetContentView() const

Return the content view of the window.

Return

void Center()

Move the window to the center of the screen.

void SetContentSize(const SizeF& size)

Resize window to make the content view fit size.

Parameters

• const SizeF& size

SizeF GetContentSize() const

Return the size of content view.

Return

void SetBounds(const RectF& bounds)

Change the position and size of the window.

Parameters

• const RectF& bounds

RectF GetBounds() const

Return the position and size of the window.

Return

void SetSizeConstraints(const SizeF& minsize, const SizeF& maxsize)

Set the minimum and maximum sizes of the window.

Passing an empty size means no constraint.

Parameters

• const SizeF& minsize - Minimum size.
• const SizeF& maxsize - Maximum size.

std::tuple<SizeF, SizeF> GetSizeConstraints() const

Return minimum and maximum sizes of the window.

Return

void SetContentSizeConstraints(const SizeF& minsize, const SizeF& maxsize)

Set the minimum and maximum content sizes of the window.

Passing an empty size means no constraint.

Parameters

• const SizeF& minsize - Minimum content size.
• const SizeF& maxsize - Maximum content size.

std::tuple<SizeF, SizeF> GetContentSizeConstraints() const

Return minimum and maximum content sizes of the window.

Return

void Activate()

Show the window and activate it.

void Deactivate()

Move the focus away from the window.

bool IsActive() const

Return whether window has focus.

Return

void SetVisible(bool visible)

Show/hide the window.

Parameters

• bool visible

bool IsVisible() const

Return whether window is visible.

Return

void SetAlwaysOnTop(bool top)

Make the window always show above other normal windows.

Parameters

• bool top

bool IsAlwaysOnTop() const

Return whether window is always above other normal windows.

Return

void SetFullscreen(bool fullscreen)

Enter/leave fullscreen state.

Parameters

• bool fullscreen

bool IsFullscreen() const

Return whether window is in fullscreen.

Return

void Maximize()

Maximize the window.

void Unmaximize()

Unmaximize the window.

bool IsMaximized() const

Return whether window is maximized.

Return

void Minimize()

Minimize the window.

void Restore()

Restore the minimized window.

bool IsMinimized() const

Return whether window is minimized.

Return

void SetResizable(bool resizable)

Set whether window can be resized.

Parameters

• bool resizable

bool IsResizable() const

Return whether window can be resized.

Return

void SetMaximizable(bool maximizable)

Set whether window can be maximize.

Parameters

• bool maximizable

bool IsMaximizable() const

Return whether window can be maximize.

Return

void SetMinimizable(bool minimizable)

Set whether window can be minimized.

Parameters

• bool minimizable

bool IsMinimizable() const

Return whether window can be minimized.

Return

void SetMovable(bool movable)

Set whether window can be moved.

Parameters

• bool movable

bool IsMovable() const

Return whether window can be moved.

Return

void SetTitle(const std::string& title)

Set window title.

Parameters

• const std::string& title

std::string GetTitle() const

Get window title.

Return

void SetBackgroundColor(Color color)

Set the background color of the window.

Parameters

• Color color

float GetScaleFactor() const

Return the scale factor of the window.

Return

void SetToolbar(scoped_refptr<Toolbar> toolbar) macOS

Set the window toolbar.

Parameters

• scoped_refptr<Toolbar> toolbar

Toolbar* GetToolbar() const macOS

Return the window toolbar.

Return

void SetTitleVisible(bool visible) macOS

Set whether the title is visible, when title was hidden the toolber would be moved into the area previously occupied by the title.

Parameters

• bool visible

bool IsTitleVisible() const; macOS

Return whether title is visible.

Return

void SetFullSizeContentView(bool full) macOS

Set the NSWindowStyleMaskFullSizeContentView style on the window.

Parameters

• bool full

bool IsFullSizeContentView() const macOS

Return whether the window has NSWindowStyleMaskFullSizeContentView style.

Return

void SetSkipTaskbar(bool skip) Windows Linux

Set whether to hide the window from taskbar.

Parameters

• bool skip

void SetIcon(scoped_refptr<Image> icon) Windows Linux

Set the window icon.

Parameters

• scoped_refptr<Image> icon

void SetMenuBar(scoped_refptr<MenuBar> menubar) Windows Linux

Set the window menu bar.

Parameters

• scoped_refptr<MenuBar> menubar

MenuBar* GetMenuBar() const Windows Linux

Return the window menu bar.

Return

void SetMenuBarVisible(bool visible) Windows Linux

Set whether the window menu bar is visible.

The accelerators of menu items will still work when menu bar is hidden.

Calling SetMenu will reset the menu bar to visible.

Parameters

• bool visible

HWND GetHWND() const Windows

Return the HWND of the native window.

Return

Window* GetParentWindow() const

Return the parent window.

Return

void AddChildWindow(scoped_refptr<Window> child)

Make child a child window of this window.

This method will do nothing if child already has a parent window.

Parameters

• scoped_refptr<Window> child

void RemoveChildWindow(Window* child)

Remove this window as child's parent window.

Parameters

• Window* child

std::vector<Window*> GetChildWindows() const

Return all the child windows of this window.

Return

Events

void on_close(Window* self)

Emitted when the window is closed.

Parameters

• Window* self

Preventable

void on_focus(Window* self)

Emitted when the window is focused.

Parameters

• Window* self

Preventable

void on_blur(Window* self)

Emitted when the window lost focus.

Parameters

• Window* self

Preventable

Delegates

bool should_close(Window* self)

Called when user requests to close the window, should return whether the window can be closed.

Parameters

• Window* self

Return

Langauge:

Version:

Formats:

Constructors:

• Window(options)

Class properties:

• kClassName

Methods:

• Close()
• HasFrame()
• IsTransparent()
• SetHasShadow(has)
• HasShadow()
• SetContentView(view)
• GetContentView()
• Center()
• SetContentSize(size)
• GetContentSize()
• SetBounds(bounds)
• GetBounds()
• SetSizeConstraints(minsize, maxsize)
• GetSizeConstraints()
• SetContentSizeConstraints(minsize, maxsize)
• GetContentSizeConstraints()
• Activate()
• Deactivate()
• IsActive()
• SetVisible(visible)
• IsVisible()
• SetAlwaysOnTop(top)
• IsAlwaysOnTop()
• SetFullscreen(fullscreen)
• IsFullscreen()
• Maximize()
• Unmaximize()
• IsMaximized()
• Minimize()
• Restore()
• IsMinimized()
• SetResizable(resizable)
• IsResizable()
• SetMaximizable(maximizable)
• IsMaximizable()
• SetMinimizable(minimizable)
• IsMinimizable()
• SetMovable(movable)
• IsMovable()
• SetTitle(title)
• GetTitle()
• SetBackgroundColor(color)
• GetScaleFactor()
• SetToolbar(toolbar)
• GetToolbar()
• SetTitleVisible(visible)
• IsTitleVisible()
• SetFullSizeContentView(full)
• IsFullSizeContentView()
• SetSkipTaskbar(skip)
• SetIcon(icon)
• SetMenuBar(menubar)
• GetMenuBar()
• SetMenuBarVisible(visible)
• GetHWND()
• GetParentWindow()
• AddChildWindow(child)
• RemoveChildWindow(child)
• GetChildWindows()

Events:

• on_close(self)
• on_focus(self)
• on_blur(self)

Delegates:

• should_close(self)

Components:

• App
• Appearance
• AttributedText
• Browser
• Button
• Canvas
• Clipboard
• Color
• ComboBox
• Container
• Cursor
• DatePicker
• Entry
• FileDialog
• FileOpenDialog
• FileSaveDialog
• Font
• GifPlayer
• GlobalShortcut
• Group
• Image
• Label
• Lifetime
• Locale
• Menu
• MenuBar
• MenuBase
• MenuItem
• MessageLoop
• MessageBox
• Notification
• NotificationCenter
• Painter
• Picker
• ProgressBar
• ProtocolAsarJob
• ProtocolFileJob
• ProtocolJob
• ProtocolStringJob
• Responder
• Screen
• Scroll
• Separator
• SimpleTableModel
• Slider
• State
• Tab
• Table
• TableModel
• TextEdit
• Toolbar
• Tray
• Vibrant
• View
• Window