IGalleyInfoUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Matt Ramme
// 
// $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.
// 
// 
// Purpose:
// Utilities for use with GalleyInfo.
// 
//========================================================================================

#ifndef __IGalleyInfoUtils__
#define __IGalleyInfoUtils__

#include "Utils.h"
#include "InCopyCoreID.h"

class ITextModel;
class IWaxLine;
class IWaxIterator;
class StatsScope;


class FitInformation
{
public:
 FitInformation() : fFractionalFitValue(-1.0), fPercentFilled(1.0), fFitDataType(kUnknownFit) {}
 
 enum TypeFit { kUnderset, kExactFit, kOverset, kUnknownFit };
 
 PMReal fFractionalFitValue;
 
 PMReal fPercentFilled;
 
 TypeFit fFitDataType;
};



class IGalleyInfoUtils : public IPMUnknown
{
 public:
 enum {kDefaultIID = IID_IGALLEYINFOUTILS};
 enum FitType{kDepthFit = 0, kWordCountFit, kLineCountFit, kPageCountFit, kGeometryFit, kCharacterFit, kDisableFit};

 virtual int32 StoryCountWords(ITextModel *textModel, TextIndex begin, TextIndex end) = 0;
 
 virtual int32 StoryCountLines(ITextModel *textModel, TextIndex begin, TextIndex end) = 0;
 
 virtual int32 StoryCountFit(ITextModel *textModel, PMReal *pctFilled = nil, FitType fitMethod = kDepthFit, PMReal *fractionalFitValue = nil) = 0;

 virtual FitInformation StoryCountFit(ITextModel *textModel, FitType fitMethod) = 0;
 
 virtual bool16 ToggleIdle(bool16 start = kTrue, IPMUnknown *pIdleLoc = nil) = 0;
 
 virtual bool16 ShouldCountLine(IWaxLine **waxLine, IWaxIterator *waxIterator) = 0;
 
 virtual PMReal StoryCountDepth(ITextModel *textModel, const StatsScope &scope) = 0;

 virtual int32 GetTotalLines(void) = 0;
};

// This lives in each stats widget. Have to do this to make this info 'global'
class StatsScope
{
public:
 StatsScope() { fWhichScope = kStoryStats; fBeginIndex = -1; fEndIndex = -1; 
 fStoryUIDRef = UIDRef(NULL, kInvalidUID); 
 fLastModelLength = 0; fLastChangedCounter = 0; fAssignedDepth = -1.0;
 fAssignedDepthIndex = -1; fFitType = IGalleyInfoUtils::kDepthFit;
 fIncludingFootnotes = kFalse; }

 enum WhichScope { kStoryStats, kSelectionStats, kToBeginStats, kToEndStats, kFitStats };

 WhichScope fWhichScope;
 
 TextIndex fBeginIndex;
 
 TextIndex fEndIndex;
 
 UIDRef fStoryUIDRef;
 
 int32 fLastModelLength;

 uint32 fLastChangedCounter;
 
 PMReal fAssignedDepth;
 
 int32 fAssignedDepthIndex;
 
 IGalleyInfoUtils::FitType fFitType;
 
 bool16 fIncludingFootnotes;
};

#endif //__IGalleyInfoUtils__