Kwave::GotoPluginBase Class Reference

#include <GotoPluginBase.h>

Inheritance diagram for Kwave::GotoPluginBase:

Collaboration diagram for Kwave::GotoPluginBase:

Public Member Functions
	GotoPluginBase (QObject *parent, const QVariantList &args)
virtual	~GotoPluginBase () Q_DECL_OVERRIDE
virtual QStringList *	setup (QStringList &previous_params) Q_DECL_OVERRIDE
virtual int	start (QStringList &params) Q_DECL_OVERRIDE
Public Member Functions inherited from Kwave::Plugin
	Plugin (QObject *parent, const QVariantList &args)
virtual	~Plugin () Q_DECL_OVERRIDE
virtual QString	name () const
virtual QString	description () const
virtual QString	progressText ()
virtual bool	canClose () const
bool	isRunning () const
bool	shouldStop () const
virtual void	load (QStringList &params)
virtual void	unload ()
virtual int	stop ()
virtual void	run (QStringList params)
Kwave::PluginManager &	manager () const
Kwave::SignalManager &	signalManager ()
QWidget *	parentWidget () const
QString	signalName ()
virtual sample_index_t	signalLength ()
virtual double	signalRate ()
virtual const QList< unsigned int >	selectedTracks ()
virtual sample_index_t	selection (QList< unsigned int > *tracks=Q_NULLPTR, sample_index_t *left=Q_NULLPTR, sample_index_t *right=Q_NULLPTR, bool expand_if_empty=false)
virtual void	selectRange (sample_index_t offset, sample_index_t length)
virtual void	migrateToActiveContext ()
Public Member Functions inherited from Kwave::Runnable
virtual	~Runnable ()

Protected Member Functions
virtual QString	command () const =0
virtual QString	title () const =0
int	interpreteParameters (QStringList &params)
Protected Member Functions inherited from Kwave::Plugin
int	execute (QStringList &params)
void	emitCommand (const QString &command)
void	use ()
void	setPluginManager (Kwave::PluginManager *new_plugin_manager)
virtual void	run_wrapper (const QVariant &params) Q_DECL_OVERRIDE

Private Attributes
Kwave::SelectTimeWidget::Mode	m_mode
unsigned int	m_position

Additional Inherited Members
Public Slots inherited from Kwave::Plugin
virtual void	setProgressDialogEnabled (bool enable)
virtual void	updateProgress (qreal progress)
virtual void	cancel ()
virtual void	close ()
void	release ()
Signals inherited from Kwave::Plugin
void	sigRunning (Kwave::Plugin *plugin)
void	sigDone (Kwave::Plugin *plugin)
void	sigClosed (Kwave::Plugin *p)
void	sigCommand (const QString &command)
void	setProgressText (const QString &text)

Detailed Description

Definition at line 35 of file GotoPluginBase.h.

Constructor & Destructor Documentation

GotoPluginBase()

Kwave::GotoPluginBase::GotoPluginBase	(	QObject *	parent,
		const QVariantList &	args
	)

Constructor

Parameters

parent	reference to our plugin manager
args	argument list [unused]

Definition at line 35 of file GotoPluginBase.cpp.

    :Kwave::Plugin(parent, args),
     m_mode(Kwave::SelectTimeWidget::bySamples), m_position(0)
{
}

~GotoPluginBase()

Kwave::GotoPluginBase::~GotoPluginBase ( )

virtual

Destructor

Definition at line 43 of file GotoPluginBase.cpp.

{
}

Member Function Documentation

command()

virtual QString Kwave::GotoPluginBase::command ( ) const

protectedpure virtual

Returns the command to be emitted

Implemented in Kwave::GotoPlugin, and Kwave::InsertAtPlugin.

Referenced by setup(), and start().

Here is the caller graph for this function:

interpreteParameters()

int Kwave::GotoPluginBase::interpreteParameters ( QStringList &  params )

protected

Reads values from the parameter list

Definition at line 109 of file GotoPluginBase.cpp.

References Kwave::SelectTimeWidget::byPercents, Kwave::SelectTimeWidget::bySamples, Kwave::SelectTimeWidget::byTime, m_mode, and m_position.

Referenced by setup(), and start().

{
    bool ok;
    QString param;
    int mode;

    // evaluate the parameter list
    if (params.count() != 2)
        return -EINVAL;

    // selection mode for start
    param = params[0];
    mode = param.toInt(&ok);
    Q_ASSERT(ok);
    if (!ok) return -EINVAL;
    Q_ASSERT(
        (mode == static_cast<int>(Kwave::SelectTimeWidget::byTime)) ||
        (mode == static_cast<int>(Kwave::SelectTimeWidget::bySamples)) ||
        (mode == static_cast<int>(Kwave::SelectTimeWidget::byPercents))
    );
    if ((mode != static_cast<int>(Kwave::SelectTimeWidget::byTime)) &&
        (mode != static_cast<int>(Kwave::SelectTimeWidget::bySamples)) &&
        (mode != static_cast<int>(Kwave::SelectTimeWidget::byPercents)))
    {
        return -EINVAL;
    }
    m_mode = static_cast<Kwave::SelectTimeWidget::Mode>(mode);

    // position in ms, samples or percent
    param = params[1];
    m_position = param.toUInt(&ok);
    if (!ok) return -EINVAL;

    return 0;
}

Here is the caller graph for this function:

setup()

QStringList * Kwave::GotoPluginBase::setup ( QStringList &  previous_params )

virtual

Shows a dialog for selecting the range and emits a command for applying the selection if OK has been pressed.

See also

Kwave::Plugin::setup

Reimplemented from Kwave::Plugin.

Definition at line 48 of file GotoPluginBase.cpp.

References _, command(), Kwave::Plugin::emitCommand(), interpreteParameters(), m_mode, m_position, Kwave::GotoDialog::mode(), Kwave::Plugin::parentWidget(), Kwave::GotoDialog::pos(), Kwave::Plugin::signalLength(), Kwave::Plugin::signalRate(), and title().

{
    // try to interpret the previous parameters
    interpreteParameters(previous_params);

    // create the setup dialog
    double rate = signalRate();
    sample_index_t length = signalLength();

    // get the name of the help section
    QString help_section = _("plugin_sect_") + command();

    Kwave::GotoDialog *dialog = new Kwave::GotoDialog(parentWidget(),
        m_mode, m_position, rate, length, help_section);
    Q_ASSERT(dialog);
    if (!dialog) return Q_NULLPTR;

    // set the title of the dialog, depending on the derived class
    dialog->setWindowTitle(title());

    QStringList *list = new QStringList();
    Q_ASSERT(list);
    if (list && dialog->exec()) {
        // user has pressed "OK"
        *list << QString::number(dialog->mode());
        *list << QString::number(dialog->pos());

        emitCommand(_("plugin:execute(") + command() +
            _(",") +  QString::number(dialog->mode()) +
            _(",") +  QString::number(dialog->pos()) +
            _(")")
        );
    } else {
        // user pressed "Cancel"
        if (list) delete list;
        list = Q_NULLPTR;
    }

    if (dialog) delete dialog;
    return list;
}

Here is the call graph for this function:

start()

int Kwave::GotoPluginBase::start ( QStringList &  params )

virtual

selects the position

See also

Kwave::Plugin::start()

Reimplemented from Kwave::Plugin.

Definition at line 91 of file GotoPluginBase.cpp.

References _, command(), Kwave::Plugin::emitCommand(), interpreteParameters(), m_mode, m_position, Kwave::Plugin::signalLength(), Kwave::Plugin::signalRate(), and Kwave::SelectTimeWidget::timeToSamples().

{
    // interprete the parameters
    int result = interpreteParameters(params);
    if (result) return result;

    // get current offset of the signal
    sample_index_t offset = Kwave::SelectTimeWidget::timeToSamples(
        m_mode, m_position, signalRate(), signalLength());

    // change the selection through the signal manager
    QString cmd = _("nomacro:") + command() + _("(%1)");
    emitCommand(cmd.arg(offset));

    return result;
}

Here is the call graph for this function:

title()

virtual QString Kwave::GotoPluginBase::title ( ) const

protectedpure virtual

Returns the title of the dialog

Implemented in Kwave::GotoPlugin, and Kwave::InsertAtPlugin.

Referenced by setup().

Here is the caller graph for this function:

Member Data Documentation

m_mode

Kwave::SelectTimeWidget::Mode Kwave::GotoPluginBase::m_mode

private

selected mode for position: by time, samples, percentage

Definition at line 77 of file GotoPluginBase.h.

Referenced by interpreteParameters(), setup(), and start().

m_position

unsigned int Kwave::GotoPluginBase::m_position

private

position in milliseconds, samples or percents

Definition at line 80 of file GotoPluginBase.h.

Referenced by interpreteParameters(), setup(), and start().

---

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

• plugins/goto/GotoPluginBase.h
• plugins/goto/GotoPluginBase.cpp