com.trolltech.qt.phonon
Class EffectDescription

java.lang.Object
  extended by com.trolltech.qt.internal.QSignalEmitterInternal
      extended by com.trolltech.qt.QSignalEmitter
          extended by com.trolltech.qt.QtJambiObject
              extended by com.trolltech.qt.phonon.EffectDescription
All Implemented Interfaces:
QtJambiInterface, java.lang.Cloneable

public class EffectDescription
extends QtJambiObject
implements java.lang.Cloneable

This class has no available documentation.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.trolltech.qt.QSignalEmitter
QSignalEmitter.AbstractSignal, QSignalEmitter.Signal0, QSignalEmitter.Signal1, QSignalEmitter.Signal2, QSignalEmitter.Signal3, QSignalEmitter.Signal4, QSignalEmitter.Signal5, QSignalEmitter.Signal6, QSignalEmitter.Signal7, QSignalEmitter.Signal8, QSignalEmitter.Signal9
 
Nested classes/interfaces inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
com.trolltech.qt.internal.QSignalEmitterInternal.AbstractSignalInternal
 
Field Summary
 
Fields inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
currentSender
 
Constructor Summary
EffectDescription()
           
EffectDescription(int index, java.util.HashMap properties)
           
 
Method Summary
 EffectDescription clone()
           
 java.lang.String description()
          Returns a more extensive description than the name() function.
 int index()
          Returns a unique identifier for this ObjectDescription.
 boolean isValid()
          Returns true if the device or effect described exists.
 java.lang.String name()
          Returns a string appropriate for a user to select between object descriptions, e.
 java.lang.Object property(java.lang.String name)
          Returns a named property.
 java.util.List propertyNames()
          Returns the names of the properties of this EffectDescription.
 
Methods inherited from class com.trolltech.qt.QtJambiObject
dispose, disposed, equals, finalize, reassignNativeResources, tr, tr, tr
 
Methods inherited from class com.trolltech.qt.QSignalEmitter
blockSignals, disconnect, disconnect, signalsBlocked, signalSender, thread
 
Methods inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
__qt_signalInitialization
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.trolltech.qt.QtJambiInterface
disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership
 

Constructor Detail

EffectDescription

public EffectDescription()

EffectDescription

public EffectDescription(int index,
                         java.util.HashMap properties)
Method Detail

description

public final java.lang.String description()
Returns a more extensive description than the name() function.

For example, in the case of s, this text should make clear which sound source is described; this is sometimes hard to describe or understand from just the name.

The text is appropriate to present to an end user in for example tool tips of items, with the name()'s as text, in a QComboBox.


index

public final int index()
Returns a unique identifier for this ObjectDescription. Used internally to distinguish between the descriptions.

Notice that the identifiers are only unique to the type of description, e.g., or .


isValid

public final boolean isValid()
Returns true if the device or effect described exists.

An ObjectDescription that is invalid, will also have an index() of -1.

See also:
index().


name

public final java.lang.String name()
Returns a string appropriate for a user to select between object descriptions, e. ., from a QComboBox.

See also:
description().


propertyNames

public final java.util.List propertyNames()
Returns the names of the properties of this EffectDescription.


property

public final java.lang.Object property(java.lang.String name)
Returns a named property. If the property is not set an invalid value is returned.

Parameters:
name - The name of the property to return
Returns:
The property corresponding to the name

clone

public EffectDescription clone()
Overrides:
clone in class java.lang.Object