class Phrase_Replace Full name TSE3::Cmd::Phrase_Replace Definition #include <Phrase.h> Inherits TSE3::Cmd::Command [public ] List of all Methods

Annotated List Files Globals Hierarchy Index

Public Methods

•  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

Detailed Description

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

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

[const]

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.

[protected virtual]

Reimplemented from Command for internal purposes..

[protected virtual]

Reimplemented from Command for internal purposes..