xlnt
column_properties.hpp
1 // Copyright (c) 2014-2022 Thomas Fussell
2 // Copyright (c) 2010-2015 openpyxl
3 // Copyright (c) 2024 xlnt-community
4 //
5 // Permission is hereby granted, free of charge, to any person obtaining a copy
6 // of this software and associated documentation files (the "Software"), to deal
7 // in the Software without restriction, including without limitation the rights
8 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 // copies of the Software, and to permit persons to whom the Software is
10 // furnished to do so, subject to the following conditions:
11 //
12 // The above copyright notice and this permission notice shall be included in
13 // all copies or substantial portions of the Software.
14 //
15 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21 // THE SOFTWARE
22 //
23 // @license: http://www.opensource.org/licenses/mit-license.php
24 // @author: see AUTHORS file
25 
26 #pragma once
27 
28 #include <xlnt/xlnt_config.hpp>
29 
30 namespace xlnt {
31 
36 class XLNT_API column_properties
37 {
38 public:
43 
47  bool custom_width = false;
48 
54 
59  bool best_fit = false;
60 
64  bool hidden = false;
65 };
66 
67 inline bool operator==(const column_properties &lhs, const column_properties &rhs)
68 {
69  return lhs.width == rhs.width
70  && lhs.custom_width == rhs.custom_width
71  && lhs.style == rhs.style
72  && lhs.best_fit == rhs.best_fit
73  && lhs.hidden == rhs.hidden;
74 }
75 
76 } // namespace xlnt
Enumerates the possible types a cell can be determined by it&#39;s current value.
Definition: cell.hpp:37
optional< double > width
The optional width of the column
Definition: column_properties.hpp:42
bool custom_width
If true, this is a custom width
Definition: column_properties.hpp:47
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
bool best_fit
Is this column sized to fit its content as best it can serialise if true
Definition: column_properties.hpp:59
bool hidden
If true, this column will be hidden
Definition: column_properties.hpp:64
optional< std::size_t > style
The style index of this column. This shouldn&#39;t be used since style indices aren&#39;t supposed to be used...
Definition: column_properties.hpp:53
Properties applied to a column in a worksheet. Columns can have a size and a style.
Definition: column_properties.hpp:36