MWAWSection.hxx Source File documentation

- Main Page
- Namespaces
- Classes
- Files

- File List
- File Members

MWAWSection.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_SECTION_H
35 #define MWAW_SECTION_H
36
37 #include <iostream>
38 #include <vector>
39
40 #include <librevenge/librevenge.h>
41
42 #include "libmwaw_internal.hxx"
43
45 class MWAWSection
46 {
47 public:
48 struct Column;
50 MWAWSection() : m_columns(), m_width(0), m_columnSeparator(), m_balanceText(false), m_backgroundColor(MWAWColor::white())
51 {
52 m_columnSeparator.m_style=MWAWBorder::None;
53 }
55 virtual ~MWAWSection();
56
61 void setColumns(int num, double width, librevenge::RVNGUnit widthUnit, double colSep=0);
63 int numColumns() const
64 {
65 return m_columns.size() <= 1 ? 1 : int(m_columns.size());
66 }
68 bool hasSingleColumns() const
69 {
70 return m_columns.size() <= 1;
71 }
73 void addTo(librevenge::RVNGPropertyList &propList) const;
75 void addColumnsTo(librevenge::RVNGPropertyListVector &propList) const;
77 friend std::ostream &operator<<(std::ostream &o, MWAWSection const &sec);
79 bool operator!=(MWAWSection const &sec) const
80 {
81 if (m_columns.size()!=sec.m_columns.size())
82 return true;
83 for (size_t c=0; c < m_columns.size(); c++) {
84 if (m_columns[c] != sec.m_columns[c])
85 return true;
86 }
87 if (m_columnSeparator != sec.m_columnSeparator)
88 return true;
89 if (m_balanceText!=sec.m_balanceText || m_backgroundColor!=sec.m_backgroundColor)
90 return true;
91 return false;
92 }
94 bool operator==(MWAWSection const &sec) const
95 {
96 return !operator!=(sec);
97 }
98
100 std::vector<Column> m_columns;
102 double m_width;
104 MWAWBorder m_columnSeparator;
106 bool m_balanceText;
108 MWAWColor m_backgroundColor;
109
110 public:
112 struct Column {
114 Column() : m_width(0), m_widthUnit(librevenge::RVNG_INCH)
115 {
116 for (int i = 0; i < 4; i++)
117 m_margins[i]=0;
118 }
120 bool addTo(librevenge::RVNGPropertyList &propList) const;
122 friend std::ostream &operator<<(std::ostream &o, Column const &column);
124 bool operator!=(Column const &col) const
125 {
126 if (m_width<col.m_width || m_width>col.m_width || m_widthUnit!=col.m_widthUnit)
127 return true;
128 for (int i = 0; i < 4; i++) {
129 if (m_margins[i]<col.m_margins[i] || m_margins[i]>col.m_margins[i])
130 return true;
131 }
132 return false;
133 }
135 bool operator==(Column const &col) const
136 {
137 return !operator!=(col);
138 }
139
141 double m_width;
143 librevenge::RVNGUnit m_widthUnit;
145 double m_margins[4];
146 };
147 };
148 #endif
149 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWSection::setColumns
void setColumns(int num, double width, librevenge::RVNGUnit widthUnit, double colSep=0)
a function which sets n uniform columns
Definition: MWAWSection.cxx:108
MWAWSection::addColumnsTo
void addColumnsTo(librevenge::RVNGPropertyListVector &propList) const
add tabs to the propList
Definition: MWAWSection.cxx:146
librevenge
Definition: MWAWDocument.hxx:56
libmwaw_internal.hxx
MWAWSection::Column::m_widthUnit
librevenge::RVNGUnit m_widthUnit
the width unit (default inches)
Definition: MWAWSection.hxx:143
MWAWSection::m_width
double m_width
the total section width ( if set )
Definition: MWAWSection.hxx:102
MWAWSection::~MWAWSection
virtual ~MWAWSection()
destructor
Definition: MWAWSection.cxx:88
MWAWSection::numColumns
int numColumns() const
returns the number of columns
Definition: MWAWSection.hxx:63
MWAWSection::m_columns
std::vector< Column > m_columns
the different column
Definition: MWAWSection.hxx:100
MWAWColor
the class to store a color
Definition: libmwaw_internal.hxx:182
MWAWSection::hasSingleColumns
bool hasSingleColumns() const
returns the true if the section has only one columns
Definition: MWAWSection.hxx:68
MWAWSection::MWAWSection
MWAWSection()
constructor
Definition: MWAWSection.hxx:50
MWAWSection::m_columnSeparator
MWAWBorder m_columnSeparator
the vertical separator between columns
Definition: MWAWSection.hxx:104
MWAWSection::Column
struct to store the columns properties
Definition: MWAWSection.hxx:112
MWAWBorder
a border
Definition: libmwaw_internal.hxx:314
MWAWSection::Column::operator<<
friend std::ostream & operator<<(std::ostream &o, Column const &column)
operator <<
Definition: MWAWSection.cxx:44
MWAWSection::operator<<
friend std::ostream & operator<<(std::ostream &o, MWAWSection const &sec)
operator <<
Definition: MWAWSection.cxx:92
MWAWSection::addTo
void addTo(librevenge::RVNGPropertyList &propList) const
add to the propList
Definition: MWAWSection.cxx:129
MWAWSection::m_balanceText
bool m_balanceText
true if the text is balanced between different columns
Definition: MWAWSection.hxx:106
MWAWSection::Column::m_margins
double m_margins[4]
the margins in inches using libmwaw::Position orders
Definition: MWAWSection.hxx:145
MWAWSection::m_backgroundColor
MWAWColor m_backgroundColor
the background color
Definition: MWAWSection.hxx:108
MWAWBorder::None
Definition: libmwaw_internal.hxx:316
MWAWSection::Column::addTo
bool addTo(librevenge::RVNGPropertyList &propList) const
add a column to the propList
Definition: MWAWSection.cxx:55
MWAWSection::Column::operator==
bool operator==(Column const &col) const
operator==
Definition: MWAWSection.hxx:135
MWAWSection
a class which stores section properties
Definition: MWAWSection.hxx:45
MWAWBorder::m_style
Style m_style
the border style
Definition: libmwaw_internal.hxx:350
MWAWSection::Column::Column
Column()
constructor
Definition: MWAWSection.hxx:114
MWAWSection::Column::m_width
double m_width
the columns width
Definition: MWAWSection.hxx:141
MWAWSection::Column::operator!=
bool operator!=(Column const &col) const
operator!=
Definition: MWAWSection.hxx:124
MWAWSection::operator!=
bool operator!=(MWAWSection const &sec) const
operator!=
Definition: MWAWSection.hxx:79
MWAWSection::operator==
bool operator==(MWAWSection const &sec) const
operator==
Definition: MWAWSection.hxx:94