CPClipView Class Reference

#import <CPClipView.h>

Inheritance diagram for CPClipView:

Instance Methods
(BOOL)	- autoscroll:
(CGPoint)	- constrainScrollPoint:
(id)	- documentView
(CGRect)	- documentVisibleRect
(void)	- encodeWithCoder:
(id)	- initWithCoder:
(void)	- resizeSubviewsWithOldSize:
(void)	- scrollToPoint:
(void)	- setBoundsOrigin:
(void)	- setDocumentView:
(void)	- viewBoundsChanged:
(void)	- viewFrameChanged:
Instance Methods inherited from CPView
(BOOL)	- acceptsFirstMouse:
(void)	- addSubview:
(void)	- addSubview:positioned:relativeTo:
(void)	- addTrackingArea:
(CGRect)	- adjustScroll:
(float)	- alphaValue
(CAAnimation)	- animationForKey:
(CPDictionary)	- animations
(id)	- animator
(BOOL)	- autoresizesSubviews
(unsigned)	- autoresizingMask
(CPColor)	- backgroundColor
(BOOL)	- becomeFirstResponder
(CGRect)	- bounds
(CGPoint)	- boundsOrigin
(CGSize)	- boundsSize
(BOOL)	- canBecomeKeyView
(CGPoint)	- center
(BOOL)	- clipsToBounds
(CGPoint)	- convertPoint:fromView:
(CGPoint)	- convertPoint:toView:
(CGPoint)	- convertPointFromBase:
(CGPoint)	- convertPointToBase:
(CGRect)	- convertRect:fromView:
(CGRect)	- convertRect:toView:
(CGRect)	- convertRectFromBase:
(CGRect)	- convertRectToBase:
(CGSize)	- convertSize:fromView:
(CGSize)	- convertSize:toView:
(CPView)	- createEphemeralSubviewNamed:
(CPString)	- debug_description
(void)	- didAddSubview:
(void)	- display
(void)	- displayIfNeeded
(void)	- displayIfNeededInRect:
(void)	- displayRect:
(void)	- displayRectIgnoringOpacity:inContext:
(void)	- dragImage:at:offset:event:pasteboard:source:slideBack:
(void)	- dragView:at:offset:event:pasteboard:source:slideBack:
(void)	- drawRect:
(CPAppearance)	- effectiveAppearance
(CPMenuItem)	- enclosingMenuItem
(CPScrollView)	- enclosingScrollView
(BOOL)	- enterFullScreenMode
(BOOL)	- enterFullScreenMode:withOptions:
(CPView)	- ephemeralSubviewNamed:
(void)	- exitFullScreenMode
(void)	- exitFullScreenModeWithOptions:
(CGRect)	- frame
(CGPoint)	- frameOrigin
(CGRect)	- frameRectOfView:inSuperviewSize:
(CGSize)	- frameSize
(CGRect)	- frameWithNewSuperviewSize:
(BOOL)	- hasCustomDrawRect
(BOOL)	- hasCustomLayoutSubviews
(CPView)	- hitTest:
(BOOL)	- hitTests
(id)	- init
(id)	- initWithFrame:
(BOOL)	- inLiveResize
(BOOL)	- isDescendantOf:
(BOOL)	- isFlipped
(BOOL)	- isHidden
(BOOL)	- isHiddenOrHasHiddenAncestor
(BOOL)	- isInFullScreenMode
(BOOL)	- isOpaque
(CALayer)	- layer
(void)	- layout
(CPView)	- layoutEphemeralSubviewNamed:positioned:relativeToEphemeralSubviewNamed:
(void)	- layoutIfNeeded
(void)	- layoutSubviews
(void)	- lockFocus
(CPMenu)	- menuForEvent:
(void)	- mouseDown:
(BOOL)	- mouseDownCanMoveWindow
(BOOL)	- needsDisplay
(BOOL)	- needsLayout
(BOOL)	- needsPanelToBecomeKey
(CPView)	- nextKeyView
(CPView)	- nextValidKeyView
(void)	- objectDidChangeTheme
(BOOL)	- performKeyEquivalent:
(BOOL)	- postsBoundsChangedNotifications
(BOOL)	- postsFrameChangedNotifications
(CPView)	- previousKeyView
(CPView)	- previousValidKeyView
(CGRect)	- rectForEphemeralSubviewNamed:
(void)	- reflectScrolledClipView:
(CPArray)	- registeredDraggedTypes
(void)	- registerForDraggedTypes:
(void)	- removeFromSuperview
(void)	- removeTrackingArea:
(void)	- replaceSubview:with:
(BOOL)	- resignFirstResponder
(void)	- resizeWithOldSuperviewSize:
(void)	- rightMouseDown:
(CGSize)	- scaleSize
(void)	- scaleUnitSquareToSize:
(void)	- scrollClipView:toPoint:
(void)	- scrollPoint:
(void)	- scrollRect:by:
(BOOL)	- scrollRectToVisible:
(void)	- setAlphaValue:
(void)	- setAnimations:
(void)	- setAppearance:
(void)	- setAutoresizesSubviews:
(void)	- setAutoresizingMask:
(void)	- setBackgroundColor:
(void)	- setBounds:
(void)	- setBoundsSize:
(void)	- setCenter:
(void)	- setClipsToBounds:
(void)	- setDOMClassName:
(void)	- setFrame:
(void)	- setFrameOrigin:
(void)	- setFrameSize:
(void)	- setHidden:
(void)	- setHitTests:
(void)	- setLayer:
(void)	- setNeedsDisplay:
(void)	- setNeedsDisplayInRect:
(void)	- setNeedsLayout
(void)	- setNeedsLayout:
(void)	- setNextKeyView:
(void)	- setPostsBoundsChangedNotifications:
(void)	- setPostsFrameChangedNotifications:
(void)	- setScaleSize:
(void)	- setSubviews:
(void)	- setTag:
(void)	- setThemeClass:
(BOOL)	- setThemeState:
(void)	- setToolTip:
(void)	- setValue:forThemeAttribute:
(void)	- setValue:forThemeAttribute:inState:
(void)	- setWantsLayer:
(CPArray)	- subviews
(CPView)	- superview
(CPInteger)	- tag
(void)	- unlockFocus
(void)	- unregisterDraggedTypes
(BOOL)	- unsetThemeState:
(void)	- updateTrackingAreas
(void)	- viewDidEndLiveResize
(void)	- viewDidHide
(void)	- viewDidLayout
(void)	- viewDidMoveToSuperview
(void)	- viewDidMoveToWindow
(void)	- viewDidUnhide
(void)	- viewWillDraw
(void)	- viewWillLayout
(void)	- viewWillMoveToSuperview:
(void)	- viewWillMoveToWindow:
(void)	- viewWillStartLiveResize
(CPView)	- viewWithTag:
(CGRect)	- visibleRect
(BOOL)	- wantsLayer
(void)	- willRemoveSubview:
(CPWindow)	- window

Additional Inherited Members
Class Methods inherited from CPView
(Class)	+ animatorClass
(CAAnimation)	+ defaultAnimationForKey:
(CPMenu)	+ defaultMenu
(CPString)	+ defaultThemeClass
(void)	+ initialize
(BOOL)	+ isHighDPIDrawingEnabled
(CPSet)	+ keyPathsForValuesAffectingBounds
(CPSet)	+ keyPathsForValuesAffectingFrame
(void)	+ setHighDPIDrawingEnabled:
(CPDictionary)	+ themeAttributes

Detailed Description

CPClipView allows you to define a clip rect and display only that portion of its containing view. It is used to hold the document view in a CPScrollView.

Definition at line 2 of file CPClipView.h.

Method Documentation

autoscroll:()

- (BOOL) autoscroll: (CPEvent)  anEvent

implementation

Scrolls the view’s CPClipView in the direction of a mouse event that occurs outside of it.

Reimplemented from CPView.

Definition at line 155 of file CPClipView.j.

constrainScrollPoint:()

- (CGPoint) constrainScrollPoint: (CGPoint)  aPoint

implementation

Returns a new point that may be adjusted from aPoint to make sure it lies within the document view.

Parameters

aPoint

Returns

the adjusted point

Definition at line 68 of file CPClipView.j.

documentView()

- (id) documentView

implementation

Returns the document view.

Definition at line 57 of file CPClipView.j.

documentVisibleRect()

- (CGRect) documentVisibleRect

implementation

Definition at line 193 of file CPClipView.j.

encodeWithCoder:()

- (void) encodeWithCoder: (CPCoder)  aCoder

implementation

Archives the view to a coder.

Parameters

aCoder

the object into which the view's data will be archived.

Reimplemented from CPView.

Provided by category CPClipView(CPCoding).

Definition at line 217 of file CPClipView.j.

initWithCoder:()

- (id) initWithCoder: (CPCoder)  aCoder

implementation

Initializes the view from an archive.

Parameters

aCoder

the coder from which to initialize

Returns

the initialized view

Reimplemented from CPView.

Provided by category CPClipView(CPCoding).

Definition at line 205 of file CPClipView.j.

resizeSubviewsWithOldSize:()

- (void) resizeSubviewsWithOldSize: (CGSize)  aSize

implementation

Initiates -superviewSizeChanged: messages to subviews.

Parameters

aSize

the size for the subviews

Reimplemented from CPView.

Definition at line 125 of file CPClipView.j.

scrollToPoint:()

- (void) scrollToPoint: (CGPoint)  aPoint

implementation

Scrolls the clip view to the specified point. The method sets its bounds origin to aPoint.

Definition at line 102 of file CPClipView.j.

setBoundsOrigin:()

- (void) setBoundsOrigin: (CGPoint)  aPoint

implementation

Sets the location of the receiver inside its frame. The method posts a CPViewBoundsDidChangeNotification to the default notification center if the receiver is configured to do so.

Parameters

aPoint

the new location for the receiver

Reimplemented from CPView.

Definition at line 81 of file CPClipView.j.

setDocumentView:()

- (void) setDocumentView: (CPView)  aView

implementation

Sets the document view to be aView.

Parameters

aView

the new document view. It's frame origin will be changed to (0,0) after calling this method.

Definition at line 40 of file CPClipView.j.

viewBoundsChanged:()

- (void) viewBoundsChanged: (CPNotification)  aNotification

implementation

Handles a CPViewBoundsDidChangeNotification.

Parameters

aNotification

the notification event

Definition at line 111 of file CPClipView.j.

viewFrameChanged:()

- (void) viewFrameChanged: (CPNotification)  aNotification

implementation

Handles a CPViewFrameDidChangeNotification.

Parameters

aNotification

the notification event

Definition at line 120 of file CPClipView.j.

---

The documentation for this class was generated from the following files:

• AppKit/CPClipView.h
• AppKit/CPClipView.j