RenderedStringComponent.h

/***********************************************************************
    created:    24/05/2009
    author:     Paul Turner
 *************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2009 Paul D Turner & The CEGUI Development Team
 *
 *   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 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.
 ***************************************************************************/
#ifndef _CEGUIRenderedStringComponent_h_
#define _CEGUIRenderedStringComponent_h_

#include "CEGUI/Size.h"
#include "CEGUI/Rect.h"
#include "CEGUI/falagard/Enums.h"

#if defined(_MSC_VER)
#   pragma warning(push)
#   pragma warning(disable : 4251)
#endif

// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT RenderedStringComponent :
    public AllocatedObject<RenderedStringComponent>
{
public:
    virtual ~RenderedStringComponent();

    void setVerticalFormatting(VerticalFormatting fmt);
    VerticalFormatting getVerticalFormatting() const;
    void setPadding(const Rectf& padding);
    void setLeftPadding(const float padding);
    void setRightPadding(const float padding);
    void setTopPadding(const float padding);
    void setBottomPadding(const float padding);
    const Rectf& getPadding() const;
    float getLeftPadding() const;
    float getRightPadding() const;
    float getTopPadding() const;
    float getBottomPadding() const;
    void setAspectLock(const bool setting);
    bool getAspectLock() const;

    virtual void draw(const Window* ref_wnd, GeometryBuffer& buffer,
                      const Vector2f& position, const ColourRect* mod_colours,
                      const Rectf* clip_rect, const float vertical_space,
                      const float space_extra) const = 0;

    virtual Sizef getPixelSize(const Window* ref_wnd) const = 0;

    virtual bool canSplit() const = 0;

    virtual RenderedStringComponent* split(const Window* ref_wnd,
                                           float split_point,
                                           bool first_component) = 0;

    virtual RenderedStringComponent* clone() const = 0;

    virtual size_t getSpaceCount() const = 0;

    virtual void setSelection(const Window* ref_wnd,
                              const float start, const float end) = 0;

protected:
    RenderedStringComponent();

    Rectf d_padding;
    VerticalFormatting d_verticalFormatting;
    bool d_aspectLock;
    const Image* d_selectionImage;
};

} // End of  CEGUI namespace section

#if defined(_MSC_VER)
#   pragma warning(pop)
#endif

#endif // end of guard _CEGUIRenderedStringComponent_h_