Platforms to show: All Mac Windows Linux Cross-Platform

Back to GTKWindowMBS class.

GTKWindowMBS.AcceptFocus as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Window MBS Linux Plugin 13.0 ❌ No ❌ No ✅ Yes ❌ No Desktop only
Get/Set whether window should receive focus.

Windows may set a hint asking the desktop environment not to receive the input focus. This function sets this hint.
(Read and Write computed property)

GTKWindowMBS.Constructor(win as DesktopWindow)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Window MBS Linux Plugin 22.0 ❌ No ❌ No ✅ Yes ❌ No Desktop only
Creates a new GTKWindow object pointing to a given window.

Raises exception on Mac/Win to prevent you from creating invalid object.

See also:

GTKWindowMBS.Constructor(win as window)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Window MBS Linux Plugin 13.0 ❌ No ❌ No ✅ Yes ❌ No Desktop only
Creates a new GTKWindow object pointing to a given window.

Raises exception on Mac/Win to prevent you from creating invalid object.

See also:

GTKWindowMBS.Deiconify

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Window MBS Linux Plugin 13.0 ❌ No ❌ No ✅ Yes ❌ No Desktop only
Asks to deiconify (i.e. unminimize) the specified window.

Note that you shouldn't assume the window is definitely deiconified afterward, because other entities (e.g. the user or window manager) could iconify it again before your code which assumes deiconification gets to run.

GTKWindowMBS.Fullscreen

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Window MBS Linux Plugin 13.0 ❌ No ❌ No ✅ Yes ❌ No Desktop only
Asks to place window in the fullscreen state.

Note that you shouldn't assume the window is definitely full screen afterward, because other entities (e.g. the user or window manager) could unfullscreen it again, and not all window managers honor requests to fullscreen windows. But normally the window will end up fullscreen. Just don't write code that crashes if not.

GTKWindowMBS.Iconify

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Window MBS Linux Plugin 13.0 ❌ No ❌ No ✅ Yes ❌ No Desktop only
Asks to iconify (i.e. minimize) the specified window.

Note that you shouldn't assume the window is definitely iconified afterward, because other entities (e.g. the user or window manager) could deiconify it again, or there may not be a window manager in which case iconification isn't possible, etc. But normally the window will end up iconified. Just don't write code that crashes if not.

It's permitted to call this function before showing a window, in which case the window will be iconified before it ever appears onscreen.

GTKWindowMBS.IsComposited as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Window MBS Linux Plugin 13.0 ❌ No ❌ No ✅ Yes ❌ No Desktop only
Whether this window can rely on having its alpha channel drawn correctly.

On X11 this function returns whether a compositing manager is running for window's screen.

Some examples using this method:

GTKWindowMBS.Maximize

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Window MBS Linux Plugin 13.0 ❌ No ❌ No ✅ Yes ❌ No Desktop only
Asks to maximize window, so that it becomes full-screen.

Note that you shouldn't assume the window is definitely maximized afterward, because other entities (e.g. the user or window manager) could unmaximize it again, and not all window managers support maximization. But normally the window will end up maximized. Just don't write code that crashes if not.

It's permitted to call this function before showing a window, in which case the window will be maximized when it appears onscreen initially.

GTKWindowMBS.Opacity as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Window MBS Linux Plugin 13.0 ❌ No ❌ No ✅ Yes ❌ No Desktop only
Get or set the Opacity of this window.

Request the windowing system to make window partially transparent, with opacity 0 being fully transparent and 1 fully opaque. (Values of the opacity parameter are clamped to the [0,1] range.) On X11 this has any effect only on X screens with a compositing manager running. See isComposited.
(Read and Write computed property)

GTKWindowMBS.Resizable as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Window MBS Linux Plugin 13.0 ❌ No ❌ No ✅ Yes ❌ No Desktop only
Get or set whether the user can resize a window.

(Read and Write computed property)

GTKWindowMBS.SetIcon(pic as picture)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Window MBS Linux Plugin 14.0 ❌ No ❌ No ✅ Yes ❌ No Desktop only
Assigns an icon to the picture.

The operation system will scale the picture to required size, so please use bigger images.
Please use picture with alpha channel for best result.

GTKWindowMBS.SetKeepAbove(setting as boolean)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Window MBS Linux Plugin 13.0 ❌ No ❌ No ✅ Yes ❌ No Desktop only
Asks to keep window above, so that it stays on top.

Note that you shouldn't assume the window is definitely above afterward, because other entities (e.g. the user or window manager) could not keep it above, and not all window managers support keeping windows above. But normally the window will end kept above. Just don't write code that crashes if not.

It's permitted to call this function before showing a window, in which case the window will be kept above when it appears onscreen initially.

Note that, according to the Extended Window Manager Hints specification, the above state is mainly meant for user preferences and should not be used by applications e.g. for drawing attention to their dialogs.

Some examples using this method:

GTKWindowMBS.SetKeepBelow(setting as boolean)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Window MBS Linux Plugin 13.0 ❌ No ❌ No ✅ Yes ❌ No Desktop only
Asks to keep window below, so that it stays in bottom.

Note that you shouldn't assume the window is definitely below afterward, because other entities (e.g. the user or window manager) could not keep it below, and not all window managers support putting windows below. But normally the window will be kept below. Just don't write code that crashes if not.

It's permitted to call this function before showing a window, in which case the window will be kept below when it appears onscreen initially.

Note that, according to the Extended Window Manager Hints specification, the above state is mainly meant for user preferences and should not be used by applications e.g. for drawing attention to their dialogs.

Some examples using this method:

GTKWindowMBS.Stick

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Window MBS Linux Plugin 13.0 ❌ No ❌ No ✅ Yes ❌ No Desktop only
Asks to stick window, which means that it will appear on all user desktops.

Note that you shouldn't assume the window is definitely stuck afterward, because other entities (e.g. the user or window manager) could unstick it again, and some window managers do not support sticking windows. But normally the window will end up stuck. Just don't write code that crashes if not.

It's permitted to call this function before showing a window.

GTKWindowMBS.Title as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Window MBS Linux Plugin 13.0 ❌ No ❌ No ✅ Yes ❌ No Desktop only
Get or set the window title.

The title of a window will be displayed in its title bar; on the X Window System, the title bar is rendered by the window manager, so exactly how the title appears to users may vary according to a user's exact configuration. The title should help a user distinguish this window from other windows they may have open. A good title might include the application name and current document filename, for example.
(Read and Write computed property)

GTKWindowMBS.Unfullscreen

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Window MBS Linux Plugin 13.0 ❌ No ❌ No ✅ Yes ❌ No Desktop only
Asks to toggle off the fullscreen state for window.

Note that you shouldn't assume the window is definitely not full screen afterward, because other entities (e.g. the user or window manager) could fullscreen it again, and not all window managers honor requests to unfullscreen windows. But normally the window will end up restored to its normal state. Just don't write code that crashes if not.

GTKWindowMBS.Unmaximize

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Window MBS Linux Plugin 13.0 ❌ No ❌ No ✅ Yes ❌ No Desktop only
Asks to unmaximize window.

Note that you shouldn't assume the window is definitely unmaximized afterward, because other entities (e.g. the user or window manager) could maximize it again, and not all window managers honor requests to unmaximize. But normally the window will end up unmaximized. Just don't write code that crashes if not.

GTKWindowMBS.Unstick

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Window MBS Linux Plugin 13.0 ❌ No ❌ No ✅ Yes ❌ No Desktop only
Asks to unstick window, which means that it will appear on only one of the user's desktops.

Note that you shouldn't assume the window is definitely unstuck afterward, because other entities (e.g. the user or window manager) could stick it again. But normally the window will end up stuck. Just don't write code that crashes if not.

Some examples using this method:

The items on this page are in the following plugins: MBS Linux Plugin.


The biggest plugin in space...