#include <url.h>
Inheritance diagram for PURL:
New functions for class. | |
enum | UrlFormat { FullURL, PathOnly, URIOnly, HostPortOnly } |
enum | TranslationType { LoginTranslation, PathTranslation, QueryTranslation } |
Type for translation of strings to URL format,. More... | |
BOOL | Parse (const char *cstr, const char *defaultScheme=NULL) |
BOOL | Parse (const PString &str, const char *defaultScheme=NULL) |
PString | AsString (UrlFormat fmt=FullURL) const |
PFilePath | AsFilePath () const |
const PCaselessString & | GetScheme () const |
Get the scheme field of the URL. | |
void | SetScheme (const PString &scheme) |
Set the scheme field of the URL. | |
const PString & | GetUserName () const |
Get the username field of the URL. | |
void | SetUserName (const PString &username) |
Set the username field of the URL. | |
const PString & | GetPassword () const |
Get the password field of the URL. | |
void | SetPassword (const PString &password) |
Set the password field of the URL. | |
const PCaselessString & | GetHostName () const |
Get the hostname field of the URL. | |
void | SetHostName (const PString &hostname) |
Set the hostname field of the URL. | |
WORD | GetPort () const |
Get the port field of the URL. | |
void | SetPort (WORD newPort) |
Set the port field in the URL. | |
BOOL | GetRelativePath () const |
Get if path is relative or absolute. | |
const PString & | GetPathStr () const |
Get the path field of the URL as a string. | |
void | SetPathStr (const PString &pathStr) |
Set the path field of the URL as a string. | |
const PStringArray & | GetPath () const |
Get the path field of the URL as a string array. | |
void | SetPath (const PStringArray &path) |
Set the path field of the URL as a string array. | |
PString | GetParameters () const |
Get the parameter (;) field of the URL. | |
void | SetParameters (const PString ¶meters) |
Set the parameter (;) field of the URL. | |
const PStringToString & | GetParamVars () const |
Get the parameter (;) field(s) of the URL as a string dictionary. | |
void | SetParamVars (const PStringToString ¶mVars) |
Set the parameter (;) field(s) of the URL as a string dictionary. | |
void | SetParamVar (const PString &key, const PString &data) |
Set the parameter (;) field of the URL as a string dictionary. | |
const PString & | GetFragment () const |
Get the fragment (##) field of the URL. | |
PString | GetQuery () const |
Get the Query (?) field of the URL as a string. | |
void | SetQuery (const PString &query) |
Set the Query (?) field of the URL as a string. | |
const PStringToString & | GetQueryVars () const |
Get the Query (?) field of the URL as a string dictionary. | |
void | SetQueryVars (const PStringToString &queryVars) |
Set the Query (?) field(s) of the URL as a string dictionary. | |
void | SetQueryVar (const PString &key, const PString &data) |
Set the Query (?) field of the URL as a string dictionary. | |
BOOL | IsEmpty () const |
Return TRUE if the URL is an empty string. | |
static PString | TranslateString (const PString &str, TranslationType type) |
static PString | UntranslateString (const PString &str, TranslationType type) |
static void | SplitQueryVars (const PString &queryStr, PStringToString &queryVars) |
static BOOL | OpenBrowser (const PString &url) |
Public Member Functions | |
PURL () | |
PURL (const char *cstr, const char *defaultScheme=NULL) | |
PURL (const PString &str, const char *defaultScheme=NULL) | |
PURL (const PFilePath &path) | |
BOOL | LegacyParse (const PString &_url, const PURLLegacyScheme *schemeInfo) |
PString | LegacyAsString (PURL::UrlFormat fmt, const PURLLegacyScheme *schemeInfo) const |
Overrides from class PObject | |
virtual Comparison | Compare (const PObject &obj) const |
virtual PINDEX | HashFunction () const |
virtual void | PrintOn (ostream &strm) const |
virtual void | ReadFrom (istream &strm) |
Protected Member Functions | |
virtual BOOL | InternalParse (const char *cstr, const char *defaultScheme) |
void | Recalculate () |
Protected Attributes | |
PString | urlString |
PCaselessString | scheme |
PString | username |
PString | password |
PCaselessString | hostname |
WORD | port |
BOOL | relativePath |
PString | pathStr |
PStringArray | path |
PStringToString | paramVars |
PString | fragment |
PStringToString | queryVars |
|
Type for translation of strings to URL format,.
|
|
Print/String output representation formats. |
|
Construct a new URL object from the URL string. |
|
Construct a new URL object from the URL string.
|
|
Construct a new URL object from the URL string.
|
|
Construct a new URL object from the file path.
|
|
Get the "file:" URL as a file path. If the URL is not a "file:" URL then returns an empty string. |
|
Convert the URL object into its string representation. The parameter indicates whether a full or partial representation os to be produced.
|
|
Compare the two URLs and return their relative rank.
Reimplemented from PObject. |
|
Get the fragment (##) field of the URL.
|
|
Get the hostname field of the URL.
|
|
Get the parameter (;) field of the URL.
|
|
Get the parameter (;) field(s) of the URL as a string dictionary.
|
|
Get the password field of the URL.
|
|
Get the path field of the URL as a string array.
|
|
Get the path field of the URL as a string.
|
|
Get the port field of the URL.
|
|
Get the Query (?) field of the URL as a string.
|
|
Get the Query (?) field of the URL as a string dictionary.
|
|
Get if path is relative or absolute.
|
|
Get the scheme field of the URL.
|
|
Get the username field of the URL.
|
|
This function yields a hash value required by the PDictionary# class. A descendent class that is required to be the key of a dictionary should override this function. The precise values returned is dependent on the semantics of the class. For example, the PString# class overrides it to provide a hash function for distinguishing text strings. The default behaviour is to return the value zero.
Reimplemented from PObject. |
|
|
|
Return TRUE if the URL is an empty string.
|
|
|
|
|
|
Open the URL in a browser.
|
|
Parse the URL string into the fields in the object instance.
|
|
Parse the URL string into the fields in the object instance.
|
|
Output the contents of the URL to the stream as a string.
Reimplemented from PObject. |
|
Input the contents of the URL from the stream. The input is a URL in string form.
Reimplemented from PObject. |
|
|
|
Set the hostname field of the URL.
|
|
Set the parameter (;) field of the URL.
|
|
Set the parameter (;) field of the URL as a string dictionary.
|
|
Set the parameter (;) field(s) of the URL as a string dictionary.
|
|
Set the password field of the URL.
|
|
Set the path field of the URL as a string array.
|
|
Set the path field of the URL as a string.
|
|
Set the port field in the URL.
|
|
Set the Query (?) field of the URL as a string.
|
|
Set the Query (?) field of the URL as a string dictionary.
|
|
Set the Query (?) field(s) of the URL as a string dictionary.
|
|
Set the scheme field of the URL.
|
|
Set the username field of the URL.
|
|
Split a string in &= form to a dictionary of names and values.
|
|
Translate a string from general form to one that can be included into a URL. All reserved characters for the particular field type are escaped.
|
|
Untranslate a string from a form that was included into a URL into a normal string. All reserved characters for the particular field type are unescaped.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|