Up

# NSPopover class documentation

### Authors

Generated by root

### Contents -

1. Software documentation for the NSPopover class
2. Software documentation for the NSObject(NSPopoverDelegate) informal protocol
3. Software documentation for the NSPopoverDelegate protocol

# Software documentation for the NSPopover class

## NSPopover : NSResponder

> Declared in:
>   AppKit/NSPopover.h

Availability: MacOS-X 10.7.0
Description forthcoming.

Instance Variables
Method summary

- -animates
- -appearance
- -behavior
- -close
- -contentSize
- -contentViewController
- -delegate
- -isShown
- -performClose:
- -positioningRect
- -setAnimates:
- -setAppearance:
- -setBehavior:
- -setContentSize:
- -setContentViewController:
- -setDelegate:
- -setPositioningRect:
- -showRelativeToRect:ofView:preferredEdge:

### animates

- (BOOL) animates;
Availability: MacOS-X 10.7.0
Returns current value of the animate flag.

### appearance

- (NSPopoverAppearance) appearance;
Availability: MacOS-X 10.7.0
Returns the current appearance setting.

### behavior

- (NSPopoverBehavior) behavior;
Availability: MacOS-X 10.7.0
Returns current behavior setting

### close

- (void) close;
Availability: MacOS-X 10.7.0
Close the popover.

### contentSize

- (NSSize) contentSize;
Availability: MacOS-X 10.7.0
Returns an NSSize representing the size of the NSPopover content view.

### contentViewController

- (NSViewController*) contentViewController;
Availability: MacOS-X 10.7.0
Returns the current contentViewController.

### delegate

- (id) delegate;
Availability: MacOS-X 10.7.0
Return delegate

### isShown

- (BOOL) isShown;
Availability: MacOS-X 10.7.0
Is the popover being shown.

### performClose:

- (IBAction) performClose: (id)sender;
Availability: MacOS-X 10.7.0
Close the popover as an IBAction.

### positioningRect

- (NSRect) positioningRect;
Availability: MacOS-X 10.7.0
Return the NSRect.

### setAnimates:

- (void) setAnimates: (BOOL)flag;
Availability: MacOS-X 10.7.0
Sets the animate flag. If `YES` then the popover will animate when it appears or disappears.

### setAppearance:

- (void) setAppearance: (NSPopoverAppearance)value;
Availability: MacOS-X 10.7.0
Sets ths appearance of the popover. Minimal is the default. HUD is not supported.

### setBehavior:

- (void) setBehavior: (NSPopoverBehavior)value;
Availability: MacOS-X 10.7.0
Sets current popup behavior. Valid settings are: NSPopupBehaviorApplicationDefined, NSPopupBehaviorTransient, NSPopupBehaviorSemiTransient.

### setContentSize:

- (void) setContentSize: (NSSize)value;
Availability: MacOS-X 10.7.0
Accepts an NSSize value for the current content size.

### setContentViewController:

- (void) setContentViewController: (NSViewController*)controller;
Availability: MacOS-X 10.7.0
Sets the contentViewController. If in a storyboard this is automatically set but if this is in a model that is NOT a storyboard (nib, xib, gorm, etc) then there must be a model with the same name as the class name of the contentViewController. Also, This model must have the "view" outlet set to the view that will be shown in the popup, if both of these conditions are not met, then the code will throw an NSInternalInconsistency exception to report the issue back to the user.

### setDelegate:

- (void) setDelegate: (id)value;
Availability: MacOS-X 10.7.0
Set delegate

### setPositioningRect:

- (void) setPositioningRect: (NSRect)value;
Availability: MacOS-X 10.7.0
Set relative position of the popup to the view it is associated with.

### showRelativeToRect: ofView: preferredEdge:

- (void) showRelativeToRect: (NSRect)positioningRect ofView: (NSView*)positioningView preferredEdge: (NSRectEdge)preferredEdge;
Availability: MacOS-X 10.7.0
Show the popover relative to the specified rect on the edge specified.

## Instance Variables for NSPopover Class

### _animates

@protected BOOL _animates;
Availability: MacOS-X 10.7.0
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

### _appearance

@protected NSPopoverAppearance _appearance;
Availability: MacOS-X 10.7.0
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

### _behavior

@protected NSPopoverBehavior _behavior;
Availability: MacOS-X 10.7.0
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

### _contentSize

@protected NSSize _contentSize;
Availability: MacOS-X 10.7.0
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

### _contentViewController

@protected NSViewController* _contentViewController;
Availability: MacOS-X 10.7.0
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

### _delegate

@protected id _delegate;
Availability: MacOS-X 10.7.0
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

### _positioningRect

@protected NSRect _positioningRect;
Availability: MacOS-X 10.7.0
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

### _realPanel

@protected NSPanel* _realPanel;
Availability: MacOS-X 10.7.0
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

### _shown

@protected BOOL _shown;
Availability: MacOS-X 10.7.0
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

# Software documentation for the NSObject(NSPopoverDelegate) informal protocol

## NSObject(NSPopoverDelegate)

> Declared in:
>   AppKit/NSPopover.h

Availability: MacOS-X 10.7.0
Description forthcoming.
Method summary

- -detachableWindowForPopover:
- -popoverDidClose:
- -popoverDidShow:
- -popoverShouldClose:
- -popoverWillClose:
- -popoverWillShow:

### detachableWindowForPopover:

- (NSWindow*) detachableWindowForPopover: (NSPopover*)popover;
Availability: MacOS-X 10.7.0
Description forthcoming.

### popoverDidClose:

- (void) popoverDidClose: (NSNotification*)notification;
Availability: MacOS-X 10.7.0
Description forthcoming.

### popoverDidShow:

- (void) popoverDidShow: (NSNotification*)notification;
Availability: MacOS-X 10.7.0
Description forthcoming.

### popoverShouldClose:

- (BOOL) popoverShouldClose: (NSPopover*)popover;
Availability: MacOS-X 10.7.0
Description forthcoming.

### popoverWillClose:

- (void) popoverWillClose: (NSNotification*)notification;
Availability: MacOS-X 10.7.0
Description forthcoming.

### popoverWillShow:

- (void) popoverWillShow: (NSNotification*)notification;
Availability: MacOS-X 10.7.0
Description forthcoming.

# Software documentation for the NSPopoverDelegate protocol

## NSPopoverDelegate

> Declared in:
>   AppKit/NSPopover.h

Availability: MacOS-X 10.7.0
Description forthcoming.
Up