EMHint.h

//
//  EMHintState.h
//  ModalStateOverviewTest
//
//  Created by Eric McConkie on 3/6/12.
/*
Copyright (c) 2012 Eric McConkie

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission 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 <Foundation/Foundation.h>
#import "EMHintsView.h"

typedef enum
{
    EMHintShapeTypeRound,
    EMHintShapeTypeRectangle//TODO
}EMHintShapeType;

@protocol EMHintDelegate <NSObject>

@optional

-(BOOL)hintStateHasDefaultTapGestureRecognizer:(id)hintState ;



/*
 // return an array of UIView where spotlights should shine     
 */
-(NSArray*)hintStateViewsToHint:(id)hintState;

/*
 // the default hint space is a label with white helvetica text dynamically centered,
 // one can return a custom view here to override that label
 */
-(UIView*)hintStateViewForDialog:(id)hintState;

/*
 // return an array of rects (NSValue objs) for where spotlights should shine.
 // convenient if UIView array is not an option
 */
-(NSArray*)hintStateRectsToHint:(id)hintState;

/*
 // return NO, if you plan to daisy chain hints, or do someother action
 // return YES, to fad out modal hint view
 */
-(BOOL) hintStateShouldCloseIfPermitted:(id)hintState ;

/*
 // called just before the close (fade) of a modal state view     
 */
-(void) hintStateWillClose:(id)hintState ;

/*
 // called immediately after the modal hint view has faded to zero alpha and is removed     
 */
-(void) hintStateDidClose:(id)hintState ;





/*
 // Default hint is a round spotlight effect,
 // TODO:// rectangle type can be returned to override
 */
//-(EMHintShapeType)hintStateShapeType:(id)hintState;


@end

@interface EMHint : NSObject
{
    EMHintsView *_modalView;//our transparent hint window with lablel and spotlight
}
@property (nonatomic,assign) id<EMHintDelegate> hintDelegate;

-(UIView*)modalView; // accessor to the modal view (use spareingly)
-(void)clear;//instant removal of modal view

/*
 //initiates the modal hint view 
 //default is a spotlight effect on the UIView or Rect returned from one of the protocol methods
 // message is the message in the label
 // where is the view onto which the modal will overlay
 */
-(void)presentModalMessage:(NSString*)message where:(UIView*)presentationPlace;
@end