WPSList Class Reference

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

#include <WPSList.h>

Classes

struct  Level
 small structure to keep information about a level More...

Public Member Functions

 WPSList ()
 default constructor
int getId () const
 returns the list id
int getPreviousId () const
 returns the previous list id
void setId (int newId)
 set the list id
int numLevels () const
 returns the number of level
void set (int levl, Level 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
bool isNumeric (int levl) const
 returns true is a level is numeric
bool mustSendLevel (int level) const
 returns true of the level must be send to the document interface
void sendTo (WPXDocumentInterface &docInterface, int level) const
 send the list information to the document interface

Protected Attributes

std::vector< Levelm_levels
int m_actLevel
std::vector< int > m_actualIndices
std::vector< int > m_nextIndices
int m_id
int m_previousId

Detailed Description

a small structure used to store the informations about a list

Constructor & Destructor Documentation

WPSList::WPSList ( )
inline

default constructor

Member Function Documentation

void WPSList::closeElement ( ) const
inline

close the list element

int WPSList::getId ( ) const
inline

returns the list id

int WPSList::getPreviousId ( ) const
inline

returns the previous list id

Note
a cheat because writerperfect imposes to get a new id if the level 1 changes
bool WPSList::isNumeric ( int  levl) const

returns true is a level is numeric

Referenced by openElement(), and sendTo().

bool WPSList::mustSendLevel ( int  level) const

returns true of the level must be send to the document interface

int WPSList::numLevels ( ) const
inline

returns the number of level

void WPSList::openElement ( ) const

open the list element

void WPSList::sendTo ( WPXDocumentInterface &  docInterface,
int  level 
) const

send the list information to the document interface

void WPSList::set ( int  levl,
Level const &  level 
)

sets a level

void WPSList::setId ( int  newId)

set the list id

void WPSList::setLevel ( int  levl) const

set the list level

Member Data Documentation

int WPSList::m_actLevel
mutableprotected

Referenced by openElement(), and setLevel().

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

Referenced by openElement(), sendTo(), set(), and setLevel().

int WPSList::m_id
mutableprotected

Referenced by getId(), sendTo(), and setId().

std::vector<Level> WPSList::m_levels
protected
std::vector<int> WPSList::m_nextIndices
mutableprotected

Referenced by openElement(), set(), and setLevel().

int WPSList::m_previousId
mutableprotected

Referenced by getPreviousId(), and setId().


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

Generated on Wed Aug 8 2012 16:07:58 for libwps by doxygen 1.8.1.2