offapi/com/sun/star/ucb/XContentCreator.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_ucb_XContentCreator_idl__
  20 #define __com_sun_star_ucb_XContentCreator_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/ucb/ContentInfo.idl>
  24 #include <com/sun/star/ucb/XContent.idl>
  25
  26
  27
  28 module com { module sun { module star { module ucb {
  29
  30 /** A creator for new (persistent) contents, like file system folders.
  31
  32     <p>Creation of a new (persistent) content:
  33     <ol>
  34         <li>creatabletypes = creator.queryCreatableContentsInfo()
  35         <li>choose a suitable type from creatabletypes
  36         <li>newObject = creator.createNewContent( type )
  37         <li>initialize the new object (i.e. newObject.Property1 = ...)
  38         <li>let the new content execute the command "insert". That command
  39             commits the data and makes the new content persistent.
  40     </ol>
  41
  42     @deprecated
  43
  44     <p>This interface is deprecated.  Use Content property
  45        "CreatableContentsInfo" and command "createNewContent" instead.
  46
  47     @version  1.0
  48     @author   Kai Sommerfeld
  49     @see      XContent
  50     @see      XCommandProcessor
  51 */
  52 published interface XContentCreator: com::sun::star::uno::XInterface
  53 {
  54     /** returns a list with information about the creatable contents.
  55
  56         @returns
  57         the list with information about the creatable contents.
  58     */
  59     sequence<com::sun::star::ucb::ContentInfo> queryCreatableContentsInfo();
  60
  61     /** creates a new content of given type.
  62
  63         @param Info
  64         the content information.
  65
  66         @returns
  67         the new content, if operation was successful.
  68     */
  69     com::sun::star::ucb::XContent createNewContent(
  70                         [in] com::sun::star::ucb::ContentInfo Info );
  71 };
  72
  73
  74 }; }; }; };
  75
  76 #endif
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */