include/svl/documentlockfile.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 _SVT_DOCUMENTLOCKFILE_HXX
  21 #define _SVT_DOCUMENTLOCKFILE_HXX
  22
  23 #include <svl/svldllapi.h>
  24
  25 #include <com/sun/star/io/XStream.hpp>
  26 #include <com/sun/star/io/XInputStream.hpp>
  27 #include <com/sun/star/io/XOutputStream.hpp>
  28 #include <com/sun/star/io/XSeekable.hpp>
  29 #include <com/sun/star/io/XTruncate.hpp>
  30
  31 #include <svl/lockfilecommon.hxx>
  32
  33 namespace svt {
  34
  35 class SVL_DLLPUBLIC DocumentLockFile : public LockFileCommon
  36 {
  37     // the workaround for automated testing!
  38     static bool m_bAllowInteraction;
  39
  40     ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream > OpenStream();
  41
  42     void WriteEntryToStream( ::com::sun::star::uno::Sequence< OUString > aEntry, ::com::sun::star::uno::Reference< ::com::sun::star::io::XOutputStream > xStream );
  43
  44 public:
  45     DocumentLockFile( const OUString& aOrigURL );
  46     ~DocumentLockFile();
  47
  48     bool CreateOwnLockFile();
  49     ::com::sun::star::uno::Sequence< OUString > GetLockData();
  50     bool OverwriteOwnLockFile();
  51     void RemoveFile();
  52
  53     // the methods allow to control whether UI interaction regarding the locked document file is allowed
  54     // this is a workaround for automated tests
  55     static void AllowInteraction( bool bAllow ) { m_bAllowInteraction = bAllow; }
  56     static bool IsInteractionAllowed() { return m_bAllowInteraction; }
  57 };
  58
  59 }
  60
  61 #endif
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */