xref: /aoo41x/main/udkapi/com/sun/star/util/XMacroExpander.idl (revision 95a17a32)

/**************************************************************
 *
 * 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_util_XMacroExpander_idl__
#define __com_sun_star_util_XMacroExpander_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif


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

module com {  module sun {  module star {  module util {

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

/** Expands macro in expressions, i.e. substitudes macro names.

    @since OpenOffice 1.1.2
*/
published interface XMacroExpander : com::sun::star::uno::XInterface
{
    /** Expands macrofied expressions.

        @param exp
               macrofied expression
        @return
                demacrofied expression
        @throws IllegalArgumentException
                if a macro name is unknown, thus cannot be expanded
    */
    string expandMacros( [in] string exp )
		raises (com::sun::star::lang::IllegalArgumentException);
};

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

}; }; }; };

#endif