/*

    File:       HIFleetingControlsView.h

    Contains:   Header file associated with HIFleetingControlsView.cp.

    Version:    1.0

    Disclaimer: IMPORTANT:  This Apple software is supplied to you by Apple, Inc.

                ("Apple") in consideration of your agreement to the following terms, and your

                use, installation, modification or redistribution of this Apple software

                constitutes acceptance of these terms.  If you do not agree with these terms,

                please do not use, install, modify or redistribute this Apple software.

                In consideration of your agreement to abide by the following terms, and subject

                to these terms, Apple grants you a personal, non-exclusive license, under AppleÕs

                copyrights in this original Apple software (the "Apple Software"), to use,

                reproduce, modify and redistribute the Apple Software, with or without

                modifications, in source and/or binary forms; provided that if you redistribute

                the Apple Software in its entirety and without modifications, you must retain

                this notice and the following text and disclaimers in all such redistributions of

                the Apple Software.  Neither the name, trademarks, service marks or logos of

                Apple, Inc. may be used to endorse or promote products derived from the

                Apple Software without specific prior written permission from Apple.  Except as

                expressly stated in this notice, no other rights or licenses, express or implied,

                are granted by Apple herein, including but not limited to any patent rights that

                may be infringed by your derivative works or by other works in which the Apple

                Software may be incorporated.

                The Apple Software is provided by Apple on an "AS IS" basis.  APPLE MAKES NO

                WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED

                WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR

                PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND OPERATION ALONE OR IN

                COMBINATION WITH YOUR PRODUCTS.

                IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR

                CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE

                GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

                ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION AND/OR DISTRIBUTION

                OF THE APPLE SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER THEORY OF CONTRACT, TORT

                (INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN

                ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

    Copyright © 2007 Apple, Inc., All Rights Reserved

*/

#ifndef __HIFLEETINGCONTROLSVIEW__

#define __HIFLEETINGCONTROLSVIEW__

#ifdef __cplusplus

extern "C" {

#endif

#define kFleetingControlsViewClassID    CFSTR("com.apple.sample.dts.HIFleetingControlsView")

/*

 *  HIFleetingControlsViewCreate(outFleetingControls)

 *  

 *  Summary:

 *    Creates a FleetingControls custom HIView.

 *  

 *  Parameters:

 *    

 *    outFleetingControls:

 *      On exit, contains the new control.

 */

extern OSStatus 

HIFleetingControlsViewCreate(HIViewRef * outFleetingControls);

/*

 *  HIFleetingControlsViewSetHotZone(inFleetingControls, inHotZone)

 *  

 *  Summary:

 *    Associates a view (the hot zone) in which the mouse has to be for the fleeting controls to appear and fade.

 *  

 *  Parameters:

 *    

 *    inFleetingControls:

 *      The fleeting controls view.

 *    inHotZone:

 *      The view where the mouse has to be.

 */

extern OSStatus 

HIFleetingControlsViewSetHotZone(HIViewRef inFleetingControls, HIViewRef inHotZone);

/*

 *  GetFleetingControlsViewClass()

 *  

 *  Summary:

 *    Registers and returns the class ID string.

 */

extern CFStringRef GetFleetingControlsViewClass();

/*

 *  HIFleetingControlViewGetAlphaIfEmbedded(embeddedView)

 *  

 *  Summary:

 *    Let a view, embedded in the fleeting controls view, get access to the alpha value necessary to its redrawing.

 *

 *    If the view is not embedded in any fleeting controls view, then an alpha value of 1.0 is returned, which is benign

 *    since this value should be used as a multiplicator and anything multiplied by 1 is unchanged...

 *  

 *  Parameters:

 *    

 *    embeddedView:

 *      The view embedded in the fleeting controls view.

 *

 *    Returns the alpha value as a float.

 */

extern float

HIFleetingControlViewGetAlphaIfEmbedded(HIViewRef embeddedView);

#ifdef __cplusplus

}

#endif

#endif