STOFFListLevel Struct Reference

small structure to keep information about a list level More...

#include <STOFFList.hxx>

Public Types

enum  Type {
  DEFAULT, NONE, BULLET, DECIMAL,
  LOWER_ALPHA, UPPER_ALPHA, LOWER_ROMAN, UPPER_ROMAN,
  LABEL
}
 the type of the level More...
 
enum  Alignment { LEFT, RIGHT, CENTER }
 the item alignment More...
 

Public Member Functions

 STOFFListLevel ()
 basic constructor More...
 
 ~STOFFListLevel ()
 destructor More...
 
bool isDefault () const
 returns true if the level type was not set More...
 
bool isNumeric () const
 returns true if the list is decimal, alpha or roman More...
 
bool operator== (STOFFListLevel const &levl) const
 operator== More...
 
bool operator!= (STOFFListLevel const &levl) const
 operator!= More...
 
void addTo (librevenge::RVNGPropertyList &propList) const
 add the information of this level in the propList More...
 
int getStartValue () const
 returns the start value (if set) or 1 More...
 
int cmp (STOFFListLevel const &levl) const
 comparison function ( compare all values excepted m_startValues More...
 

Public Attributes

Type m_type
 the type of the level More...
 
double m_labelBeforeSpace
 the extra space between inserting a label More...
 
double m_labelWidth
 the minimum label width More...
 
double m_labelAfterSpace
 the minimum distance between the label and the text More...
 
int m_numBeforeLabels
 the number of label to show before this More...
 
Alignment m_alignment
 the alignment ( left, center, ...) More...
 
int m_startValue
 the actual value (if this is an ordered level ) More...
 
librevenge::RVNGString m_label
 the text label More...
 
librevenge::RVNGString m_prefix
 string which preceedes the number if we have an ordered level More...
 
librevenge::RVNGString m_suffix
 string which follows the number if we have an ordered level More...
 
librevenge::RVNGString m_bullet
 the bullet if we have an bullet level More...
 
std::string m_extra
 extra data More...
 

Friends

std::ostream & operator<< (std::ostream &o, STOFFListLevel const &ft)
 operator<< More...
 

Detailed Description

small structure to keep information about a list level

Member Enumeration Documentation

the item alignment

Enumerator
LEFT 
RIGHT 
CENTER 

the type of the level

Enumerator
DEFAULT 
NONE 
BULLET 
DECIMAL 
LOWER_ALPHA 
UPPER_ALPHA 
LOWER_ROMAN 
UPPER_ROMAN 
LABEL 

Constructor & Destructor Documentation

STOFFListLevel::STOFFListLevel ( )
inline

basic constructor

Referenced by STOFFList::getLevel().

STOFFListLevel::~STOFFListLevel ( )
inline

destructor

Member Function Documentation

void STOFFListLevel::addTo ( librevenge::RVNGPropertyList &  propList) const

add the information of this level in the propList

Referenced by STOFFList::closeElement(), and operator!=().

int STOFFListLevel::cmp ( STOFFListLevel const &  levl) const

comparison function ( compare all values excepted m_startValues

Referenced by getStartValue(), STOFFList::isCompatibleWith(), and operator==().

int STOFFListLevel::getStartValue ( ) const
inline

returns the start value (if set) or 1

Referenced by addTo(), and STOFFList::set().

bool STOFFListLevel::isDefault ( ) const
inline

returns true if the level type was not set

bool STOFFListLevel::isNumeric ( ) const
inline

returns true if the list is decimal, alpha or roman

Referenced by STOFFList::closeElement(), STOFFList::getStartValueForNextElement(), and STOFFList::openElement().

bool STOFFListLevel::operator!= ( STOFFListLevel const &  levl) const
inline

operator!=

bool STOFFListLevel::operator== ( STOFFListLevel const &  levl) const
inline

operator==

Referenced by operator!=().

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  o,
STOFFListLevel const &  ft 
)
friend

operator<<

Referenced by getStartValue().

Member Data Documentation

Alignment STOFFListLevel::m_alignment

the alignment ( left, center, ...)

Referenced by addTo(), cmp(), and operator<<().

librevenge::RVNGString STOFFListLevel::m_bullet

the bullet if we have an bullet level

Referenced by addTo(), cmp(), and operator<<().

std::string STOFFListLevel::m_extra

extra data

Referenced by operator<<().

librevenge::RVNGString STOFFListLevel::m_label

the text label

Referenced by addTo(), cmp(), and operator<<().

double STOFFListLevel::m_labelAfterSpace

the minimum distance between the label and the text

Referenced by addTo(), cmp(), and operator<<().

double STOFFListLevel::m_labelBeforeSpace

the extra space between inserting a label

Referenced by addTo(), cmp(), and operator<<().

double STOFFListLevel::m_labelWidth

the minimum label width

Referenced by addTo(), cmp(), and operator<<().

int STOFFListLevel::m_numBeforeLabels

the number of label to show before this

Referenced by addTo(), cmp(), and operator<<().

librevenge::RVNGString STOFFListLevel::m_prefix

string which preceedes the number if we have an ordered level

Referenced by addTo(), cmp(), and operator<<().

int STOFFListLevel::m_startValue

the actual value (if this is an ordered level )

Referenced by getStartValue(), operator<<(), and STOFFList::set().

librevenge::RVNGString STOFFListLevel::m_suffix

string which follows the number if we have an ordered level

Referenced by addTo(), cmp(), and operator<<().

Type STOFFListLevel::m_type

the type of the level

Referenced by addTo(), cmp(), isDefault(), isNumeric(), operator<<(), and STOFFList::set().


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

Generated on Mon Feb 22 2016 09:38:08 for libstaroffice by doxygen 1.8.11