Effect Class Reference
Base class for a noatun effect.
More...
#include <effects.h>
List of all members.
|
Public Member Functions |
|
| Effect (const char *name) |
| Effect * | before () const |
| Effect * | after () const |
|
long | id () const |
| Arts::StereoEffect * | effect () const |
| QCString | name () const |
| QString | title () const |
| bool | isNull () const |
| QWidget * | configure (bool friendly=true) |
| bool | configurable () const |
Static Public Member Functions |
| QString | clean (const QCString &name) |
Detailed Description
Base class for a noatun effect.
Example:
new Effect("Arts::SomeEffect");
Then you can add, insert, etc. it using
Effects
Definition at line 22 of file effects.h.
Member Function Documentation
| Effect* Effect::after |
( |
|
) |
const |
|
|
|
return the effect processed directly after this one |
| Effect* Effect::before |
( |
|
) |
const |
|
|
|
return the effect processed directly before this one |
| QString Effect::clean |
( |
const QCString & |
name |
) |
[static] |
|
|
|
Return an effect name that can be presented to a user i.e. Arts::FREEVERB will end up as FREEVERB |
| bool Effect::configurable |
( |
|
) |
const |
|
|
|
Does this widget have a configurable dialog box. E.g., will configure return null? |
| QWidget* Effect::configure |
( |
bool |
friendly = true |
) |
|
|
|
|
show the configure dialog box for this effect. if friendly is true, then create a top-level window, set an icon and make it purdy. Otherwise create a plan widget that you can reparent. |
| Arts::StereoEffect* Effect::effect |
( |
|
) |
const |
|
| bool Effect::isNull |
( |
|
) |
const |
|
|
|
- Returns:
- true if this effect name is invalid, false otherwise Note: If you call StereoEffect::start() on an invalid Effect you will probably be punished with a segmentation fault.
|
| QCString Effect::name |
( |
|
) |
const |
|
|
|
Get the name of the object. |
| QString Effect::title |
( |
|
) |
const |
|
|
|
get the "clean" title of effect |
The documentation for this class was generated from the following file:
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Oct 21 23:49:46 2004 by
doxygen 1.3.8-20040913 written by
Dimitri van Heesch, © 1997-2003
