Get-Hip/FBSDKCoreKit.framework/Headers/FBSDKProfilePictureView.h
2016-03-14 22:10:37 -04:00

60 lines
2.2 KiB
Objective-C

// Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
//
// You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
// copy, modify, and distribute this software in source code or binary form for use
// in connection with the web services and APIs provided by Facebook.
//
// As with any software that integrates with the Facebook platform, your use of
// this software is subject to the Facebook Developer Principles and Policies
// [http://developers.facebook.com/policy/]. This copyright notice shall be
// included in all copies or substantial portions of the software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
// FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
// IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#import <UIKit/UIKit.h>
/*!
@typedef FBSDKProfilePictureMode enum
@abstract Defines the aspect ratio mode for the source image of the profile picture.
*/
typedef NS_ENUM(NSUInteger, FBSDKProfilePictureMode)
{
/*!
@abstract A square cropped version of the image will be included in the view.
*/
FBSDKProfilePictureModeSquare,
/*!
@abstract The original picture's aspect ratio will be used for the source image in the view.
*/
FBSDKProfilePictureModeNormal,
};
/*!
@abstract A view to display a profile picture.
*/
@interface FBSDKProfilePictureView : UIView
/*!
@abstract The mode for the receiver to determine the aspect ratio of the source image.
*/
@property (nonatomic, assign) FBSDKProfilePictureMode pictureMode;
/*!
@abstract The profile ID to show the picture for.
*/
@property (nonatomic, copy) NSString *profileID;
/*!
@abstract Explicitly marks the receiver as needing to update the image.
@discussion This method is called whenever any properties that affect the source image are modified, but this can also
be used to trigger a manual update of the image if it needs to be re-downloaded.
*/
- (void)setNeedsImageUpdate;
@end