Crazy Eddie's GUI System  0.8.4
RenderedStringImageComponent.h
00001 /***********************************************************************
00002     created:    24/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 _CEGUIRenderedStringImageComponent_h_
00028 #define _CEGUIRenderedStringImageComponent_h_
00029 
00030 #include "CEGUI/RenderedStringComponent.h"
00031 #include "CEGUI/ColourRect.h"
00032 #include "CEGUI/String.h"
00033 
00034 #if defined(_MSC_VER)
00035 #       pragma warning(push)
00036 #       pragma warning(disable : 4251)
00037 #endif
00038 
00039 // Start of CEGUI namespace section
00040 namespace CEGUI
00041 {
00043 class CEGUIEXPORT RenderedStringImageComponent : public RenderedStringComponent
00044 {
00045 public:
00047     RenderedStringImageComponent();
00048     RenderedStringImageComponent(const String& name);
00049     RenderedStringImageComponent(const Image* image);
00050 
00052     void setImage(const String& name);
00054     void setImage(const Image* image);
00056     const Image* getImage() const;
00058     void setColours(const ColourRect& cr);
00060     void setColours(const Colour& c);
00062     const ColourRect& getColours() const;
00064     void setSize(const Sizef& sz);
00066     const Sizef& getSize() const;
00067 
00068     // implementation of abstract base interface
00069     void draw(const Window* ref_wnd, GeometryBuffer& buffer,
00070               const Vector2f& position, const ColourRect* mod_colours,
00071               const Rectf* clip_rect, const float vertical_space,
00072               const float space_extra) const;
00073     Sizef getPixelSize(const Window* ref_wnd) const;
00074     bool canSplit() const;
00075     RenderedStringImageComponent* split(const Window* ref_wnd,
00076                                         float split_point,
00077                                         bool first_component);
00078     RenderedStringImageComponent* clone() const;
00079     size_t getSpaceCount() const;
00080     void setSelection(const Window* ref_wnd,
00081                       const float start, const float end);
00082 protected:
00084     const Image* d_image;
00086     ColourRect d_colours;
00088     Sizef d_size;
00089     // whether the image is marked as selected.
00090     bool d_selected;
00091 };
00092 
00093 } // End of  CEGUI namespace section
00094 
00095 #if defined(_MSC_VER)
00096 #       pragma warning(pop)
00097 #endif
00098 
00099 #endif // end of guard _CEGUIRenderedStringImageComponent_h_
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends