offapi/com/sun/star/util/XStringEscape.idl

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