sd/source/ui/inc/ShellFactory.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef SD_VIEW_SHELL_FACTORY_HXX
  21 #define SD_VIEW_SHELL_FACTORY_HXX
  22
  23 #include <sal/types.h>
  24 #include <memory>
  25
  26 class Window;
  27
  28 namespace sd {
  29
  30 class FrameView;
  31
  32 typedef sal_Int32 ShellId;
  33 // This shell id is a reserved value and does not specify any valid shell.
  34 static const sal_Int32 snInvalidShellId = -1;
  35
  36 template<class ShellType>
  37 class ShellFactory
  38 {
  39 public:
  40     /** This abstract virtual class needs a destructor so that the
  41         destructors of derived classes are called.
  42     */
  43     virtual ~ShellFactory (void) {};
  44
  45     /** Create a new instance of a view shell for the given id that will
  46         be stacked onto the given view shell base.
  47         @return
  48             Return the new view shell or NULL when a creation is not
  49             possible.
  50         */
  51     virtual ShellType* CreateShell (
  52         ShellId nId,
  53         ::Window* pParentWindow,
  54         FrameView* pFrameView = NULL) = 0;
  55
  56     /** Tell the factory that a shell is no longer in use.  It may destroy
  57         it or put it for future use in a cache.
  58     */
  59     virtual void ReleaseShell (ShellType* pShell) = 0;
  60 };
  61
  62 } // end of namespace sd
  63
  64 #endif
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */