diff options
Diffstat (limited to 'offapi')
| -rw-r--r-- | offapi/com/sun/star/util/XStringSubstitution.idl | 166 |
1 files changed, 166 insertions, 0 deletions
diff --git a/offapi/com/sun/star/util/XStringSubstitution.idl b/offapi/com/sun/star/util/XStringSubstitution.idl new file mode 100644 index 000000000..312222161 --- /dev/null +++ b/offapi/com/sun/star/util/XStringSubstitution.idl @@ -0,0 +1,166 @@ +/************************************************************************* + * + * $RCSfile: XStringSubstitution.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: cd $ $Date: 2002-08-15 05:23:02 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (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.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_util_XStringSubstitution_idl__ +#define __com_sun_star_util_XStringSubstitution_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_container_NoSuchElementException_idl__ +#include <com/sun/star/container/NoSuchElementException.idl> +#endif + +//============================================================================= + + module com { module sun { module star { module util { + +//============================================================================= +/** A common interface for substituting string variables with + other strings. + + <p> + The substitution algorithm and the syntax for a string variable are + not part of this interface definition. Please look at the documentation + of the implementation that must specify these parameters. + </p> +*/ +interface XStringSubstitution : com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + /** Exchanges variables inside a given text with a substitution text + defined for the variables. + + <p> + The method iterates through it's internal variables list to match the + variables in the given string. A match replaces the variable with the + string defined for this variable. If no variable can be found in the string + it will be returned unchanged. The behavior if a variable is found in + the string but it is unknown for the implementation depends on the parameter + bSubstRequired. + </p> + + @param aText + A string containing variables that should be substituted. + + @param bSubstRequired + Specifies if a successfull substitution is required. The + function throws a <type scope="com::sun::star::container">NoSuchElementException</type> + if it finds a variable that is unknown. In this case it is possible + that the returned string would not be what the caller expected! + + @return + Returns a string based on <var>aText</var> where all variables were + exchanged with their value defined at calling time. + */ + string substituteVariables( [in] string aText, [in] boolean bSubstRequired ) + raises( com::sun::star::container::NoSuchElementException ); + + //------------------------------------------------------------------------- + /** Tries to replace parts of aText with variables that represents + these sub strings. + + <p> + The method iterates through it's internal variable list and tries to match + parts of the given string Tries to replace parts of <var>aText</var> with + variables that represents these sub strings.If more than one variable + matches the one with the longest matching sub string will be chosen. + </p> + + @param aText + A string where known substrings should be replaced by variables. + + @return + Returns the resubstituted string with variables for all parts + that could be replaced. The unchanged argument will be returned + if nothing can be resubtituted. + */ + + string reSubstituteVariables( [in] string aText ); + + //------------------------------------------------------------------------- + /** Returns the current value of a variable. + + <p> + The method iterates through it's internal variable list and tries to + find the given variable. If the variable is unkown a + <type scope="com::sun::star::container">NoSuchElementException</type> + is thrown. + </p> + + @param variable + The name of a variable. + + @return + Returns a string that represents the variable. If the + variable is unknown a <type scope="com::sun::star::container">NoSuchElementException</type> + is thrown. + */ + string getSubstituteVariableValue( [in] string variable ) + raises (::com::sun::star::container::NoSuchElementException ); +}; + +//============================================================================= + +}; }; }; }; + +#endif |