PTLib  Version 2.10.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
PHTML Class Reference

This class describes a HyperText markup Language string as used by the World Wide Web and the PURL and PHTTP class. More...

#include <html.h>

Inheritance diagram for PHTML:
PStringStream PString PCharArray PBaseArray< T > PAbstractArray PContainer PObject PServiceHTML

Classes

class  Abbrev
class  Acronym
class  Address
class  Author
class  Banner
class  Big
class  BlockQuote
class  Body
class  Bold
class  BreakLine
class  BulletList
class  CheckBox
class  Cite
class  Code
class  Credit
class  Definition
class  DefinitionItem
class  DefinitionList
class  DefinitionTerm
class  DeletedText
class  Division
class  Element
class  Emphasis
class  FieldElement
class  Form
class  FormField
class  Head
class  Heading
class  HiddenField
class  HotLink
class  HRule
class  HTML
class  Image
class  ImageElement
class  InputField
class  InputFile
class  InputImage
class  InputNumber
class  InputPassword
class  InputRange
class  InputScribble
class  InputText
class  InsertedText
class  Italic
class  Keyboard
class  ListHeading
class  ListItem
class  Note
class  Option
class  OrderedList
class  Paragraph
class  Person
class  PreFormat
class  Quote
class  RadioButton
class  ResetButton
class  Sample
class  Select
class  SetTab
class  SimpleList
class  Small
class  StrikeThrough
class  Strong
class  SubmitButton
class  Subscript
class  Superscript
class  Tab
class  TableData
class  TableEnd
class  TableHeader
class  TableRow
class  TableStart
class  Target
class  TeleType
class  TextArea
class  Title
class  Underline
class  Variable

Public Types

enum  ElementInSet {
  InHTML, InHead, InBody, InTitle,
  InHeading, InDivision, InPreFormat, InAnchor,
  InNote, InAddress, InBlockQuote, InCredit,
  InBold, InItalic, InTeleType, InUnderline,
  InStrikeThrough, InBig, InSmall, InSubscript,
  InSuperscript, InEmphasis, InCite, InStrong,
  InCode, InSample, InKeyboard, InVariable,
  InDefinition, InQuote, InAuthor, InPerson,
  InAcronym, InAbbrev, InInsertedText, InDeletedText,
  InList, InListHeading, InDefinitionTerm, InTable,
  InForm, InSelect, InTextArea, NumElementsInSet
}
enum  BorderCodes { NoBorder, Border }
enum  DisableCodes { Enabled, Disabled }
enum  SelectionCodes { NotSelected, Selected }
enum  CheckedCodes { UnChecked, Checked }

Public Member Functions

 PHTML (ElementInSet initialState=NumElementsInSet)
 Construct a new HTML object.
 PHTML (const char *cstr)
 PHTML (const PString &str)
 ~PHTML ()
PHTMLoperator= (const PHTML &html)
 Restart the HTML string output using the specified value as the new title.
PHTMLoperator= (const PString &str)
 Assign the string to the current object.
PHTMLoperator= (const char *cstr)
 Assign the C string to the string stream.
PHTMLoperator= (char ch)
 Assign the character to the current object.
PBoolean Is (ElementInSet elmt) const
void Set (ElementInSet elmt)
void Clr (ElementInSet elmt)
void Toggle (ElementInSet elmt)
- Public Member Functions inherited from PStringStream
 PStringStream ()
 Create a new, empty, string stream.
 PStringStream (PINDEX fixedBufferSize)
 Create a new, empty, string stream of a fixed size.
 PStringStream (const PString &str)
 Create a new string stream and initialise it to the provided value.
 PStringStream (const char *cstr)
 Create a new string stream and initialise it with the provided value.
virtual PStringMakeEmpty ()
 Make the current string empty.
PStringStreamoperator= (const PStringStream &strm)
 Assign the string part of the stream to the current object.
virtual ~PStringStream ()
 Destroy the string stream, deleting the stream buffer.
- Public Member Functions inherited from PString
virtual PObjectClone () const
 Make a complete duplicate of the string.
virtual Comparison Compare (const PObject &obj) const
 Get the relative rank of the two strings.
virtual void PrintOn (ostream &strm) const
 Output the string to the specified stream.
virtual void ReadFrom (istream &strm)
 Input the string from the specified stream.
virtual PINDEX HashFunction () const
 Calculate a hash value for use in sets and dictionaries.
virtual PBoolean SetSize (PINDEX newSize)
 Set the size of the string.
virtual PBoolean IsEmpty () const
 Determine if the string is empty.
virtual PBoolean MakeUnique ()
 Make this instance to be the one and only reference to the container contents.
PBoolean MakeMinimumSize ()
 Set the actual memory block array size to the minimum required to hold the current string contents.
PINLINE PINDEX GetLength () const
 Determine the length of the null terminated string.
bool operator! () const
 Determine if the string is NOT empty.
bool operator*= (const PString &str) const
 Compare two strings using case insensitive comparison.
bool operator== (const PObject &str) const
 Compare two strings using the PObject::Compare() function.
bool operator!= (const PObject &str) const
 Compare two strings using the PObject::Compare() function.
bool operator< (const PObject &str) const
 Compare two strings using the PObject::Compare() function.
bool operator> (const PObject &str) const
 Compare two strings using the PObject::Compare() function.
bool operator<= (const PObject &str) const
 Compare two strings using the PObject::Compare() function.
bool operator>= (const PObject &str) const
 Compare two strings using the PObject::Compare() function.
bool operator*= (const char *cstr) const
 Compare a PString to a C string using a case insensitive compare function.
bool operator== (const char *cstr) const
 Compare a PString to a C string using the Compare() function.
bool operator!= (const char *cstr) const
 Compare a PString to a C string using the PObject::Compare() function.
bool operator< (const char *cstr) const
 Compare a PString to a C string using the PObject::Compare() function.
bool operator> (const char *cstr) const
 Compare a PString to a C string using the PObject::Compare() function.
bool operator<= (const char *cstr) const
 Compare a PString to a C string using the PObject::Compare() function.
bool operator>= (const char *cstr) const
 Compare a PString to a C string using the PObject::Compare() function.
Comparison NumCompare (const PString &str, PINDEX count=P_MAX_INDEX, PINDEX offset=0) const
 Compare a string against a substring of the object.
Comparison NumCompare (const char *cstr, PINDEX count=P_MAX_INDEX, PINDEX offset=0) const
 Compare a string against a substring of the object.
PINDEX Find (char ch, PINDEX offset=0) const
 Locate the position within the string of the character.
PINDEX Find (const PString &str, PINDEX offset=0) const
 Locate the position within the string of the substring.
PINDEX Find (const char *cstr, PINDEX offset=0) const
PINDEX FindLast (char ch, PINDEX offset=P_MAX_INDEX) const
 Locate the position of the last matching character.
PINDEX FindLast (const PString &str, PINDEX offset=P_MAX_INDEX) const
 Locate the position of the last matching substring.
PINDEX FindLast (const char *cstr, PINDEX offset=P_MAX_INDEX) const
 Locate the position of the last matching substring.
PINDEX FindOneOf (const PString &set, PINDEX offset=0) const
 Locate the position of one of the characters in the set.
PINDEX FindOneOf (const char *cset, PINDEX offset=0) const
 Locate the position of one of the characters in the set.
PINDEX FindSpan (const PString &set, PINDEX offset=0) const
 Locate the position of character not in the set.
PINDEX FindSpan (const char *cset, PINDEX offset=0) const
 Locate the position of character not in the set.
PINDEX FindRegEx (const PRegularExpression &regex, PINDEX offset=0) const
 Locate the position within the string of one of the regular expression.
PBoolean FindRegEx (const PRegularExpression &regex, PINDEX &pos, PINDEX &len, PINDEX offset=0, PINDEX maxPos=P_MAX_INDEX) const
 Locate the position within the string of one of the regular expression.
PBoolean MatchesRegEx (const PRegularExpression &regex) const
 Return true if the entire string matches the regular expression.
void Replace (const PString &target, const PString &subs, PBoolean all=false, PINDEX offset=0)
 Locate the substring within the string and replace it with the specifed substring.
void Splice (const PString &str, PINDEX pos, PINDEX len=0)
 Splice the string into the current string at the specified position.
void Splice (const char *cstr, PINDEX pos, PINDEX len=0)
 Splice the string into the current string at the specified position.
void Delete (PINDEX start, PINDEX len)
 Remove the substring from the string.
PString operator() (PINDEX start, PINDEX end) const
 Extract a portion of the string into a new string.
PString Left (PINDEX len) const
 Extract a portion of the string into a new string.
PString Right (PINDEX len) const
 Extract a portion of the string into a new string.
PString Mid (PINDEX start, PINDEX len=P_MAX_INDEX) const
 Extract a portion of the string into a new string.
PString LeftTrim () const
 Create a string consisting of all characters from the source string except all spaces at the beginning of the string.
PString RightTrim () const
 Create a string consisting of all characters from the source string except all spaces at the end of the string.
PString Trim () const
 Create a string consisting of all characters from the source string except all spaces at the beginning and end of the string.
PString ToLower () const
 Create a string consisting of all characters from the source string with all upper case letters converted to lower case.
PString ToUpper () const
 Create a string consisting of all characters from the source string with all lower case letters converted to upper case.
PStringArray Tokenise (const PString &separators, PBoolean onePerSeparator=true) const
 Split the string into an array of substrings.
PStringArray Tokenise (const char *cseparators, PBoolean onePerSeparator=true) const
 Split the string into an array of substrings.
PStringArray Lines () const
 Split the string into individual lines.
PINLINE PString ()
 Construct an empty string.
PINLINE PString (const PString &str)
 Create a new reference to the specified string.
PINLINE PString (const std::string &str)
 Create a new string from the specified std::string.
 PString (const char *cstr)
 Create a string from the C string array.
 PString (const wchar_t *ustr)
 Create a string from the UCS-2 string array.
 PString (const char *cstr, PINDEX len)
 Create a string from the array.
 PString (const wchar_t *ustr, PINDEX len)
 Create a string from the UCS-2 array.
 PString (const PWCharArray &ustr)
 Create a string from the UCS-2 array.
 PString (char ch)
 Create a string from the single character.
 PString (short n)
 Create a string from the integer type.
 PString (unsigned short n)
 Create a string from the integer type.
 PString (int n)
 Create a string from the integer type.
 PString (unsigned int n)
 Create a string from the integer type.
 PString (long n)
 Create a string from the integer type.
 PString (unsigned long n)
 Create a string from the integer type.
 PString (PInt64 n)
 Create a string from the integer type.
 PString (PUInt64 n)
 Create a string from the integer type.
 PString (ConversionType type, const char *str,...)
 PString (ConversionType type, long value, unsigned base=10)
 PString (ConversionType type, double value, unsigned places)
PStringoperator= (const std::string &str)
 Assign the string to the current object.
PStringoperator= (short n)
 Assign a string from the integer type.
PStringoperator= (unsigned short n)
 Assign a string from the integer type.
PStringoperator= (int n)
 Assign a string from the integer type.
PStringoperator= (unsigned int n)
 Assign a string from the integer type.
PStringoperator= (long n)
 Assign a string from the integer type.
PStringoperator= (unsigned long n)
 Assign a string from the integer type.
PStringoperator= (PInt64 n)
 Assign a string from the integer type.
PStringoperator= (PUInt64 n)
 Assign a string from the integer type.
PString operator+ (const PString &str) const
 Concatenate two strings to produce a third.
PString operator+ (const char *cstr) const
 Concatenate a C string to a PString to produce a third.
PString operator+ (char ch) const
 Concatenate a single character to a PString to produce a third.
PStringoperator+= (const PString &str)
 Concatenate a string to another string, modifiying that string.
PStringoperator+= (const char *cstr)
 Concatenate a C string to a PString, modifiying that string.
PStringoperator+= (char ch)
 Concatenate a single character to a PString.
PString operator& (const PString &str) const
 Concatenate two strings to produce a third.
PString operator& (const char *cstr) const
 Concatenate a C string to a PString to produce a third.
PString operator& (char ch) const
 Concatenate a single character to a PString to produce a third.
PStringoperator&= (const PString &str)
 Concatenate a string to another string, modifiying that string.
PStringoperator&= (const char *cstr)
 Concatenate a C string to a PString, modifiying that string.
PStringoperator&= (char ch)
 Concatenate a character to a PString, modifiying that string.
PStringsprintf (const char *cfmt,...)
 Concatenate a formatted output to the string.
PStringvsprintf (const PString &fmt, va_list args)
 Concatenate a formatted output to the string.
PStringvsprintf (const char *cfmt, va_list args)
 Concatenate a formatted output to the string.
long AsInteger (unsigned base=10) const
 Convert the string to an integer value using the specified number base.
DWORD AsUnsigned (unsigned base=10) const
 Convert the string to an integer value using the specified number base.
PInt64 AsInt64 (unsigned base=10) const
 Convert the string to an integer value using the specified number base.
PUInt64 AsUnsigned64 (unsigned base=10) const
 Convert the string to an integer value using the specified number base.
double AsReal () const
 Convert the string to a floating point number.
PWCharArray AsUCS2 () const
 Convert UTF-8 string to UCS-2.
PBYTEArray ToPascal () const
 Convert a standard null terminated string to a "pascal" style string.
PString ToLiteral () const
 Convert the string to C literal string format.
 operator const unsigned char * () const
 Get the internal buffer as a pointer to unsigned characters.
 operator std::string () const
 Cast the PString to a std::string.
- Public Member Functions inherited from PCharArray
 PCharArray (PINDEX initialSize=0)
 Construct a new dynamic array of char.
 PCharArray (char const *buffer, PINDEX length, PBoolean dynamic=true)
 Construct a new dynamic array of char.
- Public Member Functions inherited from PBaseArray< T >
 PBaseArray (PINDEX initialSize=0)
 Construct a new dynamic array of elements of the specified type.
 PBaseArray (T const *buffer, PINDEX length, PBoolean dynamic=true)
 Construct a new dynamic array of elements of the specified type.
PBoolean SetAt (PINDEX index, T val)
 Set the specific element in the array.
GetAt (PINDEX index) const
 Get a value from the array.
void Attach (const T *buffer, PINDEX bufferSize)
 Attach a pointer to a static block to the base array type.
T * GetPointer (PINDEX minSize=0)
 Get a pointer to the internal array and assure that it is of at least the specified size.
operator[] (PINDEX index) const
 Get a value from the array.
T & operator[] (PINDEX index)
 Get a reference to value from the array.
 operator T const * () const
 Get a pointer to the internal array.
PBoolean Concatenate (const PBaseArray &array)
 Concatenate one array to the end of this array.
- Public Member Functions inherited from PAbstractArray
 PAbstractArray (PINDEX elementSizeInBytes, PINDEX initialSize=0)
 Create a new dynamic array of initalSize elements of elementSizeInBytes bytes each.
 PAbstractArray (PINDEX elementSizeInBytes, const void *buffer, PINDEX bufferSizeInElements, PBoolean dynamicAllocation)
 Create a new dynamic array of bufferSizeInElements elements of elementSizeInBytes bytes each.
void Attach (const void *buffer, PINDEX bufferSize)
 Attach a pointer to a static block to the base array type.
PBoolean Concatenate (const PAbstractArray &array)
 Concatenate one array to the end of this array.
- Public Member Functions inherited from PContainer
 PContainer (PINDEX initialSize=0)
 Create a new unique container.
 PContainer (const PContainer &cont)
 Create a new refernce to container.
PContaineroperator= (const PContainer &cont)
 Assign one container reference to another.
virtual ~PContainer ()
 Destroy the container class.
virtual PINDEX GetSize () const
 Get the current size of the container.
PBoolean SetMinSize (PINDEX minSize)
 Set the minimum size of container.
PBoolean IsUnique () const
 Determine if container is unique reference.
- Public Member Functions inherited from PObject
virtual ~PObject ()
virtual Comparison CompareObjectMemoryDirect (const PObject &obj) const
 Determine the byte wise comparison of two objects.
virtual const char * GetClass (unsigned ancestor=0) const
 Get the current dynamic type of the object instance.
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.

Protected Member Functions

virtual void AssignContents (const PContainer &c)
 Copy the container contents.

Additional Inherited Members

- Static Public Member Functions inherited from PString
static PString Empty ()
 Return an empty string.
- Static Public Member Functions inherited from PObject
static Comparison InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size)
 Internal function caled from CompareObjectMemoryDirect()
static const char * Class ()
 Get the name of the class as a C string.
- Protected Attributes inherited from PAbstractArray
PINDEX elementSize
 Size of an element in bytes.
char * theArray
 Pointer to the allocated block of memory.
PBoolean allocatedDynamically
 Flag indicating the array was allocated on the heap.
- Friends inherited from PString
- Friends inherited from PObject

Detailed Description

This class describes a HyperText markup Language string as used by the World Wide Web and the PURL and PHTTP class.

All of the standard stream I/O operators, manipulators etc will operate on the PString class.

Member Enumeration Documentation

Enumerator:
NoBorder 
Border 
Enumerator:
UnChecked 
Checked 
Enumerator:
Enabled 
Disabled 
Enumerator:
InHTML 
InHead 
InBody 
InTitle 
InHeading 
InDivision 
InPreFormat 
InAnchor 
InNote 
InAddress 
InBlockQuote 
InCredit 
InBold 
InItalic 
InTeleType 
InUnderline 
InStrikeThrough 
InBig 
InSmall 
InSubscript 
InSuperscript 
InEmphasis 
InCite 
InStrong 
InCode 
InSample 
InKeyboard 
InVariable 
InDefinition 
InQuote 
InAuthor 
InPerson 
InAcronym 
InAbbrev 
InInsertedText 
InDeletedText 
InList 
InListHeading 
InDefinitionTerm 
InTable 
InForm 
InSelect 
InTextArea 
NumElementsInSet 
Enumerator:
NotSelected 
Selected 

Constructor & Destructor Documentation

PHTML::PHTML ( ElementInSet  initialState = NumElementsInSet)

Construct a new HTML object.

If a title is specified in the constructor then the HEAD, TITLE and BODY elements are output and the string is used in a H1 element.

PHTML::PHTML ( const char *  cstr)
Parameters
cstrC string representation of the title string.
PHTML::PHTML ( const PString str)
Parameters
strString representation of the title string.
PHTML::~PHTML ( )

Member Function Documentation

virtual void PHTML::AssignContents ( const PContainer c)
protectedvirtual

Copy the container contents.

This copies the contents from one reference to another.

No duplication of contents occurs, for instance if the container is an array, the pointer to the array memory is copied, not the array memory block itself.

This function will get called by the base assignment operator.

Reimplemented from PStringStream.

Referenced by operator=().

void PHTML::Clr ( ElementInSet  elmt)
PBoolean PHTML::Is ( ElementInSet  elmt) const
PHTML& PHTML::operator= ( const PHTML html)
inline

Restart the HTML string output using the specified value as the new title.

If title is empty then no HEAD or TITLE elements are placed into the HTML.

Parameters
htmlHTML stream to make a copy of.

References AssignContents().

PHTML& PHTML::operator= ( const PString str)
inline

Assign the string to the current object.

The current instance then becomes another reference to the same string in the str parameter.

This will reset the read pointer for input to the beginning of the string. Also, any data output to the string up until the asasignement will be lost.

Returns
reference to the current PStringStream object.
Parameters
strString for title in restating HTML.

Reimplemented from PStringStream.

References AssignContents().

PHTML& PHTML::operator= ( const char *  cstr)
inline

Assign the C string to the string stream.

The current instance then becomes a unique reference to a copy of the cstr parameter. The cstr parameter is typically a literal string, eg:


          myStr = "fred";
   This will reset the read pointer for input to the beginning of the
   string. Also, any data output to the string up until the asasignement
   will be lost.

   @return
   reference to the current PStringStream object.
Parameters
cstrString for title in restating HTML.

Reimplemented from PStringStream.

References AssignContents(), and PString::PString().

PHTML& PHTML::operator= ( char  ch)
inline

Assign the character to the current object.

The current instance then becomes a unique reference to a copy of the character parameter. eg:


          myStr = 'A';
Returns
reference to the current PString object.
Parameters
chString for title in restating HTML.

Reimplemented from PStringStream.

References AssignContents(), and PString::PString().

void PHTML::Set ( ElementInSet  elmt)
void PHTML::Toggle ( ElementInSet  elmt)

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