offapi/com/sun/star/linguistic2/XDictionary1.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: XDictionary1.idl,v $
  10  * $Revision: 1.9 $
  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_linguistic2_XDictionary1_idl__
  31 #define __com_sun_star_linguistic2_XDictionary1_idl__
  32
  33 #ifndef __com_sun_star_container_XNamed_idl__
  34 #include <com/sun/star/container/XNamed.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_linguistic2_DictionaryType_idl__
  38 #include <com/sun/star/linguistic2/DictionaryType.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_linguistic2_XDictionaryEntry_idl__
  42 #include <com/sun/star/linguistic2/XDictionaryEntry.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_linguistic2_XDictionaryEventListener_idl__
  46 #include <com/sun/star/linguistic2/XDictionaryEventListener.idl>
  47 #endif
  48
  49 //=============================================================================
  50
  51 module com { module sun { module star { module linguistic2 {
  52
  53 //=============================================================================
  54 /**
  55     @deprecated
  56 */
  57 published interface XDictionary1 : com::sun::star::container::XNamed
  58 {
  59     //-------------------------------------------------------------------------
  60     com::sun::star::linguistic2::DictionaryType getDictionaryType();
  61
  62     //-------------------------------------------------------------------------
  63     void setActive( [in] boolean bActivate );
  64
  65     //-------------------------------------------------------------------------
  66     boolean isActive();
  67
  68     //-------------------------------------------------------------------------
  69     short getCount();
  70
  71     //-------------------------------------------------------------------------
  72     short getLanguage();
  73
  74     //-------------------------------------------------------------------------
  75     void setLanguage( [in] short nLang );
  76
  77     //-------------------------------------------------------------------------
  78     com::sun::star::linguistic2::XDictionaryEntry getEntry( [in] string aWord );
  79
  80     //-------------------------------------------------------------------------
  81     boolean addEntry( [in] com::sun::star::linguistic2::XDictionaryEntry xDicEntry );
  82
  83     //-------------------------------------------------------------------------
  84     boolean add(
  85             [in] string aWord,
  86             [in] boolean bIsNegative,
  87             [in] string aRplcText );
  88
  89     //-------------------------------------------------------------------------
  90     boolean remove( [in] string aWord );
  91
  92     //-------------------------------------------------------------------------
  93     boolean isFull();
  94
  95     //-------------------------------------------------------------------------
  96     sequence<com::sun::star::linguistic2::XDictionaryEntry> getEntries();
  97
  98     //-------------------------------------------------------------------------
  99     void clear();
 100
 101     //-------------------------------------------------------------------------
 102     boolean addDictionaryEventListener( [in] com::sun::star::linguistic2::XDictionaryEventListener xListener );
 103
 104     //-------------------------------------------------------------------------
 105     boolean removeDictionaryEventListener( [in] com::sun::star::linguistic2::XDictionaryEventListener xListener );
 106
 107 };
 108
 109 //=============================================================================
 110
 111 }; }; }; };
 112
 113 #endif
 114
 115