include/sfx2/viewfac.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 #pragma once
  20
  21 #include <rtl/ustring.hxx>
  22 #include <sal/config.h>
  23 #include <sfx2/dllapi.h>
  24 #include <sfx2/shell.hxx>
  25
  26 class SfxViewFrame;
  27 class SfxViewShell;
  28
  29 typedef SfxViewShell* (*SfxViewCtor)(SfxViewFrame&, SfxViewShell*);
  30
  31 // CLASS -----------------------------------------------------------------
  32 class SFX2_DLLPUBLIC SfxViewFactory
  33 {
  34 public:
  35     SfxViewFactory( SfxViewCtor fnC,
  36                     SfxInterfaceId nOrdinal, const char* asciiViewName );
  37
  38     SfxViewShell*  CreateInstance(SfxViewFrame& rViewFrame, SfxViewShell *pOldSh);
  39     SfxInterfaceId GetOrdinal() const { return nOrd; }
  40
  41     /// returns a legacy view name. This is "view" with an appended ordinal/ID.
  42     OUString      GetLegacyViewName() const;
  43
  44     /** returns an API-compatible view name.
  45
  46         For details on which view names are specified, see the XModel2.getAvailableViewControllerNames
  47         documentation.
  48     */
  49     OUString      GetAPIViewName() const;
  50
  51 private:
  52     SfxViewCtor     fnCreate;
  53     SfxInterfaceId  nOrd;
  54     const OUString  m_sViewName;
  55 };
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */