IFootnoteNumber.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 __IFootnoteNumber__
#define __IFootnoteNumber__

#include "IPMUnknown.h"
#include "TextID.h"

class PMString;
class IFootnoteNumbering;


const int32 kInvalidFootnoteNumber = -1;

class IFootnoteNumber : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IFOOTNOTENUMBER };

 typedef enum { kFootnoteReferenceInText, kFootnoteNumberInFootnote } FootnoteLocation;

 virtual int32 GetTheNumber(bool16 calculateWhenInvalid) const = 0;

 virtual void GetNumberString(FootnoteLocation location, PMString& noteNum) const = 0;

 virtual void GetNominalNumberString(FootnoteLocation location, PMString& noteNum) const = 0;

 virtual bool16 ResetFootnoteNumber(int32 n = kInvalidFootnoteNumber, bool16 damageIfChanged = kTrue) = 0;

 virtual bool16 RecalculateFootnoteNumber() = 0;
 
 virtual IFootnoteNumbering* QueryFootnoteNumbering() const = 0;

};

#endif
 // __IFootNoteNumber__