offapi/com/sun/star/embed/XEncryptionProtectedSource.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_XEncryptionProtectedSource_idl__
  20 #define __com_sun_star_embed_XEncryptionProtectedSource_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/io/IOException.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 published interface XEncryptionProtectedSource: com::sun::star::uno::XInterface
  31 {
  32     /** sets a password for the object.
  33
  34     @param sPassword
  35         the new password
  36
  37     @throws ::com::sun::star::io::IOException
  38         in case password could not be set
  39      */
  40     void setEncryptionPassword( [in] string sPassword )
  41         raises( ::com::sun::star::io::IOException );
  42
  43     /** removes encryption from the object.
  44
  45     @throws ::com::sun::star::io::IOException
  46         in case encryption could not be removed
  47      */
  48     void removeEncryption()
  49         raises( ::com::sun::star::io::IOException );
  50 };
  51
  52
  53 }; }; }; };
  54
  55 #endif
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */