Noatun API Documentation
Overview Class Hierarchy Classes Classes (annotated) Members Namespaces Source Files

Effects Class Reference

#include <effects.h>

Inheritance diagram for Effects:

Inheritance graph
[legend]
List of all members.

Signals

void added (Effect *effect)
void removed (Effect *effect)
void moved (Effect *effect)
void deleting (Effect *effect)

Public Member Functions

bool insert (const Effect *after, Effect *item)
bool append (Effect *item)
void move (const Effect *after, Effect *item)
void remove (Effect *item, bool del=true)
void removeAll (bool del=true)
QStrList available () const
QPtrList< Effect > effects () const
Effect * findId (long id) const

Detailed Description

Noatuns effect stack
Author:
Charles Samuels

Definition at line 97 of file effects.h.

Member Function Documentation

void Effects::added (  Effect *  effect  )  [signal]
 

Emitted when an effect has been added to the effect stack

Parameters:
effect the effect that got added

bool Effects::append (  Effect *  item  ) 
 

create the Effect, by getting the proper item from the list, then append it here.

for example 

 append(new Effect(available()[0]));

QStrList Effects::available (   )  const
 

A list of all available effects, by name each of these can be given to the first argument of the Effect constructor

void Effects::deleting (  Effect *  effect  )  [signal]
 

Emitted when an effect is about to be deleted (from memory)

Parameters:
effect the effect to be deleted

QPtrList<Effect> Effects::effects (   )  const
 

A list of all available effects objects

Effect* Effects::findId (  long  id  )  const
 

Get the Effect that has the following id

void Effects::move (  const Effect *  after,
Effect *  item
) 
 

reorder the effect stack. If after is null, it'll be first

void Effects::moved (  Effect *  effect  )  [signal]
 

Emitted when an effect has been moved

Parameters:
effect the effect that got moved

void Effects::remove (  Effect *  item,
bool  del = true
) 
 

Removes an item from the effect stack

Parameters:
item item to remove
del delete the item from the effect stack as well (default true)

void Effects::removeAll (  bool  del = true  ) 
 

Removes all items from the effect stack.

Parameters:
del delete the items from the effect stack as well (default true)

void Effects::removed (  Effect *  effect  )  [signal]
 

Emitted when an effect has been removed to the effect stack

Parameters:
effect the effect that got removed

The documentation for this class was generated from the following file:
KDE Logo
This file is part of the documentation for Noatun 2.6.0.
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