summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/ucb/XContentCreator.idl
blob: 1d144a70fbdf7ea3e772bef73f3ce172013d5ec4 (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
83
84
85
86
87
88
89
90
91
92
93
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XContentCreator.idl,v $
 * $Revision: 1.10 $
 *
 * 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_ucb_XContentCreator_idl__
#define __com_sun_star_ucb_XContentCreator_idl__

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

#ifndef __com_sun_star_ucb_ContentInfo_idl__
#include <com/sun/star/ucb/ContentInfo.idl>
#endif

#ifndef __com_sun_star_ucb_XContent_idl__
#include <com/sun/star/ucb/XContent.idl>
#endif


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

module com { module sun { module star { module ucb {

//=============================================================================
/** A creator for new (persistent) contents, like file system folders.

    <p>Creation of a new (persistent) content:
    <ol>
        <li>newObject = creator.createNewContent( ... )
        <li>initialize the new object (i.e. newObject.Property1 = ...)
        <li>let the new content execute the command "insert". That command
            commits the data and makes the new content persistent.
    </ol>

    @version  1.0
    @author   Kai Sommerfeld
    @see      XContent
    @see      XCommandProcessor
*/
published interface XContentCreator: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /**	returns a list with information about the creatable contents.

        @returns
        the list with information about the creatable contents.
    */
    sequence<com::sun::star::ucb::ContentInfo> queryCreatableContentsInfo();

    //-------------------------------------------------------------------------
    /**	creates a new content of given type..

        @param Info
        the content information.

        @returns
        the new content, if operation was succesful.
    */
    com::sun::star::ucb::XContent createNewContent(
                        [in] com::sun::star::ucb::ContentInfo Info );
};

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

}; }; }; };

#endif