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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_util_URL_idl__
  20 #define __com_sun_star_util_URL_idl__
  21
  22
  23
  24 module com {  module sun {  module star {  module util {
  25
  26
  27 /** represents the structure of an Uniform Resource Locator.
  28
  29     <p>
  30     If the structure represents a valid URL or not depends on prior usage of
  31     the functions of XURLTransformer. Only after one of the functions
  32     returned `TRUE` this can be assumed.<br>
  33     It is not necessary to set all of the fields; either URL::Complete
  34     or (some of) the others are set. Additionally, most of the other
  35     fields, like URL::Host, URL::Port,
  36     URL::User, URL::Password,
  37     or URL::Mark, are optional.
  38
  39     @see XURLTransformer
  40
  41     </p>
  42  */
  43 published struct URL
  44 {
  45     /** contains the string representation of the complete URL, for example,
  46         http://www.sun.de:8080/pub/test/foo.txt?a=b#xyz
  47
  48         <p>
  49         It is used as a central input/output or input parameter for the interfaces of
  50         XURLTransformer. The usage of one of the XURLTransformer
  51         function is mandatory to validate the URL. It cannot be assumed that
  52         URL::Complete represents always a valid URL!
  53         </p>
  54      */
  55     string Complete;
  56
  57     /** contains the URL without a mark and without arguments, for example,
  58         http://www.sun.de:8080/pub/test/foo.txt
  59      */
  60     string Main;
  61
  62     /** contains the protocol (scheme) of the URL, for example, "http"
  63      */
  64     string Protocol;
  65
  66     /** contains the user-identifier of the URL, for example, "me"
  67      */
  68     string User;
  69
  70     /** contains the users password of the URL, for example, "pass"
  71      */
  72     string Password;
  73
  74     /** contains the server part of the URL, for example, "www.sun.de"
  75      */
  76     string Server;
  77
  78     /** contains the port at the server of the URL, for example, "8080"
  79      */
  80     short Port;
  81
  82     /** contains all segments but the last one of the hierarchical path of the URL, for example, "/pub/test/"
  83      */
  84     string Path;
  85
  86     /** contains the last segment of the hierarchical path of the URL, for the above example, "foo.txt"
  87         <p>
  88         <strong>Attention:</strong>A service implementing the XURLTransformer interface
  89         will normally not detect if the last segment is a folder or a file. So it is possible that
  90         the last segment describes a folder. If you want to be sure that a file URL that references
  91         a folder will be correctly put into the URL fields you should append a "/" at the end of the
  92         hierarchical path.
  93         </p>
  94      */
  95     string Name;
  96
  97     /** contains the arguments part of the URL, for example, "a=b"
  98      */
  99     string Arguments;
 100
 101     /** contains the mark part of the URL, for example, "xyz"
 102      */
 103     string Mark;
 104
 105 };
 106
 107
 108 }; }; }; };
 109
 110 #endif
 111
 112 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */