INumberConverter.h

//========================================================================================
// 
// $File$
// 
// Owner: Anurag Wahi
// 
// $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.
// 
// 
// The INumberConverter interface allows installable numbering styles. The styles may be
// aggregated on different services such as the page numbering service, the paragraph
// numbering service etc., which would allow each type of numbering to support different
// subsets of numbering styles.
// Given a number, this interface will convert that number into a string that will
// be used to display the number in the document. The earlier IPageNumberConverter interface
// could implement multiple styles, but this interface implements only a single style.
// 
//========================================================================================

#ifndef __INUMBERCONVERTER__
#define __INUMBERCONVERTER__

#include "IPMUnknown.h"
#include "SectionID.h"

class PMString;

class INumberConverter : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_INUMBERCONVERTER };

 void GetStyleName(PMString &styleName) const
 { return GetNumberingStyleName(styleName); }
 void GetStyleNameBase(PMString &styleName) const
 { return GetStyleName(styleName); }

 virtual bool16 IncludeStyleChoiceInUI() const = 0;

 void Convert(const int32& number, PMString &numString) const
 { return NumberToString(number, numString); }

 virtual void GetNumberingStyleName(PMString &styleName) const = 0;

 virtual void NumberToString(int32 number, PMString &numString) const = 0;
};


#endif // __INUMBERCONVERTER__