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