TextComponent.h

/***********************************************************************
    filename:   CEGUITextComponent.h
    created:    Sun Jun 19 2005
    author:     Paul D Turner <paul@cegui.org.uk>
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2012 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 _CEGUIFalTextComponent_h_
#define _CEGUIFalTextComponent_h_

#include "./ComponentBase.h"
#include "../RenderedString.h"
#include "../RefCounted.h"
#include "../FormattedRenderedString.h"
#include "CEGUI/falagard/FormattingSetting.h"

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

// Start of CEGUI namespace section
namespace CEGUI
{
    class CEGUIEXPORT TextComponent : public FalagardComponentBase
    {
    public:
        TextComponent();
        ~TextComponent();
        TextComponent(const TextComponent& obj);
        TextComponent& operator=(const TextComponent& other);

        const String& getText() const;

        /*
        \brief
            Return a copy of the actual text string that will be used when
            rendering this TextComponent.
        */
        String getEffectiveText(const Window& wnd) const;

        const String& getTextVisual() const;

        /*
        \brief
            Return a copy of the actual text - with visual ordering - that
            will be used when rendering this TextComponent.
        */
        String getEffectiveVisualText(const Window& wnd) const;

        void setText(const String& text);

        const String& getFont() const;

        /*
        \brief
            Return a copy of the name of the font that will actually be used
            when rendering this TextComponent.
        */
        String getEffectiveFont(const Window& wnd) const;

        void setFont(const String& font);

        VerticalTextFormatting getVerticalFormatting(const Window& wnd) const;

        void setVerticalFormatting(VerticalTextFormatting fmt);

        HorizontalTextFormatting getHorizontalFormatting(const Window& wnd) const;

        void setHorizontalFormatting(HorizontalTextFormatting fmt);

        void setHorizontalFormattingPropertySource(const String& property_name);

        void setVerticalFormattingPropertySource(const String& property_name);

        void writeXMLToStream(XMLSerializer& xml_stream) const;

        bool isTextFetchedFromProperty() const;

        const String& getTextPropertySource() const;

        void setTextPropertySource(const String& property);
        
        bool isFontFetchedFromProperty() const;

        const String& getFontPropertySource() const;

        void setFontPropertySource(const String& property);

        float getHorizontalTextExtent(const Window& window) const;

        float getVerticalTextExtent(const Window& window) const;
    
        // overridden from ComponentBase.
        bool handleFontRenderSizeChange(Window& window, const Font* font) const;

    protected:
        // implemets abstract from base
        void render_impl(Window& srcWindow, Rectf& destRect, const CEGUI::ColourRect* modColours, const Rectf* clipper, bool clipToDisplay) const;
        void setupStringFormatter(const Window& window,
                                  const RenderedString& rendered_string) const;
        const Font* getFontObject(const Window& window) const;

    private:
        String d_textLogical;
        BidiVisualMapping* d_bidiVisualMapping;
        mutable bool d_bidiDataValid;
        mutable RenderedString d_renderedString;
        mutable RefCounted<FormattedRenderedString> d_formattedRenderedString;
        mutable HorizontalTextFormatting d_lastHorzFormatting;

        String               d_font;            

        FormattingSetting<VerticalTextFormatting> d_vertFormatting;
        FormattingSetting<HorizontalTextFormatting> d_horzFormatting;
        String  d_textPropertyName;             
        String  d_fontPropertyName;             
    };

} // End of  CEGUI namespace section

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

#endif  // end of guard _CEGUIFalTextComponent_h_