sheet_view.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/worksheet/pane.hpp>
#include <xlnt/worksheet/selection.hpp>

namespace xlnt {

enum class sheet_view_type
{
    normal,
    page_break_preview,
    page_layout
};

class XLNT_API sheet_view
{
public:
    void id(std::size_t new_id)
    {
        id_ = new_id;
    }

    std::size_t id() const
    {
        return id_;
    }

    bool has_pane() const
    {
        return pane_.is_set();
    }

    struct pane &pane()
    {
        if (!pane_.is_set())
        {
            throw xlnt::invalid_attribute("sheet view has no pane");
        }
        return pane_.get();
    }

    const struct pane &pane() const
    {
        if (!pane_.is_set())
        {
            throw xlnt::invalid_attribute("sheet view has no pane");
        }
        return pane_.get();
    }

    void clear_pane()
    {
        pane_.clear();
    }

    void pane(const struct pane &new_pane)
    {
        pane_ = new_pane;
    }

    bool has_selections() const
    {
        return !selections_.empty();
    }

    void add_selection(const class selection &new_selection)
    {
        selections_.push_back(new_selection);
    }

    void clear_selections()
    {
        selections_.clear();
    }

    std::vector<xlnt::selection> selections() const
    {
        return selections_;
    }

    class xlnt::selection &selection(std::size_t index)
    {
        if (index >= selections_.size())
        {
            throw xlnt::invalid_parameter("sheet view selection at index " + std::to_string(index) + " does not exist (" + std::to_string(selections_.size()) + " selections available)");
        }

        return selections_.at(index);
    }

    void show_grid_lines(bool show)
    {
        show_grid_lines_ = show;
    }

    bool show_grid_lines() const
    {
        return show_grid_lines_;
    }

    void default_grid_color(bool is_default)
    {
        default_grid_color_ = is_default;
    }

    bool default_grid_color() const
    {
        return default_grid_color_;
    }

    void type(sheet_view_type new_type)
    {
        type_ = new_type;
    }

    sheet_view_type type() const
    {
        return type_;
    }

    bool has_top_left_cell() const
    {
        return top_left_cell_.is_set();
    }

    void top_left_cell(const cell_reference &ref)
    {
        top_left_cell_.set(ref);
    }

    cell_reference top_left_cell() const
    {
        if (!top_left_cell_.is_set())
        {
            throw xlnt::invalid_attribute("sheet view has no top left cell");
        }
        return top_left_cell_.get();
    }

    void zoom_scale(int scale)
    {
        zoom_scale_ = scale;
    }

    int zoom_scale() const
    {
        return zoom_scale_;
    }

    bool operator==(const sheet_view &rhs) const
    {
        return id_ == rhs.id_
            && show_grid_lines_ == rhs.show_grid_lines_
            && default_grid_color_ == rhs.default_grid_color_
            && pane_ == rhs.pane_
            && selections_ == rhs.selections_
            && top_left_cell_ == rhs.top_left_cell_
            && zoom_scale_ == rhs.zoom_scale_;
    }

    bool operator!=(const sheet_view &rhs) const
    {
        return !(*this == rhs);
    }

private:
    std::size_t id_ = 0;

    bool show_grid_lines_ = true;

    bool default_grid_color_ = true;

    sheet_view_type type_ = sheet_view_type::normal;

    optional<xlnt::pane> pane_;

    optional<cell_reference> top_left_cell_;

    std::vector<xlnt::selection> selections_;

    int zoom_scale_ = 100;
};

} // namespace xlnt