1*c45d927aSAndrew Rist /************************************************************** 2cdf0e10cSrcweir * 3*c45d927aSAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*c45d927aSAndrew Rist * or more contributor license agreements. See the NOTICE file 5*c45d927aSAndrew Rist * distributed with this work for additional information 6*c45d927aSAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*c45d927aSAndrew Rist * to you under the Apache License, Version 2.0 (the 8*c45d927aSAndrew Rist * "License"); you may not use this file except in compliance 9*c45d927aSAndrew Rist * with the License. You may obtain a copy of the License at 10cdf0e10cSrcweir * 11*c45d927aSAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12cdf0e10cSrcweir * 13*c45d927aSAndrew Rist * Unless required by applicable law or agreed to in writing, 14*c45d927aSAndrew Rist * software distributed under the License is distributed on an 15*c45d927aSAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*c45d927aSAndrew Rist * KIND, either express or implied. See the License for the 17*c45d927aSAndrew Rist * specific language governing permissions and limitations 18*c45d927aSAndrew Rist * under the License. 19cdf0e10cSrcweir * 20*c45d927aSAndrew Rist *************************************************************/ 21*c45d927aSAndrew Rist 22*c45d927aSAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir #ifndef SD_VIEW_SHELL_FACTORY_HXX 25cdf0e10cSrcweir #define SD_VIEW_SHELL_FACTORY_HXX 26cdf0e10cSrcweir 27cdf0e10cSrcweir #include <sal/types.h> 28cdf0e10cSrcweir #include <memory> 29cdf0e10cSrcweir 30cdf0e10cSrcweir class Window; 31cdf0e10cSrcweir 32cdf0e10cSrcweir namespace sd { 33cdf0e10cSrcweir 34cdf0e10cSrcweir class FrameView; 35cdf0e10cSrcweir class ViewShell; 36cdf0e10cSrcweir 37cdf0e10cSrcweir typedef sal_Int32 ShellId; 38cdf0e10cSrcweir // This shell id is a reserved value and does not specify any valid shell. 39cdf0e10cSrcweir static const sal_Int32 snInvalidShellId = -1; 40cdf0e10cSrcweir 41cdf0e10cSrcweir template<class ShellType> 42cdf0e10cSrcweir class ShellFactory 43cdf0e10cSrcweir { 44cdf0e10cSrcweir public: 45cdf0e10cSrcweir /** This abstract virtual class needs a destructor so that the 46cdf0e10cSrcweir destructors of derived classes are called. 47cdf0e10cSrcweir */ ~ShellFactory(void)48cdf0e10cSrcweir virtual ~ShellFactory (void) {}; 49cdf0e10cSrcweir 50cdf0e10cSrcweir /** Create a new instance of a view shell for the given id that will 51cdf0e10cSrcweir be stacked onto the given view shell base. 52cdf0e10cSrcweir @return 53cdf0e10cSrcweir Return the new view shell or NULL when a creation is not 54cdf0e10cSrcweir possible. 55cdf0e10cSrcweir */ 56cdf0e10cSrcweir virtual ShellType* CreateShell ( 57cdf0e10cSrcweir ShellId nId, 58cdf0e10cSrcweir ::Window* pParentWindow, 59cdf0e10cSrcweir FrameView* pFrameView = NULL) = 0; 60cdf0e10cSrcweir 61cdf0e10cSrcweir /** Tell the factory that a shell is no longer in use. It may destroy 62cdf0e10cSrcweir it or put it for future use in a cache. 63cdf0e10cSrcweir */ 64cdf0e10cSrcweir virtual void ReleaseShell (ShellType* pShell) = 0; 65cdf0e10cSrcweir }; 66cdf0e10cSrcweir 67cdf0e10cSrcweir } // end of namespace sd 68cdf0e10cSrcweir 69cdf0e10cSrcweir #endif 70