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