dbaccess/source/core/inc/recovery/dbdocrecovery.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 <com/sun/star/embed/XStorage.hpp>
  23 #include <com/sun/star/frame/XController.hpp>
  24 #include <com/sun/star/uno/XComponentContext.hpp>
  25
  26 #include <vector>
  27 #include <memory>
  28
  29 namespace dbaccess
  30 {
  31
  32     // DatabaseDocumentRecovery
  33     struct DatabaseDocumentRecovery_Data;
  34     class DatabaseDocumentRecovery
  35     {
  36     public:
  37         DatabaseDocumentRecovery(
  38             const css::uno::Reference< css::uno::XComponentContext >& i_rContext
  39         );
  40         ~DatabaseDocumentRecovery();
  41
  42         /** saves the modified sub components of the given controller(s) to the "recovery" sub storage of the document
  43             storage.
  44
  45             @throws css::uno::Exception
  46                 in case of an error.
  47         */
  48         void saveModifiedSubComponents(
  49                 const css::uno::Reference< css::embed::XStorage >& i_rTargetStorage,
  50                 const std::vector< css::uno::Reference< css::frame::XController > >& i_rControllers
  51             );
  52
  53         /** recovery sub components from the given document storage, if applicable
  54
  55             If the given document storage does not contain a recovery folder, the method silently returns.
  56
  57             @throws css::uno::Exception
  58                 in case of an error.
  59         */
  60         void recoverSubDocuments(
  61                 const css::uno::Reference< css::embed::XStorage >& i_rDocumentStorage,
  62                 const css::uno::Reference< css::frame::XController >& i_rTargetController
  63             );
  64
  65     private:
  66         const std::unique_ptr< DatabaseDocumentRecovery_Data >  m_pData;
  67     };
  68
  69 } // namespace dbaccess
  70
  71 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */