offapi/com/sun/star/frame/XDocumentTemplates.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 frame {
  22
  23 /** provides a high level API to organize document templates
  24
  25     <p>
  26     Template information is saved as links to the original content
  27     and organized in groups. This data should be persistent and can be
  28     updated by calling special method XDocumentTemplates::update().
  29     A real implementation of this interface can do that on top of
  30     a ucb content provider. Method XDocumentTemplates::getContent()
  31     force that.
  32     </p>
  33  */
  34 published interface XDocumentTemplates:  com::sun::star::uno::XInterface
  35 {
  36     /** provides access to the root of internal used hierarchy
  37
  38         <p>
  39         This content can be used for accessing the groups directly.
  40         </p>
  41
  42         @return
  43             the ucb content for template configuration
  44      */
  45     com::sun::star::ucb::XContent getContent();
  46
  47     /** creates the template with the given name in the given group using the
  48         data from the storable
  49
  50         @param GroupName
  51             specifies the group
  52
  53         @param TemplateName
  54             specifies the template
  55
  56         @param Storable
  57             specifies the target
  58
  59         @return
  60             `TRUE` if operation was successful
  61             <br>
  62             `FALSE` otherwise
  63
  64         @see XDocumentTemplates::addTemplate()
  65      */
  66     boolean storeTemplate(
  67         [in] string GroupName,
  68         [in] string TemplateName,
  69         [in] XStorable Storable);
  70
  71     /** creates the template with the given name in the given group using the
  72         given URL
  73
  74         @param GroupName
  75             specifies the group
  76
  77         @param TemplateName
  78             specifies the template
  79
  80         @param SourceURL
  81             specifies the position of template
  82
  83         @return
  84             `TRUE` if operation was successful
  85             <br>
  86             `FALSE` otherwise
  87
  88         @see XDocumentTemplates::storeTemplate()
  89      */
  90     boolean addTemplate(
  91         [in] string GroupName,
  92         [in] string TemplateName,
  93         [in] string SourceURL);
  94
  95     /** remove a template from specified group
  96
  97         @param GroupName
  98             specifies the group which include the template
  99
 100         @param TemplateName
 101             specifies the template for delete
 102
 103         @return
 104             `TRUE` if operation was successful
 105             <br>
 106             `FALSE` otherwise
 107      */
 108     boolean removeTemplate(
 109         [in] string GroupName,
 110         [in] string TemplateName);
 111
 112     /** rename a template inside specified group
 113
 114         @param GroupName
 115             specifies the group which include the template
 116
 117         @param OldTemplateName
 118             specifies the template for renaming
 119
 120         @param NewTemplateName
 121             specifies the new name for the template
 122
 123         @return
 124             `TRUE` if operation was successful
 125             <br>
 126             `FALSE` otherwise
 127      */
 128     boolean renameTemplate(
 129         [in] string GroupName,
 130         [in] string OldTemplateName,
 131         [in] string NewTemplateName);
 132
 133     /** creates a new group
 134
 135         @param GroupName
 136             the name of the group to be created
 137
 138         @return
 139             `TRUE` if operation was successful
 140             <br>
 141             `FALSE` otherwise
 142     */
 143     boolean addGroup( [in] string GroupName );
 144
 145     /** remove an existing group
 146
 147         @param GroupName
 148             the name of the group to be removed
 149
 150         @return
 151             `TRUE` if operation was successful
 152             <br>
 153             `FALSE` otherwise
 154      */
 155     boolean removeGroup( [in] string GroupName );
 156
 157     /** rename an existing group
 158
 159         @param OldGroupName
 160             the old name of the group
 161
 162         @param NewGroupName
 163             the new name of the group
 164
 165         @return
 166             `TRUE` if operation was successful
 167             <br>
 168             `FALSE` otherwise
 169      */
 170     boolean renameGroup(
 171         [in] string OldGroupName,
 172         [in] string NewGroupName);
 173
 174     /** force an update for internal structures
 175
 176         <p>
 177         Because the templates are well known by links and not as direct content
 178         they can be outdated. An update force actualization of that to find
 179         wrong links.
 180         </p>
 181      */
 182     void update();
 183 };
 184
 185
 186 }; }; }; };
 187
 188 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */