[Previous]
[Up]
[Next]
NSWindow
Authors
- Richard Frith-Macdonald
-
- James Dessart
-
Version: $Revision$
Date: $Date$
Declared in: Gui/NSWindow.h
Inherits from: NSResponder
Conforms to: NSCoding
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:.
Instance Variables
Methods
Class Methods
+ (NSRect) contentRectForFrameRect: (NSRect)frameRect;
+ (NSWindowDepth) defaultDepthLimit;
+ (NSRect) frameRectForContentRect: (NSRect)contentRect;
+ (void) menuChanged: (NSMenu*)aMenu;
+ (float) minFrameWidthWithTitle: (NSString*)aTitle styleMask: (unsigned int)aStyle;
+ (void) removeFrameUsingName: (NSString*)name;
Instances Methods
- (BOOL) acceptsMouseMovedEvents;
- (BOOL) areCursorRectsEnabled;
- (NSSize) aspectRatio;
- (NSColor*) backgroundColor;
- (NSBackingStoreType) backingType;
- (void) becomeKeyWindow;
- (void) becomeMainWindow;
- (void) cacheImageInRect: (NSRect)aRect;
- (BOOL) canBecomeKeyWindow;
- (BOOL) canBecomeMainWindow;
- (BOOL) canStoreColor;
- (NSPoint) cascadeTopLeftFromPoint: (NSPoint)topLeftPoint;
- (void) center;
- (void) close;
- (NSRect) constrainFrameRect: (NSRect)frameRect;
- (id) contentView;
Returns the NSWindow's content view.
- (NSPoint) convertBaseToScreen: (NSPoint)aPoint;
- (NSPoint) convertScreenToBase: (NSPoint)aPoint;
- (NSEvent*) currentEvent;
- (NSData*) dataWithEPSInsideRect: (NSRect)aRect;
- (NSScreen*) deepestScreen;
- (NSButtonCell*) defaultButtonCell;
- (id) delegate;
- (void) deminiaturize: (id)sender;
- (NSWindowDepth) depthLimit;
- (NSDictionary*) deviceDescription;
- (void) disableCursorRects;
- (void) disableFlushWindow;
- (void) disableKeyEquivalentForDefaultButtonCell;
- (void) discardCachedImage;
- (void) discardCursorRects;
- (void) discardEventsMatchingMask: (unsigned int)mask beforeEvent: (NSEvent*)lastEvent;
- (void) display;
- (void) displayIfNeeded;
- (void) dragImage: (NSImage*)anImage at: (NSPoint)aPoint offset: (NSSize)initialOffset event: (NSEvent *)theEvent pasteboard: (NSPasteboard*)pboard source: (id)sourceObject slideBack: (BOOL)slideBack;
- (void) enableCursorRects;
- (void) enableFlushWindow;
- (void) enableKeyEquivalentForDefaultButtonCell;
- (void) endEditingFor: (id)anObject;
- (void) fax: (id)sender;
- (NSText*) fieldEditor: (BOOL)createFlag;
- (NSResponder*) firstResponder;
- (void) flushWindow;
- (void) flushWindowIfNeeded;
- (NSRect) frame;
- (NSString*) frameAutosaveName;
- (int) gState;
- (BOOL) hasDynamicDepthLimit;
- (BOOL) hidesOnDeactivate;
- (NSView*) initialFirstResponder;
- (id) initWithContentRect: (NSRect)contentRect styleMask: (unsigned int)styleMask backing: (NSBackingStoreType)backingType;
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.
- (id) initWithContentRect: (NSRect)contentRect styleMask: (unsigned int)styleMask 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).
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.
- (NSInterfaceStyle) interfaceStyle;
- (void) invalidateCursorRectsForView: (NSView*)aView;
- (BOOL) isAutodisplay;
- (BOOL) isDocumentEdited;
- (BOOL) isExcludedFromWindowsMenu;
- (BOOL) isFlushWindowDisabled;
- (BOOL) isKeyWindow;
- (BOOL) isMainWindow;
- (BOOL) isMiniaturized;
- (BOOL) isOneShot;
- (BOOL) isReleasedWhenClosed;
- (BOOL) isVisible;
- (BOOL) isZoomed;;
- (void) keyDown: (NSEvent*)theEvent;
- (NSSelectionDirection) keyViewSelectionDirection;
- (int) level;
- (BOOL) makeFirstResponder: (NSResponder*)aResponder;
- (void) makeKeyAndOrderFront: (id)sender;
- (void) makeKeyWindow;
- (void) makeMainWindow;
- (NSSize) maxSize;
- (void) miniaturize: (id)sender;
- (NSImage*) miniwindowImage;
- (NSString*) miniwindowTitle;
- (NSSize) minSize;
- (NSPoint) mouseLocationOutsideOfEventStream;
- (NSEvent*) nextEventMatchingMask: (unsigned int)mask;
- (NSEvent*) nextEventMatchingMask: (unsigned int)mask untilDate: (NSDate*)expirationDate inMode: (NSString *)mode dequeue: (BOOL)dequeue;
- (void) orderBack: (id)sender;
- (void) orderFront: (id)sender;
- (void) orderFrontRegardless;
- (void) orderOut: (id)sender;
- (void) orderWindow: (NSWindowOrderingMode)place relativeTo: (int)otherWindowNumber;
- (void) performClose: (id)sender;
- (void) performMiniaturize: (id)sender;
- (void) performZoom: (id)sender;
- (void) postEvent: (NSEvent*)anEvent;
- (void) print: (id)sender;
- (void) registerForDraggedTypes: (NSArray*)pboardTypes;
- (NSString*) representedFilename;
- (void) resetCursorRects;
- (void) resignKeyWindow;
- (void) resignMainWindow;
- (int) resizeFlags;
- (NSSize) resizeIncrements;
- (void) restoreCachedImage;
- (void) saveFrameUsingName: (NSString*)name;
- (NSScreen*) screen;
- (void) selectKeyViewFollowingView: (NSView*)aView;
- (void) selectKeyViewPrecedingView: (NSView*)aView;
- (void) selectNextKeyView: (id)sender;
- (void) selectPreviousKeyView: (id)sender;
- (void) sendEvent: (NSEvent*)theEvent;
- (void) setAcceptsMouseMovedEvents: (BOOL)flag;
- (void) setAspectRatio: (NSSize)ratio;
- (void) setAutodisplay: (BOOL)flag;
- (void) setBackgroundColor: (NSColor*)aColor;
- (void) setBackingType: (NSBackingStoreType)backingType;
- (void) setContentSize: (NSSize)aSize;
- (void) setContentView: (NSView*)aView;
Sets the window's content view to aView, replacing any previous content view.
- (void) setDefaultButtonCell: (NSButtonCell*)aButtonCell;
- (void) setDelegate: (id)anObject;
- (void) setDepthLimit: (NSWindowDepth)limit;
- (void) setDocumentEdited: (BOOL)flag;
- (void) setDynamicDepthLimit: (BOOL)flag;
- (void) setExcludedFromWindowsMenu: (BOOL)flag;
- (void) setFrame: (NSRect)frameRect;
- (BOOL) setFrameAutosaveName: (NSString*)name;
- (void) setFrameFromString: (NSString*)aString;
- (void) setFrameOrigin: (NSPoint)aPoint;
- (void) setFrameTopLeftPoint: (NSPoint)aPoint;
- (BOOL) setFrameUsingName: (NSString*)name;
- (void) setHidesOnDeactivate: (BOOL)flag;
- (void) setInitialFirstResponder: (NSView*)aView;
- (void) setInterfaceStyle: (NSInterfaceStyle)interfaceStyle;
- (void) setLevel: (int)newLevel;
- (void) setMaxSize: (NSSize)aSize;
- (void) setMiniwindowImage: (NSImage*)anImage;
- (void) setMiniwindowTitle: (NSString*)aString;
- (void) setMinSize: (NSSize)aSize;
- (void) setOneShot: (BOOL)flag;
- (void) setReleasedWhenClosed: (BOOL)flag;
- (void) setRepresentedFilename: (NSString*)path;
- (void) setResizeIncrements: (NSSize)increments;
- (void) setTitle: (NSString*)aString;
Sets the window's title to the string aString.
- (void) setTitleWithRepresentedFilename: (NSString*)path;
- (void) setViewsNeedDisplay: (BOOL)flag;
- (void) setWindowController: (NSWindowController*)windowController;
- (NSString*) stringWithSavedFrame;
- (unsigned int) styleMask;
- (NSString*) title;
Returns an NSString containing the text of the window's title.
- (BOOL) tryToPerform: (SEL)anAction;
- (void) unregisterDraggedTypes;
- (void) update;
- (void) useOptimizedDrawing: (BOOL)flag;
- (id) validRequestorForSendType: (NSString*)sendType returnType: (NSString*)returnType;
- (BOOL) viewsNeedDisplay;
- (id) windowController;
- (void*) windowHandle;
- (int) windowNumber;
- (BOOL) worksWhenModal;
- (void) zoom: (id)sender;