AOO410/main/offapi/com/sun/star/smarttags/XRangeBasedSmartTagRecognizer.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_smarttags_XRangeBasedSmartTagRecognizer_idl__
#define __com_sun_star_smarttags_XRangeBasedSmartTagRecognizer_idl__

#ifndef __com_sun_star_uno_XInitialization_idl__
#include <com/sun/star/lang/XInitialization.idl>
#endif

#ifndef __com_sun_star_lang_Locale_idl__
#include <com/sun/star/lang/Locale.idl>
#endif

#ifndef __com_sun_star_smarttags_SmartTagRecognizerMode_idl__
#include <com/sun/star/smarttags/SmartTagRecognizerMode.idl>
#endif

#ifndef __com_sun_star_text_XTextMarkup_idl__
#include <com/sun/star/text/XTextMarkup.idl>
#endif

#ifndef __com_sun_star_frame_XController_idl__
#include <com/sun/star/frame/XController.idl>
#endif

#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
#endif

#ifndef __com_sun_star_text_XTextRange_idl__
#include <com/sun/star/text/XTextRange.idl>
#endif


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

module com {  module sun {  module star {  module smarttags {

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

/**
    provides access to a range based smart tag recognizer.
 */

interface XRangeBasedSmartTagRecognizer: com::sun::star::lang::XInitialization
{

    //-------------------------------------------------------------------------
    /** recognizes smart tags.

        @param xRange
                The text that should be scanned by the recognizer. 

        @param eDataType
                This value indicates the type of the passed text.

        @param xTextMarkup
                This object is used to submit any recognized smart tags
                to the calling application.

        @param aApplicationName
                A string containing the name of the calling application.

        @param xController
                The current controller of the document.
     */

    void recognizeTextRange( [in] com::sun::star::text::XTextRange xRange,
                       [in] SmartTagRecognizerMode eDataType,
                       [in] com::sun::star::text::XTextMarkup xTextMarkup,
                       [in] string aApplicationName,
                       [in] com::sun::star::frame::XController xController);
};

}; }; }; };

#endif