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 INCLUDED_SD_SOURCE_UI_INC_SHELLFACTORY_HXX
  21 #define INCLUDED_SD_SOURCE_UI_INC_SHELLFACTORY_HXX
  22
  23 #include <sfx2/toolbarids.hxx>
  24
  25 namespace sd {
  26
  27 typedef ToolbarId ShellId;
  28
  29 template<class ShellType>
  30 class ShellFactory
  31 {
  32 public:
  33     /** This abstract virtual class needs a destructor so that the
  34         destructors of derived classes are called.
  35     */
  36     virtual ~ShellFactory() {};
  37
  38     /** Create a new instance of a view shell for the given id that will
  39         be stacked onto the given view shell base.
  40         @return
  41             Return the new view shell or NULL when a creation is not
  42             possible.
  43         */
  44     virtual ShellType* CreateShell(ShellId nId) = 0;
  45
  46     /** Tell the factory that a shell is no longer in use.  It may destroy
  47         it or put it for future use in a cache.
  48     */
  49     virtual void ReleaseShell (ShellType* pShell) = 0;
  50 };
  51
  52 } // end of namespace sd
  53
  54 #endif
  55
  56 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */