aboutsummaryrefslogtreecommitdiff
path: root/backends/vkeybd/imageman.h
diff options
context:
space:
mode:
authorAndre Heider2009-01-20 15:24:47 +0000
committerAndre Heider2009-01-20 15:24:47 +0000
commit15b3c680da7cef0490f6b737d70eebb737bf6619 (patch)
treeb6bf5d4d253aaa9a191592ce1ae999f9b656498d /backends/vkeybd/imageman.h
parent311b267863d6c0202e5723504e98aa78206763e2 (diff)
downloadscummvm-rg350-15b3c680da7cef0490f6b737d70eebb737bf6619.tar.gz
scummvm-rg350-15b3c680da7cef0490f6b737d70eebb737bf6619.tar.bz2
scummvm-rg350-15b3c680da7cef0490f6b737d70eebb737bf6619.zip
added ImageMan to vkeybd
svn-id: r35952
Diffstat (limited to 'backends/vkeybd/imageman.h')
-rw-r--r--backends/vkeybd/imageman.h111
1 files changed, 111 insertions, 0 deletions
diff --git a/backends/vkeybd/imageman.h b/backends/vkeybd/imageman.h
new file mode 100644
index 0000000000..f555b4c844
--- /dev/null
+++ b/backends/vkeybd/imageman.h
@@ -0,0 +1,111 @@
+/* ScummVM - Graphic Adventure Engine
+ *
+ * ScummVM is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * $URL$
+ * $Id$
+ */
+
+#ifndef GRAPHICS_IMAGEMAN_H
+#define GRAPHICS_IMAGEMAN_H
+
+#include "common/scummsys.h"
+
+#include "common/archive.h"
+#include "common/singleton.h"
+#include "common/str.h"
+#include "common/list.h"
+
+namespace Graphics {
+
+struct Surface;
+
+class ImageManager : public Common::Singleton<ImageManager> {
+public:
+ ~ImageManager();
+
+ /**
+ * adds an .zip archive to the pool where the ImageManager searches
+ * for image files
+ *
+ * @param name the name of the archive
+ * @return true on success and false on failure
+ */
+ bool addArchive(const Common::String &name);
+
+ /**
+ * deletes an .zip archive from the pool where the Image Manager searches
+ * for image files
+ *
+ * @param name the name of the archive
+ */
+ void removeArchive(const Common::String &name);
+
+ /**
+ * registers a surface to the ImageManager.
+ * surf->free(), also delete surf, will be called when the ImageManager will
+ * be destroyed or if ImageManager::unregisterSurface is called.
+ * if the parameter 'surf' is 0 the Manger will try to load an image with
+ * the filename 'name'
+ *
+ * @param name the name of the new handle
+ * @param surf the surface which should be associated to the given name
+ * @return returns true on success and false on failure
+ */
+ bool registerSurface(const Common::String &name, Surface *surf);
+
+ /**
+ * unregisters a surface, after this the returned surface from
+ * getSurface should NOT be used anymore
+ *
+ * @param name the handle
+ * @return true on success, false on failure
+ */
+ bool unregisterSurface(const Common::String &name);
+
+ /**
+ * gets a surface registered to a handle
+ *
+ * @param name the name of the handle
+ * @return returns an pointer to an Surface object or 0 on failure
+ */
+ Surface *getSurface(const Common::String &name);
+private:
+ friend class Common::Singleton<SingletonBaseType>;
+ ImageManager();
+
+ struct Entry {
+ Common::String name;
+ Surface *surface;
+ };
+ typedef Common::List<Entry*>::iterator Iterator;
+
+ Iterator searchHandle(const Common::String &name);
+
+ Common::List<Entry*> _surfaces;
+ Common::SearchSet _archives;
+};
+
+} // end of namespace Graphics
+
+/** Shortcut for accessing the image manager. */
+#define ImageMan (Graphics::ImageManager::instance())
+
+#endif
+