IFootnoteViewSuite.h

//========================================================================================
// 
// $File$
// 
// Owner: Kevin Van Wiel
// 
// $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.
// 
// 
// Note:
// 
//========================================================================================

#ifndef _ITextMiscellanySuite_
#define _ITextMiscellanySuite_

#include "IPMUnknown.h"
#include "WritingModeUIID2.h"
#include "WritingModeID2.h"
#include "CTextEnum.h"

class WideString;
class IPMFont;
class GraphicsData;
class IControlView;
class IActiveContext;

class IFootnoteViewSuite : public IPMUnknown
 {
 //____________________________________________________________________________________________
 // Data Types
 //____________________________________________________________________________________________
 public:
 enum { kDefaultIID = IID_IFOOTNOTEVIEWSUITE };

 //____________________________________________________________________________________________
 // Member functions
 //____________________________________________________________________________________________
 public:
 virtual bool16 SelectionInFootnote(void) = 0;

 virtual bool16 MoveSelectionOutOfFootnote(void) = 0;

 virtual ErrorCode CollapseExpandAllFootnotes(void) = 0;
 
 virtual ErrorCode CollapseExpandFootnote(TextIndex anchorIndex) = 0;
 
 
 virtual bool16 IsFootnoteCollapsed(TextIndex anchorIndex) = 0;
 
 virtual bool16 ShouldCollapseAllFootnotes() = 0;

 };

#endif // _ITextMiscellanySuite_