1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_util_XStringEscape_idl__
24#define __com_sun_star_util_XStringEscape_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
31#include <com/sun/star/lang/IllegalArgumentException.idl>
32#endif
33
34//=============================================================================
35
36module com {  module sun {  module star {  module util {
37
38/** This interface is used to encode an arbitrary String into a
39	escaped form.
40
41	<p>The escaped form is chosen to be suitable for use with other interfaces
42	of the object or service providing this interface.</p>
43
44	<p>Any characters or character sequences that are not compatible with
45	any naming rules or restrictions must be replaced by an escaped form,
46	that complies to these rules.
47
48	<p>The transformation should preserve all traits of the string that are
49	generally respected by the service. For example, the case of a string
50	may be lost after encoding and then decoding, if the service
51	generally is case insensitive.
52
53	<p>Other than that the encoding is one-to-one and can be reversed. The
54	encoding should try to preserve as much as possible of the original
55	string, to keep human-readable input human-friendly where possible.
56	Strings that already conform to the naming conventions should be left
57	unchanged or minimally modified.</p>
58 */
59published interface XStringEscape: com::sun::star::uno::XInterface
60{
61	/** encodes an arbitrary string into an escaped form compatible with some naming rules.
62	 */
63	string escapeString([in] string aString)
64		raises( com::sun::star::lang::IllegalArgumentException);
65
66	/** decodes an escaped string into the original form.
67	 */
68	string unescapeString([in] string aEscapedString)
69		raises( com::sun::star::lang::IllegalArgumentException);
70};
71
72
73//=============================================================================
74
75}; }; }; };
76
77#endif
78
79
80