Type Alias


The following keys may be specified or returned in the options dictionary for setDesktopImageURL:forScreen:options:error:.


typedef NSString *NSWorkspaceDesktopImageOptionKey;


Type Properties


The value is an NSNumber containing an NSImageScaling constant as declared in NSCell. If this is not specified, NSImageScaleProportionallyUpOrDown is used. NSImageScaleProportionallyDown is not currently supported.


The value is an NSNumber containing a BOOL, which affects the interpretation of Proportional scaling types. A NO value will make the image fully visible, but there may be empty space on the sides or top and bottom. A YES value will cause the image to fill the entire screen, but the image may be clipped. If this is not specified, NO is assumed. Non-proportional scaling types ignore this value.


The value is an NSColor, which is used to fill any empty space around the image. If not specified, a default value is used. Currently, only colors that use or can be converted to use NSCalibratedRGBColorSpace are supported, and any alpha value is ignored.

See Also

Managing the Desktop Image

- desktopImageURLForScreen:

Returns the URL for the desktop image for the given screen.

- setDesktopImageURL:forScreen:options:error:

Sets the desktop image for the given screen to the image at the specified URL.

- desktopImageOptionsForScreen:

Returns the desktop image options for the given screen.