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