udkapi/com/sun/star/util/XMacroExpander.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_util_XMacroExpander_idl__
  20 #define __com_sun_star_util_XMacroExpander_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/lang/IllegalArgumentException.idl>
  24
  25
  26
  27 module com {  module sun {  module star {  module util {
  28
  29
  30 /** Expands macro in expressions, i.e. substitudes macro names.
  31
  32     @since OOo 1.1.2
  33 */
  34 published interface XMacroExpander : com::sun::star::uno::XInterface
  35 {
  36     /** Expands macrofied expressions.
  37
  38         @param exp
  39                macrofied expression
  40         @return
  41                 demacrofied expression
  42         @throws IllegalArgumentException
  43                 if a macro name is unknown, thus cannot be expanded
  44     */
  45     string expandMacros( [in] string exp )
  46         raises (com::sun::star::lang::IllegalArgumentException);
  47 };
  48
  49
  50 }; }; }; };
  51
  52 #endif
  53
  54 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */