offapi/com/sun/star/configuration/XTemplateInstance.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 configuration {
  22
  23
  24 /** is implemented by objects that are instances of a named template to provide
  25     information about the template.
  26
  27     <p> Template names are similar to service names, but apply to structure and
  28         content, rather than to type.
  29     </p>
  30     <p> Often a template description can be retrieved from a repository and then be
  31         interpreted by a factory object. Templates provide a means to build
  32         new kinds of objects dynamically.
  33     </p>
  34
  35     @see XTemplateContainer
  36  */
  37 published interface XTemplateInstance: com::sun::star::uno::XInterface
  38 {
  39
  40     /** retrieves the name of the template
  41
  42         @returns
  43             the name of the template this object was built from or conforms to.
  44      */
  45     string getTemplateName();
  46
  47 };
  48
  49
  50 }; }; }; };
  51
  52 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */