CEGUIImagesetManager.h

/***********************************************************************
    filename:   CEGUIImagesetManager.h
    created:    Sat Jul 18 2009
    author:     Paul D Turner <paul@cegui.org.uk>
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2009 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 _CEGUIImagesetManager_h_
#define _CEGUIImagesetManager_h_

#include "CEGUIBase.h"
#include "CEGUISingleton.h"
#include "CEGUINamedXMLResourceManager.h"
#include "CEGUIImageset.h"
#include "CEGUIImageset_xmlHandler.h"
#include "CEGUIIteratorBase.h"

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

// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT ImagesetManager :
        public Singleton<ImagesetManager>,
        public NamedXMLResourceManager<Imageset, Imageset_xmlHandler>
{
public:
    ImagesetManager();

    ~ImagesetManager();

    Imageset& create(const String& name, Texture& texture,
                     XMLResourceExistsAction action = XREA_RETURN);

    Imageset& createFromImageFile(const String& name, const String& filename,
                                const String& resourceGroup = "",
                                XMLResourceExistsAction action = XREA_RETURN);

    void notifyDisplaySizeChanged(const Size& size);

    void writeImagesetToStream(const String& imageset,
                               OutStream& out_stream) const;

    typedef ConstBaseIterator<ObjectRegistry> ImagesetIterator;

    ImagesetIterator getIterator() const;

    // ensure we see overloads from template base class
    using NamedXMLResourceManager<Imageset, Imageset_xmlHandler>::create;
};

} // End of  CEGUI namespace section

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

#endif  // end of guard _CEGUIImageSetManager_h_