comment.hpp

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

#include <xlnt/xlnt_config.hpp>
#include <xlnt/cell/rich_text.hpp>

namespace xlnt {

class XLNT_API comment
{
public:
    comment();

    comment(const rich_text &text, const std::string &author);

    comment(const std::string &text, const std::string &author);

    rich_text text() const;

    std::string plain_text() const;

    std::string author() const;

    void hide();

    void show();

    bool visible() const;

    void position(int left, int top);

    int left() const;

    int top() const;

    void size(int width, int height);

    int width() const;

    int height() const;

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

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

private:
    rich_text text_;

    std::string author_;

    bool visible_ = false;

    std::string fill_;

    int left_ = 0;

    int top_ = 0;

    int width_ = 200;

    int height_ = 100;
};

} // namespace xlnt