// $Revision: 1.5 $ // Copyright (C) 1995 Taligent, Inc. All rights reserved. #if 0 --------------------------------------------------------------------------- > Class: | TURL > Taxonomy Category: | Documented Samples | WebRunner Sample > Interface Category: | Sample. > Inherits From: | None. > Inherited By: | None. > Purpose: | This class encapsulates an Internet _Uniform_ _Resource_ _Locator_ into a CommonPoint data type that can be used to retrieve the information that is located by the abstract locator string. > Instantiation: | Allocate on the heap or the stack. > Deriving Classes: | No special considerations. > Concurrency: | _Not_ multithread safe. > Resource Use: | No special requirements. > Other Considerations: | None. --------------------------------------------------------------------------- #endif #if 0 --------------------------------------------------------------------------- > Member Function: TURL::TURL ; | 1. TURL () | 2. TURL (const TStandardText & urlText) | 3. TURL (const TURL & source) > Interface Category: | Sample. > Purpose: | 1. Default constructor. | 2. Constructs a URL out of the plain text string address. | 3. Copy constructor. > Calling Context: | 1. Called by the stream-in operators or anyone seeking the default URL. | 2. Called by clients. | 3. Called to copy an object. > Parameters: = 1. Takes no parameters. = 2. const TStandardText & urlText -The text locator string to use. = 3. const TURL & source -The object to copy. > Return Value: | None. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | _Not_ multithread safe. > Other Considerations: | None. --------------------------------------------------------------------------- #endif #if 0 --------------------------------------------------------------------------- > Member Function: TURL::~ TURL ; | virtual ~ TURL () > Interface Category: | Sample. > Purpose: | Destructor. > Calling Context: | Called to destroy an object. > Parameters: = Takes no parameters. > Return Value: | None. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | _Not_ multithread safe. > Other Considerations: | None. --------------------------------------------------------------------------- #endif #if 0 --------------------------------------------------------------------------- > Member Function: TURL::operator =; | TURL & operator =(const TURL & source) > Interface Category: | Sample. > Purpose: | Assignment operator. > Calling Context: | Called when an object is assigned to another compatible object. > Parameters: = const TURL & source -The object to be assigned. > Return Value: | A non-const reference to the left-hand side object. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | _Not_ multithread safe. > Other Considerations: | None. --------------------------------------------------------------------------- #endif #if 0 --------------------------------------------------------------------------- > Member Function: TURL::operator >>=; | virtual TStream & operator >>=(TStream & toStream) const > Interface Category: | Sample. > Purpose: | Stream-out operator. > Calling Context: | Called to stream out data. > Parameters: = TStream & toStream -The stream the object streams itself out to. > Return Value: | Returns a reference to the stream the object streams itself out to. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | _Not_ multithread safe. > Other Considerations: | None. --------------------------------------------------------------------------- #endif #if 0 --------------------------------------------------------------------------- > Member Function: TURL::operator <<= ; | virtual TStream & operator <<= (TStream & fromStream) > Interface Category: | Sample. > Purpose: | Stream-in operator. > Calling Context: | Called to stream in data. > Parameters: = TStream & fromStream -The stream the object streams itself in from. > Return Value: | Returns a reference to the stream the object streams itself in from. > Exceptions: | Throws TInvalidVersionError if the object version isn't known. > Concurrency: | _Not_ multithread safe. > Other Considerations: | None. --------------------------------------------------------------------------- #endif #if 0 --------------------------------------------------------------------------- > Member Function: TURL::operator ==; | virtual bool operator ==(const TURL & other) const > Interface Category: | Sample. > Purpose: | Compares the identity of two URLs. > Calling Context: | Called to compare two URLs for equality. > Parameters: = const TURL & other -The value to compare against. > Return Value: | Returns true if this value has the same URL value as the other. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | _Not_ multithread safe. > Other Considerations: | None. --------------------------------------------------------------------------- #endif #if 0 --------------------------------------------------------------------------- > Member Function: TURL::operator != ; | virtual bool operator != (const TURL & other) const > Interface Category: | Sample. > Purpose: | Checks for the inequality of two URLs. > Calling Context: | Called to compare two URLs for inequality. > Parameters: = const TURL & other -The value to compare against. > Return Value: | Returns true if this value is not identical to the argument URL. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | _Not_ multithread safe. > Other Considerations: | None. --------------------------------------------------------------------------- #endif #if 0 --------------------------------------------------------------------------- > Member Function: TURL::GetURLText ; | TStandardText GetURLText () const > Interface Category: | Sample. > Purpose: | Retrieves the text representation of this URL. > Calling Context: | Call this function directly. > Parameters: = Takes no parameters. > Return Value: | Returns the text representation of this URL's address. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | _Not_ multithread safe. > Other Considerations: | None. --------------------------------------------------------------------------- #endif #if 0 --------------------------------------------------------------------------- > Member Function: TURL::Follow ; | TScrapItem * Follow (const TCollectionOf < TTypeDescription > & acceptableScrapTypes) const > Interface Category: | Sample. > Purpose: | Traverses this URL to its destination, retrieves the information there, and returns it as a CommonPoint scrap item, if possible. This function serves as the gateway to the LibWWW library, so all attempts to retrieve WWW information should go through this function. > Calling Context: | Call this function directly. > Parameters: = const TCollectionOf < TTypeDescription > & acceptableScrapTypes -The list of valid CommonPoint scrap item types that can be returned. > Return Value: | Returns the CommonPoint scrap item value that was retrieved by the library, or NIL if none is found. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | _Not_ multithread safe. > Other Considerations: | None. --------------------------------------------------------------------------- #endif #if 0 --------------------------------------------------------------------------- > Member Function: TURL::TranslateNonTextStream ; | virtual TScrapItem * TranslateNonTextStream (TChunkyStream * adoptStream, const TMIMEForeignDataType & mimeType, const TCollectionOf < TTypeDescription > & acceptableScrapTypes) const > Interface Category: | Sample. > Purpose: | Translates from a CommonPoint stream of data into one of a number of requested data values, if possible. > Calling Context: | Called internally whenever TURL::Follow hits a nonhypertext data value. > Parameters: = TChunkyStream * adoptStream -The stream of data to translate. Delete this stream when finished. = const TMIMEForeignDataType & mimeType -The MIME type of this stream. = const TCollectionOf < TTypeDescription > & acceptableScrapTypes -A list of scrap item types that can be accepted from this function. > Return Value: | Returns a scrap item corresponding to the translated data, if possible, or NIL if not. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | _Not_ multithread safe. > Other Considerations: | None. --------------------------------------------------------------------------- #endif