FutureBasic Logo

<<    Index    >> FutureBasic

VisualEffectView   statement



Syntax
visualeffectview tag, rect, material, mode, state, image, emphasized, wndTag

Requires
macOS 10.10+

Description
The visualeffectview statement puts a new visualeffectview in the current output window, or alters an existing visualeffectview's characteristics.

Parameters
Parameter
Description
tag A number (1 through 1000000) that you assign when you create the visualeffectview and that you refer to when altering the view. The number you assign must be different from the tag value of all other existing widgets in the current window. A negative tag hides the view.
rect The visualeffectview's enclosing rectangle. This can be specified in either of two ways:
(i) (x,y,w,h) where x,y are the origin and w,h the size of the view.
(ii) A CGRect value
material The material shown by the visualeffectview:
NSVisualEffectMaterialAppearanceBased (default)
NSVisualEffectMaterialTitlebar
NSVisualEffectMaterialSelection
NSVisualEffectMaterialMenu // macOS 10.11+
NSVisualEffectMaterialPopover // macOS 10.11+
NSVisualEffectMaterialSidebar // macOS 10.11+
NSVisualEffectMaterialHeaderView // macOS 10.14+
NSVisualEffectMaterialSheet // macOS 10.14+
NSVisualEffectMaterialWindowBackground // macOS 10.14+
NSVisualEffectMaterialHUDWindow
NSVisualEffectMaterialFullScreenUI
NSVisualEffectMaterialToolTip // macOS 10.14+
NSVisualEffectMaterialContentBackground // macOS 10.14+
NSVisualEffectMaterialUnderWindowBackground // macOS 10.14+
NSVisualEffectMaterialUnderPageBackground // macOS 10.14+

mode A value indicating how the view’s contents blend with the surrounding contents:
NSVisualEffectBlendingModeBehindWindow (default)
NSVisualEffectBlendingModeWithinWindow
state A value that indicates whether a view has a visual effect applied:
NSVisualEffectStateFollowsWindowActiveState (default)
NSVisualEffectStateActive
NSVisualEffectStateInactive

image An image whose alpha channel masks the visual effect view's material. This parameter is optional and can be the name of (or path to) an image resource or an ImageRef (NSImage).
emphasized A Boolean value indicating whether to emphasize the look of the material. Default = NO. macOS 10.12+
wndTag An optional parameter for when the view's window is not the current output window. Note specifying this parameter does not bring the window to the front or make it the output window.
 

Apple documentation
NSVisualEffectView