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