XMLContentReference.h

//========================================================================================
// 
// $File$
// 
// Owner: Will Lin
// 
// $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 __XMLContentReference__
#define __XMLContentReference__


#include "TableTypes.h"
#include "IXMLElementCommands.h"


class IPMStream;
class IXMLReferenceData;
class ITableModel;

class XMLContentReference {
 public:
 typedef base_type data_type;


 enum ContentType {
 kContentType_Text = 0, 
 kContentType_PageItem, 
 kContentType_Table, 
 kContentType_TableGrid, 
 kContentType_TableCell, 
 kContentType_NoContent
 };


 XMLContentReference();

 XMLContentReference(const UIDRef& baseUIDRef, const GridID& gridID = kInvalidGridID);

 XMLContentReference(const UIDRef& baseUIDRef, const GridID& startGrid, const GridSpan& span);

 XMLContentReference(const XMLContentReference& other);


 ContentType GetContentType() const;

 const UIDRef& GetUIDRef() const;

 void SetUIDRef(const UIDRef& uidRef);

 UID GetUID() const;

 void SetUID(UID uid);

 IDataBase *GetDataBase() const;

 void SetDataBase(IDataBase *db);

 GridAddress GetGridAddress(const ITableModel *tableModel) const;

 const GridID& GetGridID() const;

 void SetGridID(GridID gridID);


 const GridSpan& GetSpan() const;

 void SetSpan(const GridSpan& span);
 
 GridArea GetGridArea(ITableModel *tableModel) const;
 
 void SetNoContent(void);

 IXMLReferenceData* Instantiate() const;

 bool16 IsInline() const;

 bool16 IsTable() const;

 bool16 IsTableCell() const;

 bool16 IsTableGrid() const;
 
 bool16 IsNoContent() const;

 bool16 IsTableCellPlacedPageItem() const;
 
 void ReadWrite(IPMStream *s, IDataBase *db = nil);

 bool16 operator == (const XMLContentReference& other) const;

 inline bool16 operator != (const XMLContentReference& compareAgainst) const
 { return (!(*this == compareAgainst)); }

 bool16 operator < (const XMLContentReference& compareAgainst) const;

 void SetTableTagPreference(IXMLElementCommands::TableTagPreference newSetting)
 { fTableGridSetting = newSetting; }
 IXMLElementCommands::TableTagPreference GetTableTagPreference() const
 { return fTableGridSetting; }
 
 private:
 UIDRef fBaseUIDRef;
 GridID fGridID;
 GridSpan fSpan;
 bool16 fIsGrid;
 IXMLElementCommands::TableTagPreference fTableGridSetting;
 bool16 fHasNoContent;
};

DECLARE_BASE_TYPE(XMLContentReference); // no special copy


const XMLContentReference kInvalidXMLContentReference;


#endif // __XMLContentReference__