offapi/com/sun/star/text/XAutoTextContainer.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_XAutoTextContainer_idl__
  28 #define __com_sun_star_text_XAutoTextContainer_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_text_XAutoTextGroup_idl__
  35 #include <com/sun/star/text/XAutoTextGroup.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  39 #include <com/sun/star/lang/IllegalArgumentException.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_container_ElementExistException_idl__
  43 #include <com/sun/star/container/ElementExistException.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_container_NoSuchElementException_idl__
  47 #include <com/sun/star/container/NoSuchElementException.idl>
  48 #endif
  49
  50
  51 //=============================================================================
  52
  53  module com {  module sun {  module star {  module text {
  54
  55 //=============================================================================
  56
  57 // DocMerge from xml: interface com::sun::star::text::XAutoTextContainer
  58 /** handles blocks of <type>AutoTextEntry</type>.
  59
  60
  61
  62
  63
  64
  65
  66     @example <pre>
  67     AutoTextPath=d:\office\autotext;f:\user\autotext
  68
  69     groupname:  "standard*0"
  70     -&amp;amp;gt; the group file is located n the path d:\office\autotext
  71     groupname:  "all*1"
  72     -&amp;amp;gt; the group file is located in the path f:\user\autotext\
  73     </pre>
  74
  75     <p>If the path extension is not specified, then the first directory
  76     is used.  For automatic text expansion, the name of an actual group is
  77     set to search first in this group.
  78
  79     </p>@see AutoTextContainer
  80  */
  81 published interface XAutoTextContainer: com::sun::star::container::XNameAccess
  82 {
  83     //-------------------------------------------------------------------------
  84
  85     // DocMerge from xml: method com::sun::star::text::XAutoTextContainer::insertNewByName
  86     /** creates a new AutoText group.
  87      */
  88     com::sun::star::text::XAutoTextGroup insertNewByName( [in] string aGroupName )
  89             raises( com::sun::star::lang::IllegalArgumentException,
  90                     com::sun::star::container::ElementExistException );
  91
  92     //-------------------------------------------------------------------------
  93
  94     // DocMerge from xml: method com::sun::star::text::XAutoTextContainer::removeByName
  95     /** deletes the specified AutoText group.
  96      */
  97     void removeByName( [in] string aGroupName )
  98             raises( com::sun::star::container::NoSuchElementException );
  99
 100 };
 101
 102 //=============================================================================
 103
 104 }; }; }; };
 105
 106
 107 #endif