Skip to content

Commit

Permalink
Add HeaderDoc to DCPathItemButton.h.
Browse files Browse the repository at this point in the history
  • Loading branch information
peng90 committed May 16, 2016
1 parent 0a141af commit 75b9fb5
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions DCPathButton/Classes/DCPathItemButton.h
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,42 @@

@class DCPathItemButton;

/*!
* `DCPathItemButtonDelegate` protocol defines method that informs the delegate object the event of item button's selection.
*/
@protocol DCPathItemButtonDelegate <NSObject>

/*!
* Tells the delegate that the `DCPathItemButton` has been selected.
*
* @param itemButton A `DCPathItemButton` that has been selected.
*/
- (void)itemButtonTapped:(DCPathItemButton *)itemButton;

@end

@interface DCPathItemButton : UIButton

/*!
* The location of the `DCPathItemButton` object in a `DCPathButton` object.
*/
@property (assign, nonatomic) NSUInteger index;

/*!
* The object that acts as the delegate of the `DCPathItemButton` object.
*/
@property (weak, nonatomic) id<DCPathItemButtonDelegate> delegate;

/*!
* Creates a `DCPathItemButton` with normal and highlighted foreground and background images of the button.
*
* @param image The normal foreground image.
* @param highlightedImage The highlighted foreground image.
* @param backgroundImage The normal background image.
* @param backgroundHighlightedImage The highlighted background image.
*
* @return A `DCPathItemButton` object.
*/
- (instancetype)initWithImage:(UIImage *)image
highlightedImage:(UIImage *)highlightedImage
backgroundImage:(UIImage *)backgroundImage
Expand Down

0 comments on commit 75b9fb5

Please sign in to comment.