offapi/com/sun/star/embed/XEncryptionProtectedSource2.idl

   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 #ifndef __com_sun_star_embed_XEncryptionProtectedSource2_idl__
  20 #define __com_sun_star_embed_XEncryptionProtectedSource2_idl__
  21
  22 #include <com/sun/star/embed/XEncryptionProtectedSource.idl>
  23 #include <com/sun/star/beans/NamedValue.idl>
  24
  25
  26 module com {  module sun {  module star {  module embed {
  27
  28 /** This interface allows to set a password for an object.
  29
  30     @since OOo 3.4
  31  */
  32 interface XEncryptionProtectedSource2: XEncryptionProtectedSource
  33 {
  34     /** sets an encryption data for the object.
  35
  36         @param aEncryptionData
  37             the new encryption data
  38
  39         @throws ::com::sun::star::io::IOException
  40             in case the data could not be set
  41      */
  42     void setEncryptionData( [in] sequence< ::com::sun::star::beans::NamedValue > aEncryptionData )
  43         raises( ::com::sun::star::io::IOException );
  44
  45     /** determine if an encryption data is set for this object.
  46
  47         @return
  48             true if some encryption data was set, false otherwise
  49      */
  50     boolean hasEncryptionData();
  51 };
  52
  53
  54 }; }; }; };
  55
  56 #endif
  57
  58 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */