Doxy for LFUN_CALL again

git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@22564 a592a061-630c-0410-9148-cb99ea01b6c8
This commit is contained in:
Bernhard Roider 2008-01-14 22:20:35 +00:00
parent ab6fcd9be5
commit 2714d1b8b9

View File

@ -906,17 +906,16 @@ void LyXAction::init()
* \var lyx::kb_action lyx::LFUN_CALL
* \li Action: Executes a command defined in a .def file.
* \li Notion: The definitions are by default read from lib/commands/default.def .
A .def file allows to define a command with \\define "Name" "lfun"
where Name is the name of the new command and lfun is the lfun code
A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
where <NAME> is the name of the new command and <LFUN> is the lfun code
to be executed (see e.g. command-sequence LFUN).
\\def_file "FileName" allows to include another .def file.
This is particularly useful in connection with toolbar buttons:
Since the name of the button is derived from <CMDNAME>, a button
cannot otherwise be assigned to a complex command-sequence.
* \li Syntax: call <CMDNAME>
* \li Params: <CMDNAME>: Name of the command that must be called.
<CMDNAME> can be consequently used in menu,
toolbar (image) or bind file
Since the name of the button image for this lfun is
lib/images/commands/<NAME>.png this is the way to assign an image
to a complex command-sequence.
* \li Syntax: call <NAME>
* \li Params: <NAME>: Name of the command that must be called.
* \li Origin: broider, 2 Oct 2007
*/
{ LFUN_CALL, "call", NoBuffer, System },