Branch data    TLA  Line data    Source code

       1                 :                : // Copyright (c) 2018-2022 Thomas Fussell
       2                 :                : // Copyright (c) 2024-2025 xlnt-community
       3                 :                : //
       4                 :                : // Permission is hereby granted, free of charge, to any person obtaining a copy
       5                 :                : // of this software and associated documentation files (the "Software"), to deal
       6                 :                : // in the Software without restriction, including without limitation the rights
       7                 :                : // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
       8                 :                : // copies of the Software, and to permit persons to whom the Software is
       9                 :                : // furnished to do so, subject to the following conditions:
      10                 :                : //
      11                 :                : // The above copyright notice and this permission notice shall be included in
      12                 :                : // all copies or substantial portions of the Software.
      13                 :                : //
      14                 :                : // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
      15                 :                : // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
      16                 :                : // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
      17                 :                : // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
      18                 :                : // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
      19                 :                : // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
      20                 :                : // THE SOFTWARE
      21                 :                : //
      22                 :                : // @license: http://www.opensource.org/licenses/mit-license.php
      23                 :                : // @author: see AUTHORS file
      24                 :                : 
      25                 :                : #pragma once
      26                 :                : 
      27                 :                : #include <xlnt/xlnt_config.hpp>
      28                 :                : #include <xlnt/utils/numeric.hpp>
      29                 :                : #include <xlnt/utils/optional.hpp>
      30                 :                : 
      31                 :                : namespace xlnt {
      32                 :                : 
      33                 :                : /// <summary>
      34                 :                : /// General worksheet formatting properties.
      35                 :                : /// </summary>
      36                 :                : class XLNT_API sheet_format_properties
      37                 :                : {
      38                 :                : public:
      39                 :                :     /// <summary>
      40                 :                :     /// The base column width
      41                 :                :     /// </summary>
      42                 :                :     optional<double> base_col_width;
      43                 :                : 
      44                 :                :     /// <summary>
      45                 :                :     /// The default row height is required
      46                 :                :     /// </summary>
      47                 :                :     double default_row_height = 15.0;
      48                 :                : 
      49                 :                :     /// <summary>
      50                 :                :     /// The default column width
      51                 :                :     /// </summary>
      52                 :                :     optional<double> default_column_width;
      53                 :                : 
      54                 :                :     /// <summary>
      55                 :                :     /// x14ac extension, dyDescent property
      56                 :                :     /// </summary>
      57                 :                :     optional<double> dy_descent;
      58                 :                : };
      59                 :                : 
      60                 :CBC          16 : inline bool operator==(const sheet_format_properties &lhs, const sheet_format_properties &rhs)
      61                 :                : {
      62                 :             16 :     return lhs.base_col_width == rhs.base_col_width
      63         [ +  - ]:             16 :         && lhs.default_column_width == rhs.default_column_width
      64         [ +  - ]:             16 :         && detail::float_equals(lhs.default_row_height, rhs.default_row_height)
      65   [ +  -  +  - ]:             32 :         && lhs.dy_descent == rhs.dy_descent;
      66                 :                : }
      67                 :                : 
      68                 :                : inline bool operator!=(const sheet_format_properties &lhs, const sheet_format_properties &rhs)
      69                 :                : {
      70                 :                :     return !(lhs == rhs);
      71                 :                : }
      72                 :                : 
      73                 :                : } // namespace xlnt