span_layout.h

Go to the documentation of this file.

/*
**  ClanLib SDK
**  Copyright (c) 1997-2009 The ClanLib 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 ClanLib may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Magnus Norddahl
*/


#pragma once

#include "../../Core/System/sharedptr.h"
#include "../../Core/Math/rect.h"
#include "../../Core/Math/size.h"
#include "color.h"

class CL_Font;
class CL_GraphicContext;
class CL_Point;
class CL_Size;
class CL_SpanLayout_Impl;
class CL_Image;
class CL_SpanComponent;

enum CL_SpanAlign
{
        cl_left,
        cl_right,
        cl_center,
        cl_justify
};

class CL_SpanComponent
{
public:
        virtual ~CL_SpanComponent() { }

        virtual CL_Size get_size() const = 0;

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

template<typename T>
class CL_SpanComponentBinder : public CL_SpanComponent
{
public:

        CL_SpanComponentBinder(T *component)
        : component(component)
        {
        }

        CL_Size get_size() const
        {
                return component->get_size();
        }

        void set_geometry(const CL_Rect &geometry)
        {
                component->set_geometry(geometry);
        }

private:
        T *component;
};

class CL_SpanLayout
{
public:
        CL_SpanLayout();
        ~CL_SpanLayout();

        struct HitTestResult
        {
                HitTestResult() : object_id(-1), offset(0) {}

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

                int object_id;
                int offset;
        };

public:
        void clear();

        void add_text(const CL_String &text, const CL_Font &font, const CL_Colorf &color = CL_Colorf::white, int id = -1);

        void add_image(const CL_Image &image, int baseline_offset = 0, int id = -1);

        template<typename T>

        void add_component(T *component, int baseline_offset = 0, int id = -1)
        {
                add_component_helper(new CL_SpanComponentBinder<T>(component), baseline_offset, id);
        }

        void layout(CL_GraphicContext &gc, int max_width);

        void set_position(const CL_Point &pos);

        CL_Size get_size() const;

        std::vector<CL_Rect> get_rect_by_id(int id) const;


        HitTestResult hit_test(CL_GraphicContext &gc, const CL_Point &pos);

        void draw_layout(CL_GraphicContext &gc);

        void set_component_geometry();

        CL_Size find_preferred_size(CL_GraphicContext &gc);

        void set_selection_range(CL_String::size_type start, CL_String::size_type end);

        void set_selection_colors(const CL_Colorf &foreground, const CL_Colorf &background);

        CL_String get_combined_text() const;

        void set_align(CL_SpanAlign align);

private:

        void add_component_helper(CL_SpanComponent *component, int baseline_offset, int id);

        CL_SharedPtr<CL_SpanLayout_Impl> impl;
};

---