/*

 File: ArcView.h

 Abstract: Declares the interface for the ArcView custom class that uses

 CoreText to draw text on a curve.

 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 (C) 2007 Apple Inc. All Rights Reserved.

 */ 

#include <Carbon/Carbon.h>

enum {

    kArcViewControlSignature    = 'arcv',

    kArcViewControlID           = 0

};

#define kArcViewClassID     CFSTR("com.apple.example.arcview")

typedef struct ArcView ArcView;

// Register the arc view class. This should be done very early, before the nib is loaded.

OSStatus ArcViewRegisterClass(void);

// Convenience to get the arc view for the specified window.

ArcView *GetArcViewForWindow(HIWindowRef window);

// Set the font for the arc view. This properly releases the existing font and marks the view as needing display.

void ArcViewSetFont(ArcView *arcView, CTFontRef font);

// Set the content string for the arc view. This properly releases the existing string and marks the view as needing display.

void ArcViewSetString(ArcView *arcView, CFStringRef string);

// Get the current font.

CTFontRef ArcViewGetFont(const ArcView *arcView);

// Get the current content string.

CFStringRef ArcViewGetString(const ArcView *arcView);

// Draw the view in the provided context. This should not be called directly as it draws in response events.

void ArcViewDraw(ArcView *arcView, CGContextRef context);

enum {

    kArcViewShowGlyphBoundsOption       = 1 << 0,

    kArcViewShowLineMetricsOption       = 1 << 1,

    kArcViewDimSubstitutedGlyphsOption  = 1 << 2,

};

typedef UInt32 ArcViewOptions;

// Set the state for the specified option(s)

void ArcViewSetOptions(ArcView *arcView, ArcViewOptions optionsMask, Boolean state);

// Returns true if specified options are enabled

Boolean ArcViewGetOptions(ArcView *arcView, ArcViewOptions optionsMask);