INoteSuiteUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Cindy Chen
// 
// $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 __INoteSuiteUtils__
#define __INoteSuiteUtils__

#include "InCopySharedID.h"

//-----------------------------------
// Forward References
//

#include "IPMUnknown.h"
#include "UIDRef.h"
#include "INoteSuite.h"

class ISelectionManager;
class IControlView;

class INoteSuiteUtils : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_INOTESUITEUTILS };


 virtual void NavigateNote(ISelectionManager* selMgr, IControlView *docView, TextIndex fromThisTextIndex, UIDRef storyRef, INoteSuite::NavigateType type)=0; 


 virtual bool16 IsLayerEditable(IControlView* layoutView)=0;


 virtual bool16 IsNoteHidden() =0;
 

 virtual bool16 CheckNotesState(UIDRef storyRef, bool16 collapsed)=0;
 


 virtual bool16 CanRemoveAllNotes(IDocument* document, UIDRef &storyRef, IControlView *galleyView = nil) =0;
 

 virtual bool16 UnlockLayers(UIDList &layerList) = 0;


 virtual bool16 CheckStoryCollapsed(IControlView *view, ITextModel *textModel = nil) = 0;
 

 virtual bool16 CheckExpandedNoteAnchor(IControlView *view, IDocument *doc) = 0;


 virtual IControlView * GetDocControlView() = 0;
 
 virtual bool16 CheckRemoveXML(UIDRef &storyRef, TextIndex start, TextIndex end) = 0;

 virtual bool16 RemoveAllNotesOnCollapsedStory(IControlView *galleyView, IDocument *doc) = 0;

 virtual bool16 CheckRemoveRuby(UIDRef &storyRef, TextIndex start, TextIndex end=kInvalidTextIndex) = 0;

};

#endif // __INoteSuiteUtils__