ITextCaret.h

//========================================================================================
// 
// $File$
// 
// Owner: Michael Burbidge
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __ITEXTCARET__
#define __ITEXTCARET__

#include "IPMUnknown.h"

#include "TextEditorID.h"

//========================================================================================
// Forward declarations
//========================================================================================

class PMLineSeg;
class RangeData;
class IControlView;
class IGraphicsContext;

//========================================================================================
// CLASS ITextCaret
//========================================================================================

class ITextCaret : public IPMUnknown
{
// ----- Blinking the caret
public:
 enum { kDefaultIID = IID_ITEXTCARET };


 virtual bool16 IsCaretStroked() const = 0; //looks easy

// virtual bool16 IsCaretBlinking() const = 0; //likely easy

 enum{ kStopCaretBlinking = 0, kStartCaretBlinking};
 
 enum{ kEraseCaretNow = 0, kStrokeCaretNow};
// virtual void SetCaretBlinking( bool16 bOn, bool16 bVisible = kStrokeCaretNow ) = 0;
 // To set a steady TextCaret call SetBlinking( kStopCaretBlinking, kStrokeCaretNow ).


 virtual void DrawingRegion(IControlView* view, const SysRgn& invalidRgn) = 0;
 
// ----- Activating
// virtual void ActivateCaret(bool16 active) = 0;
 // Use to activate the caret when the view the caret is
 // in becomes active.
// virtual bool16 IsCaretActive() const = 0; 
 //TextCaretSelectionObserver::Update and several incopy callers
 //also TextCaretThread::RunTask (which is silly) and EditorToFrame::ActivateTextEditor



// ----- Position

 virtual bool16 UpdateCaretPosition(IControlView *view = nil, const RangeData* newCaretPosition = nil) = 0;


 virtual bool16 GetCaretBounds( PMLineSeg* pCaretBounds ) const = 0; //WritingObserver::DoAutoScroll, ChangesDialogMenuAction::DoAutoScroll --reconcile these


 virtual void ToggleCaret() = 0;
 
 virtual void DrawCaret(IGraphicsContext *gc, PMRect updateRect) = 0;

public:
 /* The state of text caret.
 */
 enum CaretState {
 kCaretOff, kCaretErased = kCaretOff,
 kCaretParked, kCaretStroked = kCaretParked,
 kCaretOn, kCaretBlinking = kCaretOn
 };
 

 virtual void SetCaretState(CaretState, const RangeData* newCaretPosition = nil) = 0;

 virtual CaretState GetCaretState() = 0;
};

#endif