offapi/com/sun/star/text/XAutoTextGroup.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_XAutoTextGroup_idl__
  20 #define __com_sun_star_text_XAutoTextGroup_idl__
  21
  22 #include <com/sun/star/container/XNameAccess.idl>
  23
  24 #include <com/sun/star/lang/IllegalArgumentException.idl>
  25
  26 #include <com/sun/star/container/ElementExistException.idl>
  27
  28 #include <com/sun/star/io/IOException.idl>
  29
  30 #include <com/sun/star/text/XAutoTextEntry.idl>
  31
  32 #include <com/sun/star/text/XTextRange.idl>
  33
  34 #include <com/sun/star/container/NoSuchElementException.idl>
  35
  36
  37
  38  module com {  module sun {  module star {  module text {
  39
  40 /** The interface provide methods to insert, rename and delete autotext entries from the current autotext group.
  41  */
  42 published interface XAutoTextGroup: com::sun::star::container::XNameAccess
  43 {
  44     /** returns the titles of all autotext entries. The order of the entries
  45                 corresponds to the output of the function getElementNames().
  46      */
  47     sequence<string> getTitles();
  48
  49     /** renames an entry in the autotext group.
  50
  51
  52
  53         <p>The position of the autotext entry is not changed.
  54
  55         </p>
  56      */
  57     void renameByName( [in] string aElementName,
  58              [in] string aNewElementName,
  59              [in] string aNewElementTitle )
  60             raises( com::sun::star::lang::IllegalArgumentException,
  61                     com::sun::star::container::ElementExistException,
  62                     com::sun::star::io::IOException );
  63
  64     /** creates a new AutoTextEntry entry.
  65      */
  66     com::sun::star::text::XAutoTextEntry insertNewByName( [in] string aName,
  67              [in] string aTitle,
  68              [in] com::sun::star::text::XTextRange xTextRange )
  69             raises( com::sun::star::container::ElementExistException );
  70
  71     /** removes the specified autotext entry.
  72      */
  73     void removeByName( [in] string aEntryName )
  74             raises( com::sun::star::container::NoSuchElementException );
  75
  76 };
  77
  78
  79 }; }; }; };
  80
  81
  82 #endif
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */