Noatun API Documentation

VPreset Class Reference

#include <vequalizer.h>

List of all members.

Public Member Functions

 VPreset ()
 VPreset (const VPreset &copy)
VPresetoperator= (const VPreset &copy)
 ~VPreset ()
bool operator== (const VPreset &other) const
QString name () const
bool setName (const QString &name)
QString file () const
bool isValid () const
bool isNull () const
 operator bool () const
void save ()
void load () const
void remove ()


Detailed Description

a preset stores the state of the equalizer

VEqualizer provides a way to get a list of these or access them by name

this acts as a reference to the preset, so it might be invalid in which case isValid() is false, isNull() is true, and operator bool() return false

Definition at line 398 of file vequalizer.h.


Constructor & Destructor Documentation

VPreset::VPreset  ) 
 

VPreset::VPreset const VPreset copy  ) 
 

VPreset::~VPreset  ) 
 


Member Function Documentation

QString VPreset::file  )  const
 

Returns:
the file that this preset is in

bool VPreset::isNull  )  const [inline]
 

Definition at line 434 of file vequalizer.h.

References isValid().

bool VPreset::isValid  )  const
 

Referenced by isNull(), and operator bool().

void VPreset::load  )  const
 

load the preset into the equalizer

QString VPreset::name  )  const
 

Returns:
the name of the preset, which is user visible

VPreset::operator bool  )  const [inline]
 

Definition at line 435 of file vequalizer.h.

References isValid().

VPreset& VPreset::operator= const VPreset copy  ) 
 

bool VPreset::operator== const VPreset other  )  const
 

void VPreset::remove  ) 
 

obliterate this preset!

void VPreset::save  ) 
 

save the state of the equalizer into this preset

bool VPreset::setName const QString &  name  ) 
 

set the user-presentable name of the preset

Equalizer will emit renamed

Returns:
success. If another preset is named this, it'l fail.


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 Fri Oct 22 00:20:37 2004 by doxygen 1.3.8-20040913 written by Dimitri van Heesch, © 1997-2003