Xojo Developer Conference
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

Previous items Next items

Window.HasVerticalZoomButtonMBS as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Util Plugin Yes No No No No
Function: Returns true if this window can be resized vertically.
Example:
mainwindow.HasHorizontalZoomButtonMBS=false 'remove resizebox
mainwindow.HasVerticalZoomButtonMBS=false
This item is deprecated and should no longer be used. You can use NSWindowMBS for Cocoa instead.
Notes:
You can read the state on Mac Classic, but you can only change it on Mac Carbon.
Returns false on any error.

In Realbasic 2005 and newer you need to use self. in front of the method as the propertyname alone is not accepted.
(Read and Write computed property)

Some examples which use this property:

Feedback, Comments & Corrections

HideAllFloatingWindowsMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
global method Window MBS Util Plugin Yes No No No No
Function: Hides all floating windows windows.
Example:
HideAllFloatingWindowsMBS
Notes: You should hide floating windows before showing a dialog.

Feedback, Comments & Corrections

Window.HideOnFullScreenMBS as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Util Plugin 3.2 Yes No No No No
Function: The window will hide itself if full screen mode is entered by an application or another window.
Example:
Window1.HideOnFullScreenMBS=true
Notes:
This window is automatically hidden during fullscreen mode (when the menubar is invisible) and shown afterwards. Available for all windows. This attribute is automatically given to utility windows.

You can read the state on Mac Classic, but you can only change it on Mac Carbon.
Returns false on any error.

In Realbasic 2005 and newer you need to use self. in front of the method as the propertyname alone is not accepted.
(Read and Write computed property)

Feedback, Comments & Corrections

Window.HideOnSuspendMBS as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Util Plugin 3.2 Yes No No No No
Function: The window will hide itself if the application goes to background.
Example:
Window1.HideOnSuspendMBS=false
Notes:
This window is automatically hidden on suspend and shown on resume. Available for all windows. This attribute is automatically given to floating windows.

You can read the state on Mac Classic, but you can only change it on Mac Carbon.
Returns false on any error.

In Realbasic 2005 and newer you need to use self. in front of the method as the propertyname alone is not accepted.
(Read and Write computed property)

Feedback, Comments & Corrections

Window.IgnoreClicksMBS as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Util Plugin 3.2 Yes No No No No
Function: Can be used to control whether mouse clicks are ignored for this window.
Example:
Window1.IgnoreClicksMBS=true
Notes:
Whether this window never receives mouse events, even in areas that are opaque. Instead, clicks on the window will be passed through to windows beneath it. Available for all windows on Mac OS X 10.2 and later.

You can read the state on Mac Classic, but you can only change it on Mac Carbon.
Returns false on any error.

In Realbasic 2005 and newer you need to use self. in front of the method as the propertyname alone is not accepted.

Added Cocoa support in plugin version 10.0.
(Read and Write computed property)

Some examples which use this property:

Feedback, Comments & Corrections

window.InvalidateShadowMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Window MBS MacOSX Plugin 8.7 Yes No No No No
Function: This method causes a window's shadow to be recalculated.
Notes:
InvalidateShadowMBS is not typically used by applications. However, it may be useful for applications with customized window frames that change shape dynamically; in this case, after the application has drawn the new window shape, the window shadow must be recalculated to follow the new window shape.

This method causes the window shadow to be immediately recalculated and redrawn based on the current contents of the window's back buffer. For best performance and visual appearance, you should follow these steps when invalidating a window shadow: disable updates with DisableScreenUpdatesMBS, draw, flush, invalidate the shadow, and enable updates. For a compositing window, after invalidating any views that should be redrawn, you will need to explicitly draw and flush using HIWindowFlush, rather than waiting for the event loop to draw and flush the window, because you cannot disable updates or invalidate the window shadow if drawing is done via the event loop.

Requires Mac OS X 10.4 and should do nothing on 10.3.

Feedback, Comments & Corrections

Window.InWindowMenuMBS as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Util Plugin Yes No No No No
Function: Decides whether the window is inside the Window menu.
Example:
mainwindow.InWindowMenuMBS=false 'remove from window menu
This item is deprecated and should no longer be used. You can use NSWindowMBS for Cocoa instead.
Notes:
This window is added to the standard Window menu. Available for document windows.

In Realbasic 2005 and newer you need to use self. in front of the method as the propertyname alone is not accepted.
(Read and Write computed property)

Feedback, Comments & Corrections

Window.IsIconicMBS as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Util Plugin No Yes No No No
Function: Returns true if this window is inside the taskbar.
Example:
MsgBox str(window1.IsIconicMBS)
Notes:
If you set IsIconic to true the window is minimized and if you set it to false the window size and position is restored.
In Realbasic 2005 and newer you need to use self. in front of the method as the propertyname alone is not accepted.
(Read and Write computed property)

Some examples which use this property:

Feedback, Comments & Corrections

window.IsMetalWindowMBS as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Util Plugin 7.4 Yes No No No No
Function: Whether this window uses the Metal appearance.
Example:
if window1.Frame = window.FrameTypeMetal then
MsgBox "Window is metal. "+str(window1.IsMetalWindowMBS)
else
MsgBox "Window is not metal. "+str(window1.IsMetalWindowMBS)
end if
Notes:
Available for document windows on Mac OS X 10.2 and later, and for floating windows on Mac OS X 10.3 and later. Drawers can also be metal, but dynamically adjust their appearance based on their parent window's appearance; it is not necessary to specify this attribute for a metal drawer.

You can read the state on Mac Classic, but you can only change it on Mac Carbon.
Returns false on any error.

In Realbasic 2005 and newer you need to use self. in front of the method as the propertyname alone is not accepted.
(Read and Write computed property)

Feedback, Comments & Corrections

window.IsOpaqueForEventsMBS as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Util Plugin 7.4 Yes No No No No
Function: Whether this window receives mouse events even for areas of the window that are transparent (have an alpha channel component of zero).
Example:
Window1.IsOpaqueForEventsMBS=false
This item is deprecated and should no longer be used. You can use NSWindowMBS for Cocoa instead.
Notes:
Available for windows of kOverlayWindowClass on Mac OS X 10.0 and 10.1, and available for all windows on Mac OS X 10.2 and later.

You can read the state on Mac Classic, but you can only change it on Mac Carbon.
Returns false on any error.

In Realbasic 2005 and newer you need to use self. in front of the method as the propertyname alone is not accepted.
(Read and Write computed property)

Feedback, Comments & Corrections

window.IsResizableMBS as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Util Plugin 7.4 Yes No No No No
Function: Whether this window is resizeable.
Example:
Window1.IsResizableMBS=false
Notes:
You can read the state on Mac Classic, but you can only change it on Mac Carbon.
Returns false on any error.

Use GrowBoxTransparentMBS on Composite Mac OS X windows to enable the transparent grow box.

In Realbasic 2005 and newer you need to use self. in front of the method as the propertyname alone is not accepted.

Works in Cocoa.
(Read and Write computed property)

Some examples which use this property:

Feedback, Comments & Corrections

Window.IsZoomedMacMBS as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Util Plugin 3.2 Yes No No No No
Function: Returns true if the window is zoomed.
Example:
MsgBox str(window1.IsZoomedMacMBS)
Notes:
Requires Mac OS 8.5 or newer.
Seems not to work correctly on RB 5.5.
In Realbasic 2005 and newer you need to use self. in front of the method as the propertyname alone is not accepted.

Added Cocoa support in plugin version 10.0.
(Read and Write computed property)

Feedback, Comments & Corrections

Window.IsZoomedMBS as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Util Plugin No Yes No No No
Function: Returns true if this window has been maximized.
Example:
MsgBox str(window1.IsZoomedMBS)
Notes:
If you set IsZoomed to true the window is maximized and if you set it to false the window size and position is restored.
In Realbasic 2005 and newer you need to use self. in front of the method as the propertyname alone is not accepted.

Works on Cocoa.
(Read and Write computed property)

Some examples which use this property:

Feedback, Comments & Corrections

Window.MakeTransparentMBS as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Window MBS Util Plugin 5.0 Yes Yes Yes No No
Function: Installs transparency support to a REALbasic window.
Example:
dim p as Integer // property on Windows

p = window1.MakeTransparentMBS

// later in close event

window1.CleanUpTransparentMBS p
Notes:
Will return non zero value if successfull.
The window doesn't change if you don't use the CGContextMBS property.

Requires Mac OS X, Windows 2000 or Windows XP to work. The window must be a document window.

Set MacProcID of the window to 1104 and you can make it transparent without a title bar. (on Mac OS X)

With plugin version 11.1, we now return a value which should store with the window. Later in the Close event, you call CleanUpTransparentMBS passing this value.

Added Cocoa support in 11.3 plugins.
Linux supported added with 14.0, but works only with Linux desktop which support alpha channel. Calls to MakeTransparentMBS and CleanUpTransparentMBS are not required for Linux.

Some examples which use this method:

Feedback, Comments & Corrections

window.MetalNoContentSeparatorMBS as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Util Plugin 8.1 Yes No No No No
Function: Whether there should be a content separator on a metal window.
Example:
if window1.Frame = window.FrameTypeMetal then
window1.MetalNoContentSeparatorMBS = true
end if
This item is deprecated and should no longer be used. You can use NSWindowMBS for Cocoa instead.
Notes:
Indicates that no border should be drawn between the toolbar and window content. Relevant only in textured windows. Ignored in non-textured windows. Available in Mac OS X 10.4 and later for window classes that support the textured appearance.
(Read and Write computed property)

Feedback, Comments & Corrections

Window.ModifiedMBS as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Util Plugin Yes No No No No
Function: You can set or get the value of the modified state.
Example:
mainwindow.modifiedMBS=true
Notes:
Requires Mac OS 8.5 or newer.
As long as you don't set modified to false the window keeps to tell you that it's modified. Not sure why, so just set modified to false early in creating the window.

Added Cocoa support in plugin version 10.0.
(Read and Write computed property)

Some examples which use this property:

Feedback, Comments & Corrections

window.SetContentBorderThicknessMBS(left as Double, top as Double, right as Double, bottom as Double) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Window MBS Util Plugin 11.2 Yes No No No No
Function: Sets the thickness of the window border that extends into the content area of the window.
This item is deprecated and should no longer be used. You can use NSWindowMBS for Cocoa instead.
Notes:
In Mac OS X 10.5, windows can have a gradient on the top and bottom section of the window which have the appearance and behavior of being part of the window frame. The window frame gradient is drawn or extended into this border and the window is draggable from this area. Functionally, the area actually extends into the content of the window where the client can embed controls or print status messages a la iTunes. This can be set on all non-floating windows.

Requires Mac OS X 10.5 and a carbon composite window. For Cocoa, please use methods in NSWindowMBS class.

left/top/right/bottom: Values that indicates how much of the content area is used for the frame gradient drawing. Currently only the top and bottom fields are allowed. If any value other than 0 is used for the left or right fields, this function will return false.

Returns true on success and false on failure.

Some examples which use this method:

Feedback, Comments & Corrections

Window.SetTransparencyMBS(value as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Window MBS Util Plugin 5.0 Yes Yes Yes No No
Function: Your window can have transparency on Mac OS X.
Example:
if window1.SetTransparencyMBS(127) then
'fine
else
'error
end if
Notes:
Use values between 0 and 255.
Requires Mac OS X, Windows 2000 or Windows XP to work.
May be limited to simple windows like normal document windows.
You need to call MakeTransparent before to install transparency.
(this function was replaced in v4.4)
Linux supported added with 14.0, but works only with Linux desktop which support alpha channel.

Some examples which use this method:

Feedback, Comments & Corrections

window.SetWindowBoundsMBS(x as Integer, y as Integer, w as Integer, h as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Window MBS Util Plugin 8.4 Yes No No No No
Function: Sets the window structure size.
Example:
call window1.SetWindowBoundsMBS(100,100,100,100)
Notes:
Returns -1 on Windows or Linux.
Returns a Mac OS error code.

Feedback, Comments & Corrections

Window.SetWindowFeedbackSettingMBS(Feedback as Integer, value as Variant) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Window MBS Win Plugin 17.5 Yes No No No No
Function: Sets the feedback configuration for a window.
Example:
const FEEDBACK_TOUCH_CONTACTVISUALIZATION = 1
const FEEDBACK_PEN_BARRELVISUALIZATION = 2
const FEEDBACK_PEN_TAP = 3
const FEEDBACK_PEN_DOUBLETAP = 4
const FEEDBACK_PEN_PRESSANDHOLD = 5
const FEEDBACK_PEN_RIGHTTAP = 6
const FEEDBACK_TOUCH_TAP = 7
const FEEDBACK_TOUCH_DOUBLETAP = 8
const FEEDBACK_TOUCH_PRESSANDHOLD = 9
const FEEDBACK_TOUCH_RIGHTTAP = 10
const FEEDBACK_GESTURE_PRESSANDTAP = 11


dim r as Boolean = self.SetWindowFeedbackSettingMBS(FEEDBACK_TOUCH_TAP, true)

if r then
dim value as Boolean
dim b as Boolean = self.WindowFeedbackSettingMBS(FEEDBACK_TOUCH_TAP, value)
if b then
MsgBox "WindowFeedbackSettingMBS: "+str(value)
end if
end if
Notes:
Returns true if successful; otherwise, returns false.

Value can be nil to reset value. Or true/false to set it.
Requires Windows 8 or Windows Server 2012 in desktop apps only.

Constant NameValueDescription
FEEDBACK_TOUCH_CONTACTVISUALIZATION1Feedback for a touch contact event.
FEEDBACK_PEN_BARRELVISUALIZATION2Feedback for a pen barrel-button event.
FEEDBACK_PEN_TAP3Feedback for a pen tap event.
FEEDBACK_PEN_DOUBLETAP4Feedback for a pen double-tap event.
FEEDBACK_PEN_PRESSANDHOLD5Feedback for a pen press-and-hold event.
FEEDBACK_PEN_RIGHTTAP6Feedback for a pen right-tap event.
FEEDBACK_TOUCH_TAP7Feedback for a touch tap event.
FEEDBACK_TOUCH_DOUBLETAP8Feedback for a touch double-tap event.
FEEDBACK_TOUCH_PRESSANDHOLD9Feedback for a touch press-and-hold event.
FEEDBACK_TOUCH_RIGHTTAP10Feedback for a touch right-tap event.
FEEDBACK_GESTURE_PRESSANDTAP11Feedback for a press-and-tap gesture.

Feedback, Comments & Corrections

ShowAllFloatingWindowsMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
global method Window MBS Util Plugin Yes No No No No
Function: Shows all floating windows windows.
Example:
ShowAllFloatingWindowsMBS
Notes: You should hide floating windows before showing a dialog.

Feedback, Comments & Corrections

Window.ShowHideToolbarMBS(animate as boolean, value as boolean)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Window MBS Util Plugin 4.0 Yes No No No No
Function: Shows or hides the toolbar.
Notes: Only working on Mac OS X.

Feedback, Comments & Corrections

window.SmoothResizeCenteredMBS(width as Integer,height as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Window MBS Util Plugin 11.2 Yes No No No No
Function: Resizes the window smoothly to all directions.
Example:
dim w,h as Integer

// get destination dimension

w=300
h=200

// Resize

window1.SmoothResizeCenteredMBS w,h

// Now resize via RB to make it permament.

width=w
height=h
Notes:
You need to set the new size using REALbasic's Windows properties, too. (no longer needed with Xojo)
In Realbasic 2005 and newer you need to use self. in front of the method as the propertyname alone is not accepted.

Feedback, Comments & Corrections

Window.SmoothResizeMBS(width as Integer,height as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Window MBS Util Plugin Yes No No No No
Function: Resizes the window smoothly.
Example:
dim w,h as Integer

// get destination dimension

w=300
h=200

// Resize

window1.SmoothResizeMBS w,h

// Now resize via RB to make it permament.

width=w
height=h
Notes:
You need to set the new size using REALbasic's Windows properties, too. (no longer needed with Xojo)
In Realbasic 2005 and newer you need to use self. in front of the method as the propertyname alone is not accepted.

Works on Cocoa on 10.4 and newer.

Some examples which use this method:

Feedback, Comments & Corrections

window.TexturedSquareCornersMBS as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Util Plugin 8.1 Yes No No No No
Function: Whether a metal window has square corners.
Example:
if window1.Frame = window.FrameTypeMetal then
window1.TexturedSquareCornersMBS = true
else
MsgBox "Please turn window into metal frame."
end if
This item is deprecated and should no longer be used. You can use NSWindowMBS for Cocoa instead.
Notes:
Indicates that a textured window should have square corners. By default, a textured window has round corners. When this attribute is set on a window, the window frame view automatically makes the grow box view opaque, and when this attribute is cleared, the window frame view automatically makes the grow box view transparent. You can change the grow box view transparency after modifying this attribute with window.GrowBoxTransparentMBS. Relevant only for textured windows; ignored in non-textured windows. Available in Mac OS X 10.5 and later for window classes that support the textured appearance.
(Read and Write computed property)

Feedback, Comments & Corrections

Window.ToolbarVisibleMBS as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Util Plugin 4.0 Yes No No No No
Function: Whether the toolbar is shown in this window or not.
Notes:
Value is false on any error.
Only working on Mac OS X.
(Read and Write computed property)

Some examples which use this property:

Feedback, Comments & Corrections

window.TransitionWindowMBS(parent as window, effect as Integer, action as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Window MBS MacOSX Plugin 6.5 Yes No No No No
Function: Runs window transition.
Notes: see other TransitionWindow method for details.

See also:

Some examples which use this method:

Feedback, Comments & Corrections

window.TransitionWindowMBS(parent as window, effect as Integer, action as Integer, Async_ as boolean, duration as Double) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Window MBS MacOSX Plugin 6.5 Yes No No No No
Function: Runs window transition with additional parameters.
Notes: see other TransitionWindow method for details.

See also:

Some examples which use this method:

Feedback, Comments & Corrections

window.TransitionWindowMBS(parent as window, effect as Integer, action as Integer, left as Integer, top as Integer, width as Integer, height as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Window MBS MacOSX Plugin 6.5 Yes No No No No
Function: Runs window transition with rectangle.
Notes: see other TransitionWindow method for details.

See also:

Some examples which use this method:

Feedback, Comments & Corrections

window.TransitionWindowMBS(parent as window, effect as Integer, action as Integer, left as Integer, top as Integer, width as Integer, height as Integer, Async_ as boolean, duration as Double) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Window MBS MacOSX Plugin 6.5 Yes No No No No
Function: Runs window transition with additional parameters and rectangle.
Notes:
Works only in Carbon, not in Cocoa. For Cocoa please use NSWindowMBS class.
Transitions a window from one state to another with appropriate animation and sound.

self: The window that should be transitioned.
parent: For use with kWindowSheetTransitionEffect. This is the parent window of the sheet.
effect: The type of visual effect to use.
action: The action to take on the window.
left:The rectangle to be used.
top:The rectangle to be used.
width:The rectangle to be used.
height:The rectangle to be used.
async:Whether the transition should run synchronously or asynchronously. If Async is true, TransitionWindow will return immediately, and the transition will run using an event loop timer. You must run your event loop for the transition to occur. If Async is false, TransitionWindow will block until the transition is completed.
duration:The duration of the fade, in seconds. For use with the Sheet, Slide, Fade, and Genie transition effects; ignored for other effects. You may pass 0 to use the default duration. The effect is not guaranteed to last precisely this long, but should be a close approximation.

Returns Mac OS error code like 0 for success, -1 for parameter error in the plugin or -50 for parameter error.

Visual effects that are provided by TransitionWindow:
kWindowZoomTransitionEffect1Finder-like zoom rectangles. Use with TransitionWindow and Show or Hide transition actions
kWindowSheetTransitionEffect2Zoom in/out from parent. Use with TransitionWindowAndParent and Show or Hide transition actions. Available in Mac OS X, and in CarbonLib 1.5 and later.
kWindowSlideTransitionEffect3Slide the window into its new position. Use with TransitionWindow and Move or Resize transition actions. Available in Mac OS X, and in CarbonLib 1.5 and later.
kWindowFadeTransitionEffect4Fade the window into or out of visibility. Use with the Show or Hide transition actions. Available in Mac OS X 10.3 and later.
kWindowGenieTransitionEffect5Use the Genie effect that the Dock uses to minimize or maximize a window to show or hide the window. Use with the Show or Hide transition actions. Available in Mac OS X 10.3 and later.

Actions: Modifications to window state that are provided by TransitionWindow
kWindowShowTransitionAction1Shows the window. Use with the Zoom, Sheet, Fade, or Genie transition effects. For the Zoom, Sheet, and Genie effects, the rectangle parameter is the global coordinates from which to start the animation; rectangle is optional for the Zoom and Sheet effects, and in that case, the animation begins at the center of the window. The Genie effect requires a rectangle parameter. The Fade effect does not use the inRect parameter.
kWindowHideTransitionAction2Hides the window. Use with the Zoom, Sheet, Fade, or Genie transition effects. For the Zoom, Sheet, and Genie effects, the rectangle parameter is the global coordinates at which to end the animation; Recangle is optional for the Zoom and Sheet effects, and in that case, the animation ends at the center of the window. The Genie effect requires a rectangle. The Fade effect does not use the inRect parameter.
kWindowMoveTransitionAction3Moves the window. Use with the Slide transition effect. The rectangle parameter is the global coordinates of the window's new structure bounds; Rectangle must be provided. Available in Mac OS X, and in CarbonLib 1.5 and later.
kWindowResizeTransitionAction4Resizes the window. Use with the Slide transition effect. The rectangle parameter is the global coordinates of the window's new structure bounds; Rectangle must be provided. Available in Mac OS X, and in CarbonLib 1.5 and later.

See also:

Some examples which use this method:

Feedback, Comments & Corrections

Previous items Next items

The items on this page are in the following plugins: MBS MacOSX Plugin, MBS Util Plugin, MBS Win Plugin.




Links
MBS FileMaker Plugins