offapi/com/sun/star/text/XAutoTextGroup.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_text_XAutoTextGroup_idl__
  28 #define __com_sun_star_text_XAutoTextGroup_idl__
  29
  30 #ifndef __com_sun_star_container_XNameAccess_idl__
  31 #include <com/sun/star/container/XNameAccess.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  35 #include <com/sun/star/lang/IllegalArgumentException.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_container_ElementExistException_idl__
  39 #include <com/sun/star/container/ElementExistException.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_io_IOException_idl__
  43 #include <com/sun/star/io/IOException.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_text_XAutoTextEntry_idl__
  47 #include <com/sun/star/text/XAutoTextEntry.idl>
  48 #endif
  49
  50 #ifndef __com_sun_star_text_XTextRange_idl__
  51 #include <com/sun/star/text/XTextRange.idl>
  52 #endif
  53
  54 #ifndef __com_sun_star_container_NoSuchElementException_idl__
  55 #include <com/sun/star/container/NoSuchElementException.idl>
  56 #endif
  57
  58
  59 //=============================================================================
  60
  61  module com {  module sun {  module star {  module text {
  62
  63 //=============================================================================
  64
  65 // DocMerge from xml: interface com::sun::star::text::XAutoTextGroup
  66 /** The interface provide methods to insert, rename and delete autotext entries from the current autotext group.
  67  */
  68 published interface XAutoTextGroup: com::sun::star::container::XNameAccess
  69 {
  70     //-------------------------------------------------------------------------
  71
  72     // DocMerge from idl: method com::sun::star::text::XAutoTextGroup::getTitles
  73     /** returns the titles of all autotext entries. The order of the entries
  74                 corresponds to the output of the function getElementNames().
  75      */
  76     sequence<string> getTitles();
  77
  78     //-------------------------------------------------------------------------
  79
  80     // DocMerge from xml: method com::sun::star::text::XAutoTextGroup::renameByName
  81     /** renames an entry in the autotext group.
  82
  83
  84
  85         <p>The position of the autotext entry is not changed.
  86
  87         </p>
  88      */
  89     void renameByName( [in] string aElementName,
  90              [in] string aNewElementName,
  91              [in] string aNewElementTitle )
  92             raises( com::sun::star::lang::IllegalArgumentException,
  93                     com::sun::star::container::ElementExistException,
  94                     com::sun::star::io::IOException );
  95
  96     //-------------------------------------------------------------------------
  97
  98     // DocMerge from xml: method com::sun::star::text::XAutoTextGroup::insertNewByName
  99     /** creates a new <type>AutoTextEntry</type> entry.
 100      */
 101     com::sun::star::text::XAutoTextEntry insertNewByName( [in] string aName,
 102              [in] string aTitle,
 103              [in] com::sun::star::text::XTextRange xTextRange )
 104             raises( com::sun::star::container::ElementExistException );
 105
 106     //-------------------------------------------------------------------------
 107
 108     // DocMerge from xml: method com::sun::star::text::XAutoTextGroup::removeByName
 109     /** removes the specified autotext entry.
 110      */
 111     void removeByName( [in] string aEntryName )
 112             raises( com::sun::star::container::NoSuchElementException );
 113
 114 };
 115
 116 //=============================================================================
 117
 118 }; }; }; };
 119
 120
 121 #endif