xref: /trunk/main/offapi/com/sun/star/ucb/XContentCreator.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir/*************************************************************************
2*cdf0e10cSrcweir *
3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir *
5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir *
7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir *
9*cdf0e10cSrcweir * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir *
11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir *
15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir *
21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir *
26*cdf0e10cSrcweir ************************************************************************/
27*cdf0e10cSrcweir#ifndef __com_sun_star_ucb_XContentCreator_idl__
28*cdf0e10cSrcweir#define __com_sun_star_ucb_XContentCreator_idl__
29*cdf0e10cSrcweir
30*cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__
31*cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl>
32*cdf0e10cSrcweir#endif
33*cdf0e10cSrcweir
34*cdf0e10cSrcweir#ifndef __com_sun_star_ucb_ContentInfo_idl__
35*cdf0e10cSrcweir#include <com/sun/star/ucb/ContentInfo.idl>
36*cdf0e10cSrcweir#endif
37*cdf0e10cSrcweir
38*cdf0e10cSrcweir#ifndef __com_sun_star_ucb_XContent_idl__
39*cdf0e10cSrcweir#include <com/sun/star/ucb/XContent.idl>
40*cdf0e10cSrcweir#endif
41*cdf0e10cSrcweir
42*cdf0e10cSrcweir
43*cdf0e10cSrcweir//=============================================================================
44*cdf0e10cSrcweir
45*cdf0e10cSrcweirmodule com { module sun { module star { module ucb {
46*cdf0e10cSrcweir
47*cdf0e10cSrcweir//=============================================================================
48*cdf0e10cSrcweir/** A creator for new (persistent) contents, like file system folders.
49*cdf0e10cSrcweir
50*cdf0e10cSrcweir    <p>Creation of a new (persistent) content:
51*cdf0e10cSrcweir    <ol>
52*cdf0e10cSrcweir        <li>creatabletypes = creator.queryCreatableContentsInfo()
53*cdf0e10cSrcweir        <li>choose a suitable type from creatabletypes
54*cdf0e10cSrcweir        <li>newObject = creator.createNewContent( type )
55*cdf0e10cSrcweir        <li>initialize the new object (i.e. newObject.Property1 = ...)
56*cdf0e10cSrcweir        <li>let the new content execute the command "insert". That command
57*cdf0e10cSrcweir            commits the data and makes the new content persistent.
58*cdf0e10cSrcweir    </ol>
59*cdf0e10cSrcweir
60*cdf0e10cSrcweir    @deprecated
61*cdf0e10cSrcweir
62*cdf0e10cSrcweir    <p>This interface is deprecated.  Use <type>Content</type> property
63*cdf0e10cSrcweir       "CreatableContentsInfo" and command "createNewContent" instead.
64*cdf0e10cSrcweir
65*cdf0e10cSrcweir    @version  1.0
66*cdf0e10cSrcweir    @author   Kai Sommerfeld
67*cdf0e10cSrcweir    @see      XContent
68*cdf0e10cSrcweir    @see      XCommandProcessor
69*cdf0e10cSrcweir*/
70*cdf0e10cSrcweirpublished interface XContentCreator: com::sun::star::uno::XInterface
71*cdf0e10cSrcweir{
72*cdf0e10cSrcweir    //-------------------------------------------------------------------------
73*cdf0e10cSrcweir    /** returns a list with information about the creatable contents.
74*cdf0e10cSrcweir
75*cdf0e10cSrcweir        @returns
76*cdf0e10cSrcweir        the list with information about the creatable contents.
77*cdf0e10cSrcweir    */
78*cdf0e10cSrcweir    sequence<com::sun::star::ucb::ContentInfo> queryCreatableContentsInfo();
79*cdf0e10cSrcweir
80*cdf0e10cSrcweir    //-------------------------------------------------------------------------
81*cdf0e10cSrcweir    /** creates a new content of given type.
82*cdf0e10cSrcweir
83*cdf0e10cSrcweir        @param Info
84*cdf0e10cSrcweir        the content information.
85*cdf0e10cSrcweir
86*cdf0e10cSrcweir        @returns
87*cdf0e10cSrcweir        the new content, if operation was successful.
88*cdf0e10cSrcweir    */
89*cdf0e10cSrcweir    com::sun::star::ucb::XContent createNewContent(
90*cdf0e10cSrcweir                        [in] com::sun::star::ucb::ContentInfo Info );
91*cdf0e10cSrcweir};
92*cdf0e10cSrcweir
93*cdf0e10cSrcweir//=============================================================================
94*cdf0e10cSrcweir
95*cdf0e10cSrcweir}; }; }; };
96*cdf0e10cSrcweir
97*cdf0e10cSrcweir#endif
98