Xojo Developer Conference
25/27th April 2018 in Denver.
MBS Xojo Conference
6/7th September 2018 in Munich, Germany.
25/27th April 2018 in Denver.
MBS Xojo Conference
6/7th September 2018 in Munich, Germany.
Platforms to show: All Mac Windows Linux Cross-Platform
NSWindowMBS.acceptsMouseMovedEvents as boolean
Function:
Whether the receiver is to accept mouse-moved events.
Notes:
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)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Cocoa | MBS MacBase Plugin | 8.4 | Yes | No | No | Yes, macOS only | No |
Notes:
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)
NSWindowMBS.allowsConcurrentViewDrawing as boolean
Function:
Whether threading of view drawing is enabled for this window.
Notes:
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)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Cocoa | MBS MacBase Plugin | 9.6 | Yes | No | No | Yes, macOS only | No |
Notes:
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
Function:
Whether this window displays tooltips even when the application is in the background.
Notes:
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)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Cocoa | MBS MacBase Plugin | 9.6 | Yes | No | No | Yes, macOS only | No |
Notes:
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
Function:
The receiver's alpha value.
Example:
Notes:
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Cocoa | MBS MacBase Plugin | 8.4 | Yes | No | No | Yes, macOS only | No |
Example:
if TargetCocoa then
dim w as new NSWindowMBS(window1)
w.alphaValue=0.5
else
MsgBox "this sample requires REALbasic Cocoa Target"
end if
NSWindowMBS.animationBehavior as Integer
Function:
Provides for per-window control over automatic orderFront/orderOut animation behaviors added in 10.7.
Example:
Notes:
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)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Cocoa | MBS MacBase Plugin | 11.2 | Yes | No | No | Yes, macOS only | No |
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
Function:
The window's aspect ratio, which constrains the size of its frame rectangle to integral multiples of this ratio when the user resizes it.
Notes: (Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Cocoa | MBS MacBase Plugin | 9.6 | Yes | No | No | Yes, macOS only | No |
Notes: (Read and Write property)
NSWindowMBS.Autodisplay as boolean
Function:
Whether the window automatically displays views that need to be displayed.
Notes:
Automatic display typically occurs on each pass through the event loop.
Available in Mac OS X v10.0 and later.
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Cocoa | MBS MacBase Plugin | 9.6 | Yes | No | No | Yes, macOS only | No |
Notes:
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
Function:
The window background color.
Notes: (Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Cocoa | MBS MacBase Plugin | 8.6 | Yes | No | No | Yes, macOS only | No |
Notes: (Read and Write property)
NSWindowMBS.backingLocation as Integer
Function:
Indicates the window's backing store location.
Notes:
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)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Cocoa | MBS MacBase Plugin | 9.6 | Yes | No | No | Yes, macOS only | No |
Notes:
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
Function:
Returns the backing scale factor.
Notes:
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)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Cocoa | MBS MacBase Plugin | 12.3 | Yes | No | No | Yes, macOS only | No |
Notes:
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
Function:
The window's backing store type.
Notes:
Use constants like this:
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Cocoa | MBS MacBase Plugin | 9.6 | Yes | No | No | Yes, macOS only | No |
Notes:
Use constants like this:
| NSBackingStoreRetained | = 0 | The 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 | = 1 | The 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 | = 2 | The 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. |
NSWindowMBS.canBecomeKeyWindow as boolean
Function:
Indicates whether the window can become the key window.
Notes:
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)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Cocoa | MBS MacBase Plugin | 9.6 | Yes | No | No | Yes, macOS only | No |
Notes:
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
Function:
Indicates whether the window can become the application's main window.
Notes:
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)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Cocoa | MBS MacBase Plugin | 9.6 | Yes | No | No | Yes, macOS only | No |
Notes:
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
Function:
Indicates whether the window can be displayed at the login window.
Notes:
Default: false.
Available in Mac OS X v10.5 and later.
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Cocoa | MBS MacBase Plugin | 9.6 | Yes | No | No | Yes, macOS only | No |
Notes:
Default: false.
Available in Mac OS X v10.5 and later.
(Read and Write property)
NSWindowMBS.canHide as boolean
Function:
Specifies whether the window can be hidden when its application becomes hidden (during execution of the NSApplication hide method).
Notes: (Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Cocoa | MBS MacBase Plugin | 8.6 | Yes | No | No | Yes, macOS only | No |
Notes: (Read and Write property)
NSWindowMBS.canStoreColor as boolean
Function:
Indicates whether the window has a depth limit that allows it to store color values.
Notes: (Read only property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Cocoa | MBS MacBase Plugin | 9.6 | Yes | No | No | Yes, macOS only | No |
Notes: (Read only property)
NSWindowMBS.className as string
Function:
The name of this NSWindow class.
Notes: (Read only property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Cocoa | MBS MacBase Plugin | 11.3 | Yes | No | No | Yes, macOS only | No |
Notes: (Read only property)
NSWindowMBS.classPath as string
Function:
The path of this NSView class.
Notes:
Useful for debugging to know what super classes the window has.
(Read only property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Cocoa | MBS MacBase Plugin | 11.3 | Yes | No | No | Yes, macOS only | No |
Notes:
Useful for debugging to know what super classes the window has.
(Read only property)
NSWindowMBS.collectionBehavior as Integer
Function:
Identifies the window's behavior in window collections.
Notes:
Available in Mac OS X v10.5 and later.
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Cocoa | MBS MacBase Plugin | 9.6 | Yes | No | No | Yes, macOS only | No |
Notes:
Available in Mac OS X v10.5 and later.
(Read and Write property)
NSWindowMBS.colorSpace as NSColorSpaceMBS
Function:
The window's color space.
Notes:
Available in Mac OS X v10.6 and later.
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Cocoa | MBS MacBase Plugin | 9.6 | Yes | No | No | Yes, macOS only | No |
Notes:
Available in Mac OS X v10.6 and later.
(Read and Write property)
NSWindowMBS.contentAspectRatio as NSSizeMBS
Function:
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.
Notes:
Available in Mac OS X v10.3 and later
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Cocoa | MBS MacBase Plugin | 9.6 | Yes | No | No | Yes, macOS only | No |
Notes:
Available in Mac OS X v10.3 and later
(Read and Write property)
NSWindowMBS.contentMaxSize as NSSizeMBS
Function:
The maximum size of the window's content view.
Notes:
Available in Mac OS X v10.3 and later.
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Cocoa | MBS MacBase Plugin | 9.6 | Yes | No | No | Yes, macOS only | No |
Notes:
Available in Mac OS X v10.3 and later.
(Read and Write property)
NSWindowMBS.contentMinSize as NSSizeMBS
Function:
The minimum size of the window's content view.
Notes:
Available in Mac OS X v10.3 and later.
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Cocoa | MBS MacBase Plugin | 9.6 | Yes | No | No | Yes, macOS only | No |
Notes:
Available in Mac OS X v10.3 and later.
(Read and Write property)
NSWindowMBS.contentResizeIncrements as NSSizeMBS
Function:
The window's content-view resizing increments.
Notes:
Available in Mac OS X v10.3 and later.
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Cocoa | MBS MacBase Plugin | 9.6 | Yes | No | No | Yes, macOS only | No |
Notes:
Available in Mac OS X v10.3 and later.
(Read and Write property)
NSWindowMBS.contentView as NSViewMBS
Function:
The receiver's content view, the highest accessible NSView object in the receiver's view hierarchy.
Notes: (Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Cocoa | MBS MacBase Plugin | 8.4 | Yes | No | No | Yes, macOS only | No |
Notes: (Read and Write property)
NSWindowMBS.currentEvent as NSEventMBS
Function:
Returns the event currently being processed by the application, by invoking NSApplication's currentEvent method.
Notes:
Returns the event being processed by the application.
(Read only property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Cocoa | MBS MacBase Plugin | 9.6 | Yes | No | No | Yes, macOS only | No |
Notes:
Returns the event being processed by the application.
(Read only property)
NSWindowMBS.deepestScreen as NSScreenMBS
Function:
Returns the deepest screen the window is on (it may be split over several screens).
Notes:
The deepest screen the window is on; nil when the window is offscreen.
(Read only property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Cocoa | MBS MacBase Plugin | 9.6 | Yes | No | No | Yes, macOS only | No |
Notes:
The deepest screen the window is on; nil when the window is offscreen.
(Read only property)
NSWindowMBS.depthLimit as Integer
Function:
Returns the depth limit of the window.
Notes:
The value returned can be examined with the Application Kit functions NSPlanarFromDepth, NSColorSpaceFromDepth, NSBitsPerSampleFromDepth, and NSBitsPerPixelFromDepth.
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Cocoa | MBS MacBase Plugin | 9.6 | Yes | No | No | Yes, macOS only | No |
Notes:
The value returned can be examined with the Application Kit functions NSPlanarFromDepth, NSColorSpaceFromDepth, NSBitsPerSampleFromDepth, and NSBitsPerPixelFromDepth.
(Read and Write property)
NSWindowMBS.displaysWhenScreenProfileChanges as boolean
Function:
Indicates whether the window context should be updated when the screen profile changes or when the window moves to a different screen.
Notes:
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)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Cocoa | MBS MacBase Plugin | 9.6 | Yes | No | No | Yes, macOS only | No |
Notes:
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)
The items on this page are in the following plugins: MBS MacBase Plugin.
Links
MBS Xojo tutorial videos