offapi/com/sun/star/text/XAutoTextContainer.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 module com {  module sun {  module star {  module text {
  21
  22 /** handles blocks of AutoTextEntry.
  23     @see AutoTextContainer
  24 */
  25 published interface XAutoTextContainer: com::sun::star::container::XNameAccess
  26 {
  27     /** creates a new AutoText group.
  28
  29     @param aGroupName the name of the AutoTextContainer
  30
  31     <p>The name must follow the pattern <code>groupname*pathid</code>, where:</p>
  32
  33     <ul>
  34         <li><code>groupname</code> should contain only alphanumeric characters
  35             (A-Za-z0-9), underscore (_) or space (0x20)</li>
  36         <li>an asterisk (*) delimiter separates the group name from the path
  37             identifier</li>
  38         <li><code>pathid</code> is a number (0 or 1) identifying the directory
  39         where the AutoText file is stored. Paths are stored in the Office
  40         configuration and accessed through
  41         com::sun::star::util::PathSettings::AutoText.
  42             <ul>
  43                 <li>0 indicates the path of the <b>Office Basis</b> layer</li>
  44                 <li>1 indicates the path of the <b>user</b> directory</li>
  45             </ul>
  46         </li>
  47     </ul>
  48     If only <code>groupname</code> is specified, the path defaults to 0, the
  49     <b>Office Basis</b> layer.<br>Note that in some systems the user may lack of
  50     write access to the Office Basis directory.
  51
  52     Example:
  53
  54     <ul>
  55         <li><code>standard*0</code><br>the "standard" AutoTextGroup in the Office Basis layer</li>
  56         <li><code>template</code><br>the "template" AutoTextGroup in the Office Basis layer</li>
  57         <li><code>mytexts*1</code><br>the "mytexts" AutoTextGroup in the user directory</li>
  58     </ul>
  59
  60     */
  61     com::sun::star::text::XAutoTextGroup insertNewByName( [in] string aGroupName )
  62             raises( com::sun::star::lang::IllegalArgumentException,
  63                     com::sun::star::container::ElementExistException );
  64
  65     /** deletes the specified AutoText group.
  66         @param aGroupName
  67             see the documentation for XAutoTextContainer::insertNewByName()
  68     */
  69     void removeByName( [in] string aGroupName )
  70             raises( com::sun::star::container::NoSuchElementException );
  71
  72 };
  73
  74 }; }; }; };
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */