Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Namespace Members | Compound Members | File Members

TSE3::Cmd::Phrase_Replace Class Reference

#include <Phrase.h>

Inheritance diagram for TSE3::Cmd::Phrase_Replace:

Inheritance graph
[legend]
Collaboration diagram for TSE3::Cmd::Phrase_Replace:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Phrase_Replace (TSE3::Phrase *oldPhrase, TSE3::Phrase *newPhrase, TSE3::Song *song)
 Phrase_Replace (TSE3::Phrase *oldPhrase, TSE3::PhraseEdit *phraseEdit, TSE3::Song *song, const std::string &title="")
 ~Phrase_Replace ()
TSE3::Phrase * phrase () const

Protected Member Functions

virtual void executeImpl ()
virtual void undoImpl ()

Constructor & Destructor Documentation

TSE3::Cmd::Phrase_Replace::Phrase_Replace (  TSE3::Phrase *  oldPhrase,
TSE3::Phrase *  newPhrase,
TSE3::Song *  song
) 
 

Creates a new Phrase_Replace command.

Every TSE3::Part that uses the oldPhrase will be made to use the newPhrase.

Both of the TSE3::Phrase objects ought to be in the same TSE3::PhraseList (which should be in the TSE3::Song).

Parameters:
oldPhrase TSE3::Phrase to remove
newPhrase TSE3::Phrase to replace with
song TSE3::Song to act on

TSE3::Cmd::Phrase_Replace::Phrase_Replace (  TSE3::Phrase *  oldPhrase,
TSE3::PhraseEdit *  phraseEdit,
TSE3::Song *  song,
const std::string &  title = ""
) 
 

The oldPhrase is removed from the TSE3::PhraseList completely. A new Phrase created from the phraseEdit object and is inserted in its place. If the title is not specified, then it will be give the same title as the oldPhrase. The replacement operation will be performed, and the the new Phrase will be inserted into the TSE3::PhraseList.

Parameters:
oldPhrase TSE3::Phrase to remove
phraseEdit TSE3::PhraseEdit to source data from
song TSE3::Song to act on
title Title for new Phras

TSE3::Cmd::Phrase_Replace::~Phrase_Replace (   ) 
 

Member Function Documentation

TSE3::Phrase* TSE3::Cmd::Phrase_Replace::phrase (   )  const [inline]
 

Returns a pointer to the new (possibly created) Phrase.

If this Phrase has been created, then the result of this method is only valid once execute() had been called.

virtual void TSE3::Cmd::Phrase_Replace::executeImpl (   )  [protected, virtual]
 

Implements TSE3::Cmd::Command.

virtual void TSE3::Cmd::Phrase_Replace::undoImpl (   )  [protected, virtual]
 

Implements TSE3::Cmd::Command.

The documentation for this class was generated from the following file:
Generated on Wed May 25 14:47:41 2005 for TSE3 by doxygen 1.3.2