WindowManager.hpp

00001 /*******************************************************************************
00002 * Copyright (C) Maxim Integrated Products, Inc., All Rights Reserved.
00003 *
00004 * Permission is hereby granted, free of charge, to any person obtaining a
00005 * copy of this software and associated documentation files (the "Software"),
00006 * to deal in the Software without restriction, including without limitation
00007 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
00008 * and/or sell copies of the Software, and to permit persons to whom the
00009 * Software is furnished to do so, subject to the following conditions:
00010 *
00011 * The above copyright notice and this permission notice shall be included
00012 * in all copies or substantial portions of the Software.
00013 *
00014 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
00015 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00017 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
00018 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00019 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00020 * OTHER DEALINGS IN THE SOFTWARE.
00021 *
00022 * Except as contained in this notice, the name of Maxim Integrated
00023 * Products, Inc. shall not be used except as stated in the Maxim Integrated
00024 * Products, Inc. Branding Policy.
00025 *
00026 * The mere transfer of this software does not imply any licenses
00027 * of trade secrets, proprietary technology, copyrights, patents,
00028 * trademarks, maskwork rights, or any other form of intellectual
00029 * property whatsoever. Maxim Integrated Products, Inc. retains all
00030 * ownership rights.
00031 *******************************************************************************/
00032 
00033 #ifndef WINDOWMANAGER_HPP
00034 #define WINDOWMANAGER_HPP
00035 
00036 #include <memory>
00037 #include <vector>
00038 #include "Keys.hpp"
00039 #include "Window.hpp"
00040 
00041 class Bitmap;
00042 
00043 /// Stack based window manager.
00044 class WindowManager {
00045 public:
00046   /// @param canvas Canvas to use for rendering.
00047   WindowManager (Bitmap & canvas) : canvas(canvas) {}
00048 
00049   ~WindowManager();
00050 
00051   /// @brief Push a window onto the top of the stack.
00052   /// @details The operation will be queued until the next update.
00053   /// @param window
00054   /// Heap allocated object that WindowManager will take ownership of.
00055   void push(std::auto_ptr<Window> & window);
00056 
00057   /// @brief Pop a window from the top of the stack.
00058   /// @details
00059   /// The operation will be queued until the next update. The popped window
00060   /// will be deleted.
00061   void pop();
00062 
00063   /// @brief Updates all windows and redraws the top window if invalid.
00064   /// @returns True if the canvas has been updated.
00065   bool update();
00066 
00067   /// Forwards a key-press input event to the top window for processing.
00068   void processKey(Key key);
00069 
00070 private:
00071   void processAction(Window * window);
00072 
00073   Bitmap & canvas;
00074   std::vector<Window *> windowStack;
00075   std::vector<Window *> actionQueue;
00076 
00077   // Uncopyable
00078   WindowManager (const WindowManager &);
00079   const WindowManager & operator=(const WindowManager &);
00080 };
00081 
00082 #endif