MWAWTable.hxx Source File documentation

- Main Page
- Namespaces
- Classes
- Files

- File List
- File Members

MWAWTable.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 /*
35 * Structure to store and construct a table from an unstructured list
36 * of cell
37 *
38 */
39
40 #ifndef MWAW_TABLE
41 # define MWAW_TABLE
42
43 #include <iostream>
44 #include <vector>
45
46 #include "libmwaw_internal.hxx"
47
48 #include "MWAWCell.hxx"
49
51 class MWAWTable
52 {
53 public:
55 enum DataSet {
56 CellPositionBit=1, BoxBit=2, SizeBit=4, TableDimBit=8, TablePosToCellBit=0x10
57 };
61 enum Alignment {
62 Paragraph, Left, Center, Right
63 };
65 MWAWTable(uint32_t givenData=BoxBit) :
66 m_givenData(givenData), m_setData(givenData), m_mergeBorders(true), m_cellsList(),
67 m_numRows(0), m_numCols(0), m_rowsSize(), m_colsSize(), m_alignment(Paragraph), m_leftMargin(0), m_rightMargin(0),
68 m_posToCellId(), m_hasExtraLines(false) {}
69
71 virtual ~MWAWTable();
72
74 void add(shared_ptr<MWAWCell> cell)
75 {
76 if (!cell) {
77 MWAW_DEBUG_MSG(("MWAWTable::add: must be called with a cell\n"));
78 return;
79 }
80 m_cellsList.push_back(cell);
81 }
83 bool mergeBorders() const
84 {
85 return m_mergeBorders;
86 }
88 bool setMergeBorders(bool val)
89 {
90 return m_mergeBorders=val;
91 }
94 void setAlignment(Alignment align, float leftMargin=0, float rightMargin=0)
95 {
96 m_alignment = align;
97 m_leftMargin = leftMargin;
98 m_rightMargin = rightMargin;
99 }
101 int numCells() const
102 {
103 return int(m_cellsList.size());
104 }
106 std::vector<float> const &getRowsSize() const
107 {
108 return m_rowsSize;
109 }
111 void setRowsSize(std::vector<float> const &rSize)
112 {
113 m_rowsSize=rSize;
114 }
116 std::vector<float> const &getColsSize() const
117 {
118 return m_colsSize;
119 }
121 void setColsSize(std::vector<float> const &cSize)
122 {
123 m_colsSize=cSize;
124 }
125
127 shared_ptr<MWAWCell> get(int id);
128
130 bool updateTable();
132 bool hasExtraLines()
133 {
134 if (!updateTable()) return false;
135 return m_hasExtraLines;
136 }
137
142 bool sendTable(MWAWListenerPtr listener, bool inFrame=true);
143
145 bool sendAsText(MWAWListenerPtr listener);
146
147 // interface with the content listener
148
150 void addTablePropertiesTo(librevenge::RVNGPropertyList &propList) const;
151
152 protected:
154 int getCellIdPos(int col, int row) const
155 {
156 if (col<0||col>=int(m_numCols))
157 return -1;
158 if (row<0||row>=int(m_numRows))
159 return -1;
160 return col*int(m_numRows)+row;
161 }
163 bool buildStructures();
165 bool buildDims();
167 bool buildPosToCellId();
169 void sendExtraLines(MWAWListenerPtr listener) const;
170
171 protected:
173 uint32_t m_givenData;
175 uint32_t m_setData;
177 bool m_mergeBorders;
179 std::vector<shared_ptr<MWAWCell> > m_cellsList;
181 size_t m_numRows;
183 size_t m_numCols;
185 std::vector<float> m_rowsSize;
187 std::vector<float> m_colsSize;
189 Alignment m_alignment;
191 float m_leftMargin;
193 float m_rightMargin;
194
196 std::vector<int> m_posToCellId;
198 bool m_hasExtraLines;
199 };
200
201 #endif
202 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWTable::sendAsText
bool sendAsText(MWAWListenerPtr listener)
try to send the table as basic text
Definition: MWAWTable.cxx:493
MWAWListenerPtr
shared_ptr< MWAWListener > MWAWListenerPtr
a smart pointer of MWAWListener
Definition: libmwaw_internal.hxx:491
MWAWTable::Paragraph
Definition: MWAWTable.hxx:62
MWAWTable::getRowsSize
std::vector< float > const & getRowsSize() const
returns the row size if defined (in point)
Definition: MWAWTable.hxx:106
MWAWTable::getCellIdPos
int getCellIdPos(int col, int row) const
convert a cell position in a posToCellId's position
Definition: MWAWTable.hxx:154
MWAWTable::setColsSize
void setColsSize(std::vector< float > const &cSize)
define the columns size (in point)
Definition: MWAWTable.hxx:121
MWAWTable::Left
Definition: MWAWTable.hxx:62
libmwaw_internal.hxx
MWAWTable::m_leftMargin
float m_leftMargin
the left margin in point
Definition: MWAWTable.hxx:191
MWAWTable::setRowsSize
void setRowsSize(std::vector< float > const &rSize)
define the row size (in point)
Definition: MWAWTable.hxx:111
MWAWTable::TableDimBit
Definition: MWAWTable.hxx:56
MWAWTable::add
void add(shared_ptr< MWAWCell > cell)
add a new cells
Definition: MWAWTable.hxx:74
MWAWTable
a class used to recreate the table structure using cell informations, ....
Definition: MWAWTable.hxx:51
MWAWTable::BoxBit
Definition: MWAWTable.hxx:56
MWAWTable::TablePosToCellBit
Definition: MWAWTable.hxx:56
MWAWTable::updateTable
bool updateTable()
try to build the table structures
Definition: MWAWTable.cxx:449
MWAWTable::m_setData
uint32_t m_setData
a int to indicate what data are been reconstruct
Definition: MWAWTable.hxx:175
MWAWTable::addTablePropertiesTo
void addTablePropertiesTo(librevenge::RVNGPropertyList &propList) const
adds the table properties to propList
Definition: MWAWTable.cxx:122
MWAWTable::getColsSize
std::vector< float > const & getColsSize() const
returns the columns size if defined (in point)
Definition: MWAWTable.hxx:116
MWAWTable::buildPosToCellId
bool buildPosToCellId()
a function which fills to posToCellId vector using the cell position
Definition: MWAWTable.cxx:302
MWAWTable::Right
Definition: MWAWTable.hxx:62
MWAWTable::m_mergeBorders
bool m_mergeBorders
do we need to merge cell borders ( default yes)
Definition: MWAWTable.hxx:177
MWAWTable::m_rightMargin
float m_rightMargin
the right margin in point
Definition: MWAWTable.hxx:193
MWAWTable::m_hasExtraLines
bool m_hasExtraLines
true if we need to send extra lines
Definition: MWAWTable.hxx:198
MWAWTable::m_numRows
size_t m_numRows
the number of rows ( set by buildPosToCellId )
Definition: MWAWTable.hxx:181
MWAWTable::hasExtraLines
bool hasExtraLines()
returns true if the table has extralines
Definition: MWAWTable.hxx:132
MWAWTable::setMergeBorders
bool setMergeBorders(bool val)
sets the merge borders' value
Definition: MWAWTable.hxx:88
MWAW_DEBUG_MSG
#define MWAW_DEBUG_MSG(M)
Definition: libmwaw_internal.hxx:126
MWAWTable::buildDims
bool buildDims()
compute the rows and the cells size
Definition: MWAWTable.cxx:359
MWAWTable::CellPositionBit
Definition: MWAWTable.hxx:56
MWAWTable::setAlignment
void setAlignment(Alignment align, float leftMargin=0, float rightMargin=0)
defines the current alignment
Definition: MWAWTable.hxx:94
MWAWTable::~MWAWTable
virtual ~MWAWTable()
the destructor
Definition: MWAWTable.cxx:109
MWAWTable::Alignment
Alignment
an enum do define the table alignment.
Definition: MWAWTable.hxx:61
MWAWTable::m_givenData
uint32_t m_givenData
a int to indicate what data are given in entries
Definition: MWAWTable.hxx:173
MWAWTable::m_cellsList
std::vector< shared_ptr< MWAWCell > > m_cellsList
the list of cells
Definition: MWAWTable.hxx:179
MWAWTable::m_alignment
Alignment m_alignment
the table alignment
Definition: MWAWTable.hxx:189
MWAWTable::m_numCols
size_t m_numCols
the number of cols ( set by buildPosToCellId )
Definition: MWAWTable.hxx:183
MWAWTable::m_rowsSize
std::vector< float > m_rowsSize
the final row size (in point)
Definition: MWAWTable.hxx:185
MWAWCell.hxx
Defines MWAWCell (cell content and format)
MWAWTable::m_colsSize
std::vector< float > m_colsSize
the final col size (in point)
Definition: MWAWTable.hxx:187
MWAWTable::m_posToCellId
std::vector< int > m_posToCellId
a vector used to store an id corresponding to each cell
Definition: MWAWTable.hxx:196
MWAWTable::sendTable
bool sendTable(MWAWListenerPtr listener, bool inFrame=true)
try to send the table
Definition: MWAWTable.cxx:462
MWAWTable::DataSet
DataSet
an enum used to indicate what the list of entries which are filled
Definition: MWAWTable.hxx:55
MWAWTable::buildStructures
bool buildStructures()
create the correspondance list, ...
Definition: MWAWTable.cxx:212
MWAWTable::MWAWTable
MWAWTable(uint32_t givenData=BoxBit)
the constructor
Definition: MWAWTable.hxx:65
MWAWTable::mergeBorders
bool mergeBorders() const
returns true if we need to merge borders
Definition: MWAWTable.hxx:83
MWAWTable::Center
Definition: MWAWTable.hxx:62
MWAWTable::SizeBit
Definition: MWAWTable.hxx:56
MWAWTable::sendExtraLines
void sendExtraLines(MWAWListenerPtr listener) const
send extra line
Definition: MWAWTable.cxx:159
MWAWTable::numCells
int numCells() const
returns the number of cell
Definition: MWAWTable.hxx:101