Xojo Conferences
MBSSep2018MunichDE
XDCMay2019MiamiUSA

Platforms to show: All Mac Windows Linux Cross-Platform

OverlayMBS.Alpha as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Overlay Plugin 8.6 Yes Yes No No No
Function: The alpha value of the window.
Notes:
0 is invisible and 1.0 is visible.
(Read and Write property)

Feedback, Comments & Corrections

OverlayMBS.AutoCaptureMouse as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Overlay Plugin 9.2 No Yes No No No
Function: Whether the mouse should be captured automatically on Windows.
Notes:
If you return true from MouseDown the mouse is catched. This way you can get the drag events even if the mouse moves out of the window.
On MouseUp the mouse is released.
(Read and Write property)

Feedback, Comments & Corrections

OverlayMBS.CurrentImage as Variant
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Overlay Plugin 14.2 Yes No No No No
Function: Last image drawn.
Notes:
For debugging only.
CGImageMBS or NSImageMBS depending on what you set.
(Read only property)

Feedback, Comments & Corrections

OverlayMBS.Height as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Overlay Plugin 8.6 Yes Yes No No No
Function: The height of the window.
Notes:
Using Resize method is more efficient than assigning width and height properties.
(Read and Write property)

Feedback, Comments & Corrections

OverlayMBS.IgnoreMouseClicks as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Overlay Plugin 8.7 Yes Yes No No No
Function: Whether this window should react to mouse clicks.
Notes:
In Mac OS X 10.7 and newer setting IgnoreMouseClicks = false does not give the same behavior as without setting this property before.
(Read and Write property)

Feedback, Comments & Corrections

OverlayMBS.Left as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Overlay Plugin 8.6 Yes Yes No No No
Function: The position of the window.
Example:
static o as OverlayMBS // keep the variable global somewhere. Static or part of a module or in app class.

o = new OverlayMBS(100,100,100,100)

o.Pict = LogoMBS(100)
o.mask = LogoMBS(100)

o.Left = 200

o.UpdateShow
Notes:
Using Move method is more efficient than assigning left and top properties.
(Read and Write property)

Feedback, Comments & Corrections

OverlayMBS.Mask as Picture
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Overlay Plugin 8.6 Yes Yes No No No
Function: The mask for the window.
Notes:
You need to create and assign your own image.
If you assign nil for the mask, the plugin uses the mask or alpha channel of the picture.
(Read and Write property)

Feedback, Comments & Corrections

OverlayMBS.NSView as Variant
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Overlay Plugin 15.3 Yes No No No No
Function: The NSView showing the content of the overlay.
Notes: (Read only property)

Feedback, Comments & Corrections

OverlayMBS.NSWindow as Variant
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Overlay Plugin 10.5 Yes No No No No
Function: Returns a reference to the NSWindowMBS object which you can use to make additional settings to the overlay window.
Example:
dim o as OverlayMBS // your window

dim n as NSWindowMBS = o.NSWindow
// this window should not hide if app hides
n.canHide = false
Notes:
Only for the Cocoa target in Real Studio.
(Read only property)

Feedback, Comments & Corrections

OverlayMBS.Pict as Picture
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Overlay Plugin 8.6 Yes Yes No No No
Function: The picture for the window content.
Notes:
You need to provide your own picture here.
Pict and Mask pictures must have the same size.

Alpha Channel Pictures are not really supported.
But for Mac OS X an alpha channel picture does currently work.
(Read and Write property)

Feedback, Comments & Corrections

OverlayMBS.Top as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Overlay Plugin 8.6 Yes Yes No No No
Function: The position of the window.
Example:
static o as OverlayMBS // keep the variable global somewhere. Static or part of a module or in app class.

o = new OverlayMBS(100,100,100,100)

o.Pict = LogoMBS(100)
o.mask = LogoMBS(100)

o.top = 200

o.UpdateShow
Notes:
Using Move method is more efficient than assigning left and top properties.
(Read and Write property)

Feedback, Comments & Corrections

OverlayMBS.Visible as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Overlay Plugin 8.6 Yes Yes No No No
Function: Whether the window is visible.
Example:
dim o as OverlayMBS
// ....
o.visible=true
Notes:
True if visible, false if hidden.
(Read and Write property)

Feedback, Comments & Corrections

OverlayMBS.Width as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Overlay Plugin 8.6 Yes Yes No No No
Function: The width of the window.
Notes:
Using Resize method is more efficient than assigning width and height properties.
(Read and Write property)

Feedback, Comments & Corrections

OverlayMBS.WindowHandle as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Overlay Plugin 8.6 Yes Yes No No No
Function: The internal used window handle.
Notes:
On Mac OS a WindowRef and on Windows a HWND.
(Read and Write property)

Feedback, Comments & Corrections

OverlayMBS.WindowID as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Window MBS Overlay Plugin 10.2 Yes No No No No
Function: Queries the CoreGraphics Window ID for the given window.
Notes:
Returns 0 on any error.
This ID can be used for CGWindowListCreateImageMBS.
(Read only property)

Feedback, Comments & Corrections

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





Links
MBS Xojo Plugins