udkapi/com/sun/star/uri/RelativeUriExcessParentSegments.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: RelativeUriExcessParentSegments.idl,v $
  10  * $Revision: 1.8 $
  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
  31 #ifndef __com_sun_star_uri_RelativeUriExcessParentSegments_idl__
  32 #define __com_sun_star_uri_RelativeUriExcessParentSegments_idl__
  33
  34 module com { module sun { module star { module uri {
  35
  36 /**
  37    details how excess special parent segments (&ldquo;<code>..</code>&rdquo;)
  38    are handled when resolving a relative URI reference to absolute form.
  39
  40    @see com::sun::star::uri::XUriReferenceFactory::makeAbsolute
  41    for a method that uses this enumeration.
  42
  43    @since OOo 2.0.0
  44  */
  45 published enum RelativeUriExcessParentSegments {
  46     /**
  47        causes excess special parent segments to be treated as an error.
  48      */
  49     ERROR,
  50
  51     /**
  52        causes excess special parent segments to be retained, treating them like
  53        ordinary segments.
  54      */
  55     RETAIN,
  56
  57     /**
  58        causes excess special parent segments to be removed.
  59      */
  60     REMOVE
  61 };
  62
  63 }; }; }; };
  64
  65 #endif