anne/lyx_mirror
1
0
Fork 0
mirror of https://git.lyx.org/repos/lyx.git synced 2024-11-27 03:36:39 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add doxy samples from commit info.

Browse Source 
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@32945 a592a061-630c-0410-9148-cb99ea01b6c8
This commit is contained in:
Pavel Sanda 2010-01-10 16:50:25 +00:00
parent a355d0bd3d
commit 5026c87e4c
1 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
src/LyXAction.cpp
View File

@ -3448,19 +3448,24 @@ void LyXAction::init()
/*! /*!
* \var lyx::FuncCode lyx::LFUN_INSET_FORALL * \var lyx::FuncCode lyx::LFUN_INSET_FORALL
* \li Action: Apply the given commands on insets of a given name.
* \li Action: Apply the given commands on insets of a given name. WARNING: use * \li Notion: WARNING: use at your own risks; this function gives
at your own risks; this function gives you too many ways of you too many ways of shooting yourself in the foot.
shooting yourself in the foot. A typical example is A typical example is
inset-forall Note note-insert inset-forall Note note-insert
which starts an infinite loop. This is mitigated by the fact which starts an infinite loop. This is mitigated by the fact
that the number of actions is arbitrarily limited to 10000. that the number of actions is arbitrarily limited to 10000.
* \li Syntax: inset-forall <NAME> <LFUN-COMMAND> * \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
<NAME>: Type of Inset. If <NAME> is *, all insets are matched. <NAME>: Type of Inset. If <NAME> is *, all insets are matched.
* \li Sample: The name is used like for InsetLayout in layout files: "Note" The name is used like for InsetLayout in layout files: "Note"
matches all note insets, while "Note:Note" only matches LyX matches all note insets, while "Note:Note" only matches LyX
yellow note insets. The following command closes all note insets \n yellow note insets.
inset-forall Note inset-toggle close * \li Sample: Remove all index insets: \n
inset-forall Index delete-char-forward \n
Close all Notes (also works for a particular branch, for example): \n
inset-forall Note inset-toggle close \n
Try to put LyX in an infinite loop if there is at least a Note: \n
inset-forall Note char-backward
* \li Origin: lasgouttes, 27 Nov 2009 * \li Origin: lasgouttes, 27 Nov 2009
* \endvar * \endvar
*/ */