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