ClarisWksStruct::DSET Struct Reference

main structure which correspond to a document part More...

#include <ClarisWksStruct.hxx>

Inheritance diagram for ClarisWksStruct::DSET:
ClarisDrawGraphInternal::Bitmap ClarisDrawGraphInternal::Group ClarisDrawTextInternal::DSET ClarisWksDatabaseInternal::Database ClarisWksGraphInternal::Bitmap ClarisWksGraphInternal::Group ClarisWksPresentationInternal::Presentation ClarisWksSpreadsheetInternal::Spreadsheet ClarisWksTableInternal::Table ClarisWksTextInternal::Zone

Classes

struct  Child
 structure used to define the child of a DSET structure More...
 

Public Types

enum  Position {
  P_Main =0 , P_Header , P_Footer , P_Frame ,
  P_Footnote , P_Table , P_GraphicMaster , P_Slide ,
  P_SlideNote , P_SlideThumbnail , P_SlideMaster , P_Unknown
}
 the zone position More...
 
enum  ChildType { C_Zone , C_SubText , C_Graphic , C_Unknown }
 the different types of zone child More...
 

Public Member Functions

 DSET ()
 constructor
 
 DSET (DSET const &)=default
 
virtual ~DSET ()
 virtual destructor
 
bool isHeaderFooter () const
 test if the zone is an header/footer
 
bool isSlide () const
 test if the zone is a slide
 
MWAWBox2f getBdBox () const
 return the zone bdbox
 
int getMaximumPage () const
 returns the maximum page
 
virtual void removeChild (int cId, bool normalChild)
 virtual function to remove a child from a list
 
virtual void removeChild (int cId)
 virtual function to remove a child from a list
 
void updateChildPositions (MWAWVec2f const &pageDim, float formLength, int numHorizontalPages=1)
 try to update the child page and bounding box
 
void findForbiddenPagesBreaking (float pageDim, float formDim, int dim, MWAWVariable< int > &lastPage) const
 find forbidden page break
 
MWAWBox2i getUnionChildBox () const
 returns the child box (ie. the union of the childs box)
 

Public Attributes

long m_size
 the size of the DSET header
 
long m_numData
 the number of header
 
long m_dataSz
 the data size
 
long m_headerSz
 the header size
 
Position m_position
 the zone type
 
int m_fileType
 the type ( 0: text, -1: graphic, ...)
 
int m_page
 the page (if known)
 
MWAWBox2f m_box
 the bounding box (if known)
 
MWAWVec2f m_pageDimension
 the page dimension (if know)
 
int m_id
 the zone identificator
 
std::set< int > m_fathersList
 the list of fathers
 
int m_beginSelection
 the begin of selection ( at least in text header)
 
int m_endSelection
 the end of selection ( at least in text header)
 
int m_textType
 the text type (header/footer,footnote, ...)
 
int m_flags [4]
 some unknown flag
 
std::vector< Childm_childs
 the list of child zone
 
std::vector< int > m_otherChilds
 the list of other child
 
bool m_parsed
 a flag to know if the entry is sent or not to the listener
 
int m_internal
 an internal variable used to do some computation
 

Friends

std::ostream & operator<< (std::ostream &o, DSET const &doc)
 operator<<
 

Detailed Description

main structure which correspond to a document part

Member Enumeration Documentation

◆ ChildType

the different types of zone child

Enumerator
C_Zone 
C_SubText 
C_Graphic 
C_Unknown 

◆ Position

the zone position

Enumerator
P_Main 
P_Header 
P_Footer 
P_Frame 
P_Footnote 
P_Table 
P_GraphicMaster 
P_Slide 
P_SlideNote 
P_SlideThumbnail 
P_SlideMaster 
P_Unknown 

Constructor & Destructor Documentation

◆ DSET() [1/2]

ClarisWksStruct::DSET::DSET ( )
inline

constructor

◆ DSET() [2/2]

ClarisWksStruct::DSET::DSET ( DSET const &  )
default

◆ ~DSET()

virtual ClarisWksStruct::DSET::~DSET ( )
inlinevirtual

virtual destructor

Reimplemented in ClarisDrawTextInternal::DSET.

Member Function Documentation

◆ findForbiddenPagesBreaking()

void ClarisWksStruct::DSET::findForbiddenPagesBreaking ( float  pageDim,
float  formDim,
int  dim,
MWAWVariable< int > &  lastPage 
) const

find forbidden page break

◆ getBdBox()

MWAWBox2f ClarisWksStruct::DSET::getBdBox ( ) const
inline

return the zone bdbox

◆ getMaximumPage()

int ClarisWksStruct::DSET::getMaximumPage ( ) const
inline

returns the maximum page

◆ getUnionChildBox()

MWAWBox2i ClarisWksStruct::DSET::getUnionChildBox ( ) const

returns the child box (ie. the union of the childs box)

◆ isHeaderFooter()

bool ClarisWksStruct::DSET::isHeaderFooter ( ) const
inline

test if the zone is an header/footer

Referenced by findForbiddenPagesBreaking(), and ClarisWksGraph::updateGroup().

◆ isSlide()

bool ClarisWksStruct::DSET::isSlide ( ) const
inline

test if the zone is a slide

Referenced by ClarisWksGraph::sendGroup().

◆ removeChild() [1/2]

void ClarisWksStruct::DSET::removeChild ( int  cId)
virtual

virtual function to remove a child from a list

◆ removeChild() [2/2]

void ClarisWksStruct::DSET::removeChild ( int  cId,
bool  normalChild 
)
virtual

◆ updateChildPositions()

void ClarisWksStruct::DSET::updateChildPositions ( MWAWVec2f const &  pageDim,
float  formLength,
int  numHorizontalPages = 1 
)

try to update the child page and bounding box

Friends And Related Function Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream &  o,
DSET const &  doc 
)
friend

operator<<

Member Data Documentation

◆ m_beginSelection

int ClarisWksStruct::DSET::m_beginSelection

the begin of selection ( at least in text header)

Referenced by ClarisWksDocument::readDSET(), and ClarisDrawParser::readDSET().

◆ m_box

MWAWBox2f ClarisWksStruct::DSET::m_box

the bounding box (if known)

Referenced by getBdBox(), ClarisWksGraph::sendGroup(), and updateChildPositions().

◆ m_childs

std::vector<Child> ClarisWksStruct::DSET::m_childs

◆ m_dataSz

◆ m_endSelection

int ClarisWksStruct::DSET::m_endSelection

the end of selection ( at least in text header)

Referenced by ClarisWksDocument::readDSET(), and ClarisDrawParser::readDSET().

◆ m_fathersList

std::set<int> ClarisWksStruct::DSET::m_fathersList

the list of fathers

◆ m_fileType

◆ m_flags

int ClarisWksStruct::DSET::m_flags[4]

◆ m_headerSz

◆ m_id

◆ m_internal

int ClarisWksStruct::DSET::m_internal
mutable

an internal variable used to do some computation

◆ m_numData

◆ m_otherChilds

std::vector<int> ClarisWksStruct::DSET::m_otherChilds

◆ m_page

◆ m_pageDimension

MWAWVec2f ClarisWksStruct::DSET::m_pageDimension

◆ m_parsed

bool ClarisWksStruct::DSET::m_parsed
mutable

◆ m_position

◆ m_size

long ClarisWksStruct::DSET::m_size

the size of the DSET header

Referenced by ClarisWksDocument::readDSET(), and ClarisDrawParser::readDSET().

◆ m_textType

int ClarisWksStruct::DSET::m_textType

the text type (header/footer,footnote, ...)

Referenced by ClarisWksDocument::readDSET(), and ClarisDrawParser::readDSET().


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

Generated on Wed May 3 2023 07:18:29 for libmwaw by doxygen 1.9.6