NSWindow

Authors

Scott Christley(scottc@net-community.com)
Felipe A. Rodriguez(far@ix.netcom.com)
Richard Frith-Macdonald(richard@brainstorm.co.uk)

The window class

Contents -

NSWindow
Software documentation for the NSObject(NSWindowDelegate) informal protocol
Software documentation for the NSWindow(GNUstepBackend) category
Software documentation for the NSWindow(GNUstepTextView) category

NSWindow

Instances of the NSWindow class handle on-screen windows, their associated NSViews, and events generate by the user. An NSWindow's size is defined by its frame rectangle, which encompasses its entire structure, and its content rectangle, which includes only the content.

Every NSWindow has a content view, the NSView which forms the root of the window's view hierarchy. This view can be set using the setContentView: method, and accessed through the contentView method. setContentView: replaces the default content view created by NSWindow.

Other views may be added to the window by using the content view's addSubview: method. These subviews can also have subviews added, forming a tree structure, the view hierarchy. When an NSWindow must display itself, it causes this hierarchy to draw itself. Leaf nodes in the view hierarchy are drawn last, causing them to potentially obscure views further up in the hierarchy.

A delegate can be specified for an NSWindow, which will receive notifications of events pertaining to the window. The delegate is set using setDelegate:, and can be retrieved using delegate. The delegate can restrain resizing by implementing the windowWillResize: toSize: method, or control the closing of the window by implementing windowShouldClose:.

NSWindow : NSResponder

Declared in:

AppKit/NSWindow.h

Conforms to:

NSCoding

Standards:

MacOS-X

OpenStep

GNUstep

Method summary

contentRectForFrameRect:styleMask:

+ (NSRect) contentRectForFrameRect: (NSRect)aRect styleMask: (unsigned int)aStyle;

Description forthcoming.

defaultDepthLimit

+ (NSWindowDepth) defaultDepthLimit;

Description forthcoming.

frameRectForContentRect:styleMask:

+ (NSRect) frameRectForContentRect: (NSRect)aRect styleMask: (unsigned int)aStyle;

Description forthcoming.

menuChanged:

+ (void) menuChanged: (NSMenu*)aMenu;

Description forthcoming.

minFrameWidthWithTitle:styleMask:

+ (NSRect) minFrameWidthWithTitle: (NSString*)aTitle styleMask: (unsigned int)aStyle;

Description forthcoming.

removeFrameUsingName:

+ (void) removeFrameUsingName: (NSString*)name;

Description forthcoming.

acceptsMouseMovedEvents

- (BOOL) acceptsMouseMovedEvents;

Description forthcoming.

alphaValue

- (float) alphaValue;

Description forthcoming.

animationResizeTime:

- (NSTimeInterval) animationResizeTime: (NSRect)newFrame;

Description forthcoming.

areCursorRectsEnabled

- (BOOL) areCursorRectsEnabled;

Description forthcoming.

aspectRatio

- (NSSize) aspectRatio;

Description forthcoming.

backgroundColor

- (NSColor*) backgroundColor;

Description forthcoming.

backingType

- (NSBackingStoreType) backingType;

Description forthcoming.

becomeKeyWindow

- (void) becomeKeyWindow;

Description forthcoming.

becomeMainWindow

- (void) becomeMainWindow;

Description forthcoming.

cacheImageInRect:

- (void) cacheImageInRect: (NSRect)aRect;

Description forthcoming.

canBecomeKeyWindow

- (BOOL) canBecomeKeyWindow;

Returns YES if the receiver can be made key. If this method returns NO, the window will not be made key. This implementation returns YES if the window is resizable or has a title bar. You can override this method to change it's behavior

canBecomeMainWindow

- (BOOL) canBecomeMainWindow;

Returns YES if the receiver can be the main window. If this method returns NO, the window will not become the main window. This implementation returns YES if the window is resizable or has a title bar and is visible and is not an NSPanel. You can override this method to change it's behavior

canHide

- (BOOL) canHide;

Description forthcoming.

canStoreColor

- (BOOL) canStoreColor;

Description forthcoming.

cascadeTopLeftFromPoint:

- (NSPoint) cascadeTopLeftFromPoint: (NSPoint)topLeftPoint;

Description forthcoming.

center

- (void) center;

Description forthcoming.

close

- (void) close;

Description forthcoming.

constrainFrameRect:toScreen:

- (NSRect) constrainFrameRect: (NSRect)frameRect toScreen: (id)screen;

Description forthcoming.

contentView

- (id) contentView;

Description forthcoming.

convertBaseToScreen:

- (NSPoint) convertBaseToScreen: (NSPoint)basePoint;

Description forthcoming.

convertScreenToBase:

- (NSPoint) convertScreenToBase: (NSPoint)screenPoint;

Description forthcoming.

counterpart

- (NSWindow*) counterpart;

Description forthcoming.

currentEvent

- (NSEvent*) currentEvent;

Description forthcoming.

dataWithEPSInsideRect:

- (NSData*) dataWithEPSInsideRect: (NSRect)rect;

Description forthcoming.

dataWithPDFInsideRect:

- (NSData*) dataWithPDFInsideRect: (NSRect)aRect;

Description forthcoming.

deepestScreen

- (NSScreen*) deepestScreen;

Returns the screen the window is on. Unlike (apparently) OpenStep and MacOSX, GNUstep does not support windows being split across multiple screens

defaultButtonCell

- (NSButtonCell*) defaultButtonCell;

Description forthcoming.

delegate

- (id) delegate;

Description forthcoming.

deminiaturize:

- (void) deminiaturize: (id)sender;

Causes the window to deminiaturize. Normally you would not call this method directly. A window is automatically deminiaturized by the user via a mouse cloick event.

depthLimit

- (NSWindowDepth) depthLimit;

Description forthcoming.

deviceDescription

- (NSDictionary*) deviceDescription;

Description forthcoming.

disableCursorRects

- (void) disableCursorRects;

Description forthcoming.

disableFlushWindow

- (void) disableFlushWindow;

Description forthcoming.

disableKeyEquivalentForDefaultButtonCell

- (void) disableKeyEquivalentForDefaultButtonCell;

Description forthcoming.

discardCachedImage

- (void) discardCachedImage;

Description forthcoming.

discardCursorRects

- (void) discardCursorRects;

Description forthcoming.

discardEventsMatchingMask:beforeEvent:

- (void) discardEventsMatchingMask: (unsigned int)mask beforeEvent: (NSEvent*)lastEvent;

Description forthcoming.

display

- (void) display;

Description forthcoming.

displayIfNeeded

- (void) displayIfNeeded;

Description forthcoming.

dragImage:at:offset:event:pasteboard:source:slideBack:

- (void) dragImage: (NSImage*)anImage at: (NSPoint)baseLocation offset: (NSSize)initialOffset event: (NSEvent*)event pasteboard: (NSPasteboard*)pboard source: (id)sourceObject slideBack: (BOOL)slideFlag;

Description forthcoming.

drawers

- (NSArray*) drawers;

Description forthcoming.

enableCursorRects

- (void) enableCursorRects;

Description forthcoming.

enableFlushWindow

- (void) enableFlushWindow;

Description forthcoming.

enableKeyEquivalentForDefaultButtonCell

- (void) enableKeyEquivalentForDefaultButtonCell;

Description forthcoming.

endEditingFor:

- (void) endEditingFor: (id)anObject;

Description forthcoming.

fax:

- (void) fax: (id)sender;

Description forthcoming.

fieldEditor:forObject:

- (NSText*) fieldEditor: (BOOL)createFlag forObject: (id)anObject;

Description forthcoming.

firstResponder

- (NSResponder*) firstResponder;

Description forthcoming.

flushWindow

- (void) flushWindow;

Flush all drawing in the windows buffer to the screen unless the window is not buffered or flushing is not enabled.

flushWindowIfNeeded

- (void) flushWindowIfNeeded;

Description forthcoming.

frame

- (NSRect) frame;

Description forthcoming.

frameAutosaveName

- (NSString*) frameAutosaveName;

Description forthcoming.

gState

- (int) gState;

Description forthcoming.

hasDynamicDepthLimit

- (BOOL) hasDynamicDepthLimit;

Description forthcoming.

hasShadow

- (BOOL) hasShadow;

Description forthcoming.

hidesOnDeactivate

- (BOOL) hidesOnDeactivate;

Description forthcoming.

initWithContentRect:styleMask:backing:defer:

- (id) initWithContentRect: (NSRect)contentRect styleMask: (unsigned int)aStyle backing: (NSBackingStoreType)bufferingType defer: (BOOL)flag;

Initializes the receiver with a content rect of contentRect, a style mask of styleMask, and a backing store type of backingType.

The style mask values are NSTitledWindowMask, for a window with a title, NSClosableWindowMask, for a window with a close widget, NSMiniaturizableWindowMask, for a window with a miniaturize widget, and NSResizableWindowMask, for a window with a resizing widget. These mask values can be OR'd in any combination.

Backing store values are NSBackingStoreBuffered, NSBackingStoreRetained and NSBackingStoreNonretained.

initWithContentRect:styleMask:backing:defer:screen:

- (id) initWithContentRect: (NSRect)contentRect styleMask: (unsigned int)aStyle backing: (NSBackingStoreType)bufferingType defer: (BOOL)flag screen: (NSScreen*)aScreen;

Initializes the receiver with a content rect of contentRect, a style mask of styleMask, a backing store type of backingType and a boolean flag. flag specifies whether the window should be created now (NO), or when it is displayed (YES).

Backing store values are NSBackingStoreBuffered, NSBackingStoreRetained and NSBackingStoreNonretained.

initWithWindowRef:

- (NSWindow*) initWithWindowRef: (void*)windowRef;

Description forthcoming.

initialFirstResponder

- (NSView*) initialFirstResponder;

Description forthcoming.

invalidateCursorRectsForView:

- (void) invalidateCursorRectsForView: (NSView*)aView;

Description forthcoming.

isAutodisplay

- (BOOL) isAutodisplay;

Description forthcoming.

isDocumentEdited

- (BOOL) isDocumentEdited;

Description forthcoming.

isExcludedFromWindowsMenu

- (BOOL) isExcludedFromWindowsMenu;

Description forthcoming.

isFlushWindowDisabled

- (BOOL) isFlushWindowDisabled;

Description forthcoming.

isKeyWindow

- (BOOL) isKeyWindow;

Description forthcoming.

isMainWindow

- (BOOL) isMainWindow;

Description forthcoming.

isMiniaturized

- (BOOL) isMiniaturized;

Description forthcoming.

isOneShot

- (BOOL) isOneShot;

Description forthcoming.

isOpaque

- (BOOL) isOpaque;

Description forthcoming.

isReleasedWhenClosed

- (BOOL) isReleasedWhenClosed;

Description forthcoming.

isVisible

- (BOOL) isVisible;

Description forthcoming.

keyDown:

- (void) keyDown: (NSEvent*)theEvent;

Description forthcoming.

keyViewSelectionDirection

- (NSSelectionDirection) keyViewSelectionDirection;

Description forthcoming.

level

- (int) level;

Description forthcoming.

makeFirstResponder:

- (BOOL) makeFirstResponder: (NSResponder*)aResponder;

Description forthcoming.

makeKeyAndOrderFront:

- (void) makeKeyAndOrderFront: (id)sender;

Description forthcoming.

makeKeyWindow

- (void) makeKeyWindow;

Description forthcoming.

makeMainWindow

- (void) makeMainWindow;

Description forthcoming.

maxSize

- (NSSize) maxSize;

Description forthcoming.

minSize

- (NSSize) minSize;

Description forthcoming.

miniaturize:

- (void) miniaturize: (id)sender;

Causes the window to miniaturize, that is the window is removed from the screen and it's counterpart (mini)window is displayed.

miniwindowImage

- (NSImage*) miniwindowImage;

Description forthcoming.

miniwindowTitle

- (NSString*) miniwindowTitle;

Description forthcoming.

mouseLocationOutsideOfEventStream

- (NSPoint) mouseLocationOutsideOfEventStream;

Description forthcoming.

nextEventMatchingMask:

- (NSEvent*) nextEventMatchingMask: (unsigned int)mask;

Description forthcoming.

nextEventMatchingMask:untilDate:inMode:dequeue:

- (NSEvent*) nextEventMatchingMask: (unsigned int)mask untilDate: (NSDate*)expiration inMode: (NSString*)mode dequeue: (BOOL)deqFlag;

Description forthcoming.

orderBack:

- (void) orderBack: (id)sender;

Description forthcoming.

orderFront:

- (void) orderFront: (id)sender;

Description forthcoming.

orderFrontRegardless

- (void) orderFrontRegardless;

Description forthcoming.

orderOut:

- (void) orderOut: (id)sender;

Description forthcoming.

orderWindow:relativeTo:

- (void) orderWindow: (NSWindowOrderingMode)place relativeTo: (int)otherWin;

Description forthcoming.

performClose:

- (void) performClose: (id)sender;

Description forthcoming.

performMiniaturize:

- (void) performMiniaturize: (id)sender;

Miniaturize the receiver... as long as its style mask includes NSMiniaturizableWindowMask (and as long as the receiver is not an icon or mini window itsself). Calls -miniaturize to do this.
Beeps if the window can't be miniaturised.
Should ideally provide visual feedback (highlighting the miniaturize button as if it had been clicked) first... but that's not yet implemented.