include/svl/sharecontrolfile.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_SHARECONTROLFILE_HXX
  21 #define _SVT_SHARECONTROLFILE_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 #define SHARED_OOOUSERNAME_ID   LOCKFILE_OOOUSERNAME_ID
  34 #define SHARED_SYSUSERNAME_ID   LOCKFILE_SYSUSERNAME_ID
  35 #define SHARED_LOCALHOST_ID     LOCKFILE_LOCALHOST_ID
  36 #define SHARED_EDITTIME_ID      LOCKFILE_EDITTIME_ID
  37 #define SHARED_USERURL_ID       LOCKFILE_USERURL_ID
  38 #define SHARED_ENTRYSIZE        LOCKFILE_ENTRYSIZE
  39
  40 namespace svt {
  41
  42 class SVL_DLLPUBLIC ShareControlFile : public LockFileCommon
  43 {
  44     ::com::sun::star::uno::Reference< ::com::sun::star::io::XStream > m_xStream;
  45     ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream > m_xInputStream;
  46     ::com::sun::star::uno::Reference< ::com::sun::star::io::XOutputStream > m_xOutputStream;
  47     ::com::sun::star::uno::Reference< ::com::sun::star::io::XSeekable > m_xSeekable;
  48     ::com::sun::star::uno::Reference< ::com::sun::star::io::XTruncate > m_xTruncate;
  49
  50     ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Sequence< OUString > > m_aUsersData;
  51
  52     void OpenStream();
  53     void Close();
  54     sal_Bool IsValid()
  55     {
  56         return ( m_xStream.is() && m_xInputStream.is() && m_xOutputStream.is() && m_xSeekable.is() && m_xTruncate.is() );
  57     }
  58
  59 public:
  60
  61     // The constructor will throw exception in case the stream can not be opened
  62     ShareControlFile( const OUString& aOrigURL );
  63     ~ShareControlFile();
  64
  65     ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Sequence< OUString > > GetUsersData();
  66     void SetUsersDataAndStore( const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Sequence< OUString > >& aUserNames );
  67     ::com::sun::star::uno::Sequence< OUString > InsertOwnEntry();
  68     bool HasOwnEntry();
  69     void RemoveEntry( const ::com::sun::star::uno::Sequence< OUString >& aOptionalSpecification = ::com::sun::star::uno::Sequence< OUString >() );
  70     void RemoveFile();
  71 };
  72
  73 }
  74
  75 #endif
  76
  77 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */