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