STOFFList Class Reference

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

#include <STOFFList.hxx>

List of all members.

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 ( bool  outline) [inline, explicit]

default constructor


Member Function Documentation

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

retrieve the list level property

void STOFFList::closeElement ( ) const [inline]

close the list element

int STOFFList::getId ( ) const [inline]

returns the list id

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

STOFFListLevel STOFFList::getLevel ( int  levl) const [inline]

returns a level if it exists

int STOFFList::getMarker ( ) const [inline]

returns the actual modify marker

Referenced by STOFFListManager::needToSend().

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

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

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

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

bool STOFFList::isNumeric ( int  levl) const

returns true is a level is numeric

Referenced by getStartValueForNextElement(), and openElement().

int STOFFList::numLevels ( ) const [inline]

returns the number of level

void STOFFList::openElement ( ) const

open the list element

void STOFFList::resize ( int  levl)

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

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

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

sets a level

Referenced by STOFFListManager::getNewList().

void STOFFList::setId ( int  newId) const

set the list id

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

void STOFFList::setLevel ( int  levl) const

set the list level

set the startvalue corresponding to the actual level

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

Referenced by STOFFListManager::needToSend().

void STOFFList::updateIndicesFrom ( STOFFList const &  list)

update the indices, the actual level from newList


Member Data Documentation

std::vector<int> STOFFList::m_actualIndices [mutable, protected]
int STOFFList::m_id[2] [mutable, protected]

the identificator ( actual and auxilliar )

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

int STOFFList::m_modifyMarker [mutable, protected]

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().

librevenge::RVNGString STOFFList::m_name

the list name

flag to know if the list is a outline list


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