InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | List of all members
IDocumentLog::DocEvent Class Reference

#include <idocumentlog.h>

Public Member Functions

 DocEvent ()
 
 DocEvent (EventType what)
 
 DocEvent (const DocEvent &other)
 
EventType GetType () const
 
PlatformType GetPlatform () const
 
FormatID GetSystemVersion () const
 
PMString GetHighestVersion () const
 
int16 GetFeatureSet () const
 
int16 GetBuildNumber () const
 
GlobalTime GetEventTime () const
 
DocEvent & operator= (const DocEvent &other)
 
void ReadWrite (IPMStream *s)
 

Detailed Description

DocEvent class - used to hold the events in the document log.

Constructor & Destructor Documentation

IDocumentLog::DocEvent::DocEvent ()
inline

Various DocEvent constructors

Member Function Documentation

int16 IDocumentLog::DocEvent::GetBuildNumber () const
inline

Get the build number from this document event.

Returns
the build number of the app in use when this event was recorded.
GlobalTime IDocumentLog::DocEvent::GetEventTime () const
inline

Get the time from this document event.

Returns
the time when this event was recorded.
See Also
GlobalTime
int16 IDocumentLog::DocEvent::GetFeatureSet () const
inline

Get the feature set from this document event.

Returns
the feature set.
See Also
FeatureSets.h
PMString IDocumentLog::DocEvent::GetHighestVersion () const
inline

Get the highest AUM version of any plugin/library

Returns
the string for the highest AUM version of any plugin/library, i.e. "4.0.1.399"
PlatformType IDocumentLog::DocEvent::GetPlatform () const
inline

Get the OS platform type from this document event.

Returns
the OS platform type, i.e. kMacintosh
FormatID IDocumentLog::DocEvent::GetSystemVersion () const
inline

Get the OS version from this document event.

Returns
the OS version
EventType IDocumentLog::DocEvent::GetType () const
inline

Get the event type from this document event.

Returns
the event type, i.e. kConverted
DocEvent& IDocumentLog::DocEvent::operator= (const DocEvent & other)
inline

Assignment

void IDocumentLog::DocEvent::ReadWrite (IPMStream * s)

Read/Write this event from/to the given stream

Parameters
sthe stream to read/write from/to