format.hpp

// Copyright (c) 2014-2022 Thomas Fussell
// 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 <string>

#include <xlnt/xlnt_config.hpp>
#include <xlnt/internal/format_impl_ptr.hpp>

namespace xlnt {

class alignment;
class border;
class cell;
class fill;
class font;
class number_format;
class protection;
class style;

template <typename T>
class optional;

namespace detail {

struct format_impl;
struct stylesheet;
class xlsx_producer;
class xlsx_consumer;

} // namespace detail

class XLNT_API format
{
public:
    class alignment alignment() const;

    format& alignment(const xlnt::alignment &new_alignment, xlnt::optional<bool> applied = {});

    bool has_alignment() const;

    bool alignment_applied() const;

    class border border() const;

    format& border(const xlnt::border &new_border, xlnt::optional<bool> applied = {});

    bool has_border() const;

    bool border_applied() const;

    class fill fill() const;

    format& fill(const xlnt::fill &new_fill, xlnt::optional<bool> applied = {});

    bool has_fill() const;

    bool fill_applied() const;

    class font font() const;

    format& font(const xlnt::font &new_font, xlnt::optional<bool> applied = {});

    bool has_font() const;

    bool font_applied() const;

    class number_format number_format() const;

    format& number_format(const xlnt::number_format &new_number_format, xlnt::optional<bool> applied = {});

    bool has_number_format() const;

    bool number_format_applied() const;

    class protection protection() const;

    bool has_protection() const;

    bool protection_applied() const;

    format& protection(const xlnt::protection &new_protection, xlnt::optional<bool> applied = {});

    bool pivot_button() const;

    void pivot_button(bool show);

    bool quote_prefix() const;

    void quote_prefix(bool quote);

    bool has_style() const;

    void clear_style();

    format& style(const std::string &name);

    format& style(const class style &new_style);

    class style style();

    const class style style() const;

private:
    friend struct detail::stylesheet;
    friend class detail::xlsx_producer;
    friend class detail::xlsx_consumer;
    friend class cell;
    friend class workbook;

    format(detail::format_impl_ptr d);

    detail::format_impl_ptr d_;
};

} // namespace xlnt