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 {
57 }
62 void setColumns(int num, double width, librevenge::RVNGUnit widthUnit, double colSep=0);
64 int numColumns() const
65 {
66 return m_columns.size() <= 1 ? 1 : int(m_columns.size());
67 }
69 bool hasSingleColumns() const
70 {
71 return m_columns.size() <= 1;
72 }
74 void addTo(librevenge::RVNGPropertyList &propList) const;
76 void addColumnsTo(librevenge::RVNGPropertyListVector &propList) const;
78 friend std::ostream &operator<<(std::ostream &o, MWAWSection const &sec);
80 bool operator!=(MWAWSection const &sec) const
81 {
82 if (m_columns.size()!=sec.m_columns.size())
83 return true;
84 for (size_t c=0; c < m_columns.size(); c++) {
85 if (m_columns[c] != sec.m_columns[c])
86 return true;
87 }
88 if (m_columnSeparator != sec.m_columnSeparator)
89 return true;
90 if (m_balanceText!=sec.m_balanceText || m_backgroundColor!=sec.m_backgroundColor)
91 return true;
92 return false;
93 }
95 bool operator==(MWAWSection const &sec) const
96 {
97 return !operator!=(sec);
98 }
99
101 std::vector<Column> m_columns;
103 double m_width;
105 MWAWBorder m_columnSeparator;
107 bool m_balanceText;
109 MWAWColor m_backgroundColor;
110
111 public:
113 struct Column {
115 Column() : m_width(0), m_widthUnit(librevenge::RVNG_INCH)
116 {
117 for (int i = 0; i < 4; i++)
118 m_margins[i]=0;
119 }
121 bool addTo(librevenge::RVNGPropertyList &propList) const;
123 friend std::ostream &operator<<(std::ostream &o, Column const &column);
125 bool operator!=(Column const &col) const
126 {
127 if (m_width<col.m_width || m_width>col.m_width || m_widthUnit!=col.m_widthUnit)
128 return true;
129 for (int i = 0; i < 4; i++) {
130 if (m_margins[i]<col.m_margins[i] || m_margins[i]>col.m_margins[i])
131 return true;
132 }
133 return false;
134 }
136 bool operator==(Column const &col) const
137 {
138 return !operator!=(col);
139 }
140
142 double m_width;
144 librevenge::RVNGUnit m_widthUnit;
146 double m_margins[4];
147 };
148 };
149 #endif
150 // 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:100
MWAWSection::addColumnsTo
void addColumnsTo(librevenge::RVNGPropertyListVector &propList) const
add tabs to the propList
Definition: MWAWSection.cxx:138
librevenge
Definition: MWAWDocument.hxx:56
MWAWSection::~MWAWSection
virtual ~MWAWSection()
destructor
Definition: MWAWSection.hxx:55
libmwaw_internal.hxx
MWAWSection::Column::m_widthUnit
librevenge::RVNGUnit m_widthUnit
the width unit (default inches)
Definition: MWAWSection.hxx:144
MWAWSection::m_width
double m_width
the total section width ( if set )
Definition: MWAWSection.hxx:103
MWAWSection::numColumns
int numColumns() const
returns the number of columns
Definition: MWAWSection.hxx:64
MWAWSection::m_columns
std::vector< Column > m_columns
the different column
Definition: MWAWSection.hxx:101
MWAWColor
the class to store a color
Definition: libmwaw_internal.hxx:167
MWAWSection::hasSingleColumns
bool hasSingleColumns() const
returns the true if the section has only one columns
Definition: MWAWSection.hxx:69
MWAWSection::MWAWSection
MWAWSection()
constructor
Definition: MWAWSection.hxx:50
MWAWSection::m_columnSeparator
MWAWBorder m_columnSeparator
the vertical separator between columns
Definition: MWAWSection.hxx:105
MWAWSection::Column
struct to store the columns properties
Definition: MWAWSection.hxx:113
MWAWBorder
a border
Definition: libmwaw_internal.hxx:299
MWAWSection::Column::operator<<
friend std::ostream & operator<<(std::ostream &o, Column const &column)
operator <<
Definition: MWAWSection.cxx:42
MWAWSection::operator<<
friend std::ostream & operator<<(std::ostream &o, MWAWSection const &sec)
operator <<
Definition: MWAWSection.cxx:84
MWAWSection::addTo
void addTo(librevenge::RVNGPropertyList &propList) const
add to the propList
Definition: MWAWSection.cxx:121
MWAWSection::m_balanceText
bool m_balanceText
true if the text is balanced between different columns
Definition: MWAWSection.hxx:107
MWAWSection::Column::m_margins
double m_margins[4]
the margins in inches using libmwaw::Position orders
Definition: MWAWSection.hxx:146
MWAWSection::m_backgroundColor
MWAWColor m_backgroundColor
the background color
Definition: MWAWSection.hxx:109
MWAWBorder::None
Definition: libmwaw_internal.hxx:301
MWAWSection::Column::addTo
bool addTo(librevenge::RVNGPropertyList &propList) const
add a column to the propList
Definition: MWAWSection.cxx:53
MWAWSection::Column::operator==
bool operator==(Column const &col) const
operator==
Definition: MWAWSection.hxx:136
MWAWSection
a class which stores section properties
Definition: MWAWSection.hxx:45
MWAWBorder::m_style
Style m_style
the border style
Definition: libmwaw_internal.hxx:335
MWAWSection::Column::Column
Column()
constructor
Definition: MWAWSection.hxx:115
MWAWSection::Column::m_width
double m_width
the columns width
Definition: MWAWSection.hxx:142
MWAWSection::Column::operator!=
bool operator!=(Column const &col) const
operator!=
Definition: MWAWSection.hxx:125
MWAWSection::operator!=
bool operator!=(MWAWSection const &sec) const
operator!=
Definition: MWAWSection.hxx:80
MWAWSection::operator==
bool operator==(MWAWSection const &sec) const
operator==
Definition: MWAWSection.hxx:95