|
LibreOffice
LibreOffice 5.3 SDK API Reference
|
creates URI references. More...
import"XUriReferenceFactory.idl";
Public Member Functions | |
| XUriReference | parse ([in] string uriReference) |
| parses the textual representation of a URI reference. More... | |
| XUriReference | makeAbsolute ([in] XUriReference baseUriReference, [in] XUriReference uriReference, [in] boolean processSpecialBaseSegments, [in] RelativeUriExcessParentSegments excessParentSegments) |
| resolves a relative URI reference to absolute form. More... | |
| XUriReference | makeRelative ([in] XUriReference baseUriReference, [in] XUriReference uriReference, [in] boolean preferAuthorityOverRelativePath, [in] boolean preferAbsoluteOverRelativePath, [in] boolean encodeRetainedSpecialSegments) |
| changes an absolute URI reference to relative form. More... | |
Public Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) |
| queries for a new interface to an existing UNO object. More... | |
| void | acquire () |
| increases the reference counter by one. More... | |
| void | release () |
| decreases the reference counter by one. More... | |
creates URI references.
See RFC 2396 for a description of URI references and related terms.
| XUriReference makeAbsolute | ( | [in] XUriReference | baseUriReference, |
| [in] XUriReference | uriReference, | ||
| [in] boolean | processSpecialBaseSegments, | ||
| [in] RelativeUriExcessParentSegments | excessParentSegments | ||
| ) |
resolves a relative URI reference to absolute form.
| baseUriReference | the base URI reference. If the given uriReference is a same-document reference, baseUriReference is used as a reference to the current document. |
| uriReference | any URI reference. Backwards-compatible relative URI references starting with a scheme component (see RFC 2396, Section 5.2, step 3) are not supported; instead, they are interpreted as absolute URI references. |
| processSpecialBaseSegments | if TRUE, special segments (“.” and “..”) within the path of the base URI (except for the last, cut-off segment) are processed as suggested by RFC 2396. If FALSE, special segments within the path of the base URI are treated like ordinary segments. |
| excessParentSegments | details how excess special parent segments (“..”) are handled. |
uriReference is either already absolute, or can be resolved to an absolute URI reference, relative to the given baseUriReference; otherwise, NULL is returned. Especially, if baseUriReference is NULL, or is not an absolute, hierarchical URI reference, or if uriReference is NULL, then NULL is always returned. | XUriReference makeRelative | ( | [in] XUriReference | baseUriReference, |
| [in] XUriReference | uriReference, | ||
| [in] boolean | preferAuthorityOverRelativePath, | ||
| [in] boolean | preferAbsoluteOverRelativePath, | ||
| [in] boolean | encodeRetainedSpecialSegments | ||
| ) |
changes an absolute URI reference to relative form.
| baseUriReference | the base URI reference. |
| uriReference | any URI reference. |
| preferAuthorityOverRelativePath | controls how a relative URI reference is generated when both baseUriReference (e.g., “scheme://auth/a/b”) and uriReference (e.g., “scheme://auth//c/d”) have the same scheme and authority components, and the path component of uriReference starts with “//”. If TRUE, the generated relative URI reference includes an authority component (e.g., “//auth//c/d”); if FALSE, the generated relative URI reference has a relative path (e.g., “..//c/d”). |
| preferAbsoluteOverRelativePath | controls how a relative URI reference is generated when both baseUriReference (e.g., “scheme://auth/a/b”) and uriReference (e.g., “scheme://auth/c/d”) have the same scheme and authority components (if present), but share no common path segments. If TRUE, the generated relative URI reference has an absolute path (e.g., “/c/d”); if FALSE, the generated relative URI reference has a relative path (e.g., “../c/d”). |
| encodeRetainedSpecialSegments | if TRUE, special segments (“.” and “..”) that are already present in the path component of the given uriReference and which end up in a relative path returned from this method, are encoded (as “%2E” and “%2E%2E”, respectively). |
uriReference is either already relative, or is not hierarchical, or is of a different scheme than the given baseUriReference, or can be changed to a relative URI reference, relative to the given baseUriReference; otherwise, NULL is returned. Especially, if baseUriReference is NULL, or is not an absolute, hierarchical URI reference, or if uriReference is NULL, then NULL is always returned. | XUriReference parse | ( | [in] string | uriReference | ) |
parses the textual representation of a URI reference.
| uriReference | the textual representation of a URI reference. |
NULL is returned.
1.8.13