LibreOffice: com/sun/star/util/XStringSubstitution.idl Source File

LibreOffice LibreOffice 24.2 SDK API Reference

Loading...
Searching...
No Matches
XStringSubstitution.idl
Go to the documentation of this file.
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
20
21 module com { module sun { module star { module util {
22
34published interface XStringSubstitution : com::sun::star::uno::XInterface
35{
61 string substituteVariables( [in] string aText, [in] boolean bSubstRequired )
62 raises( com::sun::star::container::NoSuchElementException );
63
83 string reSubstituteVariables( [in] string aText );
84
102 string getSubstituteVariableValue( [in] string variable )
103 raises (::com::sun::star::container::NoSuchElementException );
104};
105
106
107}; }; }; };
108
109/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::container::NoSuchElementException
is thrown by child access methods of collections, if the addressed child does not exist.
Definition NoSuchElementException.idl:31
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition XInterface.idl:46
com::sun::star::util::XStringSubstitution
A common interface for substituting string variables with other strings.
Definition XStringSubstitution.idl:35
com::sun::star::util::XStringSubstitution::reSubstituteVariables
string reSubstituteVariables([in] string aText)
Tries to replace parts of aText with variables that represents these sub strings.
com::sun::star::util::XStringSubstitution::getSubstituteVariableValue
string getSubstituteVariableValue([in] string variable)
Returns the current value of a variable.
com::sun::star::util::XStringSubstitution::substituteVariables
string substituteVariables([in] string aText, [in] boolean bSubstRequired)
Exchanges variables inside a given text with a substitution text defined for the variables.
com
Definition Ambiguous.idl:20