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