Protocol: UIScrollViewDelegate

Overview

The methods declared by the UIScrollViewDelegate protocol allow the adopting delegate to respond to messages from the UIScrollView class and thus respond to, and in some affect, operations such as scrolling, zooming, deceleration of scrolled content, and scrolling animations.Tells the delegate that the scroll view has ended decelerating the scrolling movement.Tells the delegate when dragging ended in the scroll view.Tells the delegate when a scrolling animation in the scroll view concludes.Tells the delegate when zooming of the content in the scroll view completed.Tells the delegate when the user scrolls the content view within the receiver.Tells the delegate that the scroll view scrolled to the top of the content.Tells the delegate that the scroll view’s zoom factor changed.Asks the delegate if the scroll view should scroll to the top of the content.Tells the delegate that the scroll view is starting to decelerate the scrolling movement.Tells the delegate when the scroll view is about to start scrolling the content.Tells the delegate that zooming of the content in the scroll view is about to commence.Tells the delegate when the user finishes scrolling the content.Asks the delegate for the view to scale when zooming is about to occur in the scroll view.

Instance Method Summary (collapse)

Instance Method Details

- (Object) scrollViewDidEndDecelerating(scrollView)

Tells the delegate that the scroll view has ended decelerating the scrolling movement. The scroll view calls this method when the scrolling movement comes to a halt. The decelerating property of UIScrollView controls deceleration.

Parameters:

  • scrollView (UIScrollView)

    The scroll-view object that is decelerating the scrolling of the content view.

Returns:

- (Object) scrollViewDidEndDragging(scrollView, willDecelerate:decelerate)

Tells the delegate when dragging ended in the scroll view. The scroll view sends this message when the user’s finger touches up after dragging content. The decelerating property of UIScrollView controls deceleration.

Parameters:

  • scrollView (UIScrollView)

    The scroll-view object that finished scrolling the content view.

  • decelerate (Boolean)

    YES if the scrolling movement will continue, but decelerate, after a touch-up gesture during a dragging operation. If the value is NO, scrolling stops immediately upon touch-up.

Returns:

- (Object) scrollViewDidEndScrollingAnimation(scrollView)

Tells the delegate when a scrolling animation in the scroll view concludes. The scroll view calls this method at the end of its implementations of the UIScrollView and setContentOffset:animated: and scrollRectToVisible:animated: methods, but only if animations are requested.

Parameters:

  • scrollView (UIScrollView)

    The scroll-view object that is performing the scrolling animation.

Returns:

- (Object) scrollViewDidEndZooming(scrollView, withView:view, atScale:scale)

Tells the delegate when zooming of the content in the scroll view completed. The scroll view also calls this method after any “bounce” animations. It also calls this method after animated changes to the zoom level and after a zoom-related gesture ends (regardless of whether the gesture resulted in a change to the zoom level).

Parameters:

  • scrollView (UIScrollView)

    The scroll-view object displaying the content view.

  • view (UIView)

    The view object representing that part of the content view that needs to be scaled.

  • scale (Float)

    The scale factor to use for scaling; this value must be between the limits established by the UIScrollView properties maximumZoomScale and minimumZoomScale.

Returns:

- (Object) scrollViewDidScroll(scrollView)

Tells the delegate when the user scrolls the content view within the receiver. The delegate typically implements this method to obtain the change in content offset from scrollView and draw the affected portion of the content view.

Parameters:

  • scrollView (UIScrollView)

    The scroll-view object in which the scrolling occurred.

Returns:

- (Object) scrollViewDidScrollToTop(scrollView)

Tells the delegate that the scroll view scrolled to the top of the content. The scroll view sends this message when it finishes scrolling to the top of the content. It might call it immediately if the top of the content is already shown. For the scroll-to-top gesture (a tap on the status bar) to be effective, the scrollsToTop property of the UIScrollView must be set to YES.

Parameters:

  • scrollView (UIScrollView)

    The scroll-view object that perform the scrolling operation.

Returns:

- (Object) scrollViewDidZoom(scrollView)

Tells the delegate that the scroll view’s zoom factor changed.

Parameters:

  • scrollView (UIScrollView)

    The scroll-view object whose zoom factor changed.

Returns:

- (Boolean) scrollViewShouldScrollToTop(scrollView)

Asks the delegate if the scroll view should scroll to the top of the content. If the delegate doesn’t implement this method, YES is assumed. For the scroll-to-top gesture (a tap on the status bar) to be effective, the scrollsToTop property of the UIScrollView must be set to YES.

Parameters:

  • scrollView (UIScrollView)

    The scroll-view object requesting this information.

Returns:

  • (Boolean)

    YES to permit scrolling to the top of the content, NO to disallow it.

- (Object) scrollViewWillBeginDecelerating(scrollView)

Tells the delegate that the scroll view is starting to decelerate the scrolling movement. The scroll view calls this method as the user’s finger touches up as it is moving during a scrolling operation; the scroll view will continue to move a short distance afterwards. The decelerating property of UIScrollView controls deceleration.

Parameters:

  • scrollView (UIScrollView)

    The scroll-view object that is decelerating the scrolling of the content view.

Returns:

- (Object) scrollViewWillBeginDragging(scrollView)

Tells the delegate when the scroll view is about to start scrolling the content. The delegate might not receive this message until dragging has occurred over a small distance.

Parameters:

  • scrollView (UIScrollView)

    The scroll-view object that is about to scroll the content view.

Returns:

- (Object) scrollViewWillBeginZooming(scrollView, withView:view)

Tells the delegate that zooming of the content in the scroll view is about to commence. This method is called at the beginning of zoom gestures and in cases where a change in zoom level is to be animated. You can use this method to store state information or perform any additional actions prior to zooming the view’s content.

Parameters:

  • scrollView (UIScrollView)

    The scroll-view object displaying the content view.

  • view (UIView)

    The view object whose content is about to be zoomed.

Returns:

- (Object) scrollViewWillEndDragging(scrollView, withVelocity:velocity, targetContentOffset:targetContentOffset)

Tells the delegate when the user finishes scrolling the content. This method is not called when the value of the scroll view’s pagingEnabled property is YES. Your application can change the value of the targetContentOffset parameter to adjust where the scrollview finishes its scrolling animation.

Parameters:

  • scrollView (UIScrollView)

    The scroll-view object where the user ended the touch..

  • velocity (CGPoint)

    The velocity of the scroll view (in points) at the moment the touch was released.

  • targetContentOffset (inout CGPoint)

    The expected offset when the scrolling action decelerates to a stop.

Returns:

- (UIView) viewForZoomingInScrollView(scrollView)

Asks the delegate for the view to scale when zooming is about to occur in the scroll view.

Parameters:

  • scrollView (UIScrollView)

    The scroll-view object displaying the content view.

Returns:

  • (UIView)

    A UIView object that will be scaled as a result of the zooming gesture. Return nil if you don’t want zooming to occur.