sd/source/ui/inc/ShellFactory.hxx

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