text_block.h

/*
**  UICore
**  Copyright (c) 1997-2015 The UICore Team
**
**  This software is provided 'as-is', without any express or implied
**  warranty.  In no event will the authors be held liable for any damages
**  arising from the use of this software.
**
**  Permission is granted to anyone to use this software for any purpose,
**  including commercial applications, and to alter it and redistribute it
**  freely, subject to the following restrictions:
**
**  1. The origin of this software must not be misrepresented; you must not
**     claim that you wrote the original software. If you use this software
**     in a product, an acknowledgment in the product documentation would be
**     appreciated but is not required.
**  2. Altered source versions must be plainly marked as such, and must not be
**     misrepresented as being the original software.
**  3. This notice may not be removed or altered from any source distribution.
**
**  Note: Some of the libraries UICore may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Magnus Norddahl
*/

#pragma once

#include <memory>
#include "../../Core/Math/rect.h"
#include "../../Core/Math/size.h"
#include "../../Core/Math/color.h"

namespace uicore
{
    class Font;
    typedef std::shared_ptr<Font> FontPtr;
    class GraphicContext;
    class Pointf;
    class Sizef;
    class Image;
    typedef std::shared_ptr<Image> ImagePtr;
    class Canvas;
    typedef std::shared_ptr<Canvas> CanvasPtr;

    enum class SpanAlign
    {
        left,
        right,
        center,
        justify
    };

    class SpanComponent
    {
    public:
        virtual Sizef size() const = 0;

        virtual void set_geometry(const Rectf &geometry) = 0;
    };

    class TextBlock
    {
    public:
        static std::shared_ptr<TextBlock> create();

        struct HitTestResult
        {
            enum Type
            {
                no_objects_available,
                outside_top,
                outside_left,
                outside_right,
                outside_bottom,
                inside
            };

            Type type = no_objects_available;
            int object_id = -1;
            int offset = 0;
        };

        virtual void clear() = 0;

        virtual void add_text(const std::string &text, const FontPtr &font, const Colorf &color = Colorf::white, int id = -1) = 0;

        virtual void add_image(const ImagePtr &image, float baseline_offset = 0.0f, int id = -1) = 0;

        virtual void add_component(std::shared_ptr<SpanComponent> component, float baseline_offset = 0.0f, int id = -1) = 0;

        virtual void layout(const CanvasPtr &canvas, float max_width) = 0;

        virtual void set_position(const Pointf &pos) = 0;

        virtual Sizef size() const = 0;

        virtual Rectf rect() const = 0;

        virtual std::vector<Rectf> rect_by_id(int id) const = 0;

        virtual HitTestResult hit_test(const CanvasPtr &canvas, const Pointf &pos) = 0;

        virtual void draw_layout(const CanvasPtr &canvas) = 0;

        virtual void draw_layout_ellipsis(const CanvasPtr &canvas, const Rectf &content_rect) = 0;

        virtual void set_component_geometry() = 0;

        virtual Sizef find_preferred_size(const CanvasPtr &canvas) = 0;

        virtual void set_selection_range(std::string::size_type start, std::string::size_type end) = 0;

        virtual void set_selection_colors(const Colorf &foreground, const Colorf &background) = 0;

        virtual void show_cursor() = 0;

        virtual void hide_cursor() = 0;

        virtual void set_cursor_pos(std::string::size_type pos) = 0;

        virtual void set_cursor_overwrite_mode(bool enable) = 0;

        virtual void set_cursor_color(const Colorf &color) = 0;

        virtual std::string combined_text() const = 0;

        virtual void set_align(SpanAlign align) = 0;

        virtual float first_baseline_offset() = 0;

        virtual float last_baseline_offset() = 0;
    };

    typedef std::shared_ptr<TextBlock> TextBlockPtr;
}