1 /************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27 28 #ifndef SD_VIEW_SHELL_FACTORY_HXX 29 #define SD_VIEW_SHELL_FACTORY_HXX 30 31 #include <sal/types.h> 32 #include <memory> 33 34 class Window; 35 36 namespace sd { 37 38 class FrameView; 39 class ViewShell; 40 41 typedef sal_Int32 ShellId; 42 // This shell id is a reserved value and does not specify any valid shell. 43 static const sal_Int32 snInvalidShellId = -1; 44 45 template<class ShellType> 46 class ShellFactory 47 { 48 public: 49 /** This abstract virtual class needs a destructor so that the 50 destructors of derived classes are called. 51 */ 52 virtual ~ShellFactory (void) {}; 53 54 /** Create a new instance of a view shell for the given id that will 55 be stacked onto the given view shell base. 56 @return 57 Return the new view shell or NULL when a creation is not 58 possible. 59 */ 60 virtual ShellType* CreateShell ( 61 ShellId nId, 62 ::Window* pParentWindow, 63 FrameView* pFrameView = NULL) = 0; 64 65 /** Tell the factory that a shell is no longer in use. It may destroy 66 it or put it for future use in a cache. 67 */ 68 virtual void ReleaseShell (ShellType* pShell) = 0; 69 }; 70 71 } // end of namespace sd 72 73 #endif 74