offapi/com/sun/star/sdb/DocumentContainer.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
  20
  21  module com {  module sun {  module star {  module lang {
  22  published interface XMultiServiceFactory;
  23 };};};};
  24
  25  module com {  module sun {  module star {  module frame {
  26  published interface XComponentLoader;
  27 };};};};
  28
  29   module com {  module sun {  module star {  module container {
  30  published interface XHierarchicalNameContainer;
  31 };};};};
  32
  33
  34  module com {  module sun {  module star {  module sdb {
  35
  36
  37 /** describes a container which provides access to documents embedded into a database document,
  38     usually forms and reports.
  39
  40     <p>The com::sun::star::lang::XMultiServiceFactory::createInstanceWithArguments()
  41     should be used to create sub document container or form, or report objects.</p>
  42
  43     <p>The embedded documents do not support any particular database related service, instead, they're
  44     usual com::sun::star::document::OfficeDocuments.<br/>
  45     The only thing worth mentioning here is that they support the
  46     com::sun::star::container::XChild interface, whose
  47     com::sun::star::container::XChild::getParent() method can be used to
  48     obtain the database document which the embedded document belongs to.
  49     </p>
  50
  51     @see DocumentDefinition
  52     @see OfficeDatabaseDocument
  53  */
  54 service DocumentContainer
  55 {
  56     service DefinitionContainer;
  57
  58     /** provides functionality for treating the container as part of a hierarchy
  59         of a database document's sub documents.
  60
  61         <p>The com::sun::star::ucb::XCommandProcessor::execute() method
  62         of a <code>DocumentDefinition</code> supports at least the following commands, additionally to
  63         the ones already supported by the DefinitionContent:
  64         <ul>
  65             <li><strong>open</strong>: provides a com::sun::star::ucb::XDynamicResultSet
  66                 to enumerate the content of the document container.</li>
  67             <li><strong>delete</strong>: deletes the document container, including all contained documents.</li>
  68         </ul>
  69     */
  70     service DefinitionContent;
  71
  72     /** can be used to load the document inside.
  73         <p>
  74         URL: describes the name of the document definition to load,
  75         TargetFrameName: isn't used.
  76         SearchFlags: isn't used.
  77         Arguments:
  78         <ol>
  79             <li>PropertyValue</li>
  80                 Name = ActiveConnection
  81                 Value = The connection which should be used when opening the text document.
  82             <li>PropertyValue</li>
  83                 Name = OpenMode
  84                 Value = string, "open" if the document should be opened in live mode (editing is not possible),
  85                                 "openDesign" if the document should be open in design mode (editing is possible)
  86         </ol>
  87         @see com::sun::star::sdbc::XConnection
  88         </p>
  89     */
  90     interface com::sun::star::frame::XComponentLoader;
  91
  92     /** can be used to create container elements.
  93         <p>
  94         If this interface is supported, the object created using it (e.g., the object returned by
  95         com.sun.star.lang::XMultiServiceFactory::createInstanceWithArguments()
  96         ) can be used as container elements.
  97         </p>
  98      */
  99     interface com::sun::star::lang::XMultiServiceFactory;
 100
 101     /** can be used to create folder hierarchies and to organize forms or reports in different sub folders.
 102     */
 103     interface com::sun::star::container::XHierarchicalNameContainer;
 104 };
 105
 106
 107 }; }; }; };
 108
 109 /*===========================================================================
 110 ===========================================================================*/
 111
 112 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */