diff options
Diffstat (limited to 'offapi/com/sun/star/util/XStringEscape.idl')
| -rw-r--r-- | offapi/com/sun/star/util/XStringEscape.idl | 54 |
1 files changed, 15 insertions, 39 deletions
diff --git a/offapi/com/sun/star/util/XStringEscape.idl b/offapi/com/sun/star/util/XStringEscape.idl index 1c84e0096bc1..988596b17e8e 100644 --- a/offapi/com/sun/star/util/XStringEscape.idl +++ b/offapi/com/sun/star/util/XStringEscape.idl @@ -2,9 +2,9 @@ * * $RCSfile: XStringEscape.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:18:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,24 +71,24 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { - -// DocMerge from xml: interface com::sun::star::util::XStringEscape /** This interface is used to encode an arbitrary String into a escaped form. - <p> - The escaped form is chosen to be suitable for use with other interfaces + + <p>The escaped form is chosen to be suitable for use with other interfaces of the object or service providing this interface.</p> - <p> - Any characters or character sequences that are not compatible with + + <p>Any characters or character sequences that are not compatible with any naming rules or restrictions must be replaced by an escaped form, - that complies to these rules.<br> - The transformation should preserve all traits of the string that are + that complies to these rules. + + <p>The transformation should preserve all traits of the string that are generally respected by the service. For example, the case of a string may be lost after encoding and then decoding, if the service - generally is case insensitive.<br> - Other than that the encoding is one-to-one and can be reversed. The + generally is case insensitive. + + <p>Other than that the encoding is one-to-one and can be reversed. The encoding should try to preserve as much as possible of the original string, to keep human-readable input human-friendly where possible. Strings that already conform to the naming conventions should be left @@ -96,16 +96,12 @@ */ interface XStringEscape: com::sun::star::uno::XInterface { - - // DocMerge from xml: method com::sun::star::util::XStringEscape::escapeString - /** Encodes an arbitrary string into an escaped form compatible with some naming rules. + /** encodes an arbitrary string into an escaped form compatible with some naming rules. */ string escapeString([in] string aString) raises( com::sun::star::lang::IllegalArgumentException); - - // DocMerge from xml: method com::sun::star::util::XStringEscape::unescapeString - /** Decodes an escaped string into the original form. + /** decodes an escaped string into the original form. */ string unescapeString([in] string aEscapedString) raises( com::sun::star::lang::IllegalArgumentException); @@ -118,24 +114,4 @@ interface XStringEscape: com::sun::star::uno::XInterface #endif -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2001/03/16 16:41:51 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:21 hjs - initial import - - Revision 1.3 2000/09/11 11:53:06 mi - documentation merged from XML - - Revision 1.1 2000/08/09 19:09:27 jb - New interface - - -=============================================================================*/ |