InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ITextStatInfo Class Referenceabstract

#include <ITextStatInfo.h>

Inheritance diagram for ITextStatInfo:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ITEXTSTATINFO }
 

Public Member Functions

virtual void Update (bool16 forceUpdate=kFalse, bool16 fitExchanging=kFalse)=0
 
virtual uint32 GetLines ()=0
 
virtual uint32 GetWords ()=0
 
virtual uint32 GetCharacters ()=0
 
virtual void Current (bool16 isCurrent)=0
 
virtual bool16 IsCurrent ()=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Some methods for calculating statistics on text stories. Related used by the InCopy text statistics ui.

Member Function Documentation

virtual void ITextStatInfo::Current (bool16 isCurrent)
pure virtual

Internal use only; Sets whether the numbers are up to date.

Parameters
isCurrent- kTrue is current false otherwise.
virtual uint32 ITextStatInfo::GetCharacters ()
pure virtual

Get the current character count displayed in the ui

virtual uint32 ITextStatInfo::GetLines ()
pure virtual

Get the current number of lines displayed in the ui

virtual uint32 ITextStatInfo::GetWords ()
pure virtual

Get the current word count displayed in the ui

virtual bool16 ITextStatInfo::IsCurrent ()
pure virtual

Get whether the numbers stats are up to date, appears to be not used anymore may be removed

Returns
kTrue if they are up to date
virtual void ITextStatInfo::Update (bool16 forceUpdate = kFalse,
bool16 fitExchanging = kFalse 
)
pure virtual

Call this to Update the text stats ui

Parameters
forceUpdate- normally calling this function won't necessarily recalculate the text statistics unless something is changed. Passing true will force a recaclulation
fitExchanging- internal use pass false (default)