Line data    Source code

       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 <sal/types.h>
      24             : 
      25             : namespace vcl { class Window; }
      26             : 
      27             : namespace sd {
      28             : 
      29             : class FrameView;
      30             : 
      31             : typedef sal_Int32 ShellId;
      32             : // This shell id is a reserved value and does not specify any valid shell.
      33             : static const sal_Int32 snInvalidShellId = -1;
      34             : 
      35             : template<class ShellType>
      36         550 : class ShellFactory
      37             : {
      38             : public:
      39             :     /** This abstract virtual class needs a destructor so that the
      40             :         destructors of derived classes are called.
      41             :     */
      42         550 :     virtual ~ShellFactory (void) {};
      43             : 
      44             :     /** Create a new instance of a view shell for the given id that will
      45             :         be stacked onto the given view shell base.
      46             :         @return
      47             :             Return the new view shell or NULL when a creation is not
      48             :             possible.
      49             :         */
      50             :     virtual ShellType* CreateShell (
      51             :         ShellId nId,
      52             :         vcl::Window* pParentWindow,
      53             :         FrameView* pFrameView = NULL) = 0;
      54             : 
      55             :     /** Tell the factory that a shell is no longer in use.  It may destroy
      56             :         it or put it for future use in a cache.
      57             :     */
      58             :     virtual void ReleaseShell (ShellType* pShell) = 0;
      59             : };
      60             : 
      61             : } // end of namespace sd
      62             : 
      63             : #endif
      64             : 
      65             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */