PluginParameterDialog Class Reference

#include <PluginParameterDialog.h>

Collaboration diagram for PluginParameterDialog:

Collaboration graph
[legend]
List of all members.

Detailed Description

A dialog for editing the parameters of a given plugin, using a PluginParameterBox.

This dialog does not contain any mechanism for selecting the plugin in the first place. Note that the dialog directly modifies the parameters of the plugin, so they will remain modified even if the dialog is then cancelled.

Definition at line 40 of file PluginParameterDialog.h.

Signals

void pluginConfigurationChanged (QString)
void inputModelChanged (QString)

Public Member Functions

 PluginParameterDialog (Vamp::PluginBase *, QWidget *parent=0)
 ~PluginParameterDialog ()
void setChannelArrangement (int sourceChannels, int targetChannels, int defaultChannel)
void setOutputLabel (QString output, QString description)
void setShowProcessingOptions (bool showWindowSize, bool showFrequencyDomainOptions)
void setCandidateInputModels (const QStringList &names, QString defaultName)
void setShowSelectionOnlyOption (bool show)
Vamp::PluginBase * getPlugin ()
int getChannel () const
QString getInputModel () const
bool getSelectionOnly () const
void getProcessingParameters (size_t &blockSize) const
 !! merge with PluginTransform::ExecutionContext
void getProcessingParameters (size_t &stepSize, size_t &blockSize, WindowType &windowType) const

Protected Slots

void channelComboChanged (int)
void blockSizeComboChanged (const QString &)
void incrementComboChanged (const QString &)
void windowTypeChanged (WindowType type)
void advancedToggled ()
void setAdvancedVisible (bool)
void inputModelComboChanged (int)
void selectionOnlyChanged (int)
void dialogAccepted ()

Protected Attributes

Vamp::PluginBase * m_plugin
int m_channel
size_t m_stepSize
size_t m_blockSize
WindowType m_windowType
PluginParameterBoxm_parameterBox
QLabel * m_outputLabel
QLabel * m_outputValue
QLabel * m_outputDescription
QLabel * m_outputSpacer
QGroupBox * m_channelBox
bool m_haveChannelBoxData
QGroupBox * m_windowBox
bool m_haveWindowBoxData
QGroupBox * m_inputModelBox
QComboBox * m_inputModels
QCheckBox * m_selectionOnly
QStringList m_inputModelList
QString m_currentInputModel
bool m_currentSelectionOnly
QPushButton * m_advancedButton
QWidget * m_advanced
bool m_advancedVisible


Constructor & Destructor Documentation

PluginParameterDialog::PluginParameterDialog ( Vamp::PluginBase *  ,
QWidget *  parent = 0 
)

Definition at line 40 of file PluginParameterDialog.cpp.

References advancedToggled(), dialogAccepted(), m_advanced, m_advancedButton, m_advancedVisible, m_channelBox, m_haveChannelBoxData, m_haveWindowBoxData, m_inputModelBox, m_inputModels, m_outputDescription, m_outputLabel, m_outputSpacer, m_outputValue, m_parameterBox, m_plugin, m_selectionOnly, m_windowBox, pluginConfigurationChanged(), and setAdvancedVisible().

PluginParameterDialog::~PluginParameterDialog (  ) 

Definition at line 248 of file PluginParameterDialog.cpp.


Member Function Documentation

void PluginParameterDialog::setChannelArrangement ( int  sourceChannels,
int  targetChannels,
int  defaultChannel 
)

Definition at line 279 of file PluginParameterDialog.cpp.

References channelComboChanged(), m_advancedButton, m_advancedVisible, m_channel, m_channelBox, m_haveChannelBoxData, and setAdvancedVisible().

Referenced by ModelTransformerFactory::getConfigurationForTransform().

void PluginParameterDialog::setOutputLabel ( QString  output,
QString  description 
)

Definition at line 254 of file PluginParameterDialog.cpp.

References m_outputDescription, m_outputLabel, m_outputSpacer, and m_outputValue.

Referenced by ModelTransformerFactory::getConfigurationForTransform().

void PluginParameterDialog::setShowProcessingOptions ( bool  showWindowSize,
bool  showFrequencyDomainOptions 
)

Definition at line 343 of file PluginParameterDialog.cpp.

References blockSizeComboChanged(), incrementComboChanged(), m_advancedButton, m_advancedVisible, m_haveWindowBoxData, m_plugin, m_windowBox, setAdvancedVisible(), and windowTypeChanged().

Referenced by ModelTransformerFactory::getConfigurationForTransform().

void PluginParameterDialog::setCandidateInputModels ( const QStringList &  names,
QString  defaultName 
)

Definition at line 443 of file PluginParameterDialog.cpp.

References TextAbbrev::abbreviate(), inputModelComboChanged(), m_currentInputModel, m_inputModelBox, m_inputModelList, and m_inputModels.

Referenced by ModelTransformerFactory::getConfigurationForTransform().

void PluginParameterDialog::setShowSelectionOnlyOption ( bool  show  ) 

Definition at line 477 of file PluginParameterDialog.cpp.

References m_currentSelectionOnly, m_inputModelBox, m_inputModels, m_selectionOnly, and selectionOnlyChanged().

Referenced by ModelTransformerFactory::getConfigurationForTransform().

Vamp::PluginBase* PluginParameterDialog::getPlugin (  )  [inline]

Definition at line 61 of file PluginParameterDialog.h.

References m_plugin.

int PluginParameterDialog::getChannel (  )  const [inline]

Definition at line 63 of file PluginParameterDialog.h.

References m_channel.

Referenced by ModelTransformerFactory::getConfigurationForTransform().

QString PluginParameterDialog::getInputModel (  )  const

Definition at line 501 of file PluginParameterDialog.cpp.

References m_currentInputModel.

Referenced by dialogAccepted(), and ModelTransformerFactory::getConfigurationForTransform().

bool PluginParameterDialog::getSelectionOnly (  )  const

Definition at line 507 of file PluginParameterDialog.cpp.

References m_currentSelectionOnly.

Referenced by dialogAccepted(), and ModelTransformerFactory::getConfigurationForTransform().

void PluginParameterDialog::getProcessingParameters ( size_t &  blockSize  )  const

!! merge with PluginTransform::ExecutionContext

Definition at line 513 of file PluginParameterDialog.cpp.

References m_blockSize.

Referenced by ModelTransformerFactory::getConfigurationForTransform().

void PluginParameterDialog::getProcessingParameters ( size_t &  stepSize,
size_t &  blockSize,
WindowType windowType 
) const

Definition at line 520 of file PluginParameterDialog.cpp.

References m_blockSize, m_stepSize, and m_windowType.

void PluginParameterDialog::pluginConfigurationChanged ( QString   )  [signal]

Referenced by PluginParameterDialog().

void PluginParameterDialog::inputModelChanged ( QString   )  [signal]

Referenced by inputModelComboChanged().

void PluginParameterDialog::channelComboChanged ( int   )  [protected, slot]

Definition at line 587 of file PluginParameterDialog.cpp.

References m_channel.

Referenced by setChannelArrangement().

void PluginParameterDialog::blockSizeComboChanged ( const QString &   )  [protected, slot]

Definition at line 531 of file PluginParameterDialog.cpp.

References m_blockSize.

Referenced by setShowProcessingOptions().

void PluginParameterDialog::incrementComboChanged ( const QString &   )  [protected, slot]

Definition at line 538 of file PluginParameterDialog.cpp.

References m_stepSize.

Referenced by setShowProcessingOptions().

void PluginParameterDialog::windowTypeChanged ( WindowType  type  )  [protected, slot]

Definition at line 546 of file PluginParameterDialog.cpp.

References m_windowType.

Referenced by setShowProcessingOptions().

void PluginParameterDialog::advancedToggled (  )  [protected, slot]

Definition at line 552 of file PluginParameterDialog.cpp.

References m_advancedVisible, and setAdvancedVisible().

Referenced by PluginParameterDialog().

void PluginParameterDialog::setAdvancedVisible ( bool   )  [protected, slot]

Definition at line 558 of file PluginParameterDialog.cpp.

References m_advanced, m_advancedButton, and m_advancedVisible.

Referenced by advancedToggled(), PluginParameterDialog(), setChannelArrangement(), and setShowProcessingOptions().

void PluginParameterDialog::inputModelComboChanged ( int   )  [protected, slot]

Definition at line 593 of file PluginParameterDialog.cpp.

References inputModelChanged(), m_currentInputModel, and m_inputModelList.

Referenced by setCandidateInputModels().

void PluginParameterDialog::selectionOnlyChanged ( int   )  [protected, slot]

Definition at line 601 of file PluginParameterDialog.cpp.

References m_currentSelectionOnly.

Referenced by setShowSelectionOnlyOption().

void PluginParameterDialog::dialogAccepted (  )  [protected, slot]

Definition at line 611 of file PluginParameterDialog.cpp.

References getInputModel(), getSelectionOnly(), m_inputModels, and m_selectionOnly.

Referenced by PluginParameterDialog().


Member Data Documentation

Vamp::PluginBase* PluginParameterDialog::m_plugin [protected]

Definition at line 90 of file PluginParameterDialog.h.

Referenced by getPlugin(), PluginParameterDialog(), and setShowProcessingOptions().

int PluginParameterDialog::m_channel [protected]

Definition at line 92 of file PluginParameterDialog.h.

Referenced by channelComboChanged(), getChannel(), and setChannelArrangement().

size_t PluginParameterDialog::m_stepSize [protected]

Definition at line 93 of file PluginParameterDialog.h.

Referenced by getProcessingParameters(), and incrementComboChanged().

size_t PluginParameterDialog::m_blockSize [protected]

Definition at line 94 of file PluginParameterDialog.h.

Referenced by blockSizeComboChanged(), and getProcessingParameters().

WindowType PluginParameterDialog::m_windowType [protected]

Definition at line 96 of file PluginParameterDialog.h.

Referenced by getProcessingParameters(), and windowTypeChanged().

PluginParameterBox* PluginParameterDialog::m_parameterBox [protected]

Definition at line 97 of file PluginParameterDialog.h.

Referenced by PluginParameterDialog().

QLabel* PluginParameterDialog::m_outputLabel [protected]

Definition at line 99 of file PluginParameterDialog.h.

Referenced by PluginParameterDialog(), and setOutputLabel().

QLabel* PluginParameterDialog::m_outputValue [protected]

Definition at line 100 of file PluginParameterDialog.h.

Referenced by PluginParameterDialog(), and setOutputLabel().

QLabel* PluginParameterDialog::m_outputDescription [protected]

Definition at line 101 of file PluginParameterDialog.h.

Referenced by PluginParameterDialog(), and setOutputLabel().

QLabel* PluginParameterDialog::m_outputSpacer [protected]

Definition at line 102 of file PluginParameterDialog.h.

Referenced by PluginParameterDialog(), and setOutputLabel().

QGroupBox* PluginParameterDialog::m_channelBox [protected]

Definition at line 104 of file PluginParameterDialog.h.

Referenced by PluginParameterDialog(), and setChannelArrangement().

bool PluginParameterDialog::m_haveChannelBoxData [protected]

Definition at line 105 of file PluginParameterDialog.h.

Referenced by PluginParameterDialog(), and setChannelArrangement().

QGroupBox* PluginParameterDialog::m_windowBox [protected]

Definition at line 107 of file PluginParameterDialog.h.

Referenced by PluginParameterDialog(), and setShowProcessingOptions().

bool PluginParameterDialog::m_haveWindowBoxData [protected]

Definition at line 108 of file PluginParameterDialog.h.

Referenced by PluginParameterDialog(), and setShowProcessingOptions().

QGroupBox* PluginParameterDialog::m_inputModelBox [protected]

Definition at line 110 of file PluginParameterDialog.h.

Referenced by PluginParameterDialog(), setCandidateInputModels(), and setShowSelectionOnlyOption().

QComboBox* PluginParameterDialog::m_inputModels [protected]

Definition at line 111 of file PluginParameterDialog.h.

Referenced by dialogAccepted(), PluginParameterDialog(), setCandidateInputModels(), and setShowSelectionOnlyOption().

QCheckBox* PluginParameterDialog::m_selectionOnly [protected]

Definition at line 112 of file PluginParameterDialog.h.

Referenced by dialogAccepted(), PluginParameterDialog(), and setShowSelectionOnlyOption().

QStringList PluginParameterDialog::m_inputModelList [protected]

Definition at line 113 of file PluginParameterDialog.h.

Referenced by inputModelComboChanged(), and setCandidateInputModels().

QString PluginParameterDialog::m_currentInputModel [protected]

Definition at line 114 of file PluginParameterDialog.h.

Referenced by getInputModel(), inputModelComboChanged(), and setCandidateInputModels().

bool PluginParameterDialog::m_currentSelectionOnly [protected]

Definition at line 115 of file PluginParameterDialog.h.

Referenced by getSelectionOnly(), selectionOnlyChanged(), and setShowSelectionOnlyOption().

QPushButton* PluginParameterDialog::m_advancedButton [protected]

Definition at line 117 of file PluginParameterDialog.h.

Referenced by PluginParameterDialog(), setAdvancedVisible(), setChannelArrangement(), and setShowProcessingOptions().

QWidget* PluginParameterDialog::m_advanced [protected]

Definition at line 118 of file PluginParameterDialog.h.

Referenced by PluginParameterDialog(), and setAdvancedVisible().

bool PluginParameterDialog::m_advancedVisible [protected]

Definition at line 119 of file PluginParameterDialog.h.

Referenced by advancedToggled(), PluginParameterDialog(), setAdvancedVisible(), setChannelArrangement(), and setShowProcessingOptions().


The documentation for this class was generated from the following files:
Generated on Wed Feb 20 15:45:35 2008 for SonicVisualiser by  doxygen 1.5.1