NSView

Inherits From: NSResponder : NSObject

Conforms To: NSCoding (NSResponder) NSObject (NSObject)

Declared In: AppKit/NSView.h

AppKit/NSClipView.h

Class Description

NSView is an abstract class that provides its subclasses with a structure for drawing and for handling events. Any application that needs to display, print, or receive events must use NSView objects.

To be displayed, a view must be placed in a window (represented by an NSWindow object). All the views within a window are arranged in a hierarchy, with each view having a single superview and zero or more subviews. Each view has its own area to draw in and its own coordinate system, expressed as a transformation of its superview's coordinate system. An NSView object can scale, translate, or rotate its coordinates, or flip the polarity of its y-axis.

An NSView keeps track of its size and location in two ways: as a frame rectangle (expressed in its superview's coordinate system) and as a bounds rectangle (expressed in its own coordinate system). Both are represented by NSRect structures.

Subclasses of NSView typically override drawRect: to implement an object's distinctive appearance. They also frequently override one or more of NSView's or NSResponder's event-handling methods, to react to the user's manipulations of the mouse and keyboard.

Initializing NSView Objects

• - (id)initWithFrame:(NSRect)frameRect Initializes a new NSView object to the location and dimensions of frameRect.

• - (void)addSubview:(NSView *)aView Makes aView a subview of the receiving view object.
• - (void)addSubview:(NSView *)aView Makes aView a subview of the receiving view object. positioned:(NSWindowOrderingMode)place It is positioned relative to otherView according to relativeTo:(NSView *)otherView place.
• - (NSView *)ancestorSharedWithView:(NSView *)aView Returns the ancestor view shared by aView and the receiver; self if aView is the receiving view or if the receiving view is the ancestor of aView; aView if it is the superview of the receiving view; or nil in any other case.
• - (BOOL)isDescendantOf:(NSView *)aView Returns whether aView is an ancestor of the receiver.
• - (NSView *)opaqueAncestor Returns the receiver's nearest opaque ancestor.
• - (void)removeFromSuperview Removes the receiver from the view hierarchy.
• - (void)replaceSubview:(NSView *)oldView Replaces oldView with newView. with:(NSView *)newView
• - (void)sortSubviewsUsingFunction:(int (*)(id ,id ,void *))compare context:(void *)context Sorts the receiving view's subviews using the sorting function compare and the context context. The first two arguments of the function are the views to be compared.
• - (NSArray *)subviews Returns a mutable array of the receiving view object's subviews.
• - (NSView *)superview Returns the receiving view object's superview.
• - (NSWindow *)window Returns the window in which the view is displayed.
• - (void)viewWillMoveToWindow:(NSWindow *)newWindow Notifies the view that it will move to a new window. Modifying the Frame Rectangle
• - (float)frameRotation Returns the angle of the frame rectangle's rotation.
• - (NSRect)frame Gets the view's frame rectangle.
• - (void)rotateByAngle:(float)angle Rotates the view's frame rectangle by angle. This method posts the NSViewFocusChangedNotification notification with the receiving object to the default notification center.
• - (void)setFrame:(NSRect)frameRect Assigns the view a new frame rectangle.
• - (void)setFrameOrigin:(NSPoint)newOrigin Sets the origin of the view's frame to newOrigin. This method posts the NSViewFrameChangedNotification and NSViewFocusChangedNotification notifications with the receiving object to the default notification center.
• - (void)setFrameRotation:(float)angle Rotates the view's frame to angle. This method posts the NSViewFocusChangedNotification notification with the receiving object to the default notification center.
• - (void)setFrameSize:(NSSize)newSize Resizes the view's frame to newSize. This method posts the NSViewFrameChangedNotification and NSViewFocusChangedNotification notifications with the receiving object to the default notification center.

• - (float)boundsRotation Returns the rotation of the view's coordinate system.
• - (NSRect)bounds Gets the view's bounds rectangle.
• - (BOOL)isFlipped Returns whether the view is flipped.
• - (BOOL)isRotatedFromBase Returns whether the view is rotated.
• - (BOOL)isRotatedOrScaledFromBase Returns whether the view is rotated or scaled.
• - (void)scaleUnitSquareToSize:(NSSize)newSize Scales the NSView's coordinate system unit size to newSize. This method posts the notification NSViewFocusChangedNotification with the receiving object to the default notification center.
• - (void)setBounds:(NSRect)aRect Sets the NSView's bounds rectangle to aRect.
• - (void)setBoundsOrigin:(NSPoint)newOrigin Sets the NSView's drawing origin to newOrigin. This method posts the NSViewFocusChangedNotification notification with the receiving object to the default notification center.
• - (void)setBoundsRotation:(float)angle Rotates the NSView's coordinate system to angle. This method posts the NSViewFocusChangedNotification notification with the receiving object to the default notification center.
• - (void)setBoundsSize:(NSSize)newSize Resizes the NSView's coordinate system to newSize. This method posts the NSViewFocusChangedNotification notification with the receiving object to the default notification center.
• - (void)translateOriginToPoint:(NSPoint)point Shifts the NSView's coordinate system to point. This method posts the NSViewFocusChangedNotification notification with the receiving object to the default notification center.

• - (NSRect)centerScanRect:(NSRect)aRect Converts the rectangle aRect to lie on centers of pixels.
• - (NSPoint)convertPoint:(NSPoint)aPoint Converts aPoint in aView to the receiver's coordinates. fromView:(NSView *)aView
• - (NSPoint)convertPoint:(NSPoint)aPoint Converts aPoint in the receiver to aView's coordinates. toView:(NSView *)aView
• - (NSRect)convertRect:(NSRect)aRect Converts the rectangle aRect in aView to the receiver's fromView:(NSView *)aView coordinates.
• - (NSRect)convertRect:(NSRect)aRect Converts the rectangle aRect in the receiver to aView's toView:(NSView *)aView coordinates.
• - (NSSize)convertSize:(NSSize)aSize Converts aSize in aView to the receiver's coordinates. fromView:(NSView *)aView
• - (NSSize)convertSize:(NSSize)aSize Converts aSize in the receiver to aView's coordinates. toView:(NSView *)aView

• - (BOOL)postsFrameChangedNotifications Returns whether notifications of frame changes to ancestors are activated.
• - (void)setPostsFrameChangedNotifications:(BOOL)flag Sets whether to activate ancestor notifications.

• - (void)resizeSubviewsWithOldSize:(NSSize)oldSize Initiates superviewSizeChanged: messages to subviews.
• - (void)setAutoresizesSubviews:(BOOL)flag Sets whether to notify subviews of resizing.
• - (BOOL)autoresizesSubviews Returns whether the NSView notifies subviews of resizing.
• - (void)setAutoresizingMask:(unsigned int)mask Determines automatic resizing behavior.
• - (unsigned int)autoresizingMask Returns the NSView's autosizing mask.
• - (void)resizeWithOldSuperviewSize:(NSSize)oldSize Notifies subviews that the superview changed size.

• - (void)allocateGState Allocates a graphics state object.
• - (void)releaseGState Release the NSView's graphics state object.
• - (int)gState Returns the NSView's graphics state object.
• - (void)renewGState Marks the NSView's graphics state object as needing initialization.
• - (void)setUpGState Sets up the NSView's graphics state object.

• + (NSView *)focusView Returns the currently focused view.
• - (void)lockFocus Brings the receiving view into focus.
• - (void)unlockFocus Unfocuses the receiving view.

• - (BOOL)canDraw Returns whether the view object can draw.
• - (void)display Displays the receiving view and its subviews.
• - (void)displayIfNeeded Conditionally displays the receiving view and its subviews (if opaque).
• - (void)displayIfNeededIgnoringOpacity Conditionally displays the receiving view and its subviews, regardless of opacity.
• - (void)displayRect:(NSRect)aRect Displays the receiving view and its subviews (if opaque) within aRect.
• - (void)displayRectIgnoringOpacity:(NSRect)aRect Displays the receiving view and its subviews (regardless of opacity) within aRect.
• - (void)drawRect:(NSRect)rect Implemented by subclasses to supply drawing instructions.
• - (NSRect)visibleRect Gets the receiving view's visible portion.
• - (BOOL)isOpaque Returns whether the view is opaque.
• - (BOOL)needsDisplay Returns whether the view needs to be redisplayed.
• - (void)setNeedsDisplay:(BOOL)flag If flag is YES, marks the view as changed, needing redisplay.
• - (void)setNeedsDisplayInRect:(NSRect)invalidRect Marks the view as changed, needing redisplay in rectangle invalidRect.
• - (BOOL)shouldDrawColor Returns whether the view should be drawn in color.

• - (NSRect)adjustScroll:(NSRect)newVisible Lets the view object adjust the visible rectangle.
• - (BOOL)autoscroll:(NSEvent *)theEvent Scrolls in response to a mouse-dragged event.
• - (void)reflectScrolledClipView:(NSClipView *)aClipView Reflects scrolling within clip view aClipView.
• - (void)scrollClipView:(NSClipView *)aClipView Scrolls the clip view aClipView to aPoint. toPoint:(NSPoint)aPoint
• - (void)scrollPoint:(NSPoint)aPoint Aligns aPoint with the content view's origin.
• - (void)scrollRect:(NSRect)aRect Shifts the rectangle aRect by delta. by:(NSSize)delta
• - (BOOL)scrollRectToVisible:(NSRect)aRect Scrolls the view so the rectangle aRect is visible.

• - (void)addCursorRect:(NSRect)aRect Adds a cursor rectangle aRect for cursor anObject to the cursor:(NSCursor *)anObject NSView.
• - (void)discardCursorRects Removes all cursor rectangles in the view.
• - (void)removeCursorRect:(NSRect)aRect Removes cursor rectangle aRect for cursor anObject from cursor:(NSCursor *)anObject the view.
• - (void)resetCursorRects Implemented by subclasses to reset their cursor rectangles.

• - (int)tag Returns the view object's tag.
• - (id)viewWithTag:(int)aTag Returns the subview object with aTag as its tag.

• - (BOOL)acceptsFirstMouse:(NSEvent *)theEvent Returns whether the view object accepts first mouse-down events.
• - (NSView *)hitTest:(NSPoint)aPoint Returns the lowest subview containing the point aPoint.
• - (BOOL)mouse:(NSPoint)aPoint Returns whether the point aPoint lies inside the aRect. inRect:(NSRect)aRect
• - (BOOL)performKeyEquivalent:(NSEvent *)theEvent Implemented by subclasses to perform key-equivalent commands. Returns whether a subview handled theEvent.
• - (void)removeTrackingRect:(NSTrackingRectTag)tag Removes the tracking rectangle identified by tag from the view. (tag is an unique identifier returned from the addTractingRect:owner:assumeInside: method.)
• - (BOOL)shouldDelayWindowOrderingForEvent:(NSEvent *)anEvent Returns whether the view's window is brought forward normally (mouse-down) or delayed (mouse-up).
• - (NSTrackingRectTag)addTrackingRect:(NSRect)aRect owner:(id)anObject Adds a tracking rectangle (aRect) owned by anObject to userData:(void *)data the receiving NSView. assumeInside:(BOOL)flag flag indicates whether the tracking rectangle will be only inside the NSView. Returns a unique tag that identifies the tracking rectangle.

• - (BOOL)dragFile:(NSString *)filename Initiates a file-dragging session, dragging file indicated fromRect:(NSRect)rect by path filename. rect describes the position of the icon slideBack:(BOOL)slideFlag in the View's coordinates. slideFlag determines event:(NSEvent *)event whether the NSImage should slide back if rejected
• - (void)dragImage:(NSImage *)anImage Initiates an image-dragging session, dragging anImage at:(NSPoint)viewLocation from viewLocation. initialOffset is the difference in offset:(NSSize)initialOffset the mouse location from the mouse-down. event:(NSEvent *)event pboard is the pasteboard holding the data. pasteboard:(NSPasteboard *)pboard sourceObject is the object receiving source:(id)sourceObject NSDraggingSource messages. slideFlag determines slideBack:(BOOL)slideFlag whether the NSImage should slide back if rejected.
• - (void)registerForDraggedTypes:(NSArray *)newTypes Registers the pasteboard types that the window will accept in an image-dragging session.
• - (void)unregisterDraggedTypes Unregisters the window as a recipient of dragged images.

• - (NSData *)dataWithEPSInsideRect:(NSRect)aRect Returns a data object initialized with the EPS data within aRect in the receiving view.
• - (void)fax:(id)sender Faxes the view and its subviews.
• - (void)print:(id)sender Prints the view and its subviews.
• - (void)writeEPSInsideRect:(NSRect)rect Places PostScript code for the rectangle rect on the toPasteboard:(NSPasteboard *)pasteboard pasteboard.

• - (void)adjustPageHeightNew:(float *)newBottom Assists automatic pagination of the view object. top:(float)oldTop bottom:(float)oldBottom limit:(float)bottomLimit
• - (void)adjustPageWidthNew:(float *)newRight Assists automatic pagination of the view object. left:(float)oldLeft right:(float)oldRight limit:(float)rightLimit
• - (float)heightAdjustLimit Returns how much of a page can go on the next page.
• - (BOOL)knowsPagesFirst:(int *)firstPageNum Returns whether the view paginates itself. last:(int *)lastPageNum
• - (NSPoint)locationOfPrintRect:(NSRect)aRect Locates the printing rectangle on the page.
• - (NSRect)rectForPage:(int)page Provides how much of the view will print on page.
• - (float)widthAdjustLimit Returns how much of a page can go on the next page.

• - (void)addToPageSetup Allows you to adjust for differences in the graphics state between the screen and the printer.
• - (void)beginPage:(int)ordinalNum Writes a page separator. label:(NSString *)aString bBox:(NSRect)pageRect fonts:(NSString *)fontNames
• - (void)beginPageSetupRect:(NSRect)aRect Writes the beginning of a page setup section. placement:(NSPoint)location
• - (void)beginPrologueBBox:(NSRect)boundingBox Writes the header for a print job. creationDate:(NSString *)dateCreated createdBy:(NSString *)anApplication fonts:(NSString *)fontNames forWhom:(NSString *)user pages:(int)numPages title:(NSString *)aTitle
• - (void)beginSetup Writes the beginning of the job setup section.
• - (void)beginTrailer Writes the beginning of the trailer for the print job.
• - (void)drawPageBorderWithSize:(NSSize)borderSize Implemented by subclasses to draw in margins (e.g., borders, numbering). borderSize is the size of the border.
• - (void)drawSheetBorderWithSize:(NSSize)borderSize Implemented by subclasses to draw in margins (e.g., borders, numbering). borderSize is the size of the border.
• - (void)endHeaderComments Writes the end of the header.
• - (void)endPrologue Writes the end of the prologue.
• - (void)endSetup Writes the end of the job setup section.
• - (void)endPageSetup Writes the end of a page setup section.
• - (void)endPage Writes the end of a page.
• - (void)endTrailer Writes the end of the trailer.