Crazy Eddies GUI System: CEGUIResourceProvider.h Source File

Crazy Eddies GUI System 0.7.6

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- File List

CEGUIResourceProvider.h

    00001 /***********************************************************************
    00002         filename:       CEGUIResourceProvider.h
    00003         created:        8/7/2004
    00004         author:         James '_mental_' O'Sullivan
    00005
    00006         purpose:        Defines abstract base class for loading DataContainer objects
    00007 *************************************************************************/
    00008 /***************************************************************************
    00009  *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
    00010  *
    00011  *   Permission is hereby granted, free of charge, to any person obtaining
    00012  *   a copy of this software and associated documentation files (the
    00013  *   "Software"), to deal in the Software without restriction, including
    00014  *   without limitation the rights to use, copy, modify, merge, publish,
    00015  *   distribute, sublicense, and/or sell copies of the Software, and to
    00016  *   permit persons to whom the Software is furnished to do so, subject to
    00017  *   the following conditions:
    00018  *
    00019  *   The above copyright notice and this permission notice shall be
    00020  *   included in all copies or substantial portions of the Software.
    00021  *
    00022  *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
    00023  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    00024  *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
    00025  *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
    00026  *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
    00027  *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
    00028  *   OTHER DEALINGS IN THE SOFTWARE.
    00029  ***************************************************************************/
    00030 #ifndef _CEGUIResourceProvider_h_
    00031 #define _CEGUIResourceProvider_h_
    00032
    00033 #include "CEGUIBase.h"
    00034 #include "CEGUIDataContainer.h"
    00035 #include "CEGUIString.h"
    00036 #include <vector>
    00037
    00038
    00039 // Start of CEGUI namespace section
    00040 namespace CEGUI
    00041 {
    00048 class CEGUIEXPORT ResourceProvider
    00049 {
    00050 public:
    00051         /*************************************************************************
    00052                 Construction and Destruction
    00053         *************************************************************************/
    00058         ResourceProvider() { }
    00059
    00064         virtual ~ResourceProvider(void) { }
    00065
    00066     /*************************************************************************
    00067         Accessor functions
    00068     *************************************************************************/
    00069
    00070 //    /*!
    00071 //    \brief
    00072 //        Load XML data using InputSource objects.
    00073 //
    00074 //    \param filename
    00075 //        String containing a filename of the resource to be loaded.
    00076 //
    00077 //      \param output
    00078 //              Reference to a InputSourceContainer object to load the data into.
    00079 //   */
    00080 //    virtual void loadInputSourceContainer(const String& filename, InputSourceContainer& output) = 0;
    00081
    00096     virtual void loadRawDataContainer(const String& filename, RawDataContainer& output, const String& resourceGroup) = 0;
    00097
    00108     virtual void unloadRawDataContainer(RawDataContainer&)  { }
    00109
    00117     const String&   getDefaultResourceGroup(void) const     { return d_defaultResourceGroup; }
    00118
    00129     void    setDefaultResourceGroup(const String& resourceGroup)    { d_defaultResourceGroup = resourceGroup; }
    00130
    00134     virtual size_t getResourceGroupFileNames(std::vector<String>& out_vec,
    00135                                              const String& file_pattern,
    00136                                              const String& resource_group) = 0;
    00137 protected:
    00138     String  d_defaultResourceGroup;
    00139 };
    00140
    00141 } // End of  CEGUI namespace section
    00142
    00143 #endif  // end of guard _CEGUIResourceProvider_h_