alignment.hpp

// Copyright (c) 2014-2022 Thomas Fussell
// Copyright (c) 2010-2015 openpyxl
// Copyright (c) 2024 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>

namespace xlnt {

enum class XLNT_API horizontal_alignment
{
    general,
    left,
    center,
    right,
    fill,
    justify,
    center_continuous,
    distributed
};

enum class XLNT_API vertical_alignment
{
    top,
    center,
    bottom,
    justify,
    distributed
};

class XLNT_API alignment
{
public:
    bool shrink() const;

    alignment &shrink(bool shrink_to_fit);

    bool wrap() const;

    alignment &wrap(bool wrap_text);

    optional<int> indent() const;

    alignment &indent(int indent_size);

    optional<int> rotation() const;

    alignment &rotation(int text_rotation);

    optional<horizontal_alignment> horizontal() const;

    alignment &horizontal(horizontal_alignment horizontal);

    optional<vertical_alignment> vertical() const;

    alignment &vertical(vertical_alignment vertical);

    bool operator==(const alignment &other) const;

    bool operator!=(const alignment &other) const;

private:
    bool shrink_to_fit_ = false;

    bool wrap_text_ = false;

    optional<int> indent_;

    optional<int> text_rotation_;

    optional<horizontal_alignment> horizontal_;

    optional<vertical_alignment> vertical_;
};

} // namespace xlnt