INoteSuite.h

//========================================================================================
// 
// $File$
// 
// Owner: ???
// 
// $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 __INoteSuite__
#define __INoteSuite__

#include "IPMUnknown.h"
#include "InCopySharedID.h"
#include "ITextSelectionSuite.h"

class IControlView;
class ISelectionManager;
class IDocument;

class INoteSuite : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_INOTESUITE };

 enum NavigateType { kNextNote=0, kPreviousNote };
 enum CopyToNoteType {kWordToNote=0, kLineToNote, kParaToNote, kStoryToNote};


 virtual bool16 CanAddNote(IControlView* view) const = 0;

 virtual void DoAddNote(IControlView* view) = 0;

 virtual bool16 CanConvertToNote(IControlView* view) const = 0;

 virtual void DoConvertToNote(IControlView* view, ClassID commandBossID) = 0;

 virtual bool16 CanOpenNote(IControlView* view, IControlView* docView, PMString &menuString) const = 0;

 virtual void DoOpenNote(IControlView* view, IControlView* docView) = 0;

 virtual bool16 CanDeleteNote(IControlView* view, IControlView *docView) const = 0;

 virtual void DoDeleteNote(IControlView* view, IControlView* docView) = 0;


 virtual bool16 CanConvertToText(IControlView* view, IControlView *docView) const = 0;

 virtual void DoConvertToText(IControlView* view, IControlView* docView) = 0;

 virtual bool16 CanScrollToNote(IControlView* view, IControlView *docView) const = 0;

 virtual void DoScrollToNote(IControlView* view, IControlView* docView) = 0;


 virtual bool16 CanNavigateNote(IControlView* view, IControlView *docView, bool16 *inPalette=nil) const = 0;

 virtual void DoNavigateNote(IControlView* view, IControlView* docView, ISelectionManager* selMgr, NavigateType type) = 0;

 virtual bool16 CanRemoveAllNotes(IControlView* view, IControlView* docView, IDocument *doc) const = 0;

 virtual void DoRemoveAllNotes(IControlView* view, IControlView* docView, IDocument *doc) = 0;

 virtual bool16 CanRemoveStoryNotes(IControlView* view, IControlView *docView) const = 0;

 virtual void DoRemoveStoryNotes(IControlView* view, IControlView* docView) = 0;

 virtual bool16 CanSplitNote(IControlView* view, IControlView *docView, bool16 bNotesMode = kFalse) const = 0;

 virtual void DoSplitNote(IControlView* view, IControlView* docView) = 0;

 virtual bool16 CanShowHideNote(IControlView* view, IControlView *docView) const = 0;

 virtual void DoShowHideNote(IControlView* view, IControlView* docView) = 0;


 virtual bool16 CanExpandAllNotes(IControlView* view, IControlView* docView) const = 0;

 virtual void DoExpandAllNotes(IControlView* view, IControlView* docView) = 0;


 virtual bool16 CanCollapseAllNotes(IControlView* view, IControlView* docView) const =0;

 virtual void DoCollapseAllNotes(IControlView* view, IControlView* docView) =0;


 virtual void SetSelection(IControlView* view, ITextSelectionSuite::Units selectType)=0;

 virtual void DoSetNoteToPalette(IControlView* view, IControlView* docView) = 0;

 virtual bool16 IsInNote() const = 0; 

};

#endif // _INoteSuite_