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