| commit | author | age | ||
| bad748 | 1 | // Copyright (c) 2014-present, Facebook, Inc. All rights reserved. |
| W | 2 | // |
| 3 | // You are hereby granted a non-exclusive, worldwide, royalty-free license to use, | |
| 4 | // copy, modify, and distribute this software in source code or binary form for use | |
| 5 | // in connection with the web services and APIs provided by Facebook. | |
| 6 | // | |
| 7 | // As with any software that integrates with the Facebook platform, your use of | |
| 8 | // this software is subject to the Facebook Developer Principles and Policies | |
| 9 | // [http://developers.facebook.com/policy/]. This copyright notice shall be | |
| 10 | // included in all copies or substantial portions of the software. | |
| 11 | // | |
| 12 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
| 13 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS | |
| 14 | // FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR | |
| 15 | // COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER | |
| 16 | // IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN | |
| 17 | // CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | |
| 18 | ||
| 19 | #import <UIKit/UIKit.h> | |
| 20 | ||
| e81c27 | 21 | NS_ASSUME_NONNULL_BEGIN |
| H | 22 | |
| 9febd9 | 23 | /** |
| W | 24 | FBSDKTooltipViewArrowDirection enum |
| bad748 | 25 | |
| 9febd9 | 26 | Passed on construction to determine arrow orientation. |
| bad748 | 27 | */ |
| W | 28 | typedef NS_ENUM(NSUInteger, FBSDKTooltipViewArrowDirection) |
| 29 | { | |
| 9febd9 | 30 | /** View is located above given point, arrow is pointing down. */ |
| bad748 | 31 | FBSDKTooltipViewArrowDirectionDown = 0, |
| 9febd9 | 32 | /** View is located below given point, arrow is pointing up. */ |
| bad748 | 33 | FBSDKTooltipViewArrowDirectionUp = 1, |
| e81c27 | 34 | } NS_SWIFT_NAME(FBTooltipView.ArrowDirection); |
| bad748 | 35 | |
| 9febd9 | 36 | /** |
| W | 37 | FBSDKTooltipColorStyle enum |
| bad748 | 38 | |
| 9febd9 | 39 | Passed on construction to determine color styling. |
| bad748 | 40 | */ |
| W | 41 | typedef NS_ENUM(NSUInteger, FBSDKTooltipColorStyle) |
| 42 | { | |
| 9febd9 | 43 | /** Light blue background, white text, faded blue close button. */ |
| bad748 | 44 | FBSDKTooltipColorStyleFriendlyBlue = 0, |
| 9febd9 | 45 | /** Dark gray background, white text, light gray close button. */ |
| bad748 | 46 | FBSDKTooltipColorStyleNeutralGray = 1, |
| e81c27 | 47 | } NS_SWIFT_NAME(FBTooltipView.ColorStyle); |
| bad748 | 48 | |
| 9febd9 | 49 | /** |
| bad748 | 50 | |
| 9febd9 | 51 | Tooltip bubble with text in it used to display tips for UI elements, |
| bad748 | 52 | with a pointed arrow (to refer to the UI element). |
| W | 53 | |
| 9febd9 | 54 | |
| W | 55 | |
| bad748 | 56 | The tooltip fades in and will automatically fade out. See `displayDuration`. |
| W | 57 | */ |
| e81c27 | 58 | NS_SWIFT_NAME(FBTooltipView) |
| bad748 | 59 | @interface FBSDKTooltipView : UIView |
| W | 60 | |
| 9febd9 | 61 | /** |
| W | 62 | Gets or sets the amount of time in seconds the tooltip should be displayed. |
| 63 | Set this to zero to make the display permanent until explicitly dismissed. | |
| bad748 | 64 | Defaults to six seconds. |
| W | 65 | */ |
| 66 | @property (nonatomic, assign) CFTimeInterval displayDuration; | |
| 67 | ||
| 9febd9 | 68 | /** |
| W | 69 | Gets or sets the color style after initialization. |
| 70 | Defaults to value passed to -initWithTagline:message:colorStyle:. | |
| bad748 | 71 | */ |
| W | 72 | @property (nonatomic, assign) FBSDKTooltipColorStyle colorStyle; |
| 73 | ||
| 9febd9 | 74 | /** |
| W | 75 | Gets or sets the message. |
| bad748 | 76 | */ |
| e81c27 | 77 | @property (nonatomic, copy, nullable) NSString *message; |
| bad748 | 78 | |
| 9febd9 | 79 | /** |
| W | 80 | Gets or sets the optional phrase that comprises the first part of the label (and is highlighted differently). |
| bad748 | 81 | */ |
| e81c27 | 82 | @property (nonatomic, copy, nullable) NSString *tagline; |
| bad748 | 83 | |
| 9febd9 | 84 | /** |
| W | 85 | Designated initializer. |
| bad748 | 86 | |
| 13e53a | 87 | @param tagline First part of the label, that will be highlighted with different color. Can be nil. |
| bad748 | 88 | |
| 13e53a | 89 | @param message Main message to display. |
| bad748 | 90 | |
| 13e53a | 91 | @param colorStyle Color style to use for tooltip. |
| bad748 | 92 | |
| 9febd9 | 93 | |
| W | 94 | |
| bad748 | 95 | If you need to show a tooltip for login, consider using the `FBSDKLoginTooltipView` view. |
| W | 96 | |
| 9febd9 | 97 | |
| 13e53a | 98 | @see FBSDKLoginTooltipView |
| bad748 | 99 | */ |
| e81c27 | 100 | - (instancetype)initWithTagline:(nullable NSString *)tagline |
| H | 101 | message:(nullable NSString *)message |
| 102 | colorStyle:(FBSDKTooltipColorStyle)colorStyle; | |
| bad748 | 103 | |
| 9febd9 | 104 | /** |
| W | 105 | Show tooltip at the top or at the bottom of given view. |
| bad748 | 106 | Tooltip will be added to anchorView.window.rootViewController.view |
| W | 107 | |
| 13e53a | 108 | @param anchorView view to show at, must be already added to window view hierarchy, in order to decide |
| bad748 | 109 | where tooltip will be shown. (If there's not enough space at the top of the anchorView in window bounds - |
| W | 110 | tooltip will be shown at the bottom of it) |
| 111 | ||
| 9febd9 | 112 | |
| W | 113 | |
| bad748 | 114 | Use this method to present the tooltip with automatic positioning or |
| W | 115 | use -presentInView:withArrowPosition:direction: for manual positioning |
| 116 | If anchorView is nil or has no window - this method does nothing. | |
| 117 | */ | |
| 118 | - (void)presentFromView:(UIView *)anchorView; | |
| 119 | ||
| 9febd9 | 120 | /** |
| W | 121 | Adds tooltip to given view, with given position and arrow direction. |
| bad748 | 122 | |
| 13e53a | 123 | @param view View to be used as superview. |
| bad748 | 124 | |
| 13e53a | 125 | @param arrowPosition Point in view's cordinates, where arrow will be pointing |
| bad748 | 126 | |
| 13e53a | 127 | @param arrowDirection whenever arrow should be pointing up (message bubble is below the arrow) or |
| bad748 | 128 | down (message bubble is above the arrow). |
| W | 129 | */ |
| e81c27 | 130 | - (void)presentInView:(UIView *)view |
| H | 131 | withArrowPosition:(CGPoint)arrowPosition |
| 132 | direction:(FBSDKTooltipViewArrowDirection)arrowDirection | |
| 133 | NS_SWIFT_NAME(present(in:arrowPosition:direction:)); | |
| bad748 | 134 | |
| 9febd9 | 135 | /** |
| W | 136 | Remove tooltip manually. |
| bad748 | 137 | |
| 9febd9 | 138 | |
| W | 139 | |
| bad748 | 140 | Calling this method isn't necessary - tooltip will dismiss itself automatically after the `displayDuration`. |
| W | 141 | */ |
| 142 | - (void)dismiss; | |
| 143 | ||
| 144 | @end | |
| e81c27 | 145 | |
| H | 146 | NS_ASSUME_NONNULL_END |
