summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/datatransfer/XMimeContentTypeFactory.idl
blob: 5b7df3168c3be47b3ac51fe45f8c9ac93946dd95 (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
75
76
77
78
79
80
81
82
/*************************************************************************
 *
 * 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_datatransfer_XMimeContentTypeFactory_idl__
#define __com_sun_star_datatransfer_XMimeContentTypeFactory_idl__

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

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif

#ifndef __com_sun_star_datatransfer_XMimeContentType_idl__
#include <com/sun/star/datatransfer/XMimeContentType.idl>
#endif

module com { module sun { module star { module datatransfer {

//-------------------------------------------------------------------------
/** Implementations of this interface do create a
    <type scope="com::sun::star::datatransfer">XMimeContentType</type> from
    a given string that represents a MIME content-type
    (see <a href="ftp://ftp.isi.edu/in-notes/rfc2045.txt">Rfc2045</a> and
    <a href="ftp://ftp.isi.edu/in-notes/rfc2046.txt">Rfc2046</a>).

*/
published interface XMimeContentTypeFactory : com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** Creates an object that implements <type>XMimeContentType</type>.

        @param aContentType
        A string that represents a MIME content-type as specified in
        <a href="ftp://ftp.isi.edu/in-notes/rfc2045.txt">Rfc2045</a> and
        <a href="ftp://ftp.isi.edu/in-notes/rfc2046.txt">Rfc2046</a>.

        @returns
        An object that implements <type>XMimeContentType</type>.

        @throws com::sun::star::lang::IllegalArgumentException
        if the string does not conform to
        <a href="ftp://ftp.isi.edu/in-notes/rfc2045.txt">Rfc2045</a> and
        <a href="ftp://ftp.isi.edu/in-notes/rfc2046.txt">Rfc2046</a>;
        <p><strong>Exception:</strong> Quoted parameter values may contain spaces.</p>

        @see com::sun::star::datatransfer::XMimeContentType
    */
    com::sun::star::datatransfer::XMimeContentType createMimeContentType( [in] string aContentType )
        raises ( com::sun::star::lang::IllegalArgumentException );
};

}; }; }; };

#endif