// Copyright (C) 1995 Taligent, Inc. All rights reserved. #if 0 --------------------------------------------------------------------------- > Class: | TFollowURLCommand > Taxonomy Category: | Documented Samples | WebRunner Sample > Interface Category: | Sample. > Inherits From: | TCommandOn > Inherited By: | None. > Purpose: | This is a simple command to make a WebRunner Sample document display a different page of information by commanding TWebModel to retrieve and show a new URL. > 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: TFollowURLCommand::TFollowURLCommand ; | 1. TFollowURLCommand (const TURL & destination) | 2. TFollowURLCommand (const TFollowURLCommand & source) > Interface Category: | Sample. > Purpose: | 1. Constructs using the URL that the destination model should display. | 2. Copy constructor. > Calling Context: | 1. Call this function directly. | 2. Called to copy an object. > Parameters: = 1. const TURL & destination -The desired model destination. = 2. const TFollowURLCommand & source -The command 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: TFollowURLCommand::~ TFollowURLCommand ; | virtual ~ TFollowURLCommand () > 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: TFollowURLCommand::operator =; | TFollowURLCommand & operator =(const TFollowURLCommand & source) > Interface Category: | Sample. > Purpose: | Assignment operator. > Calling Context: | Called when an object is assigned to another compatible object. > Parameters: = const TFollowURLCommand & source -The target to copy. > 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: TFollowURLCommand::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: TFollowURLCommand::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: TFollowURLCommand::HandleDoBegin ; | virtual void HandleDoBegin (TModelSelection & selection) > Interface Category: | Sample. > Purpose: | Executes the command upon the target model, causing it to change to a new URL. Stores the model's old URL for future Undo operations. > Calling Context: | Called by the Document framework. > Parameters: = TModelSelection & selection -A selection upon the target TWebModel. > Return Value: | None. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | _Not_ multithread safe. > Other Considerations: | None. --------------------------------------------------------------------------- #endif #if 0 --------------------------------------------------------------------------- > Member Function: TFollowURLCommand::HandleUndo ; | virtual void HandleUndo (TModelSelection & selection) > Interface Category: | Sample. > Purpose: | Restores the model to its previous URL, which was stored during the HandleDoBegin call. > Calling Context: | Called by the Document framework. > Parameters: = TModelSelection & selection -A selection upon the target TWebModel. > Return Value: | None. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | _Not_ multithread safe. > Other Considerations: | None. --------------------------------------------------------------------------- #endif #if 0 --------------------------------------------------------------------------- > Member Function: TFollowURLCommand::HandleRedo ; | virtual void HandleRedo (TModelSelection & selection) > Interface Category: | Sample. > Purpose: | Makes the target model change to display the URL used in the call to HandleDoBegin. > Calling Context: | Called by the Document framework. > Parameters: = TModelSelection & selection -A selection upon the target TWebModel. > Return Value: | None. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | _Not_ multithread safe. > Other Considerations: | None. --------------------------------------------------------------------------- #endif