Merge pull request #32 from TimOliver/ipados-mouse

Add iPadOS mouse pointer support

Author: TimOliver

CHANGELOG.md

@@ -1,6 +1,17 @@
 x.y.z Release Notes (yyyy-MM-dd)
 =============================================================
 
+1.2.0 Release Notes (2022-01-23)
+=============================================================
+
+### Enhancements
+
+* Added iPadOS mouse pointer support.
+
+### Fixed
+
+* Tapping a segment may not have properly played the selection animation.
+
 1.1.0 Release Notes (2020-05-20)
 =============================================================
 

TOSegmentedControl.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name     = 'TOSegmentedControl'
-  s.version  = '1.1.0'
+  s.version  = '1.2.0'
   s.license  =  { :type => 'MIT', :file => 'LICENSE' }
   s.summary  = 'A segmented control in the style of iOS 13 compatible with previous versions of iOS.'
   s.homepage = 'https://github.com/TimOliver/TOSegmentedControl'

TOSegmentedControl/Private/TOSegmentedControlSegment.h

@@ -1,7 +1,7 @@
 //
 //  TOSegmentedControlItem.h
 //
-//  Copyright 2019 Timothy Oliver. All rights reserved.
+//  Copyright 2019-2022 Timothy Oliver. All rights reserved.
 //
 //  Permission is hereby granted, free of charge, to any person obtaining a copy
 //  of this software and associated documentation files (the "Software"), to
@@ -55,6 +55,9 @@ NS_ASSUME_NONNULL_BEGIN
 /** Whether the item is selected or not. */
 @property (nonatomic, assign) BOOL isSelected;
 
+/** A container view that wraps the item and arrow views */
+@property (nonatomic, strong) UIView *containerView;
+
 /** The view (either image or label) for this item */
 @property (nonatomic, readonly) UIView *itemView;
 

TOSegmentedControl/Private/TOSegmentedControlSegment.m

@@ -1,7 +1,7 @@
 //
 //  TOSegmentedControlItem.m
 //
-//  Copyright 2019 Timothy Oliver. All rights reserved.
+//  Copyright 2019-2022 Timothy Oliver. All rights reserved.
 //
 //  Permission is hereby granted, free of charge, to any person obtaining a copy
 //  of this software and associated documentation files (the "Software"), to
@@ -161,7 +161,10 @@ + (NSArray *)segmentsWithObjects:(NSArray *)objects forSegmentedControl:(nonnull
 #pragma mark - Set-up -
 
 - (void)commonInit
-{    
+{
+    // Create the container view
+    _containerView = [[UIView alloc] init];
+
     // Create the initial image / label view
     [self refreshItemView];
 
@@ -185,7 +188,7 @@ - (void)refreshReversibleView
         UIImage *arrow = self.segmentedControl.arrowImage;
         self.arrowView = [[UIView alloc] initWithFrame:(CGRect){CGPointZero, arrow.size}];
         self.arrowView.alpha = 0.0f;
-        [self.segmentedControl.trackView addSubview:self.arrowView];
+        [self.containerView addSubview:self.arrowView];
 
         self.arrowImageView = [[UIImageView alloc] initWithImage:arrow];
         self.arrowImageView.autoresizingMask = UIViewAutoresizingFlexibleWidth | UIViewAutoresizingFlexibleHeight;
@@ -250,7 +253,7 @@ - (void)refreshItemView
         imageView = nil;
 
         self.itemView = [self makeLabelForTitle:self.title];
-        [self.segmentedControl.trackView addSubview:self.itemView];
+        [self.containerView addSubview:self.itemView];
 
         label = (UILabel *)self.itemView;
     }
@@ -261,13 +264,14 @@ - (void)refreshItemView
         label = nil;
 
         self.itemView = [self makeImageViewForImage:self.image];
-        [self.segmentedControl.trackView addSubview:self.itemView];
+        [self.containerView addSubview:self.itemView];
 
         imageView = (UIImageView *)self.itemView;
     }
 
     // Update the label view
     label.textColor = self.segmentedControl.itemColor;
+
     // Set the frame off the selected text as it is larger
     label.font = self.segmentedControl.selectedTextFont;
     [label sizeToFit];

TOSegmentedControl/TOSegmentedControl.h

@@ -1,7 +1,7 @@
 //
 //  TOSegmentedControl.h
 //
-//  Copyright 2019 Timothy Oliver. All rights reserved.
+//  Copyright 2019-2022 Timothy Oliver. All rights reserved.
 //
 //  Permission is hereby granted, free of charge, to any person obtaining a copy
 //  of this software and associated documentation files (the "Software"), to

TOSegmentedControl/TOSegmentedControl.m

@@ -1,7 +1,7 @@
 //
 //  TOSegmentedControl.m
 //
-//  Copyright 2019 Timothy Oliver. All rights reserved.
+//  Copyright 2019-2022 Timothy Oliver. All rights reserved.
 //
 //  Permission is hereby granted, free of charge, to any person obtaining a copy
 //  of this software and associated documentation files (the "Software"), to
@@ -43,7 +43,7 @@
 // ----------------------------------------------------------------
 // Private Members
 
-@interface TOSegmentedControl ()
+@interface TOSegmentedControl () <UIPointerInteractionDelegate>
 
 /** The private list of item objects, storing state and view data */
 @property (nonatomic, strong) NSMutableArray<TOSegmentedControlSegment *> *segments;
@@ -81,6 +81,12 @@ @interface TOSegmentedControl ()
 /** Convenience property for testing if there are no segments */
 @property (nonatomic, readonly) BOOL hasNoSegments;
 
+/** Pointer interaction for mice interactions */
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Weverything"
+@property (nonatomic, strong) UIPointerInteraction *pointerInteraction;
+#pragma clang diagnostic pop
+
 @end
 
 @implementation TOSegmentedControl
@@ -166,7 +172,16 @@ - (void)commonInit
     self.thumbShadowRadius = 3.0f;
     self.thumbShadowOffset = 2.0f;
     self.thumbShadowOpacity = 0.13f;
-    
+
+    // Set focused index to -1 to indicate nothing is focused
+    self.focusedIndex = -1;
+
+    // Configure indirect pointing support
+    if (@available(iOS 13.4, *)) {
+        self.pointerInteraction = [[UIPointerInteraction alloc] initWithDelegate:self];
+        [self addInteraction:self.pointerInteraction];
+    }
+
     // Configure view interaction
     // When the user taps down in the view
     [self addTarget:self
@@ -398,6 +413,7 @@ - (void)removeSegmentAtIndex:(NSInteger)index
     _items = items;
 
     // Remove item object
+    [self.segments[index].containerView removeFromSuperview];
     [self.segments removeObjectAtIndex:index];
 
     // Update number of separators
@@ -407,6 +423,9 @@ - (void)removeSegmentAtIndex:(NSInteger)index
 - (void)removeAllSegments
 {
     // Remove all item objects
+    for (TOSegmentedControlSegment * segment in self.segments) {
+        [segment.containerView removeFromSuperview];
+    }
     self.segments = [NSMutableArray array];
 
     // Remove all separators
@@ -526,11 +545,12 @@ - (void)layoutItemViews
     for (TOSegmentedControlSegment *item in self.segments) {
         UIView *itemView = item.itemView;
         [itemView sizeToFit];
-        [self.trackView addSubview:itemView];
+        [self.trackView addSubview:item.containerView];
 
         // Get the container frame that the item will be aligned with
         CGRect thumbFrame = [self frameForSegmentAtIndex:i];
-        
+        item.containerView.frame = thumbFrame;
+
         // Work out the appropriate size of the item
         CGRect itemFrame = itemView.frame;
 
@@ -545,8 +565,8 @@ - (void)layoutItemViews
         }
 
         // Center the item in the container
-        itemFrame.origin.x = CGRectGetMidX(thumbFrame) - (itemFrame.size.width * 0.5f);
-        itemFrame.origin.y = CGRectGetMidY(thumbFrame) - (itemFrame.size.height * 0.5f);
+        itemFrame.origin.x = (CGRectGetWidth(thumbFrame) - itemFrame.size.width) * 0.5f;
+        itemFrame.origin.y = (CGRectGetHeight(thumbFrame) - itemFrame.size.height) * 0.5f;
 
         // Set the item frame
         itemView.frame = CGRectIntegral(itemFrame);
@@ -747,6 +767,11 @@ - (void)setItemAtIndex:(NSInteger)index faded:(BOOL)faded
 }
 
 - (void)refreshSeparatorViewsForSelectedIndex:(NSInteger)index
+{
+    [self refreshSeparatorViewsForSelectedIndexes:[NSSet setWithObject:@(index)]];
+}
+
+- (void)refreshSeparatorViewsForSelectedIndexes:(NSSet<NSNumber *> *)indexes
 {
     // Hide the separators on either side of the selected segment
     NSInteger i = 0;
@@ -757,7 +782,9 @@ - (void)refreshSeparatorViewsForSelectedIndex:(NSInteger)index
             continue;
         }
 
-        separatorView.alpha = (i == index || i == (index - 1)) ? 0.0f : 1.0f;
+        // Hide the index (right side) and the previous index (left side) if it's in the set
+        BOOL containsIndex = ([indexes containsObject:@(i)] || [indexes containsObject:@(i+1)]);
+        separatorView.alpha = containsIndex ? 0.0f : 1.0f;
         i++;
     }
 }
@@ -787,6 +814,11 @@ - (void)didTapDown:(UIControl *)control withEvent:(UIEvent *)event
     // Track the currently selected item as the focused one
     self.focusedIndex = tappedIndex;
 
+    // On iOS 13.4, update the point interaction
+    if (@available(iOS 13.4, *)) {
+        [self.pointerInteraction invalidate];
+    }
+
     // Work out which animation effects to apply
     if (!self.isDraggingThumbView) {
         [UIView animateWithDuration:0.35f animations:^{
@@ -819,7 +851,12 @@ - (void)didDragTap:(UIControl *)control withEvent:(UIEvent *)event
 
     CGPoint tapPoint = [event.allTouches.anyObject locationInView:self];
     NSInteger tappedIndex = [self segmentIndexForPoint:tapPoint];
-    
+
+    // On iOS 13.4, update the point interaction
+    if (@available(iOS 13.4, *)) {
+        [self.pointerInteraction invalidate];
+    }
+
     if (tappedIndex == self.focusedIndex) {
       return;
     }
@@ -965,6 +1002,11 @@ - (void)didEndTap:(UIControl *)control withEvent:(UIEvent *)event
         // Reset the focused index flag
         self.focusedIndex = -1;
 
+        // On iOS 13.4, update the point interaction
+        if (@available(iOS 13.4, *)) {
+            [self.pointerInteraction invalidate];
+        }
+
         return;
     }
 
@@ -980,6 +1022,11 @@ - (void)didEndTap:(UIControl *)control withEvent:(UIEvent *)event
         [self sendIndexChangedEventActions];
     }
 
+    // On iOS 13.4, update the point interaction
+    if (@available(iOS 13.4, *)) {
+        [self.pointerInteraction invalidate];
+    }
+
     // Work out which animation effects to apply
     id animationBlock = ^{
         [self setThumbViewShrunken:NO];
@@ -1013,6 +1060,80 @@ - (void)sendIndexChangedEventActions
     }
 }
 
+#pragma mark - Pointer Interaction -
+
+- (UIPointerRegion *)pointerInteraction:(UIPointerInteraction *)interaction
+                       regionForRequest:(UIPointerRegionRequest *)request
+                          defaultRegion:(UIPointerRegion *)defaultRegion API_AVAILABLE(ios(13.4))
+{
+    CGRect frame = defaultRegion.rect;
+
+    // Determine which segment the pointer is in
+    CGFloat segmentWidth = frame.size.width / self.segments.count;
+    CGPoint location = request.location;
+    NSInteger segment = floorf(location.x / segmentWidth);
+
+    // Define the selectable region for this segment
+    frame.origin.x = segmentWidth * segment;
+    frame.size.width = segmentWidth;
+
+    // Return the region and an identifier for the segment
+    return [UIPointerRegion regionWithRect:frame identifier:@(segment)];
+}
+
+- (UIPointerStyle *)pointerInteraction:(UIPointerInteraction *)interaction
+                        styleForRegion:(UIPointerRegion *)region API_AVAILABLE(ios(13.4))
+{
+    // Fetch which segment was selected
+    NSInteger segment = [(NSNumber *)region.identifier integerValue];
+
+    // Fetch the frame size of the segment
+    CGRect frame = [self frameForSegmentAtIndex:segment];
+
+    // Create a preview link to the container view containing the item and arrow
+    UITargetedPreview *preview = [[UITargetedPreview alloc] initWithView:[self.segments[segment] containerView]];
+
+    // Define the selection shape as the size of the segment with the thumb's corner radius
+    UIPointerShape *shape = [UIPointerShape shapeWithRoundedRect:frame
+                                                    cornerRadius:self.thumbView.layer.cornerRadius];
+
+    // For selected segments
+    UIPointerEffect *effect = nil;
+    if (segment == self.selectedSegmentIndex) {
+        effect = [UIPointerLiftEffect effectWithPreview:preview];
+    } else { // Un-selected segments
+        effect = [UIPointerHighlightEffect effectWithPreview:preview];
+    }
+
+    // Return the final generated shape
+    return [UIPointerStyle styleWithEffect:effect shape:shape];
+}
+
+- (void)pointerInteraction:(UIPointerInteraction *)interaction
+           willEnterRegion:(UIPointerRegion *)region
+                  animator:(id<UIPointerInteractionAnimating>)animator API_AVAILABLE(ios(13.4))
+{
+    NSInteger segment = [(NSNumber *)region.identifier integerValue];
+    NSSet *selectedSegments = [NSSet setWithArray:@[@(segment), @(self.selectedSegmentIndex)]];
+
+    // Animate the separator views fading in and out to match
+    [animator addAnimations:^{
+        [self refreshSeparatorViewsForSelectedIndexes:selectedSegments];
+    }];
+}
+
+- (void)pointerInteraction:(UIPointerInteraction *)interaction
+            willExitRegion:(UIPointerRegion *)region
+                  animator:(id<UIPointerInteractionAnimating>)animator API_AVAILABLE(ios(13.4))
+{
+    // Restore the thumb view
+    self.trackView.clipsToBounds = YES;
+
+    [animator addAnimations:^{
+        [self refreshSeparatorViewsForSelectedIndex:self.selectedSegmentIndex];
+    }];
+}
+
 #pragma mark - Accessors -
 
 // -----------------------------------------------

TOSegmentedControlExample.xcodeproj/project.pbxproj

@@ -43,6 +43,7 @@
 		22C93B05232AA79900A281CA /* TOSegmentedControl.h */ = {isa = PBXFileReference; explicitFileType = sourcecode.c.objc; fileEncoding = 4; path = TOSegmentedControl.h; sourceTree = "<group>"; };
 		22C93B07232ADBEA00A281CA /* TOSegmentedControlSegment.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = TOSegmentedControlSegment.h; sourceTree = "<group>"; };
 		22C93B0D232ADFDD00A281CA /* TOSegmentedControlSegment.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = TOSegmentedControlSegment.m; sourceTree = "<group>"; };
+		22D83E6E279D2F3700CF0D8E /* TOSegmentedControl.podspec */ = {isa = PBXFileReference; lastKnownFileType = text; path = TOSegmentedControl.podspec; sourceTree = "<group>"; };
 		22DF8D8522FF119C0051F319 /* TOSegmentedControlExample.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = TOSegmentedControlExample.app; sourceTree = BUILT_PRODUCTS_DIR; };
 		22DF8D8822FF119C0051F319 /* AppDelegate.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = AppDelegate.h; sourceTree = "<group>"; };
 		22DF8D8922FF119C0051F319 /* AppDelegate.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = AppDelegate.m; sourceTree = "<group>"; };
@@ -127,6 +128,7 @@
 				22DF8D8622FF119C0051F319 /* Products */,
 				22E1FE3A232F7F0600CE1C92 /* README.md */,
 				22E1FE3B232F7F0D00CE1C92 /* CHANGELOG.md */,
+				22D83E6E279D2F3700CF0D8E /* TOSegmentedControl.podspec */,
 			);
 			sourceTree = "<group>";
 		};
@@ -555,7 +557,7 @@
 			buildSettings = {
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				CODE_SIGN_STYLE = Automatic;
-				DEVELOPMENT_TEAM = "";
+				DEVELOPMENT_TEAM = 6LF3GMKZAB;
 				INFOPLIST_FILE = TOSegmentedControlExample/Info.plist;
 				IPHONEOS_DEPLOYMENT_TARGET = 9.0;
 				LD_RUNPATH_SEARCH_PATHS = (
@@ -573,7 +575,7 @@
 			buildSettings = {
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				CODE_SIGN_STYLE = Automatic;
-				DEVELOPMENT_TEAM = "";
+				DEVELOPMENT_TEAM = 6LF3GMKZAB;
 				INFOPLIST_FILE = TOSegmentedControlExample/Info.plist;
 				IPHONEOS_DEPLOYMENT_TARGET = 9.0;
 				LD_RUNPATH_SEARCH_PATHS = (