RBSlidingPageContainerHeaderView Class Reference

Inherits from UIView
Declared in RBSlidingPageContainerHeaderView.h

Overview

The header view for an RBSlidingPageContainerView object.

  animator

The RBAnimator to use when animating the page sliding.

@property (nonatomic, readonly, nonnull) RBAnimator *animator

Declared In

RBSlidingPageContainerHeaderView.h

  margin

The margin to apply to the content of the header.

@property (nonatomic) UIEdgeInsets margin

Declared In

RBSlidingPageContainerHeaderView.h

  shouldClipLabelsToView

Whether or not sibling labels should stay within view.

@property (nonatomic) BOOL shouldClipLabelsToView

Declared In

RBSlidingPageContainerHeaderView.h

  shouldPeakLabelsAtEdges

Whether or not sibling labels should peak at the edges.

@property (nonatomic) BOOL shouldPeakLabelsAtEdges

Declared In

RBSlidingPageContainerHeaderView.h

  minimumSpacing

The minimum spacing that should be maintained between labels.

@property (nonatomic) CGFloat minimumSpacing

Declared In

RBSlidingPageContainerHeaderView.h

– panningDidBegin

Notify the header view that the user began panning the sliding page container.

- (void)panningDidBegin

Declared In

RBSlidingPageContainerHeaderView.h

– panningDidUpdateTo:

Notify the header view that the user panned the sliding page container to a new offset.

- (void)panningDidUpdateTo:(CGFloat)swipeOffset

Parameters

swipeOffset

The new offset.

Declared In

RBSlidingPageContainerHeaderView.h

– panningDidFinish

Notify the header view that the user finished panning the sliding page container.

- (void)panningDidFinish

Declared In

RBSlidingPageContainerHeaderView.h

  titleCount

The number of page title labels in the header.

@property (nonatomic, readonly) NSUInteger titleCount

Declared In

RBSlidingPageContainerHeaderView.h

– titleAtIndex:

The title of the page at the given index.

- (nonnull NSString *)titleAtIndex:(NSUInteger)index

Parameters

index

The page index.

Return Value

The title of the page.

Declared In

RBSlidingPageContainerHeaderView.h

– addTitle:

Adds a page title.

- (void)addTitle:(nonnull NSString *)title

Parameters

title

The title of the page.

Declared In

RBSlidingPageContainerHeaderView.h

– insertTitle:atIndex:

Inserts a new page title at the given index.

- (void)insertTitle:(nonnull NSString *)title atIndex:(NSUInteger)index

Parameters

title

The title of the page.

index

The index to add the page title to.

Declared In

RBSlidingPageContainerHeaderView.h

– removeTitle:

Removes the given page title.

- (void)removeTitle:(nonnull NSString *)title

Parameters

title

The title of the page.

Declared In

RBSlidingPageContainerHeaderView.h

– removeTitleAtIndex:

Removes the page title at the given index.

- (void)removeTitleAtIndex:(NSUInteger)index

Parameters

index

The page index.

Declared In

RBSlidingPageContainerHeaderView.h

– removeAllTitles

Removes all of the page titles.

- (void)removeAllTitles

Declared In

RBSlidingPageContainerHeaderView.h

– modifyTitleAtIndex:title:

Updates the page title at the given index to the given title.

- (void)modifyTitleAtIndex:(NSUInteger)index title:(nonnull NSString *)title

Parameters

index

The page index.

title

The title of the page.

Declared In

RBSlidingPageContainerHeaderView.h

  currentTitleIndex

The index of the current page.

@property (nonatomic, readonly) NSUInteger currentTitleIndex

Declared In

RBSlidingPageContainerHeaderView.h

– moveToTitleAtIndex:animated:completion:

Move to the page at the given index.

- (void)moveToTitleAtIndex:(NSUInteger)index animated:(BOOL)animated completion:(nullable dispatch_block_t)completion

Parameters

index

The page index.

animated

Whether or not to animate the transition.

completion

An optional block to be called when the transition is complete.

Declared In

RBSlidingPageContainerHeaderView.h