MWAWList.hxx
Go to the documentation of this file.
1 /* -*- Mode: C++; c-default-style: "k&r"; indent-tabs-mode: nil; tab-width: 2; c-basic-offset: 2 -*- */
2 
3 /* libmwaw
4 * Version: MPL 2.0 / LGPLv2+
5 *
6 * The contents of this file are subject to the Mozilla Public License Version
7 * 2.0 (the "License"); you may not use this file except in compliance with
8 * the License or as specified alternatively below. You may obtain a copy of
9 * the License at http://www.mozilla.org/MPL/
10 *
11 * Software distributed under the License is distributed on an "AS IS" basis,
12 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13 * for the specific language governing rights and limitations under the
14 * License.
15 *
16 * Major Contributor(s):
17 * Copyright (C) 2002 William Lachance (wrlach@gmail.com)
18 * Copyright (C) 2002,2004 Marc Maurer (uwog@uwog.net)
19 * Copyright (C) 2004-2006 Fridrich Strba (fridrich.strba@bluewin.ch)
20 * Copyright (C) 2006, 2007 Andrew Ziem
21 * Copyright (C) 2011, 2012 Alonso Laurent (alonso@loria.fr)
22 *
23 *
24 * All Rights Reserved.
25 *
26 * For minor contributions see the git repository.
27 *
28 * Alternatively, the contents of this file may be used under the terms of
29 * the GNU Lesser General Public License Version 2 or later (the "LGPLv2+"),
30 * in which case the provisions of the LGPLv2+ are applicable
31 * instead of those above.
32 */
33 
34 #ifndef MWAW_LIST_H
35 # define MWAW_LIST_H
36 
37 #include <iostream>
38 
39 #include <vector>
40 
41 #include <librevenge/librevenge.h>
42 
44 struct MWAWListLevel {
48  };
50  enum Alignment { LEFT, RIGHT, CENTER };
51 
54  m_label(""), m_prefix(""), m_suffix(""), m_bullet(""), m_extra("")
55  {
56  }
59 
61  bool isDefault() const
62  {
63  return m_type ==DEFAULT;
64  }
66  bool isNumeric() const
67  {
68  return m_type !=DEFAULT && m_type !=NONE && m_type != BULLET;
69  }
71  void addTo(librevenge::RVNGPropertyList &propList) const;
72 
74  int getStartValue() const
75  {
76  return m_startValue <= 0 ? 1 : m_startValue;
77  }
78 
80  int cmp(MWAWListLevel const &levl) const;
81 
83  friend std::ostream &operator<<(std::ostream &o, MWAWListLevel const &ft);
84 
88  double m_labelWidth ;
96  librevenge::RVNGString m_label ,
97  m_prefix ,
98  m_suffix,
99  m_bullet ;
101  std::string m_extra;
102 };
103 
105 class MWAWList
106 {
107 public:
110  {
111  m_id[0] = m_id[1] = -1;
112  }
113 
115  int getId() const
116  {
117  return m_id[0];
118  }
119 
121  int getMarker() const
122  {
123  return m_modifyMarker;
124  }
126  void resize(int levl);
128  bool isCompatibleWith(int levl, MWAWListLevel const &level) const;
130  bool isCompatibleWith(MWAWList const &newList) const;
132  void updateIndicesFrom(MWAWList const &list);
133 
138  void swapId() const
139  {
140  int tmp = m_id[0];
141  m_id[0] = m_id[1];
142  m_id[1] = tmp;
143  }
144 
146  void setId(int newId) const;
147 
149  MWAWListLevel getLevel(int levl) const
150  {
151  if (levl >= 0 && levl < int(m_levels.size()))
152  return m_levels[size_t(levl)];
153  MWAW_DEBUG_MSG(("MWAWList::getLevel: can not find level %d\n", levl));
154  return MWAWListLevel();
155  }
157  int numLevels() const
158  {
159  return int(m_levels.size());
160  }
162  void set(int levl, MWAWListLevel const &level);
163 
165  void setLevel(int levl) const;
167  void openElement() const;
169  void closeElement() const {}
171  int getStartValueForNextElement() const;
173  void setStartValueForNextElement(int value);
174 
176  bool isNumeric(int levl) const;
177 
179  bool addTo(int level, librevenge::RVNGPropertyList &pList) const;
180 
181 protected:
183  std::vector<MWAWListLevel> m_levels;
184 
186  mutable int m_actLevel;
187  mutable std::vector<int> m_actualIndices, m_nextIndices;
189  mutable int m_id[2];
191  mutable int m_modifyMarker;
192 };
193 
196 {
197 public:
203  bool needToSend(int index, std::vector<int> &idMarkerList) const;
205  shared_ptr<MWAWList> getList(int index) const;
207  shared_ptr<MWAWList> getNewList(shared_ptr<MWAWList> actList, int levl, MWAWListLevel const &level);
208 protected:
210  std::vector<MWAWList> m_listList;
212  mutable std::vector<int> m_sendIdMarkerList;
213 };
214 #endif
215 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWList()
default constructor
Definition: MWAWList.hxx:109
librevenge::RVNGString m_label
the text label
Definition: MWAWList.hxx:96
Definition: MWAWList.hxx:50
int m_modifyMarker
a modification marker ( can be used to check if a list has been send to a interface ) ...
Definition: MWAWList.hxx:191
librevenge::RVNGString m_prefix
string which preceedes the number if we have an ordered level
Definition: MWAWList.hxx:96
void setId(int newId) const
set the list id
Definition: MWAWList.cxx:244
bool isDefault() const
returns true if the level type was not set
Definition: MWAWList.hxx:61
Alignment
the item alignment
Definition: MWAWList.hxx:50
~MWAWListLevel()
destructor
Definition: MWAWList.hxx:58
shared_ptr< MWAWList > getNewList(shared_ptr< MWAWList > actList, int levl, MWAWListLevel const &level)
returns a new list corresponding to a list where we have a new level
Definition: MWAWList.cxx:379
Definition: MWAWList.hxx:46
double m_labelBeforeSpace
the extra space between inserting a label
Definition: MWAWList.hxx:87
void openElement() const
open the list element
Definition: MWAWList.cxx:325
MWAWListLevel()
basic constructor
Definition: MWAWList.hxx:53
int cmp(MWAWListLevel const &levl) const
comparison function ( compare all values excepted m_startValues
Definition: MWAWList.cxx:106
bool isNumeric() const
returns true if the list is decimal, alpha or roman
Definition: MWAWList.hxx:66
bool needToSend(int index, std::vector< int > &idMarkerList) const
check if a list need to be send/resend to the interface
Definition: MWAWList.cxx:348
Definition: MWAWList.hxx:46
librevenge::RVNGString m_bullet
the bullet if we have an bullet level
Definition: MWAWList.hxx:96
void updateIndicesFrom(MWAWList const &list)
update the indices, the actual level from newList
Definition: MWAWList.cxx:209
Definition: MWAWList.hxx:46
MWAWListLevel getLevel(int levl) const
returns a level if it exists
Definition: MWAWList.hxx:149
bool addTo(int level, librevenge::RVNGPropertyList &pList) const
retrieve the list level property
Definition: MWAWList.cxx:250
small structure to keep information about a list level
Definition: MWAWList.hxx:44
int m_numBeforeLabels
the number of label to show before this
Definition: MWAWList.hxx:91
std::vector< int > m_nextIndices
Definition: MWAWList.hxx:187
int getStartValueForNextElement() const
returns the startvalue corresponding to the actual level ( or -1 for an unknown/unordered list) ...
Definition: MWAWList.cxx:314
Definition: MWAWList.hxx:47
int m_id[2]
the identificator ( actual and auxilliar )
Definition: MWAWList.hxx:189
double m_labelAfterSpace
the minimum distance between the label and the text
Definition: MWAWList.hxx:89
#define MWAW_DEBUG_MSG(M)
Definition: libmwaw_internal.hxx:127
void setStartValueForNextElement(int value)
set the startvalue corresponding to the actual level
Definition: MWAWList.cxx:302
std::vector< MWAWListLevel > m_levels
the different levels
Definition: MWAWList.hxx:183
Definition: MWAWList.hxx:50
void setLevel(int levl) const
set the list level
Definition: MWAWList.cxx:288
int getId() const
returns the list id
Definition: MWAWList.hxx:115
std::vector< int > m_sendIdMarkerList
the list of send list to interface
Definition: MWAWList.hxx:212
Definition: MWAWList.hxx:46
Definition: MWAWList.hxx:50
Definition: MWAWList.hxx:47
void resize(int levl)
resize the number of level of the list (keeping only n level)
Definition: MWAWList.cxx:193
void closeElement() const
close the list element
Definition: MWAWList.hxx:169
shared_ptr< MWAWList > getList(int index) const
returns a list with given index ( if found )
Definition: MWAWList.cxx:366
a manager which manages the lists, keeps the different kind of lists, to assure the unicity of each l...
Definition: MWAWList.hxx:195
bool isCompatibleWith(int levl, MWAWListLevel const &level) const
returns true if we can add a new level in the list without changing is meaning
Definition: MWAWList.cxx:221
librevenge::RVNGString m_suffix
string which follows the number if we have an ordered level
Definition: MWAWList.hxx:96
Definition: MWAWList.hxx:46
~MWAWListManager()
the destructor
Definition: MWAWList.hxx:201
Type m_type
the type of the level
Definition: MWAWList.hxx:86
int getStartValue() const
returns the start value (if set) or 1
Definition: MWAWList.hxx:74
Definition: MWAWList.hxx:47
void addTo(librevenge::RVNGPropertyList &propList) const
add the information of this level in the propList
Definition: MWAWList.cxx:46
friend std::ostream & operator<<(std::ostream &o, MWAWListLevel const &ft)
operator<<
Definition: MWAWList.cxx:134
std::vector< int > m_actualIndices
Definition: MWAWList.hxx:187
std::string m_extra
extra data
Definition: MWAWList.hxx:101
bool isNumeric(int levl) const
returns true is a level is numeric
Definition: MWAWList.cxx:335
Definition: MWAWList.hxx:46
int getMarker() const
returns the actual modify marker
Definition: MWAWList.hxx:121
Alignment m_alignment
the alignment ( left, center, ...)
Definition: MWAWList.hxx:93
int numLevels() const
returns the number of level
Definition: MWAWList.hxx:157
void swapId() const
swap the list id
Definition: MWAWList.hxx:138
double m_labelWidth
the minimum label width
Definition: MWAWList.hxx:88
a small structure used to store the informations about a list
Definition: MWAWList.hxx:105
Type
the type of the level
Definition: MWAWList.hxx:46
int m_startValue
the actual value (if this is an ordered level )
Definition: MWAWList.hxx:95
MWAWListManager()
the constructor
Definition: MWAWList.hxx:199
int m_actLevel
the actual levels
Definition: MWAWList.hxx:186
void set(int levl, MWAWListLevel const &level)
sets a level
Definition: MWAWList.cxx:269
std::vector< MWAWList > m_listList
the list of created list
Definition: MWAWList.hxx:210

Generated on Thu Jul 9 2015 20:26:36 for libmwaw by doxygen 1.8.8