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

window.TransitionWindowMBS(parentWindowHandle as Integer, 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(parentWindowHandle as Integer, 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(parentWindowHandle as Integer, 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(parentWindowHandle as Integer, 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

Window.TransparencyMBS as single
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Util Plugin 5.0 Yes Yes Yes No No
Function: The transparency of the window on Mac OS X, Windows 2000 and Windows XP.
Notes:
1 for opaque, 0 for invisible.
Return 1 on any error. On Windows it returns always 1 as the current transparency value can't be queried.
You need to call MakeTransparent before to install transparency.
(added Windows support in version 4.4)
Linux supported added with 14.0, but works only with Linux desktop which support alpha channel.
(Read and Write computed property)

Some examples which use this property:

Feedback, Comments & Corrections

window.UnifiedTitleAndToolbarMBS 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 has an unified title and toolbar look.
Example:
window1.UnifiedTitleAndToolbarMBS = true
Notes:
This window draws its window title and toolbar using a unified appearance that has no separator between the two areas. A window may not have both UnifiedTitleAndToolbar and Metal appearance. If a window already has the metal attribute, attempting to set the Unified attribute will cause ChangeWindows to return an error, and vice versa. This constant was not added to this header file until Mac OS X 10.5, but it is actually available at runtime on Mac OS X 10.4 and later for windows of kDocumentWindowClass. However, on Mac OS X 10.5 and later, kHIWindowBitUnifiedTitleAndToolbar no longer has any effect, since all windows with toolbars now have a unified look.
(Read and Write computed property)

Feedback, Comments & Corrections

Window.UpdateDockWindowMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Window MBS MacOSX Plugin Yes No No No No
Function: if your window is minimized this will update the small picture inside the dock on Mac OS X.
Example:
Mainwindow.UpdateDockWindowMBS

Some examples which use this method:

Feedback, Comments & Corrections

Window.UpdateNowMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Window MBS MacOSX Plugin Yes No No No No
Function: On Mac OS X all Windows are doublebuffered and the OS updates the screen from time to time. This method forces a screen update.
Example:
Mainwindow.UpdateNowMBS

Feedback, Comments & Corrections

Window.UpdateNowRectMBS(left as Integer, top as Integer, width as Integer, height as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Window MBS MacOSX Plugin Yes No No No No
Function: On Mac OS X all Windows are doublebuffered and the OS updates the screen from time to time. This method forces a screen update for a part of your window.
Example:
Mainwindow.UpdateNowRectMBS Mainwindow.text.left, Mainwindow.text.top,  Mainwindow.text.width, Mainwindow.text.height

Feedback, Comments & Corrections

Window.WindowCloseBoxRectMBS as IntegerRectMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Window MBS Util Plugin Yes No No No No
Function: The size of the screen area your window uses for the close box.
Notes:
Carbon only. For Cocoa, check NSWindowMBS methods.
May return nil on any error.

Feedback, Comments & Corrections

Window.WindowCollapseBoxRectMBS as IntegerRectMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Window MBS Util Plugin Yes No No No No
Function: The size of the screen area your window uses for the collapse box.
Notes:
Carbon only. For Cocoa, check NSWindowMBS methods.
May return nil on any error.

Feedback, Comments & Corrections

Window.WindowContentRectMBS as IntegerRectMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Window MBS Util Plugin Yes No No No No
Function: The size of the screen area your window uses for the content of the window.
Notes:
Empty if the window is collapsed.
Carbon only. For Cocoa, check NSWindowMBS methods.
May return nil on any error.

Some examples which use this method:

Feedback, Comments & Corrections

window.WindowDoesNotCycleMBS 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 will cycle.
Example:
window1.WindowDoesNotCycleMBS=False
Notes:
If true, this window does not participate in window cycling invoked by cmd-~ or the "Focus on Window" hotkey defined in the Keyboards preference pane. 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.WindowDragRectMBS as IntegerRectMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Window MBS Util Plugin Yes No No No No
Function: The size of the screen area your window uses for the drag box.
Notes:
Carbon only. For Cocoa, check NSWindowMBS methods.
May return nil on any error.

Feedback, Comments & Corrections

Window.WindowFeedbackSettingMBS(Feedback as Integer, byref value as boolean, IncludeAncestors as Boolean = false) 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: Retrieves the feedback configuration for a window.
Notes:
IncludeAncestors: Specifies that the parent window chain should be checked.

Returns true if the specified feedback setting is configured on the specified window. Otherwise, it returns false (and config won't be modified).

Requires Windows 8 [desktop apps only] or Windows Server 2012 [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

Window.WindowGrowRectMBS as IntegerRectMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Window MBS Util Plugin Yes No No No No
Function: The size of the screen area your window uses for the grow box.
Notes:
Carbon only. For Cocoa, check NSWindowMBS methods.
May return nil on any error.

Feedback, Comments & Corrections

window.WindowMoveToActiveSpaceMBS as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS MacOSX Plugin 8.4 Yes No No No No
Function: Whether this window should appear on the active space.
Notes:
When made visible, this window is always shown in the current Space, rather than the space in which it was last visible. When activated, this window moves to the active space, rather than forcing a switch to the Space on which it was previously located. This option is typically used with modeless dialog windows such as the Quick Search window in BBEdit. This flag and the WindowVisibleInAllSpacesMBS flag should not both be set.
For Carbon only. For Cocoa, please use NSWindowMBS.collectionBehavior.
(Read and Write computed property)

Feedback, Comments & Corrections

Window.WindowStructureRectMBS as IntegerRectMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Window MBS Util Plugin Yes No No No No
Function: The size of the screen area your window uses for the structure of the whole window.
Notes:
May return nil on any error.

Carbon only. For Cocoa, check NSWindowMBS methods.

Some examples which use this method:

Feedback, Comments & Corrections

Window.WindowTitleBarRectMBS as IntegerRectMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Window MBS Util Plugin Yes No No No No
Function: The size of the screen area your window uses for the title bar.
Notes:
Carbon only. For Cocoa, check NSWindowMBS methods (e.g. frameRectForContentRect).
May return nil on any error.

Feedback, Comments & Corrections

Window.WindowTitleProxyIconRectMBS as IntegerRectMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Window MBS Util Plugin Yes No No No No
Function: The size of the screen area your window uses for the title proxy icon.
Notes:
Carbon only. For Cocoa, check NSWindowMBS methods.
May return nil on any error.

Feedback, Comments & Corrections

Window.WindowTitleTextRectMBS as IntegerRectMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Window MBS Util Plugin Yes No No No No
Function: The size of the screen area your window uses for the title text.
Notes:
Carbon only. For Cocoa, check NSWindowMBS methods.
May return nil on any error.

Feedback, Comments & Corrections

window.WindowVisibleInAllSpacesMBS as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS MacOSX Plugin 8.4 Yes No No No No
Function: Whether a window is visible on all spaces.
Notes:
This window is visible in all window sets managed by Spaces. If this flag is not set, the window is only visible in the Space where it was created. This flag and the WindowMoveToActiveSpaceMBS flag should not both be set.
For Carbon only. For Cocoa, please use NSWindowMBS.collectionBehavior.
(Read and Write computed property)

Feedback, Comments & Corrections

Window.WindowZoomBoxRectMBS as IntegerRectMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Window MBS Util Plugin Yes No No No No
Function: The size of the screen area your window uses for the zoom box.
Notes:
Carbon only. For Cocoa, check NSWindowMBS methods.
May return nil on any error.

Feedback, Comments & Corrections

window.WinFlashWindowMBS(Invert as boolean)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Window MBS Util Plugin 16.2 No Yes No No No
Function: Flashes Window.
Example:
window1.WinFlashWindowMBS true
Notes:
Flashes the specified window one time. It does not change the active state of the window.

Invert: If this parameter is true, the window is flashed from one state to the other. If it is false, the window is returned to its original state (either active or inactive).

When an application is minimized and this parameter is true, the taskbar window button flashes active/inactive. If it is false, the taskbar window button flashes inactive, meaning that it does not change colors. It flashes, as if it were being redrawn, but it does not provide the visual invert clue to the user.

Flashing a window means changing the appearance of its caption bar as if the window were changing from inactive to active status, or vice versa. (An inactive caption bar changes to an active caption bar; an active caption bar changes to an inactive caption bar.)
Typically, a window is flashed to inform the user that the window requires attention but that it does not currently have the keyboard focus.
The FlashWindow function flashes the window only once; for repeated flashing, the application should create a system timer.

Feedback, Comments & Corrections

Window.WinMenuHandleMBS as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Util Plugin No Yes No No No
Function: A property to access the handle used for the menu of a Window.
Example:
dim menu as Integer // global

if menu=0 then
menu=Window1.WinMenuHandleMBS // read it on the first window
else
Window1.winmenuHandleMBS=menu // set it on the second window
end if
Notes:
Used in the example "Menu in every Window" to have a menubar in every window on Windows. But never forget to quit your app after all windows were closed.
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

Previous items

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




Links
MBS Xojo Plugins