Crazy Eddies GUI System  0.7.6
CEGUIRenderedStringImageComponent.h
00001 /***********************************************************************
00002     filename:   CEGUIRenderedStringImageComponent.h
00003     created:    24/05/2009
00004     author:     Paul Turner
00005  *************************************************************************/
00006 /***************************************************************************
00007  *   Copyright (C) 2004 - 2009 Paul D Turner & The CEGUI Development Team
00008  *
00009  *   Permission is hereby granted, free of charge, to any person obtaining
00010  *   a copy of this software and associated documentation files (the
00011  *   "Software"), to deal in the Software without restriction, including
00012  *   without limitation the rights to use, copy, modify, merge, publish,
00013  *   distribute, sublicense, and/or sell copies of the Software, and to
00014  *   permit persons to whom the Software is furnished to do so, subject to
00015  *   the following conditions:
00016  *
00017  *   The above copyright notice and this permission notice shall be
00018  *   included in all copies or substantial portions of the Software.
00019  *
00020  *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
00021  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00022  *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00023  *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
00024  *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00025  *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00026  *   OTHER DEALINGS IN THE SOFTWARE.
00027  ***************************************************************************/
00028 #ifndef _CEGUIRenderedStringImageComponent_h_
00029 #define _CEGUIRenderedStringImageComponent_h_
00030 
00031 #include "CEGUIRenderedStringComponent.h"
00032 #include "CEGUIColourRect.h"
00033 
00034 // Start of CEGUI namespace section
00035 namespace CEGUI
00036 {
00038 class CEGUIEXPORT RenderedStringImageComponent : public RenderedStringComponent
00039 {
00040 public:
00042     RenderedStringImageComponent();
00043     RenderedStringImageComponent(const String& imageset, const String& image);
00044     RenderedStringImageComponent(const Image* image);
00045 
00047     void setImage(const String& imageset, const String& image);
00049     void setImage(const Image* image);
00051     const Image* getImage() const;
00053     void setColours(const ColourRect& cr);
00055     void setColours(const colour& c);
00057     const ColourRect& getColours() const;
00059     void setSize(const Size& sz);
00061     const Size& getSize() const;
00062 
00063     // implementation of abstract base interface
00064     void draw(GeometryBuffer& buffer, const Vector2& position,
00065               const ColourRect* mod_colours, const Rect* clip_rect,
00066               const float vertical_space, const float space_extra) const;
00067     Size getPixelSize() const;
00068     bool canSplit() const;
00069     RenderedStringImageComponent* split(float split_point, bool first_component);
00070     RenderedStringImageComponent* clone() const;
00071     size_t getSpaceCount() const;
00072 
00073 protected:
00075     const Image* d_image;
00077     ColourRect d_colours;
00079     Size d_size;
00080 };
00081 
00082 } // End of  CEGUI namespace section
00083 
00084 #endif // end of guard _CEGUIRenderedStringImageComponent_h_