summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/embed/XEncryptionProtectedSource.idl
blob: c31cab6c378dd6b1f252dc71da29f596c6447ccd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_embed_XEncryptionProtectedSource_idl__
#define __com_sun_star_embed_XEncryptionProtectedSource_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_io_IOException_idl__
#include <com/sun/star/io/IOException.idl>
#endif

//============================================================================

 module com {  module sun {  module star {  module embed {

//============================================================================
/** This interface allows to set a password for an object.
 */
published interface XEncryptionProtectedSource: com::sun::star::uno::XInterface
{
    // -----------------------------------------------------------------------
    /** sets a password for the object.

    @param sPassword
        the new password

    @throws ::com::sun::star::io::IOException
        in case password could not be set
     */
    void setEncryptionPassword( [in] string sPassword )
        raises( ::com::sun::star::io::IOException );
    
    // -----------------------------------------------------------------------
    /** removes encryption from the object.

    @throws ::com::sun::star::io::IOException
        in case encryption could not be removed
     */
    void removeEncryption()
        raises( ::com::sun::star::io::IOException );
};

//============================================================================

}; }; }; };

#endif