1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef _SVT_DOCUMENTLOCKFILE_HXX 25*b1cdbd2cSJim Jagielski #define _SVT_DOCUMENTLOCKFILE_HXX 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski #include <svl/svldllapi.h> 28*b1cdbd2cSJim Jagielski 29*b1cdbd2cSJim Jagielski #include <com/sun/star/io/XStream.hpp> 30*b1cdbd2cSJim Jagielski #include <com/sun/star/io/XInputStream.hpp> 31*b1cdbd2cSJim Jagielski #include <com/sun/star/io/XOutputStream.hpp> 32*b1cdbd2cSJim Jagielski #include <com/sun/star/io/XSeekable.hpp> 33*b1cdbd2cSJim Jagielski #include <com/sun/star/io/XTruncate.hpp> 34*b1cdbd2cSJim Jagielski #include <com/sun/star/lang/XMultiServiceFactory.hpp> 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski #include <svl/lockfilecommon.hxx> 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski namespace svt { 39*b1cdbd2cSJim Jagielski 40*b1cdbd2cSJim Jagielski class SVL_DLLPUBLIC DocumentLockFile : public LockFileCommon 41*b1cdbd2cSJim Jagielski { 42*b1cdbd2cSJim Jagielski // the workaround for automated testing! 43*b1cdbd2cSJim Jagielski static sal_Bool m_bAllowInteraction; 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielski ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream > OpenStream(); 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski void WriteEntryToStream( ::com::sun::star::uno::Sequence< ::rtl::OUString > aEntry, ::com::sun::star::uno::Reference< ::com::sun::star::io::XOutputStream > xStream ); 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski public: 50*b1cdbd2cSJim Jagielski DocumentLockFile( const ::rtl::OUString& aOrigURL, const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& xFactory = ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >() ); 51*b1cdbd2cSJim Jagielski ~DocumentLockFile(); 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski sal_Bool CreateOwnLockFile(); 54*b1cdbd2cSJim Jagielski ::com::sun::star::uno::Sequence< ::rtl::OUString > GetLockData(); 55*b1cdbd2cSJim Jagielski sal_Bool OverwriteOwnLockFile(); 56*b1cdbd2cSJim Jagielski void RemoveFile(); 57*b1cdbd2cSJim Jagielski 58*b1cdbd2cSJim Jagielski // the methods allow to control whether UI interaction regarding the locked document file is allowed 59*b1cdbd2cSJim Jagielski // this is a workaround for automated tests AllowInteraction(sal_Bool bAllow)60*b1cdbd2cSJim Jagielski static void AllowInteraction( sal_Bool bAllow ) { m_bAllowInteraction = bAllow; } IsInteractionAllowed()61*b1cdbd2cSJim Jagielski static sal_Bool IsInteractionAllowed() { return m_bAllowInteraction; } 62*b1cdbd2cSJim Jagielski }; 63*b1cdbd2cSJim Jagielski 64*b1cdbd2cSJim Jagielski } 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski #endif 67*b1cdbd2cSJim Jagielski 68