svgui  1.9
PluginParameterDialog Class Reference

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

#include <PluginParameterDialog.h>

Inheritance diagram for PluginParameterDialog:
Collaboration diagram for PluginParameterDialog:

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 More...
 
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

◆ PluginParameterDialog()

◆ ~PluginParameterDialog()

PluginParameterDialog::~PluginParameterDialog ( )

Definition at line 259 of file PluginParameterDialog.cpp.

Member Function Documentation

◆ setChannelArrangement()

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

◆ setOutputLabel()

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

◆ setMoreInfoUrl()

void PluginParameterDialog::setMoreInfoUrl ( QString  url)

Definition at line 298 of file PluginParameterDialog.cpp.

References m_moreInfo, and m_moreInfoUrl.

◆ setShowProcessingOptions()

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

◆ setCandidateInputModels()

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

◆ setShowSelectionOnlyOption()

void PluginParameterDialog::setShowSelectionOnlyOption ( bool  show)

◆ getPlugin()

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

Definition at line 64 of file PluginParameterDialog.h.

References m_plugin.

◆ getChannel()

int PluginParameterDialog::getChannel ( ) const
inline

Definition at line 66 of file PluginParameterDialog.h.

References m_channel.

◆ getInputModel()

QString PluginParameterDialog::getInputModel ( ) const

Definition at line 531 of file PluginParameterDialog.cpp.

References m_currentInputModel.

Referenced by dialogAccepted().

◆ getSelectionOnly()

bool PluginParameterDialog::getSelectionOnly ( ) const

Definition at line 537 of file PluginParameterDialog.cpp.

References m_currentSelectionOnly.

Referenced by dialogAccepted().

◆ getProcessingParameters() [1/2]

void PluginParameterDialog::getProcessingParameters ( int &  blockSize) const

!! merge with PluginTransform::ExecutionContext

Definition at line 543 of file PluginParameterDialog.cpp.

References m_blockSize.

◆ getProcessingParameters() [2/2]

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.

◆ exec()

int PluginParameterDialog::exec ( )

Definition at line 264 of file PluginParameterDialog.cpp.

References m_advancedVisible, and setAdvancedVisible().

◆ pluginConfigurationChanged

void PluginParameterDialog::pluginConfigurationChanged ( QString  )
signal

Referenced by PluginParameterDialog().

◆ inputModelChanged

void PluginParameterDialog::inputModelChanged ( QString  )
signal

Referenced by inputModelComboChanged().

◆ channelComboChanged

void PluginParameterDialog::channelComboChanged ( int  index)
protectedslot

Definition at line 629 of file PluginParameterDialog.cpp.

References m_channel.

Referenced by setChannelArrangement().

◆ blockSizeComboChanged

void PluginParameterDialog::blockSizeComboChanged ( const QString &  text)
protectedslot

Definition at line 561 of file PluginParameterDialog.cpp.

References m_blockSize.

Referenced by setShowProcessingOptions().

◆ incrementComboChanged

void PluginParameterDialog::incrementComboChanged ( const QString &  text)
protectedslot

!! rename increment to step size throughout

Definition at line 568 of file PluginParameterDialog.cpp.

References m_stepSize.

Referenced by setShowProcessingOptions().

◆ windowTypeChanged

void PluginParameterDialog::windowTypeChanged ( WindowType  type)
protectedslot

Definition at line 576 of file PluginParameterDialog.cpp.

References m_windowType.

Referenced by setShowProcessingOptions().

◆ advancedToggled

void PluginParameterDialog::advancedToggled ( )
protectedslot

Definition at line 590 of file PluginParameterDialog.cpp.

References m_advancedVisible, and setAdvancedVisible().

Referenced by PluginParameterDialog().

◆ moreInfo

void PluginParameterDialog::moreInfo ( )
protectedslot

Definition at line 582 of file PluginParameterDialog.cpp.

References m_moreInfoUrl.

Referenced by PluginParameterDialog().

◆ setAdvancedVisible

void PluginParameterDialog::setAdvancedVisible ( bool  visible)
protectedslot

◆ inputModelComboChanged

void PluginParameterDialog::inputModelComboChanged ( int  index)
protectedslot

◆ selectionOnlyChanged

void PluginParameterDialog::selectionOnlyChanged ( int  state)
protectedslot

Definition at line 643 of file PluginParameterDialog.cpp.

References m_currentSelectionOnly.

Referenced by setShowSelectionOnlyOption().

◆ dialogAccepted

void PluginParameterDialog::dialogAccepted ( )
protectedslot

Member Data Documentation

◆ m_plugin

Vamp::PluginBase* PluginParameterDialog::m_plugin
protected

◆ m_channel

int PluginParameterDialog::m_channel
protected

Definition at line 98 of file PluginParameterDialog.h.

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

◆ m_stepSize

int PluginParameterDialog::m_stepSize
protected

Definition at line 99 of file PluginParameterDialog.h.

Referenced by getProcessingParameters(), and incrementComboChanged().

◆ m_blockSize

int PluginParameterDialog::m_blockSize
protected

Definition at line 100 of file PluginParameterDialog.h.

Referenced by blockSizeComboChanged(), and getProcessingParameters().

◆ m_windowType

WindowType PluginParameterDialog::m_windowType
protected

Definition at line 102 of file PluginParameterDialog.h.

Referenced by getProcessingParameters(), and windowTypeChanged().

◆ m_parameterBox

PluginParameterBox* PluginParameterDialog::m_parameterBox
protected

Definition at line 103 of file PluginParameterDialog.h.

Referenced by PluginParameterDialog().

◆ m_outputLabel

QLabel* PluginParameterDialog::m_outputLabel
protected

Definition at line 105 of file PluginParameterDialog.h.

Referenced by PluginParameterDialog(), and setOutputLabel().

◆ m_outputValue

QLabel* PluginParameterDialog::m_outputValue
protected

Definition at line 106 of file PluginParameterDialog.h.

Referenced by PluginParameterDialog(), and setOutputLabel().

◆ m_outputDescription

QLabel* PluginParameterDialog::m_outputDescription
protected

Definition at line 107 of file PluginParameterDialog.h.

Referenced by PluginParameterDialog(), and setOutputLabel().

◆ m_outputSpacer

QLabel* PluginParameterDialog::m_outputSpacer
protected

Definition at line 108 of file PluginParameterDialog.h.

Referenced by PluginParameterDialog(), and setOutputLabel().

◆ m_moreInfo

QPushButton* PluginParameterDialog::m_moreInfo
protected

Definition at line 110 of file PluginParameterDialog.h.

Referenced by PluginParameterDialog(), and setMoreInfoUrl().

◆ m_moreInfoUrl

QString PluginParameterDialog::m_moreInfoUrl
protected

Definition at line 111 of file PluginParameterDialog.h.

Referenced by moreInfo(), and setMoreInfoUrl().

◆ m_channelBox

QGroupBox* PluginParameterDialog::m_channelBox
protected

Definition at line 113 of file PluginParameterDialog.h.

Referenced by PluginParameterDialog(), and setChannelArrangement().

◆ m_haveChannelBoxData

bool PluginParameterDialog::m_haveChannelBoxData
protected

Definition at line 114 of file PluginParameterDialog.h.

Referenced by PluginParameterDialog(), and setChannelArrangement().

◆ m_windowBox

QGroupBox* PluginParameterDialog::m_windowBox
protected

Definition at line 116 of file PluginParameterDialog.h.

Referenced by PluginParameterDialog(), and setShowProcessingOptions().

◆ m_haveWindowBoxData

bool PluginParameterDialog::m_haveWindowBoxData
protected

Definition at line 117 of file PluginParameterDialog.h.

Referenced by PluginParameterDialog(), and setShowProcessingOptions().

◆ m_inputModelBox

QGroupBox* PluginParameterDialog::m_inputModelBox
protected

◆ m_inputModels

QComboBox* PluginParameterDialog::m_inputModels
protected

◆ m_selectionOnly

QCheckBox* PluginParameterDialog::m_selectionOnly
protected

◆ m_inputModelList

QStringList PluginParameterDialog::m_inputModelList
protected

Definition at line 122 of file PluginParameterDialog.h.

Referenced by inputModelComboChanged(), and setCandidateInputModels().

◆ m_currentInputModel

QString PluginParameterDialog::m_currentInputModel
protected

◆ m_currentSelectionOnly

bool PluginParameterDialog::m_currentSelectionOnly
protected

◆ m_advancedButton

QPushButton* PluginParameterDialog::m_advancedButton
protected

◆ m_advanced

QWidget* PluginParameterDialog::m_advanced
protected

Definition at line 127 of file PluginParameterDialog.h.

Referenced by PluginParameterDialog(), and setAdvancedVisible().

◆ m_advancedVisible

bool PluginParameterDialog::m_advancedVisible
protected

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