LibreOffice
LibreOffice 6.2 SDK API Reference
Public Attributes | List of all members
URL Struct Referencepublished

represents the structure of an Uniform Resource Locator. More...

import"URL.idl";

Public Attributes

string Complete
 contains the string representation of the complete URL, for example, http://www.sun.de:8080/pub/test/foo.txt?a=b#xyz More...
 
string Main
 contains the URL without a mark and without arguments, for example, http://www.sun.de:8080/pub/test/foo.txt More...
 
string Protocol
 contains the protocol (scheme) of the URL, for example, "http" More...
 
string User
 contains the user-identifier of the URL, for example, "me" More...
 
string Password
 contains the users password of the URL, for example, "pass" More...
 
string Server
 contains the server part of the URL, for example, "www.sun.de" More...
 
short Port
 contains the port at the server of the URL, for example, "8080" More...
 
string Path
 contains all segments but the last one of the hierarchical path of the URL, for example, "/pub/test/" More...
 
string Name
 contains the last segment of the hierarchical path of the URL, for the above example, "foo.txt" More...
 
string Arguments
 contains the arguments part of the URL, for example, "a=b" More...
 
string Mark
 contains the mark part of the URL, for example, "xyz" More...
 

Detailed Description

represents the structure of an Uniform Resource Locator.

If the structure represents a valid URL or not depends on prior usage of the functions of XURLTransformer. Only after one of the functions returned TRUE this can be assumed.
It is not necessary to set all of the fields; either URL::Complete or (some of) the others are set. Additionally, most of the other fields, like URL::Host, URL::Port, URL::User, URL::Password, or URL::Mark, are optional.

See also
XURLTransformer
Developers Guide
OfficeDev - Command URL

Member Data Documentation

string Arguments

contains the arguments part of the URL, for example, "a=b"

string Complete

contains the string representation of the complete URL, for example, http://www.sun.de:8080/pub/test/foo.txt?a=b#xyz

It is used as a central input/output or input parameter for the interfaces of XURLTransformer. The usage of one of the XURLTransformer function is mandatory to validate the URL. It cannot be assumed that URL::Complete represents always a valid URL!

string Main

contains the URL without a mark and without arguments, for example, http://www.sun.de:8080/pub/test/foo.txt

string Mark

contains the mark part of the URL, for example, "xyz"

string Name

contains the last segment of the hierarchical path of the URL, for the above example, "foo.txt"

Attention:A service implementing the XURLTransformer interface will normally not detect if the last segment is a folder or a file. So it is possible that the last segment describes a folder. If you want to be sure that a file URL that references a folder will be correctly put into the URL fields you should append a "/" at the end of the hierarchical path.

string Password

contains the users password of the URL, for example, "pass"

string Path

contains all segments but the last one of the hierarchical path of the URL, for example, "/pub/test/"

short Port

contains the port at the server of the URL, for example, "8080"

string Protocol

contains the protocol (scheme) of the URL, for example, "http"

string Server

contains the server part of the URL, for example, "www.sun.de"

string User

contains the user-identifier of the URL, for example, "me"


The documentation for this struct was generated from the following file: