Xojo Conferences
MBSSep2018MunichDE
XDCMay2019MiamiUSA

Platforms to show: All Mac Windows Linux Cross-Platform

Next items

Window.AlternateTitleMBS as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS MacOSX Plugin 3.0 Yes No No No No
Function: An alternative title for a window on Mac OS X.
Notes:
Used for the window menu.
You may use it for windows with the same name, but different entries in the standard window menu.
This property works only if CarbonLib 1.1 or newer is present.
(Read and Write computed property)

Feedback, Comments & Corrections

AreFloatingWindowsVisibleMBS as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
global method Window MBS Util Plugin Yes No No No No
Function: Returns true if floating windows are visible
Example:
if not AreFloatingWindowsVisibleMBS then
ShowAllFloatingWindowsMBS
end if
Notes: You should hide floating windows before showing a dialog.

Feedback, Comments & Corrections

window.AsyncDragMBS 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 this window uses asyncron dragging.
Example:
window1.AsyncDragMBS = true
This item is deprecated and should no longer be used. You can use NSWindowMBS for Cocoa instead.
Notes:
This window is marked so that the window server will drag the window automatically. Your application should not call DragWindow for this window, else it would confuse the heck out of the drag (it would fight with the window server for control). This attribute is ignored (async drag is not used) if your window is grouped with other windows in a window group that has the kWindowGroupAttrMoveTogether attribute. Available for all windows on Mac OS X 10.3 and later.

Seems to have no effect for RB 2008r2.
(Read and Write computed property)

Feedback, Comments & Corrections

window.BackingScaleFactorMBS as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Window MBS Util Plugin 12.3 Yes No No No No
Function: Returns the scale factor representing the number of backing store pixels corresponding to each linear unit in window space on this window.
Notes:
This is generally only necessary when building a bitmap context or image whose resolution needs to match that of a particular Window. Note that a Window's backing scale factor can change over time, such as when the window moves from one display to another, or when a display's resolution changes, so clients should not cache the value returned by this function.

If platform does not support scaling factor, we return 1.0. (on Windows, Linux and older Mac OS X)
Supported for Carbon and Cocoa windows.

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.

Some examples which use this method:

Feedback, Comments & Corrections

window.CanBeVisibleWithoutLoginMBS 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 this window can be visible before login.
Example:
window1.CanBeVisibleWithoutLoginMBS = true
Notes:
This window can be made visible prior to user login. By default, in Mac OS X 10.5 and later no windows can be visible before a user logs into the system; this protects the user against certain types of malicious use of insecure applications. However, some software, such as input methods or other accessibility software, may need to deliberately make windows available prior to user login. Such software should add this window attribute to its windows. Available for all windows in Mac OS X 10.5 and later.
(Read and Write computed property)

Feedback, Comments & Corrections

Window.CanLiveResizeMBS as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Util Plugin Yes No No No No
Function: Whether this window supports live resizing.
Example:
mainwindow.CanLiveResizeMBS=true
This item is deprecated and should no longer be used. You can use NSWindowMBS for Cocoa instead.
Notes:
Available for all windows on Mac OS X.

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

Window.CleanUpTransparentMBS(refValue 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: Cleans up transparency support for a REALbasic window.
Example:
dim p as Integer // property on Windows

p = window1.MakeTransparentMBS

// later in close event

window1.CleanUpTransparentMBS p
Notes:
Call this in the close event of a window passing the value you got from the MakeTransparentMBS call.
Linux supported added with 14.0, but works only with Linux desktop which support alpha channel.

Feedback, Comments & Corrections

Window.CollapsableMBS as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Window MBS Util Plugin Yes No No No No
Function: Returns true if this window can be collapsed.
Example:
MsgBox str(window1.CollapsableMBS)
Notes:
Collapseable windows are the normal document windows.
You can't collapse dialogs or floating windows well.
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.

Some examples which use this method:

Feedback, Comments & Corrections

CollapseAllWindowsMBS(collapse as boolean)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
global method Window MBS Util Plugin Yes No No No No
Function: Collapse all windows.
Example:
CollapseAllWindowsMBS true
Notes: Like pressing alt while you click on the collapse button with the mouse.

Some examples using this method:

Feedback, Comments & Corrections

Window.collapsedMBS 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 is collapsed. You can set it.
Example:
mainwindow.collapsedMBS=false 'show window
Notes:
Collapseable windows are the normal document windows.
You can't collapse dialogs or floating windows well.
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.ConstrainWindowToScreenMBS(animate as boolean)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Window MBS Util Plugin 10.5 Yes No No No No
Function: Makes sure the window is on one screen visible.
Notes: Implemented on Mac for both Carbon and Cocoa.

Feedback, Comments & Corrections

window.ExposeHiddenMBS as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS MacOSX Plugin 6.2 Yes No No No No
Function: Whether Expose will hide this window.
Example:
window1.ExposeHiddenMBS=CheckBox1.Value

if window1.ExposeHiddenMBS then
StaticText1.text="yes"
else
StaticText1.text="no"
end if
Notes:
Requires Mac OS X 10.4 to work.
Returns false on any error.
Default value is false for all document windows.
(Read and Write computed property)

Feedback, Comments & Corrections

window.GetWindowBoundsMBS(byref x as Integer, byref y as Integer, byref w as Integer, byref 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: Queries the window structure size.
Example:
// a Finder like Zoom from the top left of the screen to the center

dim h as Integer
dim i as Integer
dim w as Integer
dim x as Integer
dim y as Integer
dim l as Integer
dim r as IntegerRectMBS
dim e as Integer
dim TheWindow as window // the window

e=TheWindow.GetWindowBoundsMBS(x,y,w,h)

x=(screen(0).Width-300)/2
y=(screen(0).Height-300)/2

w=300
h=300
e=TheWindow.SetWindowBoundsMBS(x,y,w,h)

TheWindow.top=y
TheWindow.left=x
TheWindow.height=h
TheWindow.width=w


//Center the window

x=0
y=0
w=0
h=0

call TheWindow.TransitionWindowMBS(nil,1,1,x,y,w,h,False,5.0)
Notes:
Returns -1 on Windows or Linux.
Returns a Mac OS error code.

Feedback, Comments & Corrections

Window.GrowBoxTransparentMBS as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS MacOSX Plugin 5.1 Yes No No No No
Function: Switches the transparent grow box on and off.
Example:
if window1.Composite then
window1.GrowBoxTransparentMBS = true
else
MsgBox "Please turn on composite."
end if
Notes:
Only Mac OS X 10.2 and only on Composite windows.
Seems like RB 2010 has this on by default.
(Read and Write computed property)

Feedback, Comments & Corrections

window.GTKWindow as GTKWindowMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Window MBS Linux Plugin 13.0 No No Yes No No
Function: Queries a GTKWindow object for this window.
Notes:
Returns only a valid object on linux.
On other platforms, this function returns nil.

Feedback, Comments & Corrections

Window.HasborderMBS as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Util Plugin No Yes No No No
Function: Decides whether the window has a border.
Example:
mainwindow.HasborderMBS=false ' Remove border
Notes:
This property has only an effect on Windows. The window needs to be redrawn before the change is visible (for example move it). This option removes the title bar. HasCaptionMBS removes even more.

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.HasCaptionMBS as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Util Plugin 7.4 No Yes No No No
Function: Whether the window has a caption (a title bar)
Example:
Window1.HasCaptionMBS=false
Notes:
This property has only an effect on Windows. The window needs to be redrawn before the change is visible (for example move it).

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.HasCloseBoxMBS as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Util Plugin Yes No No No No
Function: Whether this window has a CloseBox.
Example:
mainwindow.HasCloseboxMBS=false 'remove closebox
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

Window.HasCollapseBoxMBS as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Util Plugin Yes No No No No
Function: Whether this window has a Collapsebox.
Example:
mainwindow.HasCollapseBoxMBS=false 'remove Collapsebox
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

window.HasFullZoomButtonMBS 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: Returns true if this window can be resized horizontally and vertically.
Example:
mainwindow.HasFullZoomButtonMBS=false 'remove resizebox
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)

Feedback, Comments & Corrections

Window.HasHorizontalZoomButtonMBS 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 horizontally.
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

Window.HasMaximizeBoxMBS 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 a Maximize Button.
Example:
mainwindow.HasMaximizeBoxMBS=false 'remove Maximize button
Notes:
This property has only an effect on Windows. The window needs to be redrawn before the change is visible (for example move it).

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.HasMinimizeBoxMBS 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 a Minimize Button.
Example:
mainwindow.HasMinimizeBoxMBS=false 'remove Minimize button
Notes:
This property has only an effect on Windows. The window needs to be redrawn before the change is visible (for example move it).

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.HasNoShadowMBS as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Util Plugin Yes No No No No
Function: Whether this window has no shadow.
Example:
mainwindow.HasNoShadowMBS=true 'remove shadow
Notes:
Available for all windows on Mac OS X. This attribute is automatically given to windows of kOverlayWindowClass.

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.HasNoTitleBarMBS 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: For Document, Floating, and Utility windows, this attribute allows you to hide the title bar of a window.
Example:
window1.HasNoTitleBarMBS = true

// for Cocoa:
window1.HasCloseBoxMBS = false
window1.HasCollapseBoxMBS = false
window1.IsResizableMBS = false
window1.HasNoTitleBarMBS = true
This item is deprecated and should no longer be used. You can use NSWindowMBS for Cocoa instead.
Notes:
For Mac OS X 10.4 or 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.4.
(Read and Write computed property)

Feedback, Comments & Corrections

window.HasRoundBottomBarCornersMBS 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 rounded corners.
Example:
MsgBox str(window1.HasRoundBottomBarCornersMBS)
This item is deprecated and should no longer be used. You can use NSWindowMBS for Cocoa instead.
Notes:
Indicates that this window will have rounded bottom corners. By default, a window has squared corners, and the assertion of this bit turns on rounded bottom corners for the window if the window has a bottom bar (set with HIWindowSetContentBorderThickness). If the window does not have a bottom bar, this bit is ignored. If the window is metal, the RoundBottomBarCornersMBS attribute will be ignored, as that type of window defaults to rounded corners and controls the squareness with the TexturedSquareCornersMBS attribute.
(Read and Write computed property)

Some examples which use this property:

Feedback, Comments & Corrections

Window.HasSideTitlebarMBS as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Util Plugin Yes No No No No
Function: Whether this window has the title bar on the side.
Example:
mainwindow.HasSideTitlebarMBS=true 'moves titlebar to side
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.
Only good for floating windows.
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

window.HasSystemMenuMBS as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Util Plugin 7.4 No Yes No No No
Function: Whether the window has a system menu inside the title bar.
Example:
Window1.HasSystemMenuMBS=false
Notes:
This property has only an effect on Windows. It will disable the system menu and also the minimize, maximize and close buttons. The window needs to be redrawn before the change is visible (for example move it).

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.HasToolbarButtonMBS as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Util Plugin Yes No No No No
Function: Whether this window has a toolbar button.
Example:
mainwindow.HasToolbarButtonMBS=true 'shows Toolbar Button
Notes:
You can read the state on Mac Classic, but you can only change it on Mac Carbon.
The Button is shown on next redraw of the window frame.

Use the CarbonWindowsEventsMBS class to receive events when the button is pressed.

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

Next items

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





Links
MBS Xojo Plugins