AOO410/main/offapi/com/sun/star/linguistic2/Dictionary.idl

/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/


#ifndef __com_sun_star_linguistic2_Dictionary_idl__
#define __com_sun_star_linguistic2_Dictionary_idl__

#ifndef __com_sun_star_linguistic2_XDictionary_idl__
#include <com/sun/star/linguistic2/XDictionary.idl>
#endif

#ifndef __com_sun_star_linguistic2_XSearchableDictionary_idl__
#include <com/sun/star/linguistic2/XSearchableDictionary.idl>
#endif

#ifndef __com_sun_star_util_XFlushable_idl__
#include <com/sun/star/util/XFlushable.idl>
#endif

#ifndef __com_sun_star_frame_XStorable_idl__
#include <com/sun/star/frame/XStorable.idl>
#endif

//=============================================================================

module com { module sun { module star { module linguistic2 {

//=============================================================================
/** represents a dictionary used for spell checking and hyphenation.


    @see    com::sun::star::linguistic2::DictionaryList
    @see    com::sun::star::linguistic2::XSearchableDictionaryList

    @since OpenOffice 3.0.1
*/
service Dictionary
{
    /** to access the dictionary functionality.
    */
    interface com::sun::star::linguistic2::XDictionary;

    /** provide search for similar words functionality.
    */
    [optional] interface com::sun::star::linguistic2::XSearchableDictionary;
    
    /** to save the dictionary content to file
        
        <p>storeAsURL and storeToURL are empty implementations since the dictionaries are expected
        to be found in specific locations</p>
    */
    [optional] interface com::sun::star::frame::XStorable;

};

//=============================================================================

}; }; }; };

#endif