Crazy Eddie's GUI System  0.8.4
FormattedRenderedString.h
00001 /***********************************************************************
00002     created:    25/05/2009
00003     author:     Paul Turner
00004  *************************************************************************/
00005 /***************************************************************************
00006  *   Copyright (C) 2004 - 2009 Paul D Turner & The CEGUI Development Team
00007  *
00008  *   Permission is hereby granted, free of charge, to any person obtaining
00009  *   a copy of this software and associated documentation files (the
00010  *   "Software"), to deal in the Software without restriction, including
00011  *   without limitation the rights to use, copy, modify, merge, publish,
00012  *   distribute, sublicense, and/or sell copies of the Software, and to
00013  *   permit persons to whom the Software is furnished to do so, subject to
00014  *   the following conditions:
00015  *
00016  *   The above copyright notice and this permission notice shall be
00017  *   included in all copies or substantial portions of the Software.
00018  *
00019  *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
00020  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00021  *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00022  *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
00023  *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00024  *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00025  *   OTHER DEALINGS IN THE SOFTWARE.
00026  ***************************************************************************/
00027 #ifndef _CEGUIFormattedRenderedString_h_
00028 #define _CEGUIFormattedRenderedString_h_
00029 
00030 #include "CEGUI/RenderedString.h"
00031 
00032 // Start of CEGUI namespace section
00033 namespace CEGUI
00034 {
00040 class CEGUIEXPORT FormattedRenderedString :
00041     public AllocatedObject<FormattedRenderedString>
00042 {
00043 public:
00045     virtual ~FormattedRenderedString();
00046 
00047     virtual void format(const Window* ref_wnd, const Sizef& area_size) = 0;
00048     virtual void draw(const Window* ref_wnd, GeometryBuffer& buffer,
00049                       const Vector2f& position, const ColourRect* mod_colours,
00050                       const Rectf* clip_rect) const = 0;
00051     virtual size_t getFormattedLineCount() const = 0;
00052     virtual float getHorizontalExtent(const Window* ref_wnd) const = 0;
00053     virtual float getVerticalExtent(const Window* ref_wnd) const = 0;
00054 
00056     void setRenderedString(const RenderedString& string);
00057 
00058     const RenderedString& getRenderedString() const;
00059 
00060 protected:
00062     FormattedRenderedString(const RenderedString& string);
00063 
00065     const RenderedString* d_renderedString;
00066 };
00067 
00068 } // End of  CEGUI namespace section
00069 
00070 #endif // end of guard _CEGUIFormattedRenderedString_h_
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends