FalMultiLineEditbox.h

/***********************************************************************
    filename:   FalMultiLineEditbox.h
    created:    Thu Jul 7 2005
    author:     Paul D Turner <paul@cegui.org.uk>
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2006 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 _FalMultiLineEditbox_h_
#define _FalMultiLineEditbox_h_

#include "FalModule.h"
#include "elements/CEGUIMultiLineEditbox.h"

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

// Start of CEGUI namespace section
namespace CEGUI
{
    class FALAGARDBASE_API FalagardMultiLineEditbox : public MultiLineEditboxWindowRenderer
    {
    public:
        static const utf8   TypeName[];     

        static const String UnselectedTextColourPropertyName;
        static const String SelectedTextColourPropertyName;
        static const String ActiveSelectionColourPropertyName;
        static const String InactiveSelectionColourPropertyName;

        FalagardMultiLineEditbox(const String& type);

        // overridden from base classes.
        Rect getTextRenderArea(void) const;
        void render();

    protected:
        void cacheEditboxBaseImagery();

        void cacheCaratImagery(const Rect& textArea);

        void cacheTextLines(const Rect& dest_area);

        colour getUnselectedTextColour() const;

        colour getActiveSelectionColour() const;

        colour getInactiveSelectionColour() const;

        colour getSelectedTextColour() const;

        colour getOptionalPropertyColour(const String& propertyName) const;
    };

} // End of  CEGUI namespace section


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

#endif  // end of guard _FalMultiLineEditbox_h_