IStructureMarks.h

//========================================================================================
// 
// $File$
// 
// Owner: Steve Flenniken
// 
// $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 __ISTRUCTUREMARKS__
#define __ISTRUCTUREMARKS__

#include "BravoForwardDecl.h"

class IDocument;
class ICompositionStyle;
class IStyleInfo;
class IDrawingStyle;
class IWaxLine;
class IPDFFlattenerParams;
class PMRect;
class PMMatrix;
class IWaxRun;
class IMultiColumnTextFrame;

#include "LanguageID.h"
#include "IPDFHyperlinks.h"
#include "PDFID.h"

typedef struct _t_PDDoc *PDDoc;
typedef struct _t_PDPage *PDPage;
typedef struct _t_PDEElement *PDEElement;
typedef struct OPAQUE_64_BITS CosObj;

class IStructureMarks : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_ISTRUCTUREMARKS };

 enum TableRowType
 {
 kBodyRow = 0,
 kHeaderRow,
 kFooterRow
 };

 enum ListType
 {
 kNone = 0,
 kBulleted,
 kNumbered
 };

 virtual ErrorCode BeginBook(int32 docInfoIndex, DocPageIndexList docIndexList, bool16 readerSpreads) = 0;
 virtual ErrorCode EndBook() = 0;

 virtual ErrorCode BeginDocument(IDataBase *db) = 0;
 virtual ErrorCode EndDocument() = 0;

 virtual ErrorCode BeginPage(int32 indexPageInfo, UID pageUID) = 0;
 virtual ErrorCode EndPage() = 0;

 virtual ErrorCode BeginNestedContent() = 0;
 virtual ErrorCode EndNestedContent() = 0;

 virtual ErrorCode BeginTextFrame(const IMultiColumnTextFrame* mcFrame) = 0;
 virtual ErrorCode EndTextFrame(const IMultiColumnTextFrame* mcFrame) = 0;

 virtual ErrorCode BeginParagraph(ICompositionStyle *compositionStyle, IWaxLine *waxLine, const IWaxRun* waxRun, IStyleInfo *styleInfo, IDrawingStyle *drawingStyle,
 IStructureMarks::ListType listType = IStructureMarks::kNone, int32 listLevel = 0, bool isStartWithEndnote = false, UID endnoteUID = kInvalidUID) = 0;

 virtual ErrorCode BeginHyperlink() = 0;
 virtual ErrorCode AddLinkAnnotation(int32 annotation) = 0;
 virtual ErrorCode EndHyperlink() = 0;

 virtual ErrorCode BeginTextRun(IWaxRun *waxRun, IDrawingStyle *drawingStyle, LanguageID languageID, bool32 oneCharSpan, textchar oneChar, UID paragraphStyleUID) = 0;
 virtual ErrorCode AddTextElement(int32 element) = 0;
 virtual ErrorCode EndTextRun() = 0;

 virtual ErrorCode BeginFigure() = 0;
 virtual ErrorCode EndFigure(IDataBase *db, UID pageItemUID) = 0;

 virtual ErrorCode BeginTableFrame(PMRect &bbox, bool32 firstTableFrame, bool32 oneFrameTable) = 0;
 virtual ErrorCode BeginTableRow(IStructureMarks::TableRowType rowType = IStructureMarks::kBodyRow) = 0;
 virtual ErrorCode BeginTableCell(int32 spanWidth, int32 spanHeight) = 0;
 virtual ErrorCode EndTableFrame(bool32 lastTableFrame, IDataBase *db, UID pageItemUID) = 0;

 virtual void BeginPageItemDrawing(IPMUnknown *pageItem, const PMMatrix &matrix) = 0;
 virtual void EndPageItemDrawing(IPMUnknown *pageItem) = 0;

 virtual void BeginArtifacts() = 0;
 virtual void EndArtifacts() = 0;

 virtual ErrorCode BeginLayer(CosObj layerInfo) = 0;
 virtual ErrorCode EndLayer() = 0;

 virtual bool32 RecordingStructure() = 0;

 virtual bool32 RecordingHyperlinks() = 0;

 virtual ErrorCode BeginFootnoteReference() = 0;
 virtual ErrorCode EndFootnoteReference() = 0;
 
 virtual ErrorCode BeginEndnoteReference() = 0;
 virtual ErrorCode EndEndnoteReference() = 0;

 virtual ErrorCode BeginFootnote() = 0;
 virtual ErrorCode EndFootnote() = 0;

 virtual ErrorCode BeginTableCellHyperlink() = 0;

 virtual void SetTagIndexOnce(bool16 setValue) = 0;

 virtual void BeginAnchoredObject(IDataBase* db, UID pageItemUID) = 0;

 virtual void EndAnchoredObject(IDataBase* db, UID pagetItemUID) = 0;


 virtual ErrorCode BeginEndnote() = 0;

 virtual ErrorCode EndEndnote() = 0;

 virtual bool IsEndnoteRun() = 0;

 virtual void AddAnchoredObjectMarker(const IPMUnknown *inlineData, TextIndex textIndex) = 0;

 virtual ErrorCode AddEndnoteLinkAnnotation(int32 annotation) = 0;

};
#endif