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

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