1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_util_XStringEscape_idl__
28#define __com_sun_star_util_XStringEscape_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
35#include <com/sun/star/lang/IllegalArgumentException.idl>
36#endif
37
38//=============================================================================
39
40module com {  module sun {  module star {  module util {
41
42/** This interface is used to encode an arbitrary String into a
43	escaped form.
44
45	<p>The escaped form is chosen to be suitable for use with other interfaces
46	of the object or service providing this interface.</p>
47
48	<p>Any characters or character sequences that are not compatible with
49	any naming rules or restrictions must be replaced by an escaped form,
50	that complies to these rules.
51
52	<p>The transformation should preserve all traits of the string that are
53	generally respected by the service. For example, the case of a string
54	may be lost after encoding and then decoding, if the service
55	generally is case insensitive.
56
57	<p>Other than that the encoding is one-to-one and can be reversed. The
58	encoding should try to preserve as much as possible of the original
59	string, to keep human-readable input human-friendly where possible.
60	Strings that already conform to the naming conventions should be left
61	unchanged or minimally modified.</p>
62 */
63published interface XStringEscape: com::sun::star::uno::XInterface
64{
65	/** encodes an arbitrary string into an escaped form compatible with some naming rules.
66	 */
67	string escapeString([in] string aString)
68		raises( com::sun::star::lang::IllegalArgumentException);
69
70	/** decodes an escaped string into the original form.
71	 */
72	string unescapeString([in] string aEscapedString)
73		raises( com::sun::star::lang::IllegalArgumentException);
74};
75
76
77//=============================================================================
78
79}; }; }; };
80
81#endif
82
83
84