include/oox/helper/zipstorage.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_OOX_HELPER_ZIPSTORAGE_HXX
  21 #define INCLUDED_OOX_HELPER_ZIPSTORAGE_HXX
  22
  23 #include <oox/helper/storagebase.hxx>
  24
  25 namespace com { namespace sun { namespace star {
  26     namespace uno { class XComponentContext; }
  27 } } }
  28
  29 namespace oox {
  30
  31
  32
  33 /** Implements stream access for ZIP storages containing XML streams. */
  34 class ZipStorage : public StorageBase
  35 {
  36 public:
  37     explicit            ZipStorage(
  38                             const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& rxContext,
  39                             const ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >& rxInStream );
  40
  41     explicit            ZipStorage(
  42                             const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& rxContext,
  43                             const ::com::sun::star::uno::Reference< ::com::sun::star::io::XStream >& rxStream );
  44
  45     virtual             ~ZipStorage();
  46
  47 private:
  48     explicit            ZipStorage(
  49                             const ZipStorage& rParentStorage,
  50                             const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& rxStorage,
  51                             const OUString& rElementName );
  52
  53     /** Returns true, if the object represents a valid storage. */
  54     virtual bool        implIsStorage() const SAL_OVERRIDE;
  55
  56     /** Returns the com.sun.star.embed.XStorage interface of the current storage. */
  57     virtual ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >
  58                         implGetXStorage() const SAL_OVERRIDE;
  59
  60     /** Returns the names of all elements of this storage. */
  61     virtual void        implGetElementNames( ::std::vector< OUString >& orElementNames ) const SAL_OVERRIDE;
  62
  63     /** Opens and returns the specified sub storage from the storage. */
  64     virtual StorageRef  implOpenSubStorage( const OUString& rElementName, bool bCreateMissing ) SAL_OVERRIDE;
  65
  66     /** Opens and returns the specified input stream from the storage. */
  67     virtual ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >
  68                         implOpenInputStream( const OUString& rElementName ) SAL_OVERRIDE;
  69
  70     /** Opens and returns the specified output stream from the storage. */
  71     virtual ::com::sun::star::uno::Reference< ::com::sun::star::io::XOutputStream >
  72                         implOpenOutputStream( const OUString& rElementName ) SAL_OVERRIDE;
  73
  74     /** Commits the current storage. */
  75     virtual void        implCommit() const SAL_OVERRIDE;
  76
  77 private:
  78     ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >
  79                         mxStorage;      ///< Storage based on input or output stream.
  80 };
  81
  82
  83
  84 } // namespace oox
  85
  86 #endif
  87
  88 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */