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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XEncryptionProtectedSource.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_embed_XEncryptionProtectedSource_idl__
  31 #define __com_sun_star_embed_XEncryptionProtectedSource_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_io_IOException_idl__
  38 #include <com/sun/star/io/IOException.idl>
  39 #endif
  40
  41 //============================================================================
  42
  43  module com {  module sun {  module star {  module embed {
  44
  45 //============================================================================
  46 /** This interface allows to set a password for an object.
  47  */
  48 interface XEncryptionProtectedSource: com::sun::star::uno::XInterface
  49 {
  50     // -----------------------------------------------------------------------
  51     /** sets a password for the object.
  52
  53     @param sPassword
  54         the new password
  55
  56     @throws ::com::sun::star::io::IOException
  57         in case password could not be set
  58      */
  59     void setEncryptionPassword( [in] string sPassword )
  60         raises( ::com::sun::star::io::IOException );
  61
  62     // -----------------------------------------------------------------------
  63     /** removes encryption from the object.
  64
  65     @throws ::com::sun::star::io::IOException
  66         in case encryption could not be removed
  67      */
  68     void removeEncryption()
  69         raises( ::com::sun::star::io::IOException );
  70 };
  71
  72 //============================================================================
  73
  74 }; }; }; };
  75
  76 #endif
  77