Kwave::StringEnterPlugin Class Reference

#include <StringEnterPlugin.h>

Inheritance diagram for Kwave::StringEnterPlugin:

Collaboration diagram for Kwave::StringEnterPlugin:

Public Member Functions
	StringEnterPlugin (QObject *parent, const QVariantList &args)
virtual	~StringEnterPlugin () Q_DECL_OVERRIDE
virtual void	load (QStringList &params) Q_DECL_OVERRIDE
virtual QStringList *	setup (QStringList &previous_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	unload ()
virtual int	start (QStringList &params)
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 ()

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)
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

Detailed Description

Definition at line 34 of file StringEnterPlugin.h.

Constructor & Destructor Documentation

StringEnterPlugin()

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

Constructor

Parameters

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

Definition at line 36 of file StringEnterPlugin.cpp.

    :Kwave::Plugin(parent, args)
{
}

~StringEnterPlugin()

Kwave::StringEnterPlugin::~StringEnterPlugin ( )

virtual

Destructor

Definition at line 43 of file StringEnterPlugin.cpp.

{
}

Member Function Documentation

load()

void Kwave::StringEnterPlugin::load ( QStringList &  params )

virtual

See also

Kwave::Plugin::load()

Reimplemented from Kwave::Plugin.

Definition at line 48 of file StringEnterPlugin.cpp.

References _, and Kwave::Plugin::emitCommand().

{
    Q_UNUSED(params);
    QString entry =
        _("menu(plugin:setup(stringenter),%1/%2/#icon(editor),F12)");
    emitCommand(entry.arg(_("Settings")).arg(_(I18N_NOOP2(
        "menu: /Settings/Enter Command",
                        "Enter Command")
    )));
}

Here is the call graph for this function:

setup()

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

virtual

Shows a dialog for a command that will be emitted through sigCommand if OK has been pressed.

See also

Kwave::Plugin::setup

Reimplemented from Kwave::Plugin.

Definition at line 60 of file StringEnterPlugin.cpp.

References Kwave::Plugin::emitCommand(), and Kwave::Plugin::parentWidget().

{
    QString preset;
    if (previous_params.count() == 1)
        preset = previous_params[0];

    // create the setup dialog
    QPointer<Kwave::StringEnterDialog> dialog =
        new Kwave::StringEnterDialog(parentWidget(), preset);
    Q_ASSERT(dialog);
    if (!dialog) return Q_NULLPTR;

    QStringList *list = new QStringList();
    Q_ASSERT(list);
    if (list && dialog->exec()) {
        // user has pressed "OK"
        QString command = dialog->command();
        emitCommand(command);
    } 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:

---

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

• plugins/stringenter/StringEnterPlugin.h
• plugins/stringenter/StringEnterPlugin.cpp