3 * \file ControlCommand.h
4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Angus Leeming
9 * Full author contact details are available in file CREDITS.
11 * ControlCommand is a controller class for dialogs that create or modify
12 * an inset derived from InsetCommand.
15 #ifndef CONTROLCOMMAND_H
16 #define CONTROLCOMMAND_H
20 #include "insets/insetcommandparams.h"
23 class ControlCommand : public Dialog::Controller {
25 /** LFUN_INSET_APPLY requires a name, "citation", "ref" etc so that
26 it knows what to do with the rest of the contents.
27 An empty name indicates that no action will occur on 'Apply'.
29 ControlCommand(Dialog &, std::string const & lfun_name = std::string());
31 InsetCommandParams & params() { return params_; }
33 InsetCommandParams const & params() const { return params_; }
35 virtual bool initialiseParams(std::string const & data);
37 virtual void clearParams();
39 virtual void dispatchParams();
41 virtual bool isBufferDependent() const { return true; }
45 InsetCommandParams params_;
46 /// Flags what action is taken by Kernel::dispatch()
47 std::string const lfun_name_;
51 #endif // CONTROLCOMMAND_H