offapi/com/sun/star/util/URL.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: URL.idl,v $
  10  * $Revision: 1.10 $
  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_URL_idl__
  31 #define __com_sun_star_util_URL_idl__
  32
  33
  34 //=============================================================================
  35
  36 module com {  module sun {  module star {  module util {
  37
  38 //=============================================================================
  39
  40 /** represents the structure of an Uniform Resource Locator.
  41
  42     <p>
  43     If the structure represents a valid URL or not depends on prior usage of
  44     the functions of <type>XURLTransformer</type>. Only after one of the functions
  45     returned <TRUE/> this can be assumed.</br>
  46     It is not necessary to set all of the fields; either <member>URL::Complete</member>
  47     or (some of) the others are set. Additionally, most of the other
  48     fields, like <member>URL::Host</member>, <member>URL::Port</member>,
  49     <member>URL::User</member>, <member>URL::Password</member>,
  50     or <member>URL::Mark</member>, are optional.
  51
  52     @see XURLTransformer
  53
  54     </p>
  55  */
  56 published struct URL
  57 {
  58     /** contains the string representation of the complete URL, for example,
  59         http://www.sun.de:8080/pub/test/foo.txt?a=b#xyz
  60
  61         <p>
  62         It is used as a central input/output or input parameter for the interfaces of
  63         <type>XURLTransformer</type>. The usage of one of the <type>XURLTransformer</type>
  64         function is mandatory to validate the URL. It cannot be assumed that
  65         <member>URL::Complete</member> represents always a valid URL!
  66         </p>
  67      */
  68     string Complete;
  69
  70     //-------------------------------------------------------------------------
  71     /** contains the URL without a mark and without arguments, for example,
  72         http://www.sun.de:8080/pub/test/foo.txt
  73      */
  74     string Main;
  75
  76     //-------------------------------------------------------------------------
  77     /** contains the protocol (scheme) of the URL, for example, "http"
  78      */
  79     string Protocol;
  80
  81     //-------------------------------------------------------------------------
  82     /** contains the user-identifier of the URL, for example, "me"
  83      */
  84     string User;
  85
  86     //-------------------------------------------------------------------------
  87     /** contains the users password of the URL, for example, "pass"
  88      */
  89     string Password;
  90
  91     //-------------------------------------------------------------------------
  92     /** contains the server part of the URL, for example, "www.sun.de"
  93      */
  94     string Server;
  95
  96     //-------------------------------------------------------------------------
  97     /** contains the port at the server of the URL, for example, "8080"
  98      */
  99     short Port;
 100
 101     //-------------------------------------------------------------------------
 102     /** contains all segments but the last one of the hierarchical path of the URL, for example, "/pub/test/"
 103      */
 104     string Path;
 105
 106     //-------------------------------------------------------------------------
 107     /** contains the last segment of the hierarchical path of the URL, for the above example, "foo.txt"
 108         <p>
 109         <strong>Attention:</strong>A service implementing the <type>XURLTransformer</type> interface
 110         will normally not detect if the last segment is a folder or a file. So it is possible that
 111         the last segment describes a folder. If you want to be sure that a file URL that references
 112         a folder will be correctly put into the URL fields you should append a '/' at the end of the
 113         hierarchical path.
 114         </p>
 115      */
 116     string Name;
 117
 118     //-------------------------------------------------------------------------
 119     /** contains the arguments part of the URL, for example, "a=b"
 120      */
 121     string Arguments;
 122
 123     //-------------------------------------------------------------------------
 124     /** contains the mark part of the URL, for example, "xyz"
 125      */
 126     string Mark;
 127
 128 };
 129
 130 //=============================================================================
 131
 132 }; }; }; };
 133
 134 #endif