MWAWListLevel Struct Reference

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

#include <MWAWList.hxx>

List of all members.

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 alignement More...

Public Member Functions

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

Public Attributes

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

Friends

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

Detailed Description

small structure to keep information about a list level


Member Enumeration Documentation

the item alignement

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

basic constructor

destructor


Member Function Documentation

void MWAWListLevel::addTo ( WPXPropertyList &  propList) const

add the information of this level in the propList

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

comparison function ( compare all values excepted m_startValues

Referenced by MWAWParagraph::cmp(), and MWAWList::isCompatibleWith().

int MWAWListLevel::getStartValue ( ) const [inline]

returns the start value (if set) or 1

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

bool MWAWListLevel::isDefault ( ) const [inline]

returns true if the level type was not set

bool MWAWListLevel::isNumeric ( ) const [inline]

returns true if the list is decimal, alpha or roman

Referenced by MDWParserInternal::ZoneInfo::updateListId().


Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  o,
MWAWListLevel const &  ft 
) [friend]

operator<<


Member Data Documentation

the alignement ( left, center, ...)

Referenced by addTo(), cmp(), operator<<(), and MRWText::readRulers().

extra data

Referenced by operator<<(), and MORText::readCustomListLevel().

the text label

Referenced by addTo(), cmp(), operator<<(), and MORText::readCustomListLevel().

the minimum distance between the label and the text

Referenced by addTo(), cmp(), ACParser::getMainList(), operator<<(), and MDWParserInternal::ZoneInfo::updateListId().

the extra space between inserting a label

Referenced by addTo(), cmp(), operator<<(), and MDWParserInternal::ZoneInfo::updateListId().

the actual value (if this is an ordered level )

Referenced by getStartValue(), operator<<(), MWAWList::set(), and MDWParserInternal::ZoneInfo::updateListId().


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