PTLib
Version 2.10.10
|
#include <vcard.h>
Public Member Functions | |
URIValue (const char *str=NULL) | |
URIValue (const PString &str) | |
virtual void | PrintOn (ostream &strm) const |
Output the contents of the URL to the stream as a string. More... | |
virtual void | ReadFrom (istream &strm) |
Input the contents of the URL from the stream. More... | |
![]() | |
PURL () | |
Construct a new URL object from the URL string. More... | |
PURL (const char *cstr, const char *defaultScheme="http") | |
Construct a new URL object from the URL string. More... | |
PURL (const PString &str, const char *defaultScheme="http") | |
Construct a new URL object from the URL string. More... | |
PURL (const PFilePath &path) | |
Construct a new URL object from the file path. More... | |
PURL (const PURL &other) | |
PURL & | operator= (const PURL &other) |
PBoolean | LegacyParse (const PString &url, const PURLLegacyScheme *schemeInfo) |
PString | LegacyAsString (PURL::UrlFormat fmt, const PURLLegacyScheme *schemeInfo) const |
virtual Comparison | Compare (const PObject &obj) const |
Compare the two URLs and return their relative rank. More... | |
virtual PINDEX | HashFunction () const |
This function yields a hash value required by the PDictionary class. More... | |
PBoolean | Parse (const char *cstr, const char *defaultScheme=NULL) |
Parse the URL string into the fields in the object instance. More... | |
PBoolean | Parse (const PString &str, const char *defaultScheme=NULL) |
Parse the URL string into the fields in the object instance. More... | |
PString | AsString (UrlFormat fmt=FullURL) const |
Convert the URL object into its string representation. More... | |
operator PString () const | |
PFilePath | AsFilePath () const |
Get the "file:" URL as a file path. More... | |
const PCaselessString & | GetScheme () const |
Get the scheme field of the URL. More... | |
void | SetScheme (const PString &scheme) |
Set the scheme field of the URL. More... | |
const PString & | GetUserName () const |
Get the username field of the URL. More... | |
void | SetUserName (const PString &username) |
Set the username field of the URL. More... | |
const PString & | GetPassword () const |
Get the password field of the URL. More... | |
void | SetPassword (const PString &password) |
Set the password field of the URL. More... | |
const PCaselessString & | GetHostName () const |
Get the hostname field of the URL. More... | |
void | SetHostName (const PString &hostname) |
Set the hostname field of the URL. More... | |
WORD | GetPort () const |
Get the port field of the URL. More... | |
void | SetPort (WORD newPort) |
Set the port field in the URL. More... | |
PBoolean | GetPortSupplied () const |
Get if explicit port is specified. More... | |
PBoolean | GetRelativePath () const |
Get if path is relative or absolute. More... | |
PString | GetPathStr () const |
Get the path field of the URL as a string. More... | |
void | SetPathStr (const PString &pathStr) |
Set the path field of the URL as a string. More... | |
const PStringArray & | GetPath () const |
Get the path field of the URL as a string array. More... | |
void | SetPath (const PStringArray &path) |
Set the path field of the URL as a string array. More... | |
void | AppendPath (const PString &segment) |
Append segment to the path field of the URL. More... | |
PString | GetParameters () const |
Get the parameter (;) field of the URL. More... | |
void | SetParameters (const PString ¶meters) |
Set the parameter (;) field of the URL. More... | |
const PStringOptions & | GetParamVars () const |
Get the parameter (;) field(s) of the URL as a string dictionary. More... | |
void | SetParamVars (const PStringToString ¶mVars) |
Set the parameter (;) field(s) of the URL as a string dictionary. More... | |
void | SetParamVar (const PString &key, const PString &data, bool emptyDataDeletes=true) |
Set the parameter (;) field of the URL as a string dictionary. More... | |
const PString & | GetFragment () const |
Get the fragment (#) field of the URL. More... | |
PString | GetQuery () const |
Get the Query (?) field of the URL as a string. More... | |
void | SetQuery (const PString &query) |
Set the Query (?) field of the URL as a string. More... | |
const PStringOptions & | GetQueryVars () const |
Get the Query (?) field of the URL as a string dictionary. More... | |
void | SetQueryVars (const PStringToString &queryVars) |
Set the Query (?) field(s) of the URL as a string dictionary. More... | |
void | SetQueryVar (const PString &key, const PString &data) |
Set the Query (?) field of the URL as a string dictionary. More... | |
const PString & | GetContents () const |
Get the contents of URL, data left after all elemetns are parsed out. More... | |
void | SetContents (const PString &str) |
Set the contents of URL, data left after all elemetns are parsed out. More... | |
PBoolean | IsEmpty () const |
Return true if the URL is an empty string. More... | |
bool | LoadResource (PString &data, const PString &requiredContentType=PString::Empty()) const |
Get the resource the URL is pointing at. More... | |
bool | LoadResource (PBYTEArray &data, const PString &requiredContentType=PString::Empty()) const |
bool | OpenBrowser () const |
Open the URL in a browser. More... | |
![]() | |
virtual | ~PObject () |
virtual PObject * | Clone () const |
Create a copy of the class on the heap. More... | |
virtual const char * | GetClass (unsigned ancestor=0) const |
Get the current dynamic type of the object instance. More... | |
PBoolean | IsClass (const char *cls) const |
virtual PBoolean | InternalIsDescendant (const char *clsName) const |
Determine if the dynamic type of the current instance is a descendent of the specified class. More... | |
virtual Comparison | CompareObjectMemoryDirect (const PObject &obj) const |
Determine the byte wise comparison of two objects. More... | |
bool | operator== (const PObject &obj) const |
Compare the two objects. More... | |
bool | operator!= (const PObject &obj) const |
Compare the two objects. More... | |
bool | operator< (const PObject &obj) const |
Compare the two objects. More... | |
bool | operator> (const PObject &obj) const |
Compare the two objects. More... | |
bool | operator<= (const PObject &obj) const |
Compare the two objects. More... | |
bool | operator>= (const PObject &obj) const |
Compare the two objects. More... | |
Additional Inherited Members | |
![]() | |
enum | UrlFormat { FullURL, PathOnly, URIOnly, HostPortOnly } |
Print/String output representation formats. More... | |
enum | TranslationType { LoginTranslation, PathTranslation, QueryTranslation, ParameterTranslation, QuotedParameterTranslation } |
Type for translation of strings to URL format,. More... | |
![]() | |
enum | Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 } |
Result of the comparison operation performed by the Compare() function. More... | |
![]() | |
static PString | TranslateString (const PString &str, TranslationType type) |
Translate a string from general form to one that can be included into a URL. More... | |
static PString | UntranslateString (const PString &str, TranslationType type) |
Untranslate a string from a form that was included into a URL into a normal string. More... | |
static void | SplitVars (const PString &str, PStringToString &vars, char sep1= ';', char sep2= '=', TranslationType type=ParameterTranslation) |
Split a string to a dictionary of names and values. More... | |
static void | SplitQueryVars (const PString &queryStr, PStringToString &queryVars) |
Split a string in &= form to a dictionary of names and values. More... | |
static void | OutputVars (ostream &strm, const PStringToString &vars, char sep0= ';', char sep1= ';', char sep2= '=', TranslationType type=ParameterTranslation) |
Construct string from a dictionary using separators. More... | |
static bool | OpenBrowser (const PString &url) |
![]() | |
static const char * | Class () |
Get the name of the class as a C string. More... | |
static Comparison | InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size) |
Internal function caled from CompareObjectMemoryDirect() More... | |
![]() | |
void | CopyContents (const PURL &other) |
virtual PBoolean | InternalParse (const char *cstr, const char *defaultScheme) |
void | Recalculate () |
![]() | |
PString | urlString |
PCaselessString | scheme |
PString | username |
PString | password |
PCaselessString | hostname |
WORD | port |
PBoolean | portSupplied |
PBoolean | relativePath |
port was supplied in string input More... | |
PStringArray | path |
PStringOptions | paramVars |
PString | fragment |
PStringOptions | queryVars |
PString | m_contents |
![]() |
|
inline |
|
inline |
|
virtual |
Output the contents of the URL to the stream as a string.
Reimplemented from PURL.
Reimplemented in PvCard::InlineValue.
|
virtual |
Input the contents of the URL from the stream.
The input is a URL in string form.
Reimplemented from PURL.
Reimplemented in PvCard::InlineValue.