STOFFList Class Reference

a small structure used to store the informations about a list More...

#include <STOFFList.hxx>

Public Member Functions

 STOFFList (bool outline)
 default constructor
 
int getId () const
 returns the list id
 
int getMarker () const
 returns the actual modify marker
 
void resize (int levl)
 resize the number of level of the list (keeping only n level)
 
bool isCompatibleWith (int levl, STOFFListLevel const &level) const
 returns true if we can add a new level in the list without changing is meaning
 
bool isCompatibleWith (STOFFList const &newList) const
 returns true if the list is compatible with the defined level of new list
 
void updateIndicesFrom (STOFFList const &list)
 update the indices, the actual level from newList
 
void swapId () const
 swap the list id
 
void setId (int newId) const
 set the list id
 
STOFFListLevel getLevel (int levl) const
 returns a level if it exists
 
int numLevels () const
 returns the number of level
 
void set (int levl, STOFFListLevel const &level)
 sets a level
 
void setLevel (int levl) const
 set the list level
 
void openElement () const
 open the list element
 
void closeElement () const
 close the list element
 
int getStartValueForNextElement () const
 returns the startvalue corresponding to the actual level ( or -1 for an unknown/unordered list)
 
void setStartValueForNextElement (int value)
 set the startvalue corresponding to the actual level
 
bool isNumeric (int levl) const
 returns true is a level is numeric
 
bool addTo (int level, librevenge::RVNGPropertyList &pList) const
 retrieve the list level property
 

Public Attributes

bool m_outline
 flag to know if the list is a outline list
 
librevenge::RVNGString m_name
 the list name
 

Protected Attributes

std::vector< STOFFListLevelm_levels
 the different levels
 
int m_actLevel
 the actual levels
 
std::vector< int > m_actualIndices
 
std::vector< int > m_nextIndices
 
int m_id [2]
 the identificator ( actual and auxilliar )
 
int m_modifyMarker
 a modification marker ( can be used to check if a list has been send to a interface )
 

Detailed Description

a small structure used to store the informations about a list

Constructor & Destructor Documentation

◆ STOFFList()

STOFFList::STOFFList ( bool  outline)
inlineexplicit

default constructor

Member Function Documentation

◆ addTo()

bool STOFFList::addTo ( int  level,
librevenge::RVNGPropertyList &  pList 
) const

retrieve the list level property

◆ closeElement()

void STOFFList::closeElement ( ) const
inline

close the list element

◆ getId()

int STOFFList::getId ( ) const
inline

returns the list id

Referenced by addTo().

◆ getLevel()

STOFFListLevel STOFFList::getLevel ( int  levl) const
inline

returns a level if it exists

◆ getMarker()

int STOFFList::getMarker ( ) const
inline

returns the actual modify marker

◆ getStartValueForNextElement()

int STOFFList::getStartValueForNextElement ( ) const

returns the startvalue corresponding to the actual level ( or -1 for an unknown/unordered list)

◆ isCompatibleWith() [1/2]

bool STOFFList::isCompatibleWith ( int  levl,
STOFFListLevel const &  level 
) const

returns true if we can add a new level in the list without changing is meaning

◆ isCompatibleWith() [2/2]

bool STOFFList::isCompatibleWith ( STOFFList const &  newList) const

returns true if the list is compatible with the defined level of new list

◆ isNumeric()

bool STOFFList::isNumeric ( int  levl) const

returns true is a level is numeric

Referenced by getStartValueForNextElement(), and openElement().

◆ numLevels()

int STOFFList::numLevels ( ) const
inline

returns the number of level

◆ openElement()

void STOFFList::openElement ( ) const

open the list element

◆ resize()

void STOFFList::resize ( int  levl)

resize the number of level of the list (keeping only n level)

Referenced by STOFFListManager::getNewList(), and set().

◆ set()

void STOFFList::set ( int  levl,
STOFFListLevel const &  level 
)

sets a level

Referenced by STOFFListManager::getNewList().

◆ setId()

void STOFFList::setId ( int  newId) const

set the list id

Referenced by addTo(), and STOFFListManager::getNewList().

◆ setLevel()

void STOFFList::setLevel ( int  levl) const

set the list level

◆ setStartValueForNextElement()

void STOFFList::setStartValueForNextElement ( int  value)

set the startvalue corresponding to the actual level

◆ swapId()

void STOFFList::swapId ( ) const
inline

swap the list id

Note
a cheat because writerperfect imposes to get a new id if the level 1 changes

◆ updateIndicesFrom()

void STOFFList::updateIndicesFrom ( STOFFList const &  list)

update the indices, the actual level from newList

Member Data Documentation

◆ m_actLevel

int STOFFList::m_actLevel
mutableprotected

◆ m_actualIndices

std::vector<int> STOFFList::m_actualIndices
mutableprotected

◆ m_id

int STOFFList::m_id[2]
mutableprotected

the identificator ( actual and auxilliar )

Referenced by getId(), setId(), STOFFList(), and swapId().

◆ m_levels

◆ m_modifyMarker

int STOFFList::m_modifyMarker
mutableprotected

a modification marker ( can be used to check if a list has been send to a interface )

Referenced by getMarker(), resize(), set(), setStartValueForNextElement(), and updateIndicesFrom().

◆ m_name

librevenge::RVNGString STOFFList::m_name

the list name

◆ m_nextIndices

std::vector<int> STOFFList::m_nextIndices
protected

◆ m_outline

bool STOFFList::m_outline

flag to know if the list is a outline list


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

Generated on Fri Apr 14 2023 04:41:10 for libstaroffice by doxygen 1.9.6