Platforms to show: All Mac Windows Linux Cross-Platform

Back to NSWindowMBS class.

Next items

NSWindowMBS.acceptsMouseMovedEvents as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 8.4 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Whether the receiver is to accept mouse-moved events.

True to have the receiver accept mouse-moved events (and to distribute them to its responders); false to not accept such events.
(Read and Write property)

Some examples using this property:

NSWindowMBS.allowsConcurrentViewDrawing as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Whether threading of view drawing is enabled for this window.

Whether threading of view drawing should be enabled for this window. Defaults to true. When this is set to true, AppKit's view system is allowed to perform drawRect activity for the window's views on threads other than the main thread, for views that have canDrawConcurrently = true. When this is set to false, the window's views will be drawn serially as on 10.5 and earlier, even though some of the views may have canDrawConcurrently = true.

Available on Mac OS X 10.6.
(Read and Write property)

NSWindowMBS.allowsToolTipsWhenApplicationIsInactive as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Whether this window displays tooltips even when the application is in the background.

Default is false. Set to true to allow a window to display tooltips even when the application is in the background. Note that, enabling tooltips in an inactive application will cause the app to do work any time the mouse passes over the window. This can degrade system performance.
(Read and Write property)

NSWindowMBS.alphaValue as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 8.4 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The receiver's alpha value.
Example
if TargetCocoa then
dim w as new NSWindowMBS(window1)
w.alphaValue=0.5
else
MsgBox "this sample requires Xojo Cocoa Target"
end if

(Read and Write property)

NSWindowMBS.animationBehavior as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 11.2 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Provides for per-window control over automatic orderFront/orderOut animation behaviors added in 10.7.
Example
dim w as new NSWindowMBS(window1)

w.animationBehavior = NSWindowMBS.NSWindowAnimationBehaviorDocumentWindow

Title = str(W.animationBehavior)

Can be set to NSWindowAnimationBehaviorNone to disable Appkit's automatic animations for a given window, or to one of the other non-Default NSWindowAnimationBehavior values to override AppKit's automatic inference of appropriate animation behavior based on the window's apparent type.
Available on Mac OS X 10.7 or later.
(Read and Write property)

NSWindowMBS.aspectRatio as NSSizeMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The window's aspect ratio, which constrains the size of its frame rectangle to integral multiples of this ratio when the user resizes it.

(Read and Write property)

NSWindowMBS.Autodisplay as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Whether the window automatically displays views that need to be displayed.

Automatic display typically occurs on each pass through the event loop.

Available in Mac OS X v10.0 and later.
(Read and Write property)

NSWindowMBS.backgroundColor as NSColorMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 8.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The window background color.

(Read and Write property)

NSWindowMBS.backingLocation as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Indicates the window's backing store location.

The location of the window's backing store. See "Constants" for possible values.
Available in Mac OS X v10.5 and later.
(Read only property)

NSWindowMBS.backingScaleFactor as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 12.3 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Returns the backing scale factor.

Returns 2.0 for high resolution scaled display modes, and 1.0 for all other cases.

There are some scenarios where an application that is resolution-aware may want to reason on its own about the display environment it is running in.

It is important to note that this number returned by this method does not represent anything concrete, such as pixel density or physical size, since it can vary based on the configured display mode. For example, the display may be in a mirrored configuration that is still high resolution scaled, resulting in pixel geometry that may not match the native resolution of the display device.

Note: For almost all common cases, developers should avoid using the backingScaleFactor as an input to layout or drawing calculations. Developers should instead use the backing coordinate space conversion methods instead, as the resulting code will more likely work consistently and correctly under both low and high resolution operation.

For apps which are not enabled for retina support, the function returns 1. So you only see 2 here if app is Cocoa, display is retina and info.plist has the NSHighResolutionCapable key.
(Read only property)

NSWindowMBS.backingType as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The window's backing store type.

Use constants like this:

NSBackingStoreRetained= 0The window uses a buffer, but draws directly to the screen where possible and to the buffer for obscured portions. You should not use this mode. It combines the limitations of NSBackingStoreNonretained with the memory use of NSBackingStoreBuffered. The original NeXTSTEP implementation was an interesting compromise that worked well with fast memory mapped framebuffers on the CPU bus—something that hasn't been in general use since around 1994. These tend to have performance problems. In Mac OS X 10.5 and later, requests for retained windows will result in the window system creating a buffered window, as that better matches actual use. Available in Mac OS X v10.0 and later.
NSBackingStoreNonretained= 1The window draws directly to the screen without using any buffer. You should not use this mode. It exists primarily for use in the original Classic Blue Box. It does not support Quartz drawing, alpha blending, or opacity. Moreover, it does not support hardware acceleration, and interferes with system-wide display acceleration. If you use this mode, your application must manage visibility region clipping itself, and manage repainting on visibility changes. Available in Mac OS X v10.0 and later.
NSBackingStoreBuffered= 2The window renders all drawing into a display buffer and then flushes it to the screen. You should use this mode. It supports hardware acceleration, Quartz drawing, and takes advantage of the GPU when possible. It also supports alpha channel drawing, opacity controls, using the compositor. Available in Mac OS X v10.0 and later.
(Read and Write property)

Some examples using this property:

NSWindowMBS.canBecomeKeyWindow as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Indicates whether the window can become the key window.

Attempts to make the window the key window are abandoned if this method returns false. The NSWindow implementation returns true if the window has a title bar or a resize bar, or false otherwise.
(Read only property)

NSWindowMBS.canBecomeMainWindow as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Indicates whether the window can become the application's main window.

Attempts to make the window the main window are abandoned if this method returns false. The NSWindow implementation returns true if the window is visible, is not an NSPanel object, and has a title bar or a resize mechanism. Otherwise it returns false.
(Read only property)

NSWindowMBS.canBecomeVisibleWithoutLogin as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Indicates whether the window can be displayed at the login window.

Default: false.
Available in Mac OS X v10.5 and later.
(Read and Write property)

NSWindowMBS.canHide as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 8.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Specifies whether the window can be hidden when its application becomes hidden (during execution of the NSApplication hide method).

(Read and Write property)

NSWindowMBS.canStoreColor as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Indicates whether the window has a depth limit that allows it to store color values.

(Read only property)

NSWindowMBS.className as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 11.3 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The name of this NSWindow class.

(Read only property)

NSWindowMBS.classPath as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 11.3 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The path of this NSView class.

Useful for debugging to know what super classes the window has.
(Read only property)

NSWindowMBS.collectionBehavior as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Identifies the window's behavior in window collections.

Available in Mac OS X v10.5 and later.
(Read and Write property)

NSWindowMBS.colorSpace as NSColorSpaceMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 9.6 ✅ Yes ❌ No ❌ No ❌ No Desktop only
The window's color space.

Available in Mac OS X v10.6 and later.
(Read and Write property)

NSWindowMBS.contentAspectRatio as NSSizeMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The aspect ratio (height in relation to width) of the window's content view, constraining the dimensions of its content rectangle to integral multiples of that ratio when the user resizes it.

Available in Mac OS X v10.3 and later
(Read and Write property)

NSWindowMBS.contentLayoutRect as NSRectMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 21.4 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The area inside the window that is for non-obscured content, in window coordinates.

Typically, the area represented by this property is the same as the frame of the contentView. However, for windows with NSFullSizeContentViewWindowMask set, there needs to be a way to determine the portion that is not under the toolbar. The contentLayoutRect property contains the portion of the layout that is not obscured under the toolbar.
(Read only property)

NSWindowMBS.contentMaxSize as NSSizeMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The maximum size of the window's content view.

Available in Mac OS X v10.3 and later.
(Read and Write property)

NSWindowMBS.contentMinSize as NSSizeMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The minimum size of the window's content view.

Available in Mac OS X v10.3 and later.
(Read and Write property)

NSWindowMBS.contentResizeIncrements as NSSizeMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The window's content-view resizing increments.

Available in Mac OS X v10.3 and later.
(Read and Write property)

NSWindowMBS.contentView as NSViewMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 8.4 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The receiver's content view, the highest accessible NSView object in the receiver's view hierarchy.

(Read and Write property)

NSWindowMBS.currentEvent as NSEventMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Returns the event currently being processed by the application, by invoking NSApplication's currentEvent method.

Returns the event being processed by the application.
(Read only property)

NSWindowMBS.deepestScreen as NSScreenMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Returns the deepest screen the window is on (it may be split over several screens).

The deepest screen the window is on; nil when the window is offscreen.
(Read only property)

NSWindowMBS.depthLimit as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Returns the depth limit of the window.

The value returned can be examined with the Application Kit functions NSPlanarFromDepth, NSColorSpaceFromDepth, NSBitsPerSampleFromDepth, and NSBitsPerPixelFromDepth.
(Read and Write property)

NSWindowMBS.displaysWhenScreenProfileChanges as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Indicates whether the window context should be updated when the screen profile changes or when the window moves to a different screen.

Returns true when the window context should be updated when the screen profile changes or when the window moves to a different screen; otherwise, false.

The default value is false.

Available in Mac OS X v10.4 and later.
(Read and Write property)

NSWindowMBS.frame as NSRectMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The window's frame rectangle.

(Read only property)

NSWindowMBS.hasDynamicDepthLimit as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Indicates whether the window's depth limit can change to match the depth of the screen it's on.

True when the window has a dynamic depth limit; otherwise, false.
(Read and Write property)

NSWindowMBS.hasShadow as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 8.4 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Whether the receiver has a shadow.

True when the receiver has a shadow, false when it doesn't.
(Read and Write property)

NSWindowMBS.Height as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
Property Cocoa MBS MacBase Plugin 8.2 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The height of the color panel in pixel.

(Read and Write property)

NSWindowMBS.hidesOnDeactivate as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 8.4 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Whether the receiver is removed from the screen when its application becomes inactive.

True when the receiver is removed from the screen when its application is deactivated; false if it remains onscreen.

The default for NSWindow is false; the default for NSPanel is true.
(Read and Write property)

NSWindowMBS.identifier as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 13.2 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
A string that identifies this user interface item.
Example
dim w as new NSWindowMBS(window1)

w.identifier = "window1"
MsgBox w.identifier

It should be set to a unique value on NSViews when they are intended to be used inside a view-based NSTableView. Identifiers should be unique per-window. For programmatically created user interface items, you would typically set this value in code after creating a control but before adding it to a window. You may also want to set an identifier on a window, after creating it programmatically, to identify the window easily when it is reopened. You should not change the identifier after a control is added to a window. Identifiers beginning with an underscore are reserved for the system. In framework classes that implement this protocol, the accessor methods are not intended to be overridden.

To help avoid collision of identifiers, it is recommended that identifiers use the same prefix as is used for the framework or application. For example, identifiers for standard AppKit interface items, such as the open panel, will begin with "NS".

The slash '/', backslash '\', and colon ':' characters are reserved and should not be used in identifiers.
(Read and Write property)

NSWindowMBS.ignoresMouseEvents as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 8.4 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Indicates whether the receiver is transparent to mouse events.

True when the receiver is transparent to mouse events, otherwise false.
(Read and Write property)

NSWindowMBS.initialFirstResponder as NSViewMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The view that's made first responder the first time the window is placed onscreen.

(Read and Write property)

NSWindowMBS.isDocumentEdited as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 8.4 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Indicates whether the receiver's document has been edited.

True when the receiver's document has been edited; false otherwise.
Initially, by default, NSWindow objects are in the "not edited" state.
(Read and Write property)

NSWindowMBS.isExcludedFromWindowsMenu as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 8.4 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Whether the receiver's title is omitted from the application's Windows menu.

True to specify that the receiver is to be omitted from the application's Windows menu; false to specify otherwise.
(Read and Write property)

NSWindowMBS.isFlushWindowDisabled as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Indicates whether the window's flushing ability is disabled.

(Read only property)

NSWindowMBS.isKeyWindow as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Indicates whether the window is the key window for the application.

(Read only property)

Some examples using this property:

NSWindowMBS.isMainWindow as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Indicates whether the window is the application's main window.

(Read only property)

NSWindowMBS.isMiniaturized as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 8.4 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Whether the receiver is minimized.

A minimized window is removed from the screen and replaced by a image, icon, or button that represents it, called the counterpart.
(Read only property)

NSWindowMBS.isMovableByWindowBackground as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 8.4 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
A Boolean value that indicates whether the receiver is movable by clicking and dragging anywhere in its background.

True when the window is movable by clicking and dragging anywhere in its background, otherwise false.

A window with a style mask of NSTexturedBackgroundWindowMask is movable by background by default. Sheets and drawers cannot be movable by window background.

Available in Mac OS X v10.2 and later.
Works in Xojo 2011r3, but not in 2011r4.
(Read and Write property)

Some examples using this property:

NSWindowMBS.isOnActiveSpace as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Indicates whether the window is on the currently active space.

For visible windows, this method indicates whether the window is currently visible on the active space. For offscreen windows, it indicates whether ordering the window onscreen would cause it to be on the active space.
Available in Mac OS X v10.6 and later.
(Read only property)

NSWindowMBS.isOneShot as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Indicates whether the window device the window manages is freed when it's removed from the screen list.

(Read and Write property)

NSWindowMBS.isOpaque as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 8.4 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Whether the receiver is opaque.

True when the receiver is opaque; false otherwise.
(Read and Write property)

NSWindowMBS.isSheet as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Cocoa MBS MacBase Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Indicates whether the window has ever run as a modal sheet.

Sheets are created using the NSPanel subclass.
Available in Mac OS X v10.1 and later.
(Read only property)

Next items

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


The biggest plugin in space...