-
Notifications
You must be signed in to change notification settings - Fork 507
AppKit macOS xcode14.1 b3
Chris Hamons edited this page Oct 11, 2022
·
2 revisions
#AppKit.framework https://github.com/xamarin/xamarin-macios/pull/16255
diff -ruN /Applications/Xcode_14.1.0-beta2.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/AppKit.framework/Headers/NSSharingService.h /Applications/Xcode_14.1.0-beta3.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/AppKit.framework/Headers/NSSharingService.h
--- /Applications/Xcode_14.1.0-beta2.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/AppKit.framework/Headers/NSSharingService.h 2022-09-07 13:39:55.000000000 -0500
+++ /Applications/Xcode_14.1.0-beta3.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/AppKit.framework/Headers/NSSharingService.h 2022-09-22 09:18:45.000000000 -0500
@@ -271,6 +271,11 @@
- (void)showRelativeToRect:(NSRect)rect ofView:(NSView *)view preferredEdge:(NSRectEdge)preferredEdge;
/**
+ * Closes the picker UI. `-[NSSharingServicePickerDelegate sharingServicePicker:didChooseSharingService:]` will be invoked if `delegate` is set, with a `nil` service.
+ */
+- (void)close API_AVAILABLE(macos(13.0));
+
+/**
* Returns a menu item suitable to display the picker for the given items.
*/
@property (readonly) NSMenuItem *standardShareMenuItem API_AVAILABLE(macos(13.0));
diff -ruN /Applications/Xcode_14.1.0-beta2.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/AppKit.framework/Headers/NSTextView.h /Applications/Xcode_14.1.0-beta3.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/AppKit.framework/Headers/NSTextView.h
--- /Applications/Xcode_14.1.0-beta2.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/AppKit.framework/Headers/NSTextView.h 2022-09-07 13:39:55.000000000 -0500
+++ /Applications/Xcode_14.1.0-beta3.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/AppKit.framework/Headers/NSTextView.h 2022-09-22 09:18:45.000000000 -0500
@@ -83,6 +83,12 @@
// This variant will create the text network (textStorage, layoutManager, and a container).
- (instancetype)initWithFrame:(NSRect)frameRect;
+// Return a new instance of NSTextView. This method constructs a network of TextKit 2 objects (NSTextLayoutManager, NSTextContentManager) or TextKit 1 objects (NSLayoutManager, NSTextStorage) to back the text view, depending on the value of 'usingTextLayoutManager'. The new text view is initialized with frame NSZeroRect.
+- (instancetype)initUsingTextLayoutManager:(BOOL)usingTextLayoutManager;
+
+// This initializer constructs a network of TextKit 2 objects (NSTextLayoutManager, NSTextContentManager) or TextKit 1 objects (NSLayoutManager, NSTextStorage) to back the text view, depending on the value of 'usingTextLayoutManager'. The result is initialized with frame NSZeroRect.
++ (instancetype)textViewUsingTextLayoutManager:(BOOL)usingTextLayoutManager;
+
/***************** Get/Set the container and other stuff *****************/
// The set method should not be called directly, but you might want to override it. Gets or sets the text container for this view. Setting the text container marks the view as needing display. The text container calls the set method from its setTextView: method.
diff -ruN /Applications/Xcode_14.1.0-beta2.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/AppKit.framework/Headers/NSWindow.h /Applications/Xcode_14.1.0-beta3.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/AppKit.framework/Headers/NSWindow.h
--- /Applications/Xcode_14.1.0-beta2.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/AppKit.framework/Headers/NSWindow.h 2022-09-07 13:39:58.000000000 -0500
+++ /Applications/Xcode_14.1.0-beta3.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks/AppKit.framework/Headers/NSWindow.h 2022-09-22 09:18:47.000000000 -0500
@@ -33,99 +33,160 @@
static const NSAppKitVersion NSAppKitVersionNumberWithCustomSheetPosition = 686.0;
static const NSAppKitVersion NSAppKitVersionNumberWithDeferredWindowDisplaySupport = 1019.0;
+/*!
+ * @typedef NSWindowStyleMask
+ *
+ * @const NSWindowStyleMaskBorderless
+ * @const NSWindowStyleMaskTitled
+ * @const NSWindowStyleMaskClosable
+ * @const NSWindowStyleMaskMiniaturizable
+ * @const NSWindowStyleMaskResizable
+ * @const NSWindowStyleMaskTexturedBackground Textured window style is deprecated and should no longer be used. Specifies a window with textured background. Textured windows generally don't draw a top border line under the titlebar/toolbar. To get that line, use the \c NSUnifiedTitleAndToolbarWindowMask mask.
+ * @const NSWindowStyleMaskUnifiedTitleAndToolbar Specifies a window whose titlebar and toolbar have a unified look - that is, a continuous background. Under the titlebar and toolbar a horizontal separator line will appear.
+ * @const NSWindowStyleMaskFullScreen When present, the window will appear full screen. This mask is automatically toggled when \c -toggleFullScreen: is called.
+ * @const NSWindowStyleMaskFullSizeContentView If set, the \c contentView will consume the full size of the window; it can be combined with other window style masks, but is only respected for windows with a titlebar. Utilizing this mask opts-in to layer-backing. Utilize the \c contentLayoutRect or auto-layout \c contentLayoutGuide to layout views underneath the titlebar/toolbar area.
+ * @const NSWindowStyleMaskUtilityWindow Only applicable for \c NSPanel (or a subclass thereof).
+ * @const NSWindowStyleMaskDocModalWindow Only applicable for \c NSPanel (or a subclass thereof).
+ * @const NSWindowStyleMaskNonactivatingPanel Specifies that a panel that does not activate the owning application. Only applicable for \c NSPanel (or a subclass thereof).
+ * @const NSWindowStyleMaskHUDWindow Specifies a heads up display panel. Only applicable for \c NSPanel (or a subclass thereof).
+ */
typedef NS_OPTIONS(NSUInteger, NSWindowStyleMask) {
NSWindowStyleMaskBorderless = 0,
NSWindowStyleMaskTitled = 1 << 0,
NSWindowStyleMaskClosable = 1 << 1,
NSWindowStyleMaskMiniaturizable = 1 << 2,
NSWindowStyleMaskResizable = 1 << 3,
-
- /* Specifies a window with textured background. Textured windows generally don't draw a top border line under the titlebar/toolbar. To get that line, use the NSUnifiedTitleAndToolbarWindowMask mask.
- */
NSWindowStyleMaskTexturedBackground API_DEPRECATED("Textured window style should no longer be used", macos(10.2, 11.0)) = 1 << 8,
-
- /* Specifies a window whose titlebar and toolbar have a unified look - that is, a continuous background. Under the titlebar and toolbar a horizontal separator line will appear.
- */
NSWindowStyleMaskUnifiedTitleAndToolbar = 1 << 12,
-
- /* When present, the window will appear full screen. This mask is automatically toggled when toggleFullScreen: is called.
- */
NSWindowStyleMaskFullScreen API_AVAILABLE(macos(10.7)) = 1 << 14,
-
- /* If set, the contentView will consume the full size of the window; it can be combined with other window style masks, but is only respected for windows with a titlebar.
- Utilizing this mask opts-in to layer-backing. Utilize the contentLayoutRect or auto-layout contentLayoutGuide to layout views underneath the titlebar/toolbar area.
- */
NSWindowStyleMaskFullSizeContentView API_AVAILABLE(macos(10.10)) = 1 << 15,
-
- /* The following are only applicable for NSPanel (or a subclass thereof)
- */
- NSWindowStyleMaskUtilityWindow = 1 << 4,
- NSWindowStyleMaskDocModalWindow = 1 << 6,
- NSWindowStyleMaskNonactivatingPanel = 1 << 7, // Specifies that a panel that does not activate the owning application
- NSWindowStyleMaskHUDWindow API_AVAILABLE(macos(10.6)) = 1 << 13 // Specifies a heads up display panel
+ NSWindowStyleMaskUtilityWindow = 1 << 4,
+ NSWindowStyleMaskDocModalWindow = 1 << 6,
+ NSWindowStyleMaskNonactivatingPanel = 1 << 7,
+ NSWindowStyleMaskHUDWindow API_AVAILABLE(macos(10.6)) = 1 << 13
};
// Additional NSModalResponse values
static const NSModalResponse NSModalResponseOK = 1;
static const NSModalResponse NSModalResponseCancel = 0;
-/* used with NSRunLoop's performSelector:target:argument:order:modes: */
+/// Used with \c NSRunLoop's `-performSelector:target:argument:order:modes:`.
enum {
NSDisplayWindowRunLoopOrdering = 600000,
NSResetCursorRectsRunLoopOrdering = 700000
};
+/*!
+ * @typedef NSWindowSharingType
+ *
+ * @const NSWindowSharingNone Window contents may not be read by another process.
+ * @const NSWindowSharingReadOnly Window contents may be read but not modified by another process.
+ * @const NSWindowSharingReadWrite Window contents may be read or modified by another process.
+ */
typedef NS_ENUM(NSUInteger, NSWindowSharingType) {
- NSWindowSharingNone = 0, // Window contents may not be read by another process
- NSWindowSharingReadOnly = 1, // Window contents may be read but not modified by another process
- NSWindowSharingReadWrite = 2 // Window contents may be read or modified by another process
+ NSWindowSharingNone = 0,
+ NSWindowSharingReadOnly = 1,
+ NSWindowSharingReadWrite = 2
} API_AVAILABLE(macos(10.5));
+/*!
+ * @typedef NSWindowCollectionBehavior
+ *
+ * @const NSWindowCollectionBehaviorPrimary Marks a window as primary. This collection behavior should commonly be used for document or viewer windows.
+ * @const NSWindowCollectionBehaviorAuxiliary Marks a window as auxiliary. This collection behavior should commonly be used for About or Settings windows, as well as utility panes.
+ * @const NSWindowCollectionBehaviorCanJoinAllApplications Marks a window as able to join all applications, allowing it to join other apps' sets and full screen spaces when eligible. This collection behavior should commonly be used for floating windows and system overlays.
+ *
+ * @discussion You may specify at most one of @c NSWindowCollectionBehaviorPrimary, @c NSWindowCollectionBehaviorAuxiliary, or @c NSWindowCollectionBehaviorCanJoinAllApplications. If unspecified, the window gets the default treatment determined by its other collection behaviors.
+ *
+ * @const NSWindowCollectionBehaviorDefault
+ * @const NSWindowCollectionBehaviorCanJoinAllSpaces
+ * @const NSWindowCollectionBehaviorMoveToActiveSpace
+ *
+ * @discussion You may specify at most one of \c NSWindowCollectionBehaviorManaged, \c NSWindowCollectionBehaviorTransient, or \c NSWindowCollectionBehaviorStationary. If neither is specified, the window gets the default behavior determined by its window level.
+ *
+ * @const NSWindowCollectionBehaviorManaged Participates in spaces, exposé. Default behavior if `windowLevel == NSNormalWindowLevel`.
+ * @const NSWindowCollectionBehaviorTransient Floats in spaces, hidden by exposé. Default behavior if `windowLevel != NSNormalWindowLevel`.
+ * @const NSWindowCollectionBehaviorStationary Unaffected by exposé. Stays visible and stationary, like desktop window.
+ *
+ * @discussion You may specify at most one of \c NSWindowCollectionBehaviorParticipatesInCycle or \c NSWindowCollectionBehaviorIgnoresCycle. If unspecified, the window gets the default behavior determined by its window level.
+ *
+ * @const NSWindowCollectionBehaviorParticipatesInCycle Default behavior if `windowLevel != NSNormalWindowLevel`.
+ * @const NSWindowCollectionBehaviorIgnoresCycle Default behavior if `windowLevel != NSNormalWindowLevel`.
+ *
+ * @discussion You may specify at most one of \c NSWindowCollectionBehaviorFullScreenPrimary, \c NSWindowCollectionBehaviorFullScreenAuxiliary, or \c NSWindowCollectionBehaviorFullScreenNone.
+ *
+ * @const NSWindowCollectionBehaviorFullScreenPrimary The frontmost window with this collection behavior will be the fullscreen window.
+ * @const NSWindowCollectionBehaviorFullScreenAuxiliary Windows with this collection behavior can be shown with the fullscreen window.
+ * @const NSWindowCollectionBehaviorFullScreenNone The window can not be made fullscreen when this bit is set.
+ *
+ * @discussion You may specify at most one of \c NSWindowCollectionBehaviorFullScreenAllowsTiling or \c NSWindowCollectionBehaviorFullScreenDisallowsTiling, or an assertion will be raised.
+ *
+ * The default behavior is to allow any window to participate in full screen tiling, as long as it meets certain requirements, such as being resizable and not a panel or sheet. Windows which are not full screen capable can still become a secondary tile in full screen. A window can explicitly allow itself to be placed into a full screen tile by including \c NSWindowCollectionBehaviorFullScreenAllowsTiling. Even if a window allows itself to be placed in a tile, it still may not be put in the tile if its \c minFullScreenContentSize is too large to fit. A window can explicitly disallow itself from being placed in a full screen tile by including \c NSWindowCollectionBehaviorFullScreenDisallowsTiling. This is useful for non-full screen capable windows to explicitly prevent themselves from being tiled. It can also be used by a full screen window to prevent any other windows from being placed in its full screen tile.
+ *
+ * @const NSWindowCollectionBehaviorFullScreenAllowsTiling This window can be a full screen tile window. It does not have to have \c NSWindowCollectionBehaviorFullScreenPrimary set.
+ * @const NSWindowCollectionBehaviorFullScreenDisallowsTiling This window can NOT be made a full screen tile window; it still may be allowed to be a regular \c NSWindowCollectionBehaviorFullScreenPrimary window.
+ */
typedef NS_OPTIONS(NSUInteger, NSWindowCollectionBehavior) {
NSWindowCollectionBehaviorDefault = 0,
NSWindowCollectionBehaviorCanJoinAllSpaces = 1 << 0,
NSWindowCollectionBehaviorMoveToActiveSpace = 1 << 1,
- /* You may specify at most one of NSWindowCollectionBehaviorManaged, NSWindowCollectionBehaviorTransient, or NSWindowCollectionBehaviorStationary. If unspecified, the window gets the default behavior determined by its window level */
- NSWindowCollectionBehaviorManaged API_AVAILABLE(macos(10.6)) = 1 << 2, // participates in spaces, exposé. Default behavior if windowLevel == NSNormalWindowLevel
- NSWindowCollectionBehaviorTransient API_AVAILABLE(macos(10.6)) = 1 << 3, // floats in spaces, hidden by exposé. Default behavior if windowLevel != NSNormalWindowLevel
- NSWindowCollectionBehaviorStationary API_AVAILABLE(macos(10.6)) = 1 << 4, // unaffected by exposé. Stays visible and stationary, like desktop window
-
- /* You may specify at most one of NSWindowCollectionBehaviorParticipatesInCycle or NSWindowCollectionBehaviorIgnoresCycle. If unspecified, the window gets the default behavior determined by its window level */
- NSWindowCollectionBehaviorParticipatesInCycle API_AVAILABLE(macos(10.6)) = 1 << 5, // default behavior if windowLevel == NSNormalWindowLevel
- NSWindowCollectionBehaviorIgnoresCycle API_AVAILABLE(macos(10.6)) = 1 << 6, // default behavior if windowLevel != NSNormalWindowLevel
+ NSWindowCollectionBehaviorManaged API_AVAILABLE(macos(10.6)) = 1 << 2,
+ NSWindowCollectionBehaviorTransient API_AVAILABLE(macos(10.6)) = 1 << 3,
+ NSWindowCollectionBehaviorStationary API_AVAILABLE(macos(10.6)) = 1 << 4,
+
+ NSWindowCollectionBehaviorParticipatesInCycle API_AVAILABLE(macos(10.6)) = 1 << 5,
+ NSWindowCollectionBehaviorIgnoresCycle API_AVAILABLE(macos(10.6)) = 1 << 6,
- /* You may specify at most one of NSWindowCollectionBehaviorFullScreenPrimary, NSWindowCollectionBehaviorFullScreenAuxiliary, or NSWindowCollectionBehaviorFullScreenNone. */
- NSWindowCollectionBehaviorFullScreenPrimary API_AVAILABLE(macos(10.7)) = 1 << 7, // the frontmost window with this collection behavior will be the fullscreen window.
- NSWindowCollectionBehaviorFullScreenAuxiliary API_AVAILABLE(macos(10.7)) = 1 << 8, // windows with this collection behavior can be shown with the fullscreen window.
- NSWindowCollectionBehaviorFullScreenNone API_AVAILABLE(macos(10.7)) = 1 << 9, // The window can not be made fullscreen when this bit is set
+ NSWindowCollectionBehaviorFullScreenPrimary API_AVAILABLE(macos(10.7)) = 1 << 7,
+ NSWindowCollectionBehaviorFullScreenAuxiliary API_AVAILABLE(macos(10.7)) = 1 << 8,
+ NSWindowCollectionBehaviorFullScreenNone API_AVAILABLE(macos(10.7)) = 1 << 9,
- /* You may specify at most one of NSWindowCollectionBehaviorFullScreenAllowsTiling or NSWindowCollectionBehaviorFullScreenDisallowsTiling, or an assertion will be raised.
-
- The default behavior is to allow any window to participate in full screen tiling, as long as it meets certain requirements, such as being resizable and not a panel or sheet. Windows which are not full screen capable can still become a secondary tile in full screen. A window can explicitly allow itself to be placed into a full screen tile by including NSWindowCollectionBehaviorFullScreenAllowsTiling. Even if a window allows itself to be placed in a tile, it still may not be put in the tile if its minFullScreenContentSize is too large to fit. A window can explicitly disallow itself from being placed in a full screen tile by including NSWindowCollectionBehaviorFullScreenDisallowsTiling. This is useful for non-full screen capable windows to explicitly prevent themselves from being tiled. It can also be used by a full screen window to prevent any other windows from being placed in its full screen tile. */
- NSWindowCollectionBehaviorFullScreenAllowsTiling API_AVAILABLE(macos(10.11)) = 1 << 11, // This window can be a full screen tile window. It does not have to have FullScreenPrimary set.
- NSWindowCollectionBehaviorFullScreenDisallowsTiling API_AVAILABLE(macos(10.11)) = 1 << 12 // This window can NOT be made a full screen tile window; it still may be allowed to be a regular FullScreenPrimary window.
+ NSWindowCollectionBehaviorFullScreenAllowsTiling API_AVAILABLE(macos(10.11)) = 1 << 11,
+ NSWindowCollectionBehaviorFullScreenDisallowsTiling API_AVAILABLE(macos(10.11)) = 1 << 12,
+
+ NSWindowCollectionBehaviorPrimary API_AVAILABLE(macos(13.0)) = 1 << 16,
+ NSWindowCollectionBehaviorAuxiliary API_AVAILABLE(macos(13.0)) = 1 << 17,
+ NSWindowCollectionBehaviorCanJoinAllApplications API_AVAILABLE(macos(13.0)) = 1 << 18,
} API_AVAILABLE(macos(10.5));
-
+/*!
+ * @typedef NSWindowAnimationBehavior
+ *
+ * @const NSWindowAnimationBehaviorDefault Let AppKit infer animation behavior for this window.
+ * @const NSWindowAnimationBehaviorNone Suppress inferred animations (don't animate).
+ * @const NSWindowAnimationBehaviorDocumentWindow
+ * @const NSWindowAnimationBehaviorUtilityWindow
+ * @const NSWindowAnimationBehaviorAlertPanel
+ */
typedef NS_ENUM(NSInteger, NSWindowAnimationBehavior) {
- NSWindowAnimationBehaviorDefault = 0, // let AppKit infer animation behavior for this window
- NSWindowAnimationBehaviorNone = 2, // suppress inferred animations (don't animate)
+ NSWindowAnimationBehaviorDefault = 0,
+ NSWindowAnimationBehaviorNone = 2,
NSWindowAnimationBehaviorDocumentWindow = 3,
NSWindowAnimationBehaviorUtilityWindow = 4,
NSWindowAnimationBehaviorAlertPanel = 5
} API_AVAILABLE(macos(10.7));
-
-/* Options used in +windowNumbersWithOptions:. If no options are specified, the returned list contains window numbers for visible windows on the active space belonging to the calling application. */
+/*!
+ * @typedef NSWindowNumberListOptions
+ *
+ * Options used in `+windowNumbersWithOptions:`. If no options are specified, the returned list contains window numbers for visible windows on the active space belonging to the calling application.
+ *
+ * @const NSWindowNumberListAllApplications
+ * @const NSWindowNumberListAllSpaces
+ */
typedef NS_OPTIONS(NSUInteger, NSWindowNumberListOptions) {
NSWindowNumberListAllApplications = 1 << 0,
NSWindowNumberListAllSpaces = 1 << 4
} API_AVAILABLE(macos(10.6));
+/*!
+ * @typedef NSWindowOcclusionState
+ *
+ * @const NSWindowOcclusionStateVisible If set, at least part of the window is visible. If not set, the entire window is occluded. Windows with non-rectangular shapes may be completely occluded on screen but still count as visible, if their bounding box falls into a visible region. Windows that are completely transparent may also still count as visible.
+ */
typedef NS_OPTIONS(NSUInteger, NSWindowOcclusionState) {
- /* If set, at least part of the window is visible. If not set, the entire window is occluded. Windows with non-rectangular shapes may be completely occluded on screen but still count as visible, if their bounding box falls into a visible region. Windows that are completely transparent may also still count as visible. */
NSWindowOcclusionStateVisible = 1UL << 1,
} API_AVAILABLE(macos(10.9));
@@ -146,7 +207,11 @@
NSSelectingPrevious
};
-/* Standard window buttons */
+/*!
+ * @typedef NSWindowButton
+ *
+ * Standard window buttons.
+ */
typedef NS_ENUM(NSUInteger, NSWindowButton) {
NSWindowCloseButton,
NSWindowMiniaturizeButton,
@@ -156,23 +221,31 @@
NSWindowDocumentVersionsButton API_AVAILABLE(macos(10.7)) = 6,
};
+/*!
+ * @typedef NSWindowTitleVisibility
+ *
+ * @const NSWindowTitleVisible The default mode has a normal window title and titlebar buttons.
+ * @const NSWindowTitleHidden The always hidden mode hides the title and moves the toolbar up into the area previously occupied by the title.
+ */
typedef NS_ENUM(NSInteger, NSWindowTitleVisibility) {
- /* The default mode has a normal window title and titlebar buttons. */
NSWindowTitleVisible = 0,
- /* The always hidden mode hides the title and moves the toolbar up into the area previously occupied by the title. */
NSWindowTitleHidden = 1,
} API_AVAILABLE(macos(10.10));
+/*!
+ * @typedef NSWindowToolbarStyle
+ *
+ * @const NSWindowToolbarStyleAutomatic The default value. The style will be determined by the window's given configuration.
+ * @const NSWindowToolbarStyleExpanded The toolbar will appear below the window title.
+ * @const NSWindowToolbarStylePreference The toolbar will appear below the window title and the items in the toolbar will attempt to have equal widths when possible.
+ * @const NSWindowToolbarStyleUnified The window title will appear inline with the toolbar when visible.
+ * @const NSWindowToolbarStyleUnifiedCompact Same as \c NSWindowToolbarStyleUnified, but with reduced margins in the toolbar allowing more focus to be on the contents of the window.
+ */
typedef NS_ENUM(NSInteger, NSWindowToolbarStyle) {
- // The default value. The style will be determined by the window's given configuration
NSWindowToolbarStyleAutomatic,
- // The toolbar will appear below the window title
NSWindowToolbarStyleExpanded,
- // The toolbar will appear below the window title and the items in the toolbar will attempt to have equal widths when possible
NSWindowToolbarStylePreference,
- // The window title will appear inline with the toolbar when visible
NSWindowToolbarStyleUnified,
- // Same as NSWindowToolbarStyleUnified, but with reduced margins in the toolbar allowing more focus to be on the contents of the window
NSWindowToolbarStyleUnifiedCompact
} API_AVAILABLE(macos(11.0));
@@ -184,10 +257,17 @@
NSWindowUserTabbingPreferenceInFullScreen,
} API_AVAILABLE(macos(10.12));
+/*!
+ * @typedef NSWindowTabbingMode
+ *
+ * @const NSWindowTabbingModeAutomatic The system automatically prefers to tab this window when appropriate.
+ * @const NSWindowTabbingModePreferred The window explicitly should prefer to tab when shown.
+ * @const NSWindowTabbingModeDisallowed The window explicitly should not prefer to tab when shown.
+ */
typedef NS_ENUM(NSInteger, NSWindowTabbingMode) {
- NSWindowTabbingModeAutomatic, // The system automatically prefers to tab this window when appropriate
- NSWindowTabbingModePreferred, // The window explicitly should prefer to tab when shown
- NSWindowTabbingModeDisallowed // The window explicitly should not prefer to tab when shown
+ NSWindowTabbingModeAutomatic,
+ NSWindowTabbingModePreferred,
+ NSWindowTabbingModeDisallowed
} API_AVAILABLE(macos(10.12));
typedef NS_ENUM(NSInteger, NSTitlebarSeparatorStyle) {
@@ -217,29 +297,25 @@
@property (copy) NSString *title;
-/*
- Secondary text that may be displayed adjacent to or below the primary title depending on the configuration of the window.
- A value of empty string will remove the subtitle from the window layout.
-*/
+/*!
+ * Secondary text that may be displayed adjacent to or below the primary title depending on the configuration of the window.
+ * A value of empty string will remove the subtitle from the window layout.
+ */
@property (copy) NSString *subtitle API_AVAILABLE(macos(11.0));
-/* See the enum values for how this property works.
- */
+/// See the enum values for how this property works.
@property NSWindowTitleVisibility titleVisibility API_AVAILABLE(macos(10.10)); // Default value is NSWindowTitleVisible
-/* When YES, the titlebar doesn't draw its background, allowing all buttons to show through, and "click through" to happen. In general, this is only useful when NSFullSizeContentViewWindowMask is set.
- */
+/// When \c YES, the titlebar doesn't draw its background, allowing all buttons to show through, and "click through" to happen. In general, this is only useful when \c NSFullSizeContentViewWindowMask is set.
@property BOOL titlebarAppearsTransparent API_AVAILABLE(macos(10.10));
-/* Specifies how the titlebar area of the window should appear when the window displays an NSToolbar
- */
+/// Specifies how the titlebar area of the window should appear when the window displays an NSToolbar
@property NSWindowToolbarStyle toolbarStyle API_AVAILABLE(macos(11.0));
-/* The contentLayoutRect will return the area inside the window that is for non-obscured content. Typically, this is the same thing as the contentView's frame. However, for windows with the NSFullSizeContentViewWindowMask set, there needs to be a way to determine the portion that is not under the toolbar. The contentLayoutRect returns the portion of the layout that is not obscured under the toolbar. contentLayoutRect is in window coordinates. It is KVO compliant. */
+/// The \c contentLayoutRect will return the area inside the window that is for non-obscured content. Typically, this is the same thing as the `contentView`'s frame. However, for windows with the \c NSFullSizeContentViewWindowMask set, there needs to be a way to determine the portion that is not under the toolbar. The \c contentLayoutRect returns the portion of the layout that is not obscured under the toolbar. \c contentLayoutRect is in window coordinates. It is KVO compliant. */
@property (readonly) NSRect contentLayoutRect API_AVAILABLE(macos(10.10));
-/* contentLayoutGuide is a corollary to contentLayoutRect. It can be used by autolayout constraints to automatically bind to the contentLayoutRect.
- */
+/// \c contentLayoutGuide is a corollary to \c contentLayoutRect. It can be used by autolayout constraints to automatically bind to the \c contentLayoutRect.
@property (nullable, readonly) id contentLayoutGuide API_AVAILABLE(macos(10.10));
/* The following methods allow you to add accessory views to the titlebar/toolbar area of a window. See NSTitlebarAccessoryViewController for more details.
@@ -250,11 +326,11 @@
/* NOTE: you can use this method, or removeFromParentViewController, which ever is easier. */
- (void)removeTitlebarAccessoryViewControllerAtIndex:(NSInteger)index API_AVAILABLE(macos(10.10));
-
-/* setRepresentedURL:
-If url is not nil and its path is not empty, the window will show a document icon in the titlebar.
-If the url represents a filename or other resource with a known icon, that icon will be used as the document icon. Otherwise the default document icon will be used. The icon can be customized using [[NSWindow standardWindowButton:NSWindowDocumentIconButton] setImage:customImage]. If url is not nil and its path is not empty, the window will have a pop-up menu which can be shown via command-click on the area containing the document icon and title. By default, this menu will display the path components of the url. The presence and contents of this menu can be controlled by the delegate method window:shouldPopUpDocumentPathMenu:If the url is nil or has an empty path, the window will not show a document icon and will not have a pop-up menu available via command-click.
-*/
+/*!
+ * If url is not nil and its path is not empty, the window will show a document icon in the titlebar.
+ * If the url represents a filename or other resource with a known icon, that icon will be used as the document icon. Otherwise the default document icon will be used. The icon can be customized using `-[[NSWindow standardWindowButton:NSWindowDocumentIconButton] setImage:customImage]`. If url is not nil and its path is not empty, the window will have a pop-up menu which can be shown via command-click on the area containing the document icon and title. By default, this menu will display the path components of the url. The presence and contents of this menu can be controlled by the delegate method `-[window:shouldPopUpDocumentPathMenu:]`
+ * If the url is nil or has an empty path, the window will not show a document icon and will not have a pop-up menu available via command-click.
+ */
@property (nullable, copy) NSURL *representedURL API_AVAILABLE(macos(10.5));
@property (copy) NSString *representedFilename;
- (void)setTitleWithRepresentedFilename:(NSString *)filename;
@@ -263,7 +339,7 @@
@property (nullable, weak) id<NSWindowDelegate> delegate;
@property (readonly) NSInteger windowNumber;
-/* NOTE: The styleMask can only be set on OS 10.6 and later. Valid styleMask settings have the same restrictions as the styleMask passed to -initWithContentRect:styleMask:backing:defer:. Some styleMask changes will cause the view hierarchy to be rebuilt, since there is a different subclass for the top level view of a borderless window than for the top level view of a titled window. */
+/// @note The styleMask can only be set on macOS 10.6 and later. Valid \c styleMask settings have the same restrictions as the \c styleMask passed to `-initWithContentRect:styleMask:backing:defer:`. Some \c styleMask changes will cause the view hierarchy to be rebuilt, since there is a different subclass for the top level view of a borderless window than for the top level view of a titled window.
@property NSWindowStyleMask styleMask;
- (nullable NSText *)fieldEditor:(BOOL)createFlag forObject:(nullable id)object;
@@ -334,7 +410,7 @@
@property BOOL hidesOnDeactivate;
-// indicate whether a window can be hidden during -[NSApplication hide:]. Default is YES
+/// Indicates whether a window can be hidden during `-[NSApplication hide:]`. Default is \c YES.
@property BOOL canHide;
- (void)center;
@@ -365,7 +441,8 @@
@property (readonly) BOOL worksWhenModal;
-/* Normally, application termination is prohibited when a modal window or sheet is open, without consulting the application delegate. Some windows like the open panel or toolbar customization sheet should not prevent application termination. -setPreventsApplicationTerminationWhenModal:NO on a modal window or sheet will override the default behavior and allow application termination to proceed, either through the sudden termination path if enabled, or on to the next step of consulting the application delegate. By default, -preventsApplicationTerminationWhenModal returns YES */
+/*! Normally, application termination is prohibited when a modal window or sheet is open, without consulting the application delegate. Some windows like the open panel or toolbar customization sheet should not prevent application termination. `-setPreventsApplicationTerminationWhenModal:NO` on a modal window or sheet will override the default behavior and allow application termination to proceed, either through the sudden termination path if enabled, or on to the next step of consulting the application delegate. By default, `-preventsApplicationTerminationWhenModal` returns \c YES
+ */
@property BOOL preventsApplicationTerminationWhenModal API_AVAILABLE(macos(10.6));
/* Methods to convert window coordinates to screen coordinates */
@@ -380,10 +457,10 @@
- (NSPoint)convertPointToBacking:(NSPoint)point API_AVAILABLE(macos(10.14));
- (NSPoint)convertPointFromBacking:(NSPoint)point API_AVAILABLE(macos(10.14));
-/* Use NSIntegralRectWithOptions() to produce a backing store pixel aligned rectangle from the given input rectangle in window coordinates. */
+/// Use `NSIntegralRectWithOptions()` to produce a backing store pixel aligned rectangle from the given input rectangle in window coordinates.
- (NSRect)backingAlignedRect:(NSRect)rect options:(NSAlignmentOptions)options API_AVAILABLE(macos(10.7));
-/* Returns the scale factor representing the number of backing store pixels corresponding to each linear unit in window space on this NSWindow. This method is provided for rare cases when the explicit scale factor is needed. Please use -convert*ToBacking: methods whenever possible. */
+/// Returns the scale factor representing the number of backing store pixels corresponding to each linear unit in window space on this \c NSWindow. This method is provided for rare cases when the explicit scale factor is needed. Please use `-convert*ToBacking:` methods whenever possible.
@property (readonly) CGFloat backingScaleFactor API_AVAILABLE(macos(10.7));
- (void)performClose:(nullable id)sender;
@@ -393,9 +470,9 @@
- (NSData *)dataWithPDFInsideRect:(NSRect)rect;
- (void)print:(nullable id)sender;
-/*
- Default is NO. Set to YES to allow a window to display tooltips even when the application is in the background. Note that, enabling tooltips in an inactive application will cause the app to do work any time the mouse passes over the window. This can degrade system performance.
- Returns YES if this window displays tooltips even when the application is in the background. To configure this setting you should call setAllowsToolTipsWhenApplicationIsInactive: instead of overriding -allowsToolTipsWhenApplicationIsInactive.
+/*!
+ * Default is \c NO. Set to \c YES to allow a window to display tooltips even when the application is in the background. Note that, enabling tooltips in an inactive application will cause the app to do work any time the mouse passes over the window. This can degrade system performance.
+ * Returns \c YES if this window displays tooltips even when the application is in the background. To configure this setting you should call `-setAllowsToolTipsWhenApplicationIsInactive:` instead of overriding `-allowsToolTipsWhenApplicationIsInactive`.
*/
@property BOOL allowsToolTipsWhenApplicationIsInactive;
@@ -405,7 +482,7 @@
- (void)setDynamicDepthLimit:(BOOL)flag;
@property (readonly) BOOL hasDynamicDepthLimit;
-/* The screen property returns the best screen for the window. If the window only intersects one screen, it returns that screen. If it intersects more than one screen, then it resolves the tie through based on what space it is mostly on. It may return nil if there are no available screens, or it is completely off screen.
+/*! The screen property returns the best screen for the window. If the window only intersects one screen, it returns that screen. If it intersects more than one screen, then it resolves the tie through based on what space it is mostly on. It may return nil if there are no available screens, or it is completely off screen.
*/
@property (nullable, readonly, strong) NSScreen *screen;
@property (nullable, readonly, strong) NSScreen *deepestScreen;
@@ -416,22 +493,22 @@
@property (getter=isOpaque) BOOL opaque;
-/* -setSharingType: specifies whether the window content can be read and/or written from another process. The default sharing type is NSWindowSharingReadOnly, which means other processes can read the window content (eg. for window capture) but cannot modify it. If you set your window sharing type to NSWindowSharingNone, so that the content cannot be captured, your window will also not be able to participate in a number of system services, so this setting should be used with caution. If you set your window sharing type to NSWindowSharingReadWrite, other processes can both read and modify the window content.
+/*! `-setSharingType:` specifies whether the window content can be read and/or written from another process. The default sharing type is \c NSWindowSharingReadOnly, which means other processes can read the window content (eg. for window capture) but cannot modify it. If you set your window sharing type to \c NSWindowSharingNone, so that the content cannot be captured, your window will also not be able to participate in a number of system services, so this setting should be used with caution. If you set your window sharing type to \c NSWindowSharingReadWrite, other processes can both read and modify the window content.
*/
@property NSWindowSharingType sharingType API_AVAILABLE(macos(10.5));
-/* Controls whether threading of view drawing should be enabled for this window. Defaults to YES. When this is set to YES, AppKit's view system is allowed to perform -drawRect: activity for the window's views on threads other than the main thread, for views that have canDrawConcurrently == YES. When this is set to NO, the window's views will be drawn serially as on 10.5 and earlier, even though some of the views may have canDrawConcurrently == YES.
+/*! Controls whether threading of view drawing should be enabled for this window. Defaults to \c YES. When this is set to \c YES, AppKit's view system is allowed to perform `-drawRect:` activity for the window's views on threads other than the main thread, for views that have `canDrawConcurrently == YES`. When this is set to \c NO, the window's views will be drawn serially as on 10.5 and earlier, even though some of the views may have `canDrawConcurrently == YES`.
*/
@property BOOL allowsConcurrentViewDrawing API_AVAILABLE(macos(10.6));
@property BOOL displaysWhenScreenProfileChanges;
-/*
+/*!
In recent macOS versions this method does not do anything and should not be called.
*/
- (void)disableScreenUpdatesUntilFlush;
-/* This API controls whether the receiver is permitted onscreen before the user has logged in. This property is off by default. Alert panels and windows presented by input managers are examples of windows which should have this property set.
+/*! This API controls whether the receiver is permitted onscreen before the user has logged in. This property is off by default. Alert panels and windows presented by input managers are examples of windows which should have this property set.
*/
@property BOOL canBecomeVisibleWithoutLogin API_AVAILABLE(macos(10.5));
@@ -439,15 +516,15 @@
@property NSWindowCollectionBehavior collectionBehavior API_AVAILABLE(macos(10.5));
-/* Provides for per-window control over automatic orderFront/orderOut animation behaviors added in 10.7. Can be set to NSWindowAnimationBehaviorNone to disable Appkit's automatic animations for a given window, or to one of the other non-Default NSWindowAnimationBehavior values to override AppKit's automatic inference of appropriate animation behavior based on the window's apparent type.
+/*! Provides for per-window control over automatic orderFront/orderOut animation behaviors added in 10.7. Can be set to \c NSWindowAnimationBehaviorNone to disable Appkit's automatic animations for a given window, or to one of the other non-Default \c NSWindowAnimationBehavior values to override AppKit's automatic inference of appropriate animation behavior based on the window's apparent type.
*/
@property NSWindowAnimationBehavior animationBehavior API_AVAILABLE(macos(10.7));
-/* Returns YES if this window is associated with the active space. For visible windows, this API indicates whether the window is currently visible on the active space. For offscreen windows, it indicates whether ordering the window onscreen would make it bring it onto the active space */
+/*! Returns \c YES if this window is associated with the active space. For visible windows, this API indicates whether the window is currently visible on the active space. For offscreen windows, it indicates whether ordering the window onscreen would make it bring it onto the active space */
@property (getter=isOnActiveSpace, readonly) BOOL onActiveSpace API_AVAILABLE(macos(10.6));
-/* toggleFullScreen: enters or exits for full screen. A window must have NSWindowCollectionBehaviorFullScreenAuxiliary or NSWindowCollectionBehaviorFullScreenPrimary included in the collectionBehavior property; if it does not, this method may simply do nothing.
+/*! `-toggleFullScreen:` enters or exits for full screen. A window must have \c NSWindowCollectionBehaviorFullScreenAuxiliary or \c NSWindowCollectionBehaviorFullScreenPrimary included in the \c collectionBehavior property; if it does not, this method may simply do nothing.
*/
- (void)toggleFullScreen:(nullable id)sender API_AVAILABLE(macos(10.7));
@@ -489,15 +566,19 @@
- (void)beginCriticalSheet:(NSWindow *)sheetWindow completionHandler:(void (^ _Nullable)(NSModalResponse returnCode))handler API_AVAILABLE(macos(10.9));
- (void)endSheet:(NSWindow *)sheetWindow API_AVAILABLE(macos(10.9));
- (void)endSheet:(NSWindow *)sheetWindow returnCode:(NSModalResponse)returnCode API_AVAILABLE(macos(10.9));
-@property (readonly, copy) NSArray<__kindof NSWindow *> *sheets API_AVAILABLE(macos(10.9)); // An ordered array of the sheets on the window. This consists of the presented sheets in top-to-bottom order, followed by queued sheets in the order they were queued. This does not include nested/sub-sheets.
-@property (nullable, readonly, strong) NSWindow *attachedSheet; // Returns the top-most sheet if there is one or more sheets, or nil if there is no sheet.
+
+/// An ordered array of the sheets on the window. This consists of the presented sheets in top-to-bottom order, followed by queued sheets in the order they were queued. This does not include nested/sub-sheets.
+@property (readonly, copy) NSArray<__kindof NSWindow *> *sheets API_AVAILABLE(macos(10.9));
+
+/// Returns the top-most sheet if there is one or more sheets, or nil if there is no sheet.
+@property (nullable, readonly, strong) NSWindow *attachedSheet;
@property (getter=isSheet, readonly) BOOL sheet;
-/* Returns the window that the sheet is directly attached to. This is based on the logical attachment of the sheet, not visual attachment.
- This relationship exists starting when the sheet is begun (using NSApplication's -beginSheet:modalForWindow:modalDelegate:didEndSelector:contextInfo: or NSWindow's -beginSheet:completionHandler:), and ending once it is ordered out.
-
- Returns nil if the window is not a sheet or has no sheet parent.
+/*!
+ * Returns the window that the sheet is directly attached to. This is based on the logical attachment of the sheet, not visual attachment.
+ * This relationship exists starting when the sheet is begun (using \c NSApplication's `-beginSheet:modalForWindow:modalDelegate:didEndSelector:contextInfo: or NSWindow's -beginSheet:completionHandler:`), and ending once it is ordered out.
+ * Returns nil if the window is not a sheet or has no sheet parent.
*/
@property (nullable, readonly, strong) NSWindow *sheetParent API_AVAILABLE(macos(10.9));
@@ -516,28 +597,28 @@
@property (nullable, strong) NSColorSpace *colorSpace API_AVAILABLE(macos(10.6));
-/* canRepresentDisplayGamut: returns YES if the colorSpace of the receiving window, and the colorSpace of the screen containing that window, are capable of representing the given display gamut
+/*! `-canRepresentDisplayGamut:` returns \c YES if the colorSpace of the receiving window, and the \c colorSpace of the screen containing that window, are capable of representing the given display gamut
*/
- (BOOL)canRepresentDisplayGamut:(NSDisplayGamut)displayGamut API_AVAILABLE(macos(10.12));
-/* windowNumbersWithOptions: returns an autoreleased array of NSNumbers containing windowNumbers for all visible windows satisfying options. If no options are specified, only visible windows belonging to the calling application and on the active space are included. If options include NSWindowNumberListAllApplications, visible windows belonging to all applications are included. If options include NSWindowNumberListAllSpaces, visible windows on all spaces are included. Windows on the active space are returned in z-order.
+/*! `+windowNumbersWithOptions:` returns an autoreleased array of \c NSNumbers containing windowNumbers for all visible windows satisfying options. If no options are specified, only visible windows belonging to the calling application and on the active space are included. If options include \c NSWindowNumberListAllApplications, visible windows belonging to all applications are included. If options include \c NSWindowNumberListAllSpaces, visible windows on all spaces are included. Windows on the active space are returned in z-order.
Examples:
To get an array of windowNumbers visible on the current space and belonging to the calling application:
- windowNumbers = [NSWindow windowNumbersWithOptions:0];
+ `windowNumbers = [NSWindow windowNumbersWithOptions:0];`
To get an array of windowNumbers visible on any space and belonging to any application:
- windowNumbers = [NSWindow windowNumbersWithOptions:NSWindowNumberListAllApplications|NSWindowNumberListAllSpaces];
+ `windowNumbers = [NSWindow windowNumbersWithOptions:NSWindowNumberListAllApplications|NSWindowNumberListAllSpaces];`
To get an array of windowNumbers visible on any space and belonging to the calling application:
- windowNumbers = [NSWindow windowNumbersWithOptions:NSWindowNumberListAllSpaces];
+ `windowNumbers = [NSWindow windowNumbersWithOptions:NSWindowNumberListAllSpaces];`
*/
+ (nullable NSArray<NSNumber *> *)windowNumbersWithOptions:(NSWindowNumberListOptions)options API_AVAILABLE(macos(10.6));
-/* windowNumberAtPoint:belowWindowWithWindowNumber: returns the number of the frontmost window that would be hit by a mouseDown at the screen location "point". "windowNum" can be specified to exclude a given window along with all windows above it, and may belong to any application. If no windows are to be excluded, specify 0 for "windowNum". The windowNumber returned may correspond to a window in another application.
+/*! `+windowNumberAtPoint:belowWindowWithWindowNumber:` returns the number of the frontmost window that would be hit by a mouseDown at the screen location "point". "windowNum" can be specified to exclude a given window along with all windows above it, and may belong to any application. If no windows are to be excluded, specify 0 for "windowNum". The windowNumber returned may correspond to a window in another application.
*/
+ (NSInteger)windowNumberAtPoint:(NSPoint)point belowWindowWithWindowNumber:(NSInteger)windowNumber API_AVAILABLE(macos(10.6));
@property (readonly) NSWindowOcclusionState occlusionState API_AVAILABLE(macos(10.9));
-/* Specifies the style of separator displayed between the window's titlebar and content.
+/*! Specifies the style of separator displayed between the window's titlebar and content.
The default value is NSTitlebarSeparatorStyleAutomatic. Changing this value will override any preference made by `NSSplitViewItem`.
*/
@@ -546,17 +627,17 @@
#pragma mark - NSViewController Support
-/* The main content view controller for the window. This provides the contentView of the window. Assigning this value will remove the existing contentView and will make the contentViewController.view the main contentView for the window. The default value is nil. The contentViewController only controls the contentView, and not the title of the window. The window title can easily be bound to the contentViewController with the following: [window bind:NSTitleBinding toObject:contentViewController withKeyPath:@"title" options:nil]. Setting the contentViewController will cause the window to resize based on the current size of the contentViewController. Autolayout should be used to restrict the size of the window. The value of the contentViewController is encoded in the NIB. Directly assigning a contentView will clear out the contentViewController.
+/*! The main content view controller for the window. This provides the contentView of the window. Assigning this value will remove the existing contentView and will make the contentViewController.view the main contentView for the window. The default value is nil. The contentViewController only controls the contentView, and not the title of the window. The window title can easily be bound to the contentViewController with the following: [window bind:NSTitleBinding toObject:contentViewController withKeyPath:@"title" options:nil]. Setting the contentViewController will cause the window to resize based on the current size of the contentViewController. Autolayout should be used to restrict the size of the window. The value of the contentViewController is encoded in the NIB. Directly assigning a contentView will clear out the contentViewController.
*/
@property (nullable, strong) NSViewController *contentViewController API_AVAILABLE(macos(10.10));
-/* Convenience method for creating an autoreleased titled window with the given contentViewController. A basic NSWindow with the following attributes is made: titled, closable, resizable, miniaturizable. The window's title is automatically bound to the contentViewController's title. The size of the window can easily be controlled by utilizing autolayout and applying size constraints to the view (or its subviews). The window has isReleasedWhenClosed set to NO, and it must be explicitly retained to keep the window instance alive. To have it automatically be freed when it is closed, do the following: [window retain] and [window setReleasedWhenClosed:YES].
+/*! Convenience method for creating an autoreleased titled window with the given contentViewController. A basic NSWindow with the following attributes is made: titled, closable, resizable, miniaturizable. The window's title is automatically bound to the contentViewController's title. The size of the window can easily be controlled by utilizing autolayout and applying size constraints to the view (or its subviews). The window has isReleasedWhenClosed set to NO, and it must be explicitly retained to keep the window instance alive. To have it automatically be freed when it is closed, do the following: [window retain] and [window setReleasedWhenClosed:YES].
*/
+ (instancetype)windowWithContentViewController:(NSViewController *)contentViewController API_AVAILABLE(macos(10.10));
#pragma mark - Window Dragging
-/* Call to start a drag (moving the window) in the Window Server process. In general, this can be done after a mouseDown event has come in and been examined by an application or view. The view may determine it wants to allow that portion of the window to start a window drag, and can hand off the work to the Window Server process by calling this method. This allows the window to participate in space switching, and other system features. Pass the original mouseDown event to the method. The method will return right away, and a mouseUp may not get sent.
+/*! Call to start a drag (moving the window) in the Window Server process. In general, this can be done after a mouseDown event has come in and been examined by an application or view. The view may determine it wants to allow that portion of the window to start a window drag, and can hand off the work to the Window Server process by calling this method. This allows the window to participate in space switching, and other system features. Pass the original mouseDown event to the method. The method will return right away, and a mouseUp may not get sent.
*/
- (void)performWindowDragWithEvent:(NSEvent *)event API_AVAILABLE(macos(10.11));
@@ -583,52 +664,53 @@
#pragma mark - Automatic Window Tabbing
-/* Allows automatic window tabbing when the value is YES. By default, this will be set to YES, but applications can explicitly opt out of all automatic tabbing by setting it to NO, and can still adopted explicit window tabbing, if desired.
+/*! Allows automatic window tabbing when the value is \c YES. By default, this will be set to \c YES, but applications can explicitly opt out of all automatic tabbing by setting it to NO, and can still adopted explicit window tabbing, if desired.
*/
@property (class) BOOL allowsAutomaticWindowTabbing API_AVAILABLE(macos(10.12));
-/* Returns the user's tabbing preference as set in System Preferences. This value should be queried anytime a new window is made to see if the user wants to automatically show it in tabs.
+/*! Returns the user's tabbing preference as set in System Preferences. This value should be queried anytime a new window is made to see if the user wants to automatically show it in tabs.
*/
@property (class, readonly) NSWindowUserTabbingPreference userTabbingPreference API_AVAILABLE(macos(10.12));
-/* Get and set the tabbing mode for this window. This should be set before a window is shown. The default value is NSWindowTabbingModeAutomatic. When the value is NSWindowTabbingModeAutomatic, the system will look at the userTabbingPreference and automatically tab windows together based on the tabbingIdentifier, when it is appropriate to do so.
+/*! Get and set the tabbing mode for this window. This should be set before a window is shown. The default value is \c NSWindowTabbingModeAutomatic. When the value is \c NSWindowTabbingModeAutomatic, the system will look at the \c userTabbingPreference and automatically tab windows together based on the tabbingIdentifier, when it is appropriate to do so.
*/
@property NSWindowTabbingMode tabbingMode API_AVAILABLE(macos(10.12));
-/* Windows with the same tabbingIdentifier will have the ability to be tabbed together when a window is being shown. This allows aggregation of similar windows. By default, the tabbingIdentifier will be generated based on inherent window properties, such as the window class name, the delegate class name, the window controller class name, and some additional state. Windows can be explicitly made to group together by using the same tabbingIdentifier.
+/*! Windows with the same \c tabbingIdentifier will have the ability to be tabbed together when a window is being shown. This allows aggregation of similar windows. By default, the \c tabbingIdentifier will be generated based on inherent window properties, such as the window class name, the delegate class name, the window controller class name, and some additional state. Windows can be explicitly made to group together by using the same \c tabbingIdentifier.
*/
@property (copy) NSWindowTabbingIdentifier tabbingIdentifier API_AVAILABLE(macos(10.12));
-/* Actions that can be called to perform various tabbed window behaviors. UI that is hooked up to these items can be automatically validated by calling NSWindow's validateUserInterfaceItem.
+/*! Actions that can be called to perform various tabbed window behaviors. UI that is hooked up to these items can be automatically validated by calling `NSWindow`'s \c validateUserInterfaceItem.
*/
- (IBAction)selectNextTab:(nullable id)sender API_AVAILABLE(macos(10.12));
- (IBAction)selectPreviousTab:(nullable id)sender API_AVAILABLE(macos(10.12));
- (IBAction)moveTabToNewWindow:(nullable id)sender API_AVAILABLE(macos(10.12));
- (IBAction)mergeAllWindows:(nullable id)sender API_AVAILABLE(macos(10.12));
- (IBAction)toggleTabBar:(nullable id)sender API_AVAILABLE(macos(10.12));
-/* Toggle the Tab Picker / Tab Overview UI which is invoked via "Show All Tabs". Performs the toggle in an animated fashion. Use tabGroup.isOverviewVisible to find out if it is visible or not at a given time.
+
+/*! Toggle the Tab Picker / Tab Overview UI which is invoked via "Show All Tabs". Performs the toggle in an animated fashion. Use `tabGroup.isOverviewVisible` to find out if it is visible or not at a given time.
*/
- (IBAction)toggleTabOverview:(nullable id)sender API_AVAILABLE(macos(10.13));
-/* This is now a cover for self.tabGroup.windows, but will return nil if the window is not showing a tab bar.
+/*! This is now a cover for `self.tabGroup.windows`, but will return nil if the window is not showing a tab bar.
*/
@property (readonly, copy, nullable) NSArray<NSWindow *> *tabbedWindows API_AVAILABLE(macos(10.12));
-/* This is now a cover for [self.tabGroup addWindow:], which allows more precise placement.
+/*! This is now a cover for `-[self.tabGroup addWindow:]`, which allows more precise placement.
*/
- (void)addTabbedWindow:(NSWindow *)window ordered:(NSWindowOrderingMode)ordered API_AVAILABLE(macos(10.12));
-/* Access the properties for this window when it is a tabbed window environment. See the NSWindowTab header and comments for more information.
+/*! Access the properties for this window when it is a tabbed window environment. See the \c NSWindowTab header and comments for more information.
*/
@property (strong, readonly) NSWindowTab *tab API_AVAILABLE(macos(10.13));
-/* Represents a tab group of windows. This tabGroup is lazily created on demand.
+/*! Represents a tab group of windows. This \c tabGroup is lazily created on demand.
*/
@property (readonly, weak) NSWindowTabGroup *tabGroup API_AVAILABLE(macos(10.13));
#pragma mark - Other
-/* Retrieve the layout direction of the window titlebar: this includes the standard window buttons (close/minimize/maximize buttons) and the title for this window. In general, this will return "right to left" (RTL) if the primary system language is RTL. The layout direction may be RTL even in applications that do not have a RTL language localization. This value should be utilized if an application uses titlebarAppearsTransparent and places controls underneath the titlebar.
+/*! Retrieve the layout direction of the window titlebar: this includes the standard window buttons (close/minimize/maximize buttons) and the title for this window. In general, this will return "right to left" (RTL) if the primary system language is RTL. The layout direction may be RTL even in applications that do not have a RTL language localization. This value should be utilized if an application uses titlebarAppearsTransparent and places controls underneath the titlebar.
*/
@property (readonly) NSUserInterfaceLayoutDirection windowTitlebarLayoutDirection API_AVAILABLE(macos(10.12));
@@ -637,7 +719,7 @@
@end
@interface NSWindow(NSEvent)
-/* Tracks events matching the supplied mask with the supplied tracking handler until the tracking handler explicitly terminates tracking. Each event is removed from the event queue then passed to the tracking handler. If a matching event does not exist in the event queue, then the main thread blocks in the specified runloop mode until an event of the requested type is received or the timeout expires. If the timeout expires, the tracking handler is called with a nil event. A negative timeout is interpreted as 0. Use NSEventDurationForever to never timeout. Tracking continues until *stop is set to YES. Calls to -nextEventMatchingMask:… are allowed inside the trackingHandler block. This method returns once tracking is terminated.
+/*! Tracks events matching the supplied mask with the supplied tracking handler until the tracking handler explicitly terminates tracking. Each event is removed from the event queue then passed to the tracking handler. If a matching event does not exist in the event queue, then the main thread blocks in the specified runloop mode until an event of the requested type is received or the timeout expires. If the timeout expires, the tracking handler is called with a nil event. A negative timeout is interpreted as 0. Use \c NSEventDurationForever to never timeout. Tracking continues until `*stop` is set to \c YES. Calls to `-nextEventMatchingMask:…` are allowed inside the trackingHandler block. This method returns once tracking is terminated.
*/
- (void)trackEventsMatchingMask:(NSEventMask)mask timeout:(NSTimeInterval)timeout mode:(NSRunLoopMode)mode handler:(void (NS_NOESCAPE ^)(NSEvent *_Nullable event, BOOL *stop))trackingHandler API_AVAILABLE(macos(10.10));
- (nullable NSEvent *)nextEventMatchingMask:(NSEventMask)mask;
@@ -670,11 +752,11 @@
@interface NSWindow(NSCarbonExtensions)
-/* Create an NSWindow for a Carbon window - windowRef must be a Carbon WindowRef - see MacWindows.h. This method can only be called on NSWindow, and not subclasses of NSWindow. On 10.11, it will throw an exception if this is done.
+/*! Create an \c NSWindow for a Carbon window - \c windowRef must be a Carbon \c WindowRef - see `MacWindows.h`. This method can only be called on \c NSWindow, and not subclasses of \c NSWindow. On 10.11, it will throw an exception if this is done.
*/
- (nullable NSWindow *)initWithWindowRef:(void * /* WindowRef */)windowRef;
-/* return the Carbon WindowRef for this window, creating if necessary: - see MacWindows.h
+/*! Return the Carbon \c WindowRef for this window, creating if necessary: - see `MacWindows.h`.
*/
@property (readonly) void * /* WindowRef */windowRef NS_RETURNS_INNER_POINTER;
@end
@@ -689,15 +771,15 @@
- (BOOL)windowShouldZoom:(NSWindow *)window toFrame:(NSRect)newFrame NS_SWIFT_UI_ACTOR;
- (nullable NSUndoManager *)windowWillReturnUndoManager:(NSWindow *)window NS_SWIFT_UI_ACTOR;
-/* Tells the delegate that the window is about to show a sheet, and gives the delegate a chance to customize the location of the sheet.
+/*! Tells the delegate that the window is about to show a sheet, and gives the delegate a chance to customize the location of the sheet.
*/
- (NSRect)window:(NSWindow *)window willPositionSheet:(NSWindow *)sheet usingRect:(NSRect)rect NS_SWIFT_UI_ACTOR;
-/* If a window has a representedURL, the window will by default show a path popup menu for a command-click on a rectangle containing the window document icon button and the window title. The window delegate may implement -window:shouldPopupDocumentPathMenu: to override NSWindow's default behavior for path popup menu. A return of NO will prevent the menu from being shown. A return of YES will cause the window to show the menu passed to this method, which by default will contain a menuItem for each path component of the representedURL. If the representedURL has no path components, the menu will have no menu items. Before returning YES, the window delegate may customize the menu by changing the menuItems. menuItems may be added or deleted, and each menuItem title, action, or target may be modified.
+/*! If a window has a \c representedURL, the window will by default show a path popup menu for a command-click on a rectangle containing the window document icon button and the window title. The window delegate may implement `-window:shouldPopupDocumentPathMenu:` to override `NSWindow`'s default behavior for path popup menu. A return of \c NO will prevent the menu from being shown. A return of \c YES will cause the window to show the menu passed to this method, which by default will contain a menuItem for each path component of the \c representedURL. If the \c representedURL has no path components, the menu will have no menu items. Before returning \c YES, the window delegate may customize the menu by changing the menuItems. menuItems may be added or deleted, and each menuItem title, action, or target may be modified.
*/
- (BOOL)window:(NSWindow *)window shouldPopUpDocumentPathMenu:(NSMenu *)menu NS_SWIFT_UI_ACTOR API_AVAILABLE(macos(10.5));
-/* The window delegate may implement -window:shouldDragDocumentWithEvent:from:withPasteboard: to override NSWindow document icon's default drag behavior. The delegate can prohibit the drag by returning NO. Before returning NO, the delegate may implement its own dragging behavior using -[NSWindow dragImage:at:offset:event:pasteboard:source:slideBack:]. Alternatively, the delegate can enable a drag by returning YES, for example to override NSWindow's default behavior of prohibiting the drag of an edited document. Lastly, the delegate can customize the pasteboard contents before returning YES.
+/*! The window delegate may implement `-window:shouldDragDocumentWithEvent:from:withPasteboard:` to override \c NSWindow document icon's default drag behavior. The delegate can prohibit the drag by returning \c NO. Before returning \c NO, the delegate may implement its own dragging behavior using `-[NSWindow dragImage:at:offset:event:pasteboard:source:slideBack:]`. Alternatively, the delegate can enable a drag by returning \c YES, for example to override NSWindow's default behavior of prohibiting the drag of an edited document. Lastly, the delegate can customize the pasteboard contents before returning \c YES.
*/
- (BOOL)window:(NSWindow *)window shouldDragDocumentWithEvent:(NSEvent *)event from:(NSPoint)dragImageLocation withPasteboard:(NSPasteboard *)pasteboard NS_SWIFT_UI_ACTOR API_AVAILABLE(macos(10.5));
@@ -705,45 +787,47 @@
- (NSApplicationPresentationOptions)window:(NSWindow *)window willUseFullScreenPresentationOptions:(NSApplicationPresentationOptions)proposedOptions NS_SWIFT_UI_ACTOR API_AVAILABLE(macos(10.7));
-/* The default animation between a window and its fullscreen representation is a crossfade. With knowledge of the layout of a window before and after it enters fullscreen, an application can do a much better job on the animation. The following API allows a window delegate to customize the animation by providing a custom window or windows containing layers or other effects. In order to manage windows on spaces, we need the window delegate to provide a list of windows involved in the animation. If an application does not do a custom animation, this method can be unimplemented or can return nil. window:startCustomAnimationToEnterFullScreenWithDuration: will be called only if customWindowsToEnterFullScreenForWindow: returns non-nil.
+/*! The default animation between a window and its fullscreen representation is a crossfade. With knowledge of the layout of a window before and after it enters fullscreen, an application can do a much better job on the animation. The following API allows a window delegate to customize the animation by providing a custom window or windows containing layers or other effects. In order to manage windows on spaces, we need the window delegate to provide a list of windows involved in the animation. If an application does not do a custom animation, this method can be unimplemented or can return nil. `-window:startCustomAnimationToEnterFullScreenWithDuration:` will be called only if `-customWindowsToEnterFullScreenForWindow:` returns non-nil.
*/
- (nullable NSArray<NSWindow *> *)customWindowsToEnterFullScreenForWindow:(NSWindow *)window NS_SWIFT_UI_ACTOR API_AVAILABLE(macos(10.7));
-/* The system has started its animation into fullscreen, including transitioning to a new space. Start the window fullscreen animation immediately, and perform the animation with the given duration to be in sync with the system animation. This method is called only if customWindowToEnterFullScreenForWindow: returned non-nil.
+/*! The system has started its animation into fullscreen, including transitioning to a new space. Start the window fullscreen animation immediately, and perform the animation with the given duration to be in sync with the system animation. This method is called only if `-customWindowToEnterFullScreenForWindow:` returned non-nil.
*/
- (void)window:(NSWindow *)window startCustomAnimationToEnterFullScreenWithDuration:(NSTimeInterval)duration NS_SWIFT_UI_ACTOR API_AVAILABLE(macos(10.7));
-/* In some cases, the transition to enter fullscreen will fail, due to being in the midst of handling some other animation or user gesture. We will attempt to minimize these cases, but believe there is a need for failure handling. This method indicates that there was an error, and the application should clean up any work it may have done to prepare to enter fullscreen. This message will be sent whether or not the delegate indicated a custom animation by returning non-nil from customWindowsToEnterFullScreenForWindow:.
+/*! In some cases, the transition to enter fullscreen will fail, due to being in the midst of handling some other animation or user gesture. We will attempt to minimize these cases, but believe there is a need for failure handling. This method indicates that there was an error, and the application should clean up any work it may have done to prepare to enter fullscreen. This message will be sent whether or not the delegate indicated a custom animation by returning non-nil from `-customWindowsToEnterFullScreenForWindow:`.
*/
- (void)windowDidFailToEnterFullScreen:(NSWindow *)window NS_SWIFT_UI_ACTOR API_AVAILABLE(macos(10.7));
-/* The window is about to exit fullscreen mode. The following API allows a window delegate to customize the animation when the window is about to exit fullscreen. In order to manage windows on spaces, we need the window delegate to provide a list of windows involved in the animation. If an application does not do a custom animation, this method can be unimplemented or can return nil. window:startCustomAnimationToExitFullScreenWithDuration: will be called only if customWindowsToExitFullScreenForWindow: returns non-nil.
+/*! The window is about to exit fullscreen mode. The following API allows a window delegate to customize the animation when the window is about to exit fullscreen. In order to manage windows on spaces, we need the window delegate to provide a list of windows involved in the animation. If an application does not do a custom animation, this method can be unimplemented or can return nil. `-window:startCustomAnimationToExitFullScreenWithDuration:` will be called only if `-customWindowsToExitFullScreenForWindow:` returns non-nil.
*/
- (nullable NSArray<NSWindow *> *)customWindowsToExitFullScreenForWindow:(NSWindow *)window NS_SWIFT_UI_ACTOR API_AVAILABLE(macos(10.7));
-/* The system has started its animation out of fullscreen, including transitioning back to the desktop space. Start the window animation immediately, and perform the animation with the given duration to be in sync with the system animation. This method is called only if customWindowsToExitFullScreenForWindow: returned non-nil.
+/*! The system has started its animation out of fullscreen, including transitioning back to the desktop space. Start the window animation immediately, and perform the animation with the given duration to be in sync with the system animation. This method is called only if `-customWindowsToExitFullScreenForWindow:` returned non-nil.
*/
- (void)window:(NSWindow *)window startCustomAnimationToExitFullScreenWithDuration:(NSTimeInterval)duration NS_SWIFT_UI_ACTOR API_AVAILABLE(macos(10.7));
-/* customWindowsToEnterFullScreenForWindow:onScreen: will be called in place of customWindowsToEnterFullScreenForWindow: if both are implemented */
+/*! `-customWindowsToEnterFullScreenForWindow:onScreen:` will be called in place of `-customWindowsToEnterFullScreenForWindow:` if both are implemented.
+ */
- (nullable NSArray<NSWindow *> *)customWindowsToEnterFullScreenForWindow:(NSWindow *)window onScreen:(NSScreen *)screen NS_SWIFT_UI_ACTOR API_AVAILABLE(macos(10.9));
-/* window:startCustomAnimationToEnterFullScreenOnScreen:withDuration: will be called in place of window:startCustomAnimationToEnterFullScreenWithDuration: if both are implemented */
+/*! `-window:startCustomAnimationToEnterFullScreenOnScreen:withDuration:` will be called in place of `-window:startCustomAnimationToEnterFullScreenWithDuration:` if both are implemented.
+ */
- (void)window:(NSWindow *)window startCustomAnimationToEnterFullScreenOnScreen:(NSScreen *)screen withDuration:(NSTimeInterval)duration NS_SWIFT_UI_ACTOR API_AVAILABLE(macos(10.9));
-/* In some cases, the transition to exit fullscreen will fail, due to being in the midst of handling some other animation or user gesture. We will attempt to minimize these cases, but believe there is a need for failure handling. This method indicates that there was an error, and the application should clean up any work it may have done to prepare to exit fullscreen. This message will be sent whether or not the delegate indicated a custom animation by returning non-nil from customWindowsToExitFullScreenForWindow:.
+/*! In some cases, the transition to exit fullscreen will fail, due to being in the midst of handling some other animation or user gesture. We will attempt to minimize these cases, but believe there is a need for failure handling. This method indicates that there was an error, and the application should clean up any work it may have done to prepare to exit fullscreen. This message will be sent whether or not the delegate indicated a custom animation by returning non-nil from `-customWindowsToExitFullScreenForWindow:`.
*/
- (void)windowDidFailToExitFullScreen:(NSWindow *)window NS_SWIFT_UI_ACTOR API_AVAILABLE(macos(10.7));
-/* Windows entering the version browser will be resized to the size returned by this method. If either dimension of the returned size is larger than the maxPreferredFrameSize, the window will also be scaled down to ensure it fits properly in the version browser. Returned sizes larger than maxAllowedSize will be constrained to that size. If this method is not implemented, the version browser will use -window:willUseStandardFrame: to determine the resulting window frame size.
+/*! Windows entering the version browser will be resized to the size returned by this method. If either dimension of the returned size is larger than the \c maxPreferredFrameSize, the window will also be scaled down to ensure it fits properly in the version browser. Returned sizes larger than \c maxAllowedSize will be constrained to that size. If this method is not implemented, the version browser will use `-window:willUseStandardFrame:` to determine the resulting window frame size.
*/
- (NSSize)window:(NSWindow *)window willResizeForVersionBrowserWithMaxPreferredSize:(NSSize)maxPreferredFrameSize maxAllowedSize:(NSSize)maxAllowedFrameSize NS_SWIFT_UI_ACTOR API_AVAILABLE(macos(10.7));
-/* Method called by -[NSWindow encodeRestorableStateWithCoder:] to give the delegate a chance to encode any additional state into the NSCoder. This state is available in the NSCoder passed to restoreWindowWithIdentifier:state:handler: . See the header NSWindowRestoration.h for more information.
+/*! Method called by `-[NSWindow encodeRestorableStateWithCoder:]` to give the delegate a chance to encode any additional state into the NSCoder. This state is available in the NSCoder passed to `-restoreWindowWithIdentifier:state:handler:`. See the header `NSWindowRestoration.h` for more information.
*/
- (void)window:(NSWindow *)window willEncodeRestorableState:(NSCoder *)state NS_SWIFT_UI_ACTOR API_AVAILABLE(macos(10.7));
-/* Method called by -[NSWindow restoreStateWithCoder:] to give the delegate a chance to restore its own state, which it may decode from the NSCoder. See the header NSWindowRestoration.h for more information.
+/*! Method called by `-[NSWindow restoreStateWithCoder:]` to give the delegate a chance to restore its own state, which it may decode from the \c NSCoder. See the header `NSWindowRestoration.h` for more information.
*/
- (void)window:(NSWindow *)window didDecodeRestorableState:(NSCoder *)state NS_SWIFT_UI_ACTOR API_AVAILABLE(macos(10.7));
@@ -799,7 +883,7 @@
APPKIT_EXTERN NSNotificationName NSWindowWillBeginSheetNotification;
APPKIT_EXTERN NSNotificationName NSWindowDidEndSheetNotification;
-/* NSWindowDidChangeBackingPropertiesNotification is posted on 10.7.3 and later, when a window's backingScaleFactor and/or its colorSpace changes. When running on a system version where this new notification is available, applications should use it instead of NSWindowDidChangeScreenProfileNotification to watch for changes to either of these backing store properties. Many applications won't have any need to watch for this notification, but those that perform sophisticated color handling or manually manage their own caches of window-resolution-and/or/colorspace-appropriate bitmapped images will find this notification useful, as a prompt to invalidate their caches or schedule other reassessment for the new resolution and/or color space as needed. The notification's userInfo dictionary specifies the window's previous backingScaleFactor and colorSpace. You can compare these with the window's new backingScaleFactor and colorSpace at the time of the notification, to determine which of these two properties (potentially both) changed.
+/*! \c NSWindowDidChangeBackingPropertiesNotification is posted on 10.7.3 and later, when a window's \c backingScaleFactor and/or its \c colorSpace changes. When running on a system version where this new notification is available, applications should use it instead of \c NSWindowDidChangeScreenProfileNotification to watch for changes to either of these backing store properties. Many applications won't have any need to watch for this notification, but those that perform sophisticated color handling or manually manage their own caches of window-resolution-and/or/colorspace-appropriate bitmapped images will find this notification useful, as a prompt to invalidate their caches or schedule other reassessment for the new resolution and/or color space as needed. The notification's userInfo dictionary specifies the window's previous \c backingScaleFactor and \c colorSpace. You can compare these with the window's new \c backingScaleFactor and \c colorSpace at the time of the notification, to determine which of these two properties (potentially both) changed.
*/
APPKIT_EXTERN NSNotificationName const NSWindowDidChangeBackingPropertiesNotification API_AVAILABLE(macos(10.7)); // added in 10.7.3; userInfo keys: NSBackingPropertyOldScaleFactorKey, NSBackingPropertyOldColorSpaceKey
@@ -807,13 +891,15 @@
APPKIT_EXTERN NSString * const NSBackingPropertyOldColorSpaceKey API_AVAILABLE(macos(10.7)); // added in 10.7.3; an NSColorSpace
-/* NSWindowDidChangeScreenProfileNotification is posted when a window's display's color profile changes, or when the window moves to a display that has a different color profile. When running on 10.7.3 or later, this notification is still posted for compatibility, but modern applications should instead watch for NSWindowDidChangeBackingPropertiesNotification, which is posted for both color space and resolution changes, and facilitates handling both in a single update and redisplay pass.
+/*! \c NSWindowDidChangeScreenProfileNotification is posted when a window's display's color profile changes, or when the window moves to a display that has a different color profile. When running on 10.7.3 or later, this notification is still posted for compatibility, but modern applications should instead watch for \c NSWindowDidChangeBackingPropertiesNotification, which is posted for both color space and resolution changes, and facilitates handling both in a single update and redisplay pass.
*/
APPKIT_EXTERN NSNotificationName NSWindowDidChangeScreenProfileNotification;
-/* NSWindowWillStartLiveResizeNotification is sent when the user starts a live resize operation via a mouseDown in the resize corner. The notification will be sent before the window size is changed. Note that this notification is sent once for a sequence of window resize operations */
+/*! \c NSWindowWillStartLiveResizeNotification is sent when the user starts a live resize operation via a mouseDown in the resize corner. The notification will be sent before the window size is changed. Note that this notification is sent once for a sequence of window resize operations
+ */
APPKIT_EXTERN NSNotificationName const NSWindowWillStartLiveResizeNotification API_AVAILABLE(macos(10.6));
-/* NSWindowDidEndLiveResizeNotification is sent after the user ends a live resize operation via a mouseUp in the resize corner. The notification will be sent after the final window size change. Note that this notification is sent once for a sequence of window resize operations */
+/*! \c NSWindowDidEndLiveResizeNotification is sent after the user ends a live resize operation via a mouseUp in the resize corner. The notification will be sent after the final window size change. Note that this notification is sent once for a sequence of window resize operations
+ */
APPKIT_EXTERN NSNotificationName const NSWindowDidEndLiveResizeNotification API_AVAILABLE(macos(10.6));
APPKIT_EXTERN NSNotificationName const NSWindowWillEnterFullScreenNotification API_AVAILABLE(macos(10.7));
APPKIT_EXTERN NSNotificationName const NSWindowDidEnterFullScreenNotification API_AVAILABLE(macos(10.7));
@@ -823,7 +909,8 @@
APPKIT_EXTERN NSNotificationName const NSWindowDidEnterVersionBrowserNotification API_AVAILABLE(macos(10.7));
APPKIT_EXTERN NSNotificationName const NSWindowWillExitVersionBrowserNotification API_AVAILABLE(macos(10.7));
APPKIT_EXTERN NSNotificationName const NSWindowDidExitVersionBrowserNotification API_AVAILABLE(macos(10.7));
-/* Upon receiving this notification, you can query the NSWindow for its current occlusion state. Note that this only notifies about changes in the state of the occlusion, not when the occlusion region changes. You can use this notification to increase responsiveness and save power, by halting any expensive calculations that the user can not see. */
+/*! Upon receiving this notification, you can query the \c NSWindow for its current occlusion state. Note that this only notifies about changes in the state of the occlusion, not when the occlusion region changes. You can use this notification to increase responsiveness and save power, by halting any expensive calculations that the user can not see.
+ */
APPKIT_EXTERN NSNotificationName const NSWindowDidChangeOcclusionStateNotification API_AVAILABLE(macos(10.9));
@interface NSWindow(NSDeprecated)
- README
- xcode13.0 Binding Status
- xcode13.1 Binding Status
- xcode13.2 Binding Status
- xcode13.3 Binding Status
- xcode13.4 Binding Status
- xcode14.0 Binding Status
- xcode14.1 Binding Status
- xcode14.2 Binding Status
- xcode14.3 Binding Status
- xcode15.0 Binding Status
- xcode15.1 Binding Status
- xcode15.3 Binding Status
- xcode15.4 Binding Status
- xcode16.0 Binding Status