include/filter/msfilter/svxmsbas.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_FILTER_MSFILTER_SVXMSBAS_HXX
  21 #define INCLUDED_FILTER_MSFILTER_SVXMSBAS_HXX
  22
  23 #include <filter/msfilter/msfilterdllapi.h>
  24 #include <rtl/ustring.hxx>
  25 #include <sot/storage.hxx>
  26 #include <comphelper/errcode.hxx>
  27 #include <tools/ref.hxx>
  28
  29 class SfxObjectShell;
  30
  31 /* Construct with the root storage of the MS document, with bImportCode
  32  * set the visual basic code will be imported into the stardocument when Import
  33  * is called, with bCopyStorage set, the visual basic storage tree will be
  34  * copied completely into staroffice, so that any future export to a msoffice
  35  * format will retain the vba code, allowing a lossless roundtrip from
  36  * msoffice to staroffice and back.
  37  *
  38  * Setting bAsComment to true in Import will import the visual basic as a
  39  * starbasic comment. Which is currently necessary, as vb is not valid sb.
  40  *
  41  * Setting bStripped will remove the "Attribute" lines from the vb, msoffice
  42  * does this itself when it shows the vb code in the vbeditor, so this is
  43  * probably what the user expects to see when viewing the code
  44  */
  45
  46 class MSFILTER_DLLPUBLIC SvxImportMSVBasic
  47 {
  48 public:
  49     SvxImportMSVBasic(SfxObjectShell& rDocS, SotStorage& rRoot)
  50         : xRoot(&rRoot)
  51         , rDocSh(rDocS)
  52     {
  53     }
  54     // only for the export - copy or delete the saved VBA-macro-storage
  55     // form the ObjectShell
  56     // - returns a warning code if a modified basic exist, in all other
  57     //   cases return ERRCODE_NONE.
  58     ErrCode SaveOrDelMSVBAStorage(bool bSaveInto, const OUString& rStorageName);
  59
  60     // check if the MS-VBA-Storage exist in the RootStorage of the DocShell.
  61     // If it exist, then return the WarningId for losing the information.
  62     static ErrCode GetSaveWarningOfMSVBAStorage(SfxObjectShell& rDocS);
  63
  64     static OUString GetMSBasicStorageName();
  65
  66 private:
  67     rtl::Reference<SotStorage> xRoot;
  68     SfxObjectShell& rDocSh;
  69 };
  70
  71 #endif
  72
  73 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */