LibreOffice Module lotuswordpro (master) 1
Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
LwpDocument Class Reference

Document object, represent document and division. More...

#include <lwpdoc.hxx>

Inheritance diagram for LwpDocument:
[legend]
Collaboration diagram for LwpDocument:
[legend]

Public Member Functions

 LwpDocument (LwpObjectHeader const &objHdr, LwpSvStream *pStrm)
 
virtual ~LwpDocument () override
 
void Parse (IXFStream *pOutputStream) override
 @descr Parse obj to IXFStream More...
 
void RegisterStyle () override
 @descr Register all styles in this division More...
 
bool IsChildDoc () const
 
bool GetHonorProtection () const
 
LwpObjectIDGetDocData ()
 
LwpObjectIDGetSocket ()
 
LwpFoundryGetFoundry ()
 
LwpObjectIDGetDivInfoID ()
 
LwpObjectIDGetPageHintsID ()
 
LwpObjectIDGetFootnoteOpts ()
 
LwpObjectIDGetVerDoc ()
 
LwpObjectIDGetValidFootnoteOpts ()
 @descr Get the footnoteoptions from the root document More...
 
sal_uInt16 GetEndnoteType ()
 @descr Get the endnote type More...
 
LwpDocumentGetPreviousDivision ()
 @descr Get previous division More...
 
LwpDocumentGetNextDivision ()
 @descr Get next division More...
 
LwpDocumentGetParentDivision ()
 @descr Get parent division More...
 
LwpDocumentGetPreviousInGroup ()
 @descr Get previous division in group, copy from lwp source code More...
 
LwpDocumentGetNextInGroup ()
 @descr Get previous division in group, copy from lwp source code More...
 
LwpDocumentGetPreviousDivisionWithContents ()
 @descr Get previous division which has contents, copy from lwp source code More...
 
LwpDocumentGetLastDivisionWithContents ()
 @descr Get last division which has contents, copy from lwp source code More...
 
LwpDocumentGetLastInGroupWithContents ()
 @descr Get last division in group which has contents, copy from lwp source code More...
 
LwpDocumentGetRootDocument ()
 @descr Get root document More...
 
LwpDocumentGetFirstDivisionWithContentsThatIsNotOLE ()
 
LwpDocumentGetLastDivisionThatHasEndnote ()
 @descr Get last division that has endnote More...
 
LwpDocumentGetLastDivision ()
 @descr Get last division More...
 
LwpDocumentGetFirstDivision ()
 @descr Get first division More...
 
rtl::Reference< LwpVirtualLayoutGetEnSuperTableLayout ()
 @descr Get endnote supertable layout, every division has only one endnote supertable layout. More...
 
bool GetNumberOfPages (LwpDocument *pEndDivision, sal_uInt16 &nCount)
 @descr Get the numbers of page before pEndDivision, copy from lwp source code More...
 
sal_uInt16 GetNumberOfPagesBefore ()
 @descr Get the numbers of page before current division More...
 
void ParseFrameInPage (IXFStream *pOutputStream)
 @descr Parse the frame which anchor is to page before parse other contents, This method is called when the document is root document. More...
 
- Public Member Functions inherited from LwpDLNFPVList
 LwpDLNFPVList (LwpObjectHeader const &objHdr, LwpSvStream *pStrm)
 @descr ctor of LwpDLNFPVList from object stream Note that m_bHasProperties is initialized to true More...
 
virtual ~LwpDLNFPVList () override
 @descr release property list More...
 
LwpPropListGetPropList ()
 
- Public Member Functions inherited from LwpDLNFVList
 LwpDLNFVList (LwpObjectHeader const &objHdr, LwpSvStream *pStrm)
 
LwpAtomHolderGetName ()
 
LwpObjectIDGetChildHead ()
 
LwpObjectIDGetChildTail ()
 
LwpObjectIDGetParent ()
 
- Public Member Functions inherited from LwpDLVList
 LwpDLVList (LwpObjectHeader const &objHdr, LwpSvStream *pStrm)
 
LwpObjectIDGetNext ()
 
LwpObjectIDGetPrevious ()
 
- Public Member Functions inherited from LwpObject
 LwpObject (LwpObjectHeader objHdr, LwpSvStream *pStrm)
 @descr construct lwpobject from stream More...
 
void QuickRead ()
 @descr QuickRead template More...
 
void DoRegisterStyle ()
 
void DoParse (IXFStream *pOutputStream)
 
void DoXFConvert (XFContentContainer *pCont)
 
LwpFoundryGetFoundry ()
 
void SetFoundry (LwpFoundry *pFoundry)
 
LwpObjectIDGetObjectID ()
 
sal_uInt32 GetTag () const
 
- Public Member Functions inherited from salhelper::SimpleReferenceObject
 SimpleReferenceObject ()
 
void acquire ()
 
void release ()
 

Protected Member Functions

void Read () override
 @descr Read VO_Document from object stream More...
 
void ReadPlug ()
 @descr Read plug related data from m_pObjStram More...
 
void ParseDocContent (IXFStream *pOutputStream)
 @descr Parse content in this division to IXFStream LwpDocument->LwpDivInfo->LwpPageLayout.Parse() More...
 
void RegisterTextStyles ()
 @descr Register all named para styles More...
 
void RegisterLayoutStyles ()
 @descr Register all layouts styles (page master and master page) All para styles used in master page (header and footer) are registered and then showed More...
 
void RegisterStylesInPara ()
 @descr Register all styles used in para More...
 
void RegisterBulletStyles ()
 @descr Register all bullet styles used in this division More...
 
void RegisterGraphicsStyles ()
 @descr Register all styles used in VO_Graphic More...
 
void RegisterLinenumberStyles ()
 @descr Register line number styles More...
 
void RegisterFootnoteStyles ()
 @descr Register footnote/endnote configuration for the entire document More...
 
void RegisterDefaultParaStyles ()
 @descr Register default para styles More...
 
- Protected Member Functions inherited from LwpDLNFPVList
void Read () override
 @descr Read name of LwpDLNFVList from object stream More...
 
void ReadPropertyList (LwpObjectStream *pObjStrm)
 @descr Read property list More...
 
- Protected Member Functions inherited from LwpDLNFVList
virtual ~LwpDLNFVList () override
 
void Read () override
 @descr Read LwpDLNFVList data from object stream More...
 
void ReadName (LwpObjectStream *pObjStrm)
 @descr Read name of LwpDLNFVList from object stream More...
 
- Protected Member Functions inherited from LwpDLVList
virtual ~LwpDLVList () override
 
void Read () override
 @descr Read LwpDLVList data from object stream More...
 
- Protected Member Functions inherited from LwpObject
virtual ~LwpObject () override
 @descr dtor() More...
 
virtual void Read ()
 @descr default read function More...
 
virtual void RegisterStyle ()
 @descr default register style function More...
 
virtual void Parse (IXFStream *pOutputStream)
 @descr default parse function More...
 
virtual void XFConvert (XFContentContainer *pCont)
 @descr default XFConvert function pCont is the XFContentContainer for the object conversion More...
 
- Protected Member Functions inherited from salhelper::SimpleReferenceObject
virtual ~SimpleReferenceObject () COVERITY_NOEXCEPT_FALSE
 

Private Types

enum  {
  DOC_PROTECTED = 0x00000004UL ,
  DOC_CHILDDOC = 0x00000800UL
}
 

Private Member Functions

LwpDocumentImplGetFirstDivisionWithContentsThatIsNotOLE ()
 @descr Get first division with contents that is not ole, copy from lwp-source code More...
 
void XFConvertFrameInPage (XFContentContainer *pCont)
 @descr Parse the frame which anchor is to page in the entire document More...
 
bool IsSkippedDivision ()
 

Static Private Member Functions

static void ChangeStyleName ()
 @descr change click here to placeholder More...
 

Private Attributes

std::unique_ptr< LwpFoundrym_xOwnedFoundry
 
bool m_bGettingFirstDivisionWithContentsThatIsNotOLE
 
bool m_bGettingPreviousDivisionWithContents
 
bool m_bGettingGetLastDivisionWithContents
 
LwpObjectID m_DocSockID
 
sal_uInt16 m_nFlags
 
sal_uInt32 m_nPersistentFlags
 
std::optional< LwpLineNumberOptionsm_oLnOpts
 
LwpObjectID m_DivOpts
 
LwpObjectID m_FootnoteOpts
 
LwpObjectID m_DocData
 
LwpObjectID m_DivInfo
 
LwpAtomHolder m_Epoch
 
LwpObjectID m_WYSIWYGPageHints
 
LwpObjectID m_VerDoc
 
LwpObjectID m_STXInfo
 

Additional Inherited Members

- Static Public Member Functions inherited from salhelper::SimpleReferenceObject
static void * operator new (std::size_t nSize)
 
static void * operator new (std::size_t nSize, std::nothrow_t const &rNothrow)
 
static void operator delete (void *pPtr)
 
static void operator delete (void *pPtr, std::nothrow_t const &rNothrow)
 
- Protected Attributes inherited from LwpDLNFVList
LwpObjectID m_ChildHead
 
LwpObjectID m_ChildTail
 
LwpObjectID m_Parent
 
LwpAtomHolder m_Name
 
- Protected Attributes inherited from LwpObject
LwpObjectHeader m_ObjHdr
 
std::unique_ptr< LwpObjectStreamm_pObjStrm
 
LwpFoundrym_pFoundry
 
LwpSvStreamm_pStrm
 
bool m_bRegisteringStyle
 
bool m_bParsingStyle
 
bool m_bConvertingContent
 
- Protected Attributes inherited from salhelper::SimpleReferenceObject
oslInterlockedCount m_nCount
 

Detailed Description

Document object, represent document and division.

Definition at line 75 of file lwpdoc.hxx.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
private
Enumerator
DOC_PROTECTED 
DOC_CHILDDOC 

Definition at line 91 of file lwpdoc.hxx.

Constructor & Destructor Documentation

◆ LwpDocument()

LwpDocument::LwpDocument ( LwpObjectHeader const &  objHdr,
LwpSvStream pStrm 
)

Definition at line 76 of file lwpdoc.cxx.

References m_nFlags.

◆ ~LwpDocument()

LwpDocument::~LwpDocument ( )
overridevirtual

Definition at line 86 of file lwpdoc.cxx.

Member Function Documentation

◆ ChangeStyleName()

void LwpDocument::ChangeStyleName ( )
staticprivate

@descr change click here to placeholder

Definition at line 785 of file lwpdoc.cxx.

References XFStyleManager::FindStyle(), LwpGlobalMgr::GetInstance(), LwpGlobalMgr::GetXFStyleManager(), XFStyle::SetStyleName(), and u.

Referenced by RegisterTextStyles().

◆ GetDivInfoID()

LwpObjectID & LwpDocument::GetDivInfoID ( )
inline

◆ GetDocData()

LwpObjectID & LwpDocument::GetDocData ( )
inline

Definition at line 186 of file lwpdoc.hxx.

References m_DocData.

Referenced by Lwp9Reader::ParseDocument().

◆ GetEndnoteType()

sal_uInt16 LwpDocument::GetEndnoteType ( )

◆ GetEnSuperTableLayout()

rtl::Reference< LwpVirtualLayout > LwpDocument::GetEnSuperTableLayout ( )

@descr Get endnote supertable layout, every division has only one endnote supertable layout.

Definition at line 697 of file lwpdoc.cxx.

References LwpHeadLayout::FindEnSuperTableLayout(), GetFoundry(), LwpFoundry::GetLayout(), and LwpObjectID::obj().

Referenced by GetLastDivisionThatHasEndnote().

◆ GetFirstDivision()

LwpDocument * LwpDocument::GetFirstDivision ( )

◆ GetFirstDivisionWithContentsThatIsNotOLE()

LwpDocument * LwpDocument::GetFirstDivisionWithContentsThatIsNotOLE ( )
inline

◆ GetFootnoteOpts()

LwpObjectID & LwpDocument::GetFootnoteOpts ( )
inline

Definition at line 185 of file lwpdoc.hxx.

References m_FootnoteOpts.

Referenced by GetValidFootnoteOpts().

◆ GetFoundry()

LwpFoundry * LwpDocument::GetFoundry ( )
inline

◆ GetHonorProtection()

bool LwpDocument::GetHonorProtection ( ) const
inline

◆ GetLastDivision()

LwpDocument * LwpDocument::GetLastDivision ( )

@descr Get last division

Definition at line 615 of file lwpdoc.cxx.

References LwpDLNFVList::GetChildTail(), GetSocket(), and LwpObjectID::obj().

Referenced by GetLastDivisionWithContents().

◆ GetLastDivisionThatHasEndnote()

LwpDocument * LwpDocument::GetLastDivisionThatHasEndnote ( )

◆ GetLastDivisionWithContents()

LwpDocument * LwpDocument::GetLastDivisionWithContents ( )

◆ GetLastInGroupWithContents()

LwpDocument * LwpDocument::GetLastInGroupWithContents ( )

@descr Get last division in group which has contents, copy from lwp source code

Definition at line 596 of file lwpdoc.cxx.

References GetDivInfoID(), GetNextInGroup(), LwpDivInfo::HasContents(), and LwpObjectID::obj().

Referenced by LwpFootnote::GetFootnoteTableDivision().

◆ GetNextDivision()

LwpDocument * LwpDocument::GetNextDivision ( )

◆ GetNextInGroup()

LwpDocument * LwpDocument::GetNextInGroup ( )

@descr Get previous division in group, copy from lwp source code

Definition at line 524 of file lwpdoc.cxx.

References GetDivInfoID(), GetNextDivision(), LwpDivInfo::HasContents(), and LwpObjectID::obj().

Referenced by GetLastInGroupWithContents().

◆ GetNumberOfPages()

bool LwpDocument::GetNumberOfPages ( LwpDocument pEndDivision,
sal_uInt16 &  nCount 
)

@descr Get the numbers of page before pEndDivision, copy from lwp source code

Definition at line 711 of file lwpdoc.cxx.

References GetFirstDivision(), GetNextDivision(), GetNumberOfPages(), LwpDivInfo::GetNumberOfPages(), m_DivInfo, nCount, and LwpObjectID::obj().

Referenced by GetNumberOfPages(), and GetNumberOfPagesBefore().

◆ GetNumberOfPagesBefore()

sal_uInt16 LwpDocument::GetNumberOfPagesBefore ( )

@descr Get the numbers of page before current division

Definition at line 734 of file lwpdoc.cxx.

References GetNumberOfPages(), and GetRootDocument().

Referenced by LwpPageLayout::GetPageNumber().

◆ GetPageHintsID()

LwpObjectID & LwpDocument::GetPageHintsID ( )
inline

◆ GetParentDivision()

LwpDocument * LwpDocument::GetParentDivision ( )

@descr Get parent division

Definition at line 497 of file lwpdoc.cxx.

References LwpDLNFVList::GetParent(), GetSocket(), and LwpObjectID::obj().

Referenced by GetPreviousDivisionWithContents(), and GetRootDocument().

◆ GetPreviousDivision()

LwpDocument * LwpDocument::GetPreviousDivision ( )

◆ GetPreviousDivisionWithContents()

LwpDocument * LwpDocument::GetPreviousDivisionWithContents ( )

◆ GetPreviousInGroup()

LwpDocument * LwpDocument::GetPreviousInGroup ( )

@descr Get previous division in group, copy from lwp source code

Definition at line 509 of file lwpdoc.cxx.

References GetDivInfoID(), GetPreviousDivision(), LwpDivInfo::HasContents(), and LwpObjectID::obj().

Referenced by LwpFootnote::GetFootnoteTableDivision().

◆ GetRootDocument()

LwpDocument * LwpDocument::GetRootDocument ( )

◆ GetSocket()

LwpObjectID & LwpDocument::GetSocket ( )
inline

◆ GetValidFootnoteOpts()

LwpObjectID * LwpDocument::GetValidFootnoteOpts ( )

@descr Get the footnoteoptions from the root document

Definition at line 443 of file lwpdoc.cxx.

References GetFootnoteOpts(), and GetRootDocument().

Referenced by LwpPageLayout::ParseFootNoteSeparator().

◆ GetVerDoc()

LwpObjectID & LwpDocument::GetVerDoc ( )
inline

Definition at line 187 of file lwpdoc.hxx.

References m_VerDoc.

Referenced by RegisterDefaultParaStyles().

◆ ImplGetFirstDivisionWithContentsThatIsNotOLE()

LwpDocument * LwpDocument::ImplGetFirstDivisionWithContentsThatIsNotOLE ( )
private

◆ IsChildDoc()

bool LwpDocument::IsChildDoc ( ) const
inline

◆ IsSkippedDivision()

bool LwpDocument::IsSkippedDivision ( )
private

◆ Parse()

void LwpDocument::Parse ( IXFStream pOutputStream)
overridevirtual

@descr Parse obj to IXFStream

Reimplemented from LwpObject.

Definition at line 152 of file lwpdoc.cxx.

References GetSocket(), IsSkippedDivision(), LwpObjectID::obj(), ParseDocContent(), ParseFrameInPage(), and VO_DOCSOCK.

Referenced by Lwp9Reader::ParseDocument().

◆ ParseDocContent()

void LwpDocument::ParseDocContent ( IXFStream pOutputStream)
protected

@descr Parse content in this division to IXFStream LwpDocument->LwpDivInfo->LwpPageLayout.Parse()

Definition at line 423 of file lwpdoc.cxx.

References LwpDivInfo::GetInitialLayoutID(), m_DivInfo, m_xOwnedFoundry, and LwpObjectID::obj().

Referenced by Parse().

◆ ParseFrameInPage()

void LwpDocument::ParseFrameInPage ( IXFStream pOutputStream)

@descr Parse the frame which anchor is to page before parse other contents, This method is called when the document is root document.

Definition at line 747 of file lwpdoc.cxx.

References IsChildDoc(), and XFConvertFrameInPage().

Referenced by Parse().

◆ Read()

void LwpDocument::Read ( )
overrideprotectedvirtual

◆ ReadPlug()

void LwpDocument::ReadPlug ( )
protected

@descr Read plug related data from m_pObjStram

Definition at line 142 of file lwpdoc.cxx.

References m_DocSockID, m_nFlags, LwpObject::m_pObjStrm, and LwpObjectID::ReadIndexed().

Referenced by Read().

◆ RegisterBulletStyles()

void LwpDocument::RegisterBulletStyles ( )
protected

◆ RegisterDefaultParaStyles()

void LwpDocument::RegisterDefaultParaStyles ( )
protected

@descr Register default para styles

Definition at line 401 of file lwpdoc.cxx.

References GetFirstDivisionWithContentsThatIsNotOLE(), GetVerDoc(), IsChildDoc(), LwpObjectID::obj(), and LwpVerDocument::RegisterStyle().

Referenced by RegisterStyle().

◆ RegisterFootnoteStyles()

void LwpDocument::RegisterFootnoteStyles ( )
protected

◆ RegisterGraphicsStyles()

void LwpDocument::RegisterGraphicsStyles ( )
protected

@descr Register all styles used in VO_Graphic

Definition at line 337 of file lwpdoc.cxx.

References m_xOwnedFoundry, and VO_GRAPHIC.

Referenced by RegisterStyle().

◆ RegisterLayoutStyles()

void LwpDocument::RegisterLayoutStyles ( )
protected

@descr Register all layouts styles (page master and master page) All para styles used in master page (header and footer) are registered and then showed

Definition at line 256 of file lwpdoc.cxx.

References LwpMiddleLayout::GetContent(), LwpDivInfo::GetInitialLayoutID(), m_DivInfo, m_xOwnedFoundry, LwpObjectID::obj(), LwpStory::SetCurrentLayout(), LwpStory::SortPageLayout(), VO_DIVISIONINFO, VO_PAGELAYOUT, and VO_STORY.

Referenced by RegisterStyle().

◆ RegisterLinenumberStyles()

void LwpDocument::RegisterLinenumberStyles ( )
protected

@descr Register line number styles

Definition at line 351 of file lwpdoc.cxx.

References m_oLnOpts.

Referenced by RegisterStyle().

◆ RegisterStyle()

void LwpDocument::RegisterStyle ( )
overridevirtual

◆ RegisterStylesInPara()

void LwpDocument::RegisterStylesInPara ( )
protected

◆ RegisterTextStyles()

void LwpDocument::RegisterTextStyles ( )
protected

◆ XFConvertFrameInPage()

void LwpDocument::XFConvertFrameInPage ( XFContentContainer pCont)
private

Member Data Documentation

◆ m_bGettingFirstDivisionWithContentsThatIsNotOLE

bool LwpDocument::m_bGettingFirstDivisionWithContentsThatIsNotOLE
private

Definition at line 83 of file lwpdoc.hxx.

Referenced by GetFirstDivisionWithContentsThatIsNotOLE().

◆ m_bGettingGetLastDivisionWithContents

bool LwpDocument::m_bGettingGetLastDivisionWithContents
private

Definition at line 85 of file lwpdoc.hxx.

Referenced by GetLastDivisionWithContents().

◆ m_bGettingPreviousDivisionWithContents

bool LwpDocument::m_bGettingPreviousDivisionWithContents
private

Definition at line 84 of file lwpdoc.hxx.

Referenced by GetPreviousDivisionWithContents().

◆ m_DivInfo

LwpObjectID LwpDocument::m_DivInfo
private

◆ m_DivOpts

LwpObjectID LwpDocument::m_DivOpts
private

Definition at line 99 of file lwpdoc.hxx.

Referenced by Read().

◆ m_DocData

LwpObjectID LwpDocument::m_DocData
private

Definition at line 101 of file lwpdoc.hxx.

Referenced by GetDocData(), and Read().

◆ m_DocSockID

LwpObjectID LwpDocument::m_DocSockID
private

Definition at line 88 of file lwpdoc.hxx.

Referenced by GetSocket(), and ReadPlug().

◆ m_Epoch

LwpAtomHolder LwpDocument::m_Epoch
private

Definition at line 103 of file lwpdoc.hxx.

Referenced by Read().

◆ m_FootnoteOpts

LwpObjectID LwpDocument::m_FootnoteOpts
private

Definition at line 100 of file lwpdoc.hxx.

Referenced by GetFootnoteOpts(), Read(), and RegisterFootnoteStyles().

◆ m_nFlags

sal_uInt16 LwpDocument::m_nFlags
private

Definition at line 89 of file lwpdoc.hxx.

Referenced by ReadPlug().

◆ m_nPersistentFlags

sal_uInt32 LwpDocument::m_nPersistentFlags
private

Definition at line 90 of file lwpdoc.hxx.

Referenced by GetHonorProtection(), IsChildDoc(), and Read().

◆ m_oLnOpts

std::optional<LwpLineNumberOptions> LwpDocument::m_oLnOpts
private

Definition at line 97 of file lwpdoc.hxx.

Referenced by Read(), and RegisterLinenumberStyles().

◆ m_STXInfo

LwpObjectID LwpDocument::m_STXInfo
private

Definition at line 107 of file lwpdoc.hxx.

Referenced by Read().

◆ m_VerDoc

LwpObjectID LwpDocument::m_VerDoc
private

Definition at line 106 of file lwpdoc.hxx.

Referenced by GetVerDoc(), and Read().

◆ m_WYSIWYGPageHints

LwpObjectID LwpDocument::m_WYSIWYGPageHints
private

Definition at line 105 of file lwpdoc.hxx.

Referenced by GetPageHintsID(), and Read().

◆ m_xOwnedFoundry

std::unique_ptr<LwpFoundry> LwpDocument::m_xOwnedFoundry
private

The documentation for this class was generated from the following files: