This class describes a Universal Resource Locator.
Inheritance:
Inherited from PObject:
Public Methods
-
Run Time Type functions
-
I/O functions
-
Miscellaneous functions
Public Members
-
Comparison functions
Documentation
This class describes a Universal Resource Locator.
This is the desciption of a resource location as used by the World Wide
Web and the PHTTPSocket class.
virtual Comparison Compare( const PObject & obj ) const
- Compare the two URLs and return their relative rank.
- Parameters:
- obj - Object to compare against.
- Returns:
- LessThan, EqualTo or GreaterThan
according to the relative rank of the objects.
virtual PINDEX HashFunction() const
- 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.
- Returns:
- hash function value for class instance.
virtual void PrintOn( ostream &strm ) const
- Output the contents of the URL to the stream as a string.
- Parameters:
- - strm Stream to print the object into.
virtual void ReadFrom( istream &strm )
- Input the contents of the URL from the stream. The input is a URL in
string form.
- Parameters:
- - strm Stream to read the objects contents from.
void Parse( const char* cstr, const char* defaultScheme = NULL )
- Parse the URL string into the fields in the object instance.
- Parameters:
- - cstr URL as a string to parse.
defaultScheme - Default scheme for URL
void Parse( const PString & str, const char* defaultScheme = NULL )
- Parse the URL string into the fields in the object instance.
- Parameters:
- - str URL as a string to parse.
defaultScheme - Default scheme for URL
enum UrlFormat
- Print/String output representation formats.
FullURL
- Translate to a string as a full URL
PathOnly
- Translate to a string as only path
URIOnly
- Translate to a string with no scheme or host
HostPortOnly
- Translate to a string with scheme and host/port
PString AsString( UrlFormat fmt = FullURL ) const
- Convert the URL object into its string representation. The parameter
indicates whether a full or partial representation os to be produced.
- Parameters:
- - fmt The type of string to be returned.
- Returns:
- String representation of the URL.
PFilePath AsFilePath() const
- Get the "file:" URL as a file path.
If the URL is not a "file:" URL then returns an empty string.
enum TranslationType
- Type for translation of strings to URL format,
LoginTranslation
- Translate a username/password field for a URL
PathTranslation
- Translate the path field for a URL
QueryTranslation
- Translate the query parameters field for a URL
static PString TranslateString( const PString & str, TranslationType type )
- 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.
- Parameters:
- - str String to be translated.
- type Type of translation.
- Returns:
- String for the URL ready translation.
static PString UntranslateString( const PString & str, TranslationType type )
- 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.
- Parameters:
- - str String to be translated.
- type Type of translation.
- Returns:
- String from the URL untranslated.
static void SplitQueryVars( const PString & queryStr, PStringToString & queryVars )
- Split a string in &= form to a dictionary of names and values.
- Parameters:
- queryStr - String to split into variables.
queryVars - Dictionary of variable names and values.
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 & parameters)
- 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 & paramVars)
- 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 BOOL OpenBrowser( const PString & url )
- Open the URL in a browser.
- Parameters:
- url - URL to open
- Returns:
- The browser was successfully opened. This does not mean the URL exists and was
displayed.
- This class has no child classes.
Alphabetic index HTML hierarchy of classes or Java
This page was generated with the help of DOC++.