svgui  1.9
PluginParameterDialog Class Reference

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

#include <PluginParameterDialog.h>

Collaboration diagram for PluginParameterDialog:

List of all members.

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 setMoreInfoUrl (QString url)
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 (int &blockSize) const
 !! merge with PluginTransform::ExecutionContext
void getProcessingParameters (int &stepSize, int &blockSize, WindowType &windowType) const
int exec ()

Protected Slots

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

Protected Attributes

Vamp::PluginBase * m_plugin
int m_channel
int m_stepSize
int m_blockSize
WindowType m_windowType
PluginParameterBoxm_parameterBox
QLabel * m_outputLabel
QLabel * m_outputValue
QLabel * m_outputDescription
QLabel * m_outputSpacer
QPushButton * m_moreInfo
QString m_moreInfoUrl
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

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 41 of file PluginParameterDialog.h.


Constructor & Destructor Documentation


Member Function Documentation

void PluginParameterDialog::setChannelArrangement ( int  sourceChannels,
int  targetChannels,
int  defaultChannel 
)
void PluginParameterDialog::setOutputLabel ( QString  output,
QString  description 
)

Definition at line 298 of file PluginParameterDialog.cpp.

References m_moreInfo, and m_moreInfoUrl.

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

Definition at line 64 of file PluginParameterDialog.h.

References m_plugin.

int PluginParameterDialog::getChannel ( ) const [inline]

Definition at line 66 of file PluginParameterDialog.h.

References m_channel.

Definition at line 531 of file PluginParameterDialog.cpp.

References m_currentInputModel.

Referenced by dialogAccepted().

Definition at line 537 of file PluginParameterDialog.cpp.

References m_currentSelectionOnly.

Referenced by dialogAccepted().

void PluginParameterDialog::getProcessingParameters ( int &  blockSize) const

!! merge with PluginTransform::ExecutionContext

Definition at line 543 of file PluginParameterDialog.cpp.

References m_blockSize.

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

Definition at line 550 of file PluginParameterDialog.cpp.

References m_blockSize, m_stepSize, and m_windowType.

void PluginParameterDialog::inputModelChanged ( QString  ) [signal]

Referenced by inputModelComboChanged().

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

Definition at line 629 of file PluginParameterDialog.cpp.

References m_channel.

Referenced by setChannelArrangement().

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

Definition at line 561 of file PluginParameterDialog.cpp.

References m_blockSize.

Referenced by setShowProcessingOptions().

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

!! rename increment to step size throughout

Definition at line 568 of file PluginParameterDialog.cpp.

References m_stepSize.

Referenced by setShowProcessingOptions().

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

Definition at line 576 of file PluginParameterDialog.cpp.

References m_windowType.

Referenced by setShowProcessingOptions().

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

Definition at line 590 of file PluginParameterDialog.cpp.

References m_advancedVisible, and setAdvancedVisible().

Referenced by PluginParameterDialog().

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

Definition at line 582 of file PluginParameterDialog.cpp.

References m_moreInfoUrl.

Referenced by PluginParameterDialog().

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

Definition at line 643 of file PluginParameterDialog.cpp.

References m_currentSelectionOnly.

Referenced by setShowSelectionOnlyOption().


Member Data Documentation

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

Definition at line 102 of file PluginParameterDialog.h.

Referenced by getProcessingParameters(), and windowTypeChanged().

Definition at line 105 of file PluginParameterDialog.h.

Referenced by PluginParameterDialog(), and setOutputLabel().

Definition at line 106 of file PluginParameterDialog.h.

Referenced by PluginParameterDialog(), and setOutputLabel().

Definition at line 107 of file PluginParameterDialog.h.

Referenced by PluginParameterDialog(), and setOutputLabel().

Definition at line 108 of file PluginParameterDialog.h.

Referenced by PluginParameterDialog(), and setOutputLabel().

QPushButton* PluginParameterDialog::m_moreInfo [protected]

Definition at line 110 of file PluginParameterDialog.h.

Referenced by PluginParameterDialog(), and setMoreInfoUrl().

Definition at line 111 of file PluginParameterDialog.h.

Referenced by moreInfo(), and setMoreInfoUrl().

QGroupBox* PluginParameterDialog::m_channelBox [protected]

Definition at line 113 of file PluginParameterDialog.h.

Referenced by PluginParameterDialog(), and setChannelArrangement().

QGroupBox* PluginParameterDialog::m_windowBox [protected]

Definition at line 116 of file PluginParameterDialog.h.

Referenced by PluginParameterDialog(), and setShowProcessingOptions().

QStringList PluginParameterDialog::m_inputModelList [protected]

Definition at line 122 of file PluginParameterDialog.h.

Referenced by inputModelComboChanged(), and setCandidateInputModels().

QWidget* PluginParameterDialog::m_advanced [protected]

Definition at line 127 of file PluginParameterDialog.h.

Referenced by PluginParameterDialog(), and setAdvancedVisible().


The documentation for this class was generated from the following files: