page_setup.hpp

// Copyright (c) 2014-2022 Thomas Fussell
// Copyright (c) 2010-2015 openpyxl
// Copyright (c) 2024-2026 xlnt-community
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE
//
// @license: http://www.opensource.org/licenses/mit-license.php
// @author: see AUTHORS file

#pragma once

#include <xlnt/xlnt_config.hpp>
#include <xlnt/utils/optional.hpp>
#include <xlnt/utils/value_with_default.h>

namespace xlnt {

namespace detail {

class xlsx_producer;

} // namespace detail

enum class orientation
{
    default_orientation,
    portrait,
    landscape
};

enum class page_break
{
    none = 0,
    row = 1,
    column = 2
};

enum class paper_size
{
    letter = 1,
    letter_small = 2,
    tabloid = 3,
    ledger = 4,
    legal = 5,
    statement = 6,
    executive = 7,
    a3 = 8,
    a4 = 9,
    a4_small = 10,
    a5 = 11
};

enum class sheet_state
{
    visible,
    hidden,
    very_hidden
};

struct XLNT_API page_setup
{
public:
    page_setup();

    xlnt::page_break page_break() const;

    void page_break(xlnt::page_break b);

    xlnt::sheet_state sheet_state() const;

    void sheet_state(xlnt::sheet_state sheet_state);

    xlnt::paper_size paper_size() const;

    void paper_size(xlnt::paper_size paper_size);

    bool has_paper_size() const;

    bool fit_to_page() const;

    void fit_to_page(bool fit_to_page);

    bool fit_to_height() const;

    void fit_to_height(bool fit_to_height);

    bool fit_to_width() const;

    void fit_to_width(bool fit_to_width);

    void scale(unsigned int scale);

    unsigned int scale() const;

    bool has_scale() const;

    const std::string& rel_id() const;

    void rel_id(const std::string& val);

    bool has_rel_id() const;

    xlnt::optional<xlnt::orientation> orientation_;
    xlnt::optional<std::size_t> horizontal_dpi_;
    xlnt::optional<std::size_t> vertical_dpi_;

    bool operator==(const page_setup &rhs) const;

    bool operator!=(const page_setup &rhs) const;

private:
    friend class xlnt::detail::xlsx_producer;

    std::string rel_id_;

    xlnt::page_break break_;

    xlnt::sheet_state sheet_state_;

    xlnt::optional<xlnt::paper_size> paper_size_;

    bool fit_to_page_;

    bool fit_to_height_;

    bool fit_to_width_;

    detail::value_with_default<unsigned int, 100> scale_;
};

} // namespace xlnt