Merge pull request #21 from TimOliver/polish-nil-items-pr

Polished PR that fixed deadlocking and crashing with items

Author: TimOliver

CHANGELOG.md

@@ -1,14 +1,24 @@
 x.y.z Release Notes (yyyy-MM-dd)
 =============================================================
 
+### Enhancements
+
+* All `add` APIs have had `new` removed from them for more succinct naming.
+* Most Swift annotated methods have been renamed to match `UISegmentedControl` more closely.
+
 ### Added
 
 * Support for iOS 9.
+* A new method called  `setSelectedSegmentIndex(_:animated:)` to allow animated transitions of the thumb.
 
 ### Fixed
 
-* A bug where creating instances with `init(items:)` would yield no visible items.
-* A bug where the tint color of the reversible arrow icon wouldn't update properly.
+* Creating instances with `init(items:)` was yielding no visible items.
+* Tint color of the reversible arrow icon wasn't updating properly.
+* A deadlock was occurring when creating an instance with no items initially, and adding items later.
+* A crash was occurring when trying to insert new items with invalid index numbers.
+* Removed trailing separators when appending items with using `insert` functions.
+* If touch events were canceled while tapping down on the control, UI state wasn't being restored to an untapped state.
 
 1.0.1 Release Notes (2019-09-24)
 =============================================================

README.md

@@ -29,16 +29,58 @@ As part of the visual improvements featured in iOS 13, `UISegmentedControl` was
 
 `TOSegmentedControl` has been written to follow the interface of `UISegmentedControl` as closely as possible. This should make it very intuitive to work with.
 
+## Swift
+
+In Swift, the class is renamed to `SegmentedControl`. Creating a new instance is very similar to `UISegmentedControl`.
+
 ```Swift
 
-let segmentedControl = SegmentedControl(items: ["First", "Second", "Third"])
+// Create a new instance
+let segmentedControl = SegmentedControl(items: )
+
+// Add a closure that will be called each time the selected segment changes
 segmentedControlsegmentTappedHandler = { segmentIndex, reversed in
    print("Segment \(segmentIndex) was tapped!")
 }
+
+// Add a new item to the end
+segmentedControl.addSegment(withTitle: "Fourth")
+
+// Insert a new item at the beginning
+segmentedControl.insertSegment(withTitle: "Zero", at: 0)
+
+// Remove all segments
+segmentedControl.removeAllSegments()
+
 ```
 
-## System Requirements
-iOS 10.0 or above
+## Objective-C
+
+```objc
+
+NSArray *items = @[@"First", @"Second", @"Third"];
+
+// Create a new instance
+TOSegmentedControl *segmentedControl = [[TOSegmentedControl alloc] initWithItems:items]];
+
+// Add a block that will be called each time the selected segment changes
+segmentedControl.segmentTappedHandler = ^(NSInteger index, BOOL reversed) {
+    NSLog(@"Segment %d was tapped!", index);
+};
+
+// Add a new item to the end
+[segmentedControl addSegmentWithTitle:@"Fourth"];
+
+// Insert a new item at the beginning
+[segmentedControl insertSegmentWithTitle:@"Zero" atIndex:0];
+
+// Remove all segments
+[segmentedControl removeAllSegments];
+```
+
+
+# System Requirements
+iOS 9.0 or above
 
 # Installation
 

TOSegmentedControl/Private/TOSegmentedControlSegment.h

@@ -22,7 +22,6 @@
 
 #import <Foundation/Foundation.h>
 
-@class UIColor;
 @class UIView;
 @class UIImage;
 @class UIImageView;
@@ -68,33 +67,33 @@ NS_ASSUME_NONNULL_BEGIN
 /** If the item is reversible, the subsequent arrow image view. */
 @property (nonatomic, nullable, readonly) UIView *arrowView;
 
-// Create an array of objects given an array of strings and images
+/// Create an array of objects given an array of strings and images
 + (NSArray *)segmentsWithObjects:(NSArray *)objects
              forSegmentedControl:(TOSegmentedControl *)segmentedControl;;
 
-// Create a non-reversible item from this class
+/// Create a non-reversible item from this class
 - (nullable instancetype)initWithObject:(id)object
                     forSegmentedControl:(TOSegmentedControl *)segmentedControl;
 - (instancetype)initWithTitle:(NSString *)title
           forSegmentedControl:(TOSegmentedControl *)segmentedControl;
 - (instancetype)initWithImage:(UIImage *)image
           forSegmentedControl:(TOSegmentedControl *)segmentedControl;
 
-// Create a potentially reversible item from this class
+/// Create a potentially reversible item from this class
 - (instancetype)initWithTitle:(NSString *)title
                    reversible:(BOOL)reversible
           forSegmentedControl:(TOSegmentedControl *)segmentedControl;
 - (instancetype)initWithImage:(UIImage *)image
                    reversible:(BOOL)reversible
           forSegmentedControl:(TOSegmentedControl *)segmentedControl ;
 
-// If the item is reversible, flip the direction
+/// If the item is reversible, flip the direction
 - (void)toggleDirection;
 
-// Re-synchronize the item view when the segmented control style changes
+/// Re-synchronize the item view when the segmented control style changes
 - (void)refreshItemView;
 
-// Rotates the arrow image view to 180 degrees and back again
+/// Rotates the arrow image view to 180 degrees and back again
 - (void)setArrowImageReversed:(BOOL)reversed;
 
 @end

TOSegmentedControl/TOSegmentedControl.h

@@ -104,7 +104,7 @@ IB_DESIGNABLE @interface TOSegmentedControl : UIControl
  @param image The image to set.
  @param index The index of the segment to set.
 */
-- (void)setImage:(UIImage *)image forSegmentAtIndex:(NSInteger)index NS_SWIFT_NAME(set(_:for:));
+- (void)setImage:(UIImage *)image forSegmentAtIndex:(NSInteger)index NS_SWIFT_NAME(set(_:forSegmentAt:));
 
 /**
  Replaces the content of an existing segment with a new image,
@@ -115,23 +115,23 @@ IB_DESIGNABLE @interface TOSegmentedControl : UIControl
  @param index The index of the segment to set.
 */
 - (void)setImage:(UIImage *)image reversible:(BOOL)reversible
-                              forSegmentAtIndex:(NSInteger)index NS_SWIFT_NAME(set(_:reversible:for:));
+                              forSegmentAtIndex:(NSInteger)index NS_SWIFT_NAME(set(_:reversible:forSegmentAt:));
 
 /**
  Returns the image that was assigned to a specific segment.
  Will return nil if the content at that segment is not an image.
 
  @param index The index at which the image is located.
 */
-- (nullable UIImage *)imageForSegmentAtIndex:(NSInteger)index NS_SWIFT_NAME(image(for:));
+- (nullable UIImage *)imageForSegmentAtIndex:(NSInteger)index NS_SWIFT_NAME(image(forSegmentAt:));
 
 /**
  Sets the content of a given segment to a text label.
 
  @param title The text to display at the segment.
  @param index The index of the segment to set.
 */
-- (void)setTitle:(NSString *)title forSegmentAtIndex:(NSInteger)index NS_SWIFT_NAME(set(_:for:));
+- (void)setTitle:(NSString *)title forSegmentAtIndex:(NSInteger)index NS_SWIFT_NAME(set(_:forSegmentAt:));
 
 /**
  Sets the content of a given segment to a text label, and
@@ -142,53 +142,53 @@ IB_DESIGNABLE @interface TOSegmentedControl : UIControl
  @param index The index of the segment to set.
 */
 - (void)setTitle:(NSString *)title reversible:(BOOL)reversible
-                               forSegmentAtIndex:(NSInteger)index NS_SWIFT_NAME(set(_:reversible:for:));
+                               forSegmentAtIndex:(NSInteger)index NS_SWIFT_NAME(set(_:reversible:forSegmentAt:));
 
 /**
  Returns the string of the title that was assigned to a specific segment.
  Will return nil if the content at that segment is not a string.
 
  @param index The index at which the image is located.
 */
-- (nullable NSString *)titleForSegmentAtIndex:(NSInteger)index NS_SWIFT_NAME(title(for:));
+- (nullable NSString *)titleForSegmentAtIndex:(NSInteger)index NS_SWIFT_NAME(titleForSegment(for:));
 
 /**
  Adds a new text segment to the end of the list.
  
  @param title The title of the new item.
 */
-- (void)addNewSegmentWithTitle:(NSString *)title NS_SWIFT_NAME(addSegment(with:));
+- (void)addSegmentWithTitle:(NSString *)title NS_SWIFT_NAME(addSegment(withTitle:));
 
 /**
  Adds a new text segment to the end of the list, and optionally makes it reversible.
  
  @param title The title of the new item.
  @param reversible Whether the item is reversible or not.
 */
-- (void)addNewSegmentWithTitle:(NSString *)title reversible:(BOOL)reversible NS_SWIFT_NAME(addSegment(with:reversible:));
+- (void)addSegmentWithTitle:(NSString *)title reversible:(BOOL)reversible NS_SWIFT_NAME(addSegment(withTitle:reversible:));
 
 /**
  Adds a new image segment to the end of the list.
  
  @param image The image of the new item.
 */
-- (void)addNewSegmentWithImage:(UIImage *)image NS_SWIFT_NAME(addSegment(with:));
+- (void)addSegmentWithImage:(UIImage *)image NS_SWIFT_NAME(addSegment(with:));
 
 /**
  Adds a new image segment to the end of the list, and optionally makes it reversible.
  
  @param image The image of the new item.
  @param reversible Whether the item is reversible or not.
 */
-- (void)addNewSegmentWithImage:(UIImage *)image reversible:(BOOL)reversible NS_SWIFT_NAME(addSegment(with:reversible:));
+- (void)addSegmentWithImage:(UIImage *)image reversible:(BOOL)reversible NS_SWIFT_NAME(addSegment(with:reversible:));
 
 /**
  Inserts a new image segment at the specified index.
 
  @param image The image to set.
  @param index The index of the segment to which the image will be set.
 */
-- (void)insertSegmentWithImage:(UIImage *)image atIndex:(NSInteger)index NS_SWIFT_NAME(insertSegment(_:at:));
+- (void)insertSegmentWithImage:(UIImage *)image atIndex:(NSInteger)index NS_SWIFT_NAME(insertSegment(with:at:));
 
 /**
  Inserts a new image segment at the specified segment index, and optionally makes it reversible.
@@ -198,15 +198,15 @@ IB_DESIGNABLE @interface TOSegmentedControl : UIControl
  @param index The index of the segment to which the image will be set.
 */
 - (void)insertSegmentWithImage:(UIImage *)image reversible:(BOOL)reversible
-                                                atIndex:(NSInteger)index NS_SWIFT_NAME(insertSegment(_:reversible:at:));
+                                                atIndex:(NSInteger)index NS_SWIFT_NAME(insertSegment(with:reversible:at:));
 
 /**
  Inserts a new title segment at the specified index.
 
  @param title The title to set.
  @param index The index of the segment to which the image will be set.
 */
-- (void)insertSegmentWithTitle:(NSString *)title atIndex:(NSInteger)index NS_SWIFT_NAME(insertSegment(_:at:));
+- (void)insertSegmentWithTitle:(NSString *)title atIndex:(NSInteger)index NS_SWIFT_NAME(insertSegment(withTitle:at:));
 
 /**
  Inserts a new title segment at the specified index, and optionally makes it reversible.
@@ -216,7 +216,7 @@ IB_DESIGNABLE @interface TOSegmentedControl : UIControl
  @param index The index of the segment to which the image will be set.
 */
 - (void)insertSegmentWithTitle:(NSString *)title reversible:(BOOL)reversible
-                       atIndex:(NSInteger)index NS_SWIFT_NAME(insertSegment(_:reversible:at:));
+                       atIndex:(NSInteger)index NS_SWIFT_NAME(insertSegment(withTitle:reversible:at:));
 
 /**
  Remove the last segment in the list
@@ -241,37 +241,37 @@ IB_DESIGNABLE @interface TOSegmentedControl : UIControl
  @param enabled Whether the segment is enabled or not.
  @param index The specific index to enable/disable.
 */
-- (void)setEnabled:(BOOL)enabled forSegmentAtIndex:(NSInteger)index NS_SWIFT_NAME(setEnabled(_:at:));
+- (void)setEnabled:(BOOL)enabled forSegmentAtIndex:(NSInteger)index NS_SWIFT_NAME(setEnabled(_:forSegmentAt:));
 
 /**
  Returns whether the segment at the specified index is currently enabled or not.
 
  @param index The index to check.
 */
-- (BOOL)isEnabledForSegmentAtIndex:(NSInteger)index NS_SWIFT_NAME(isEnabled(at:));
+- (BOOL)isEnabledForSegmentAtIndex:(NSInteger)index NS_SWIFT_NAME(isEnabledForSegment(at:));
 
 /**
  Sets whether a specific segment is currently reversible or not.
 
  @param reversible Whether the segment is reversible or not.
  @param index The specific index to enable/disable.
 */
-- (void)setReversible:(BOOL)reversible forSegmentAtIndex:(NSInteger)index NS_SWIFT_NAME(setReversible(_:at:));
+- (void)setReversible:(BOOL)reversible forSegmentAtIndex:(NSInteger)index NS_SWIFT_NAME(setReversible(_:forSegmentAt:));
 
 /**
  Returns whether the segment at the specified index is reversible or not.
 
  @param index The index to check.
 */
-- (BOOL)isReversibleForSegmentAtIndex:(NSInteger)index NS_SWIFT_NAME(isReversible(at:));
+- (BOOL)isReversibleForSegmentAtIndex:(NSInteger)index NS_SWIFT_NAME(isReversibleForSegment(at:));
 
 /**
  Sets whether a specific segment is currently in a reversed state or not.
 
  @param reversed Whether the segment is currently reversed or not.
  @param index The specific index to enable/disable.
 */
-- (void)setReversed:(BOOL)reversed forSegmentAtIndex:(NSInteger)index NS_SWIFT_NAME(setReversed(_:at:));
+- (void)setReversed:(BOOL)reversed forSegmentAtIndex:(NSInteger)index NS_SWIFT_NAME(setReversed(_:forSegmentAt:));
 
 /**
  Returns whether the segment at the specified index is currently reversed or not.
@@ -280,6 +280,14 @@ IB_DESIGNABLE @interface TOSegmentedControl : UIControl
 */
 - (BOOL)isReversedForSegmentAtIndex:(NSInteger)index NS_SWIFT_NAME(isReversed(at:));
 
+/**
+ Sets which segment is currently selected, and optionally play an animation during the transition.
+
+ @param selectedSegmentIndex The index of the segment to select.
+ @param animated Whether the transition to the newly selected index is animated or not.
+*/
+- (void)setSelectedSegmentIndex:(NSInteger)selectedSegmentIndex animated:(BOOL)animated NS_SWIFT_NAME(setSelectedSegmentIndex(_:animated:));
+
 @end
 
 NS_ASSUME_NONNULL_END