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