*/
/**
- *
+ * \var lyx::kb_action lyx::LFUN_
* \li Action:
* \li Notion:
* \li Syntax:
ev_item const items[] = {
#endif
/**
- * \li Action: adds an acute accent (á) to the next character typed
+ * \var lyx::kb_action lyx::LFUN_ACCENT_ACUTE
+ * \li Action: adds an acute accent \htmlonly (á)\endhtmlonly
+ to the next character typed
* \li Syntax: accent-acute
*/
{ LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit },
/**
- * \li Action: adds a breve accent to the next character typed
+ * \var lyx::kb_action lyx::LFUN_ACCENT_BREVE
+ * \li Action: adds a breve accent \htmlonly (ă)\endhtmlonly
+ to the next character typed
* \li Syntax: accent-breve
*/
{ LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit },
/**
- * \li Action: adds a caron to the next character typed
+ * \var lyx::kb_action lyx::LFUN_ACCENT_CARON
+ * \li Action: adds a caron \htmlonly (ǎ)\endhtmlonly
+ to the next character typed
* \li Syntax: accent-caron
*/
{ LFUN_ACCENT_CARON, "accent-caron", Noop, Edit },
/**
- * \li Action: adds a cedilla (ç) to the next character typed
+ * \var lyx::kb_action lyx::LFUN_ACCENT_CEDILLA
+ * \li Action: adds a cedilla \htmlonly (ç)\endhtmlonly
+ to the next character typed
* \li Syntax: accent-cedilla
*/
{ LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit },
/**
- * \li Action: adds a circle accent (Å) to the next character typed
+ * \var lyx::kb_action lyx::LFUN_ACCENT_CIRCLE
+ * \li Action: adds a circle accent \htmlonly (å)\endhtmlonly
+ to the next character typed
* \li Syntax: accent-circle
*/
{ LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit },
/**
- * \li Action: adds a circumflex (â) to the next character typed
+ * \var lyx::kb_action lyx::LFUN_ACCENT_CIRCUMFLEX
+ * \li Action: adds a circumflex \htmlonly (ê)\endhtmlonly
+ to the next character typed
* \li Syntax: accent-circumflex
*/
{ LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit },
/**
- * \li Action: adds a dot accent to the next character typed
+ * \var lyx::kb_action lyx::LFUN_ACCENT_DOT
+ * \li Action: adds a dot accent \htmlonly (ż)\endhtmlonly
+ to the next character typed
* \li Syntax: accent-dot
*/
{ LFUN_ACCENT_DOT, "accent-dot", Noop, Edit },
/**
- * \li Action: adds a grave accent (à) to the next character typed
+ * \var lyx::kb_action lyx::LFUN_ACCENT_GRAVE
+ * \li Action: adds a grave accent \htmlonly (è)\endhtmlonly
+ to the next character typed
* \li Syntax: accent-grave
*/
{ LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit },
/**
- * \li Action: adds a Hungarian umlaut to the next character typed
+ * \var lyx::kb_action lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT
+ * \li Action: adds a Hungarian umlaut \htmlonly (ő)\endhtmlonly
+ to the next character typed
* \li Syntax: accent-grave
*/
{ LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit },
/**
- * \li Action: adds a macron to the next character typed
+ * \var lyx::kb_action lyx::LFUN_ACCENT_MACRON
+ * \li Action: adds a macron \htmlonly (ā)\endhtmlonly
+ to the next character typed
* \li Syntax: accent-macron
*/
{ LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit },
/**
- * \li Action: adds an ogonek accent to the next character typed
+ * \var lyx::kb_action lyx::LFUN_ACCENT_OGONEK
+ * \li Action: adds an ogonek accent \htmlonly (ą)\endhtmlonly
+ to the next character typed
* \li Syntax: accent-ogonek
*/
{ LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit },
{ LFUN_ACCENT_SPECIAL_CARON, "accent-special-caron", Noop, Edit },
/**
- * \li Action: adds a tie over the next two character typed
+ * \var lyx::kb_action lyx::LFUN_ACCENT_TIE
+ * \li Action: adds a tie \htmlonly (a͡)\endhtmlonly
+ over the next two character typed
+ * \li Notion: the following char will finish the tie.
* \li Syntax: accent-tie
*/
{ LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
/**
- * \li Action: adds a tilde (ñ) over the next character typed
+ * \var lyx::kb_action lyx::LFUN_ACCENT_TILDE
+ * \li Action: adds a tilde \htmlonly (ã)\endhtmlonly
+ over the next character typed
* \li Syntax: accent-tilde
*/
{ LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
/**
- * \li Action: adds an umlaut (ö) over the next character typed
+ * \var lyx::kb_action lyx::LFUN_ACCENT_UMLAUT
+ * \li Action: adds an umlaut \htmlonly (ä)\endhtmlonly
+ over the next character typed
* \li Syntax: accent-umlaut
*/
{ LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
/**
- * \li Action: adds a bar under the next character typed
+ * \var lyx::kb_action lyx::LFUN_ACCENT_UNDERBAR
+ * \li Action: adds a bar \htmlonly (a̠)\endhtmlonly
+ under the next character typed
* \li Syntax: accent-underbar
*/
{ LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
/**
- * \li Action: adds a dot under the next character typed
+ * \var lyx::kb_action lyx::LFUN_ACCENT_UNDERDOT
+ * \li Action: adds a dot \htmlonly (ạ)\endhtmlonly
+ under the next character typed
* \li Syntax: accent-underdot
*/
{ LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_BREAK_PARAGRAPH
+ * \li Action: Breaks the current paragraph at the current location
+ * \li Syntax: break-paragraph
+ */
{ LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_BREAK_PARAGRAPH_SKIP
+ * \li Action: Breaks the current paragraph at the current location,
+ unless used at the beginning of a line, where it sets
+ the label width string to empty.
+ * \li Syntax: break-paragraph-skip
+ */
{ LFUN_BREAK_PARAGRAPH_SKIP, "break-paragraph-skip", Noop, Edit },
-
+/**
+ * \var lyx::kb_action lyx::LFUN_CAPTION_INSERT
+ * \li Action: Inserts a caption inset.
+ * \li Syntax: caption-insert
+ * \li Origin: Lgb, 18 Jul 2000
+ */
{ LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_DATE_INSERT
+ * \li Action: Inserts the current date
+ * \li Syntax: date-insert [<ARG>]
+ * \li Param: <ARG>: Format of date. The default value (%x) can be set
+ in Preferences->Date format. For possible formats
+ see manual page of strftime function.
+ * \li Origin: jdblair, 31 Jan 2000
+ */
{ LFUN_DATE_INSERT, "date-insert", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_FOOTNOTE_INSERT
+ * \li Action: Inserts a footnote inset.
+ * \li Syntax: footnote-insert
+ * \li Origin: Jug, 7 Mar 2000
+ */
{ LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_ERT_INSERT
+ * \li Action: Inserts an ERT inset.
+ * \li Syntax: ert-insert
+ * \li Origin: Jug, 18 Feb 2000
+ */
{ LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
{ LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
{ LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
{ LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_HFILL_INSERT
+ * \li Action: Inserts an hfill inset.
+ * \li Syntax: hfill-insert
+ */
{ LFUN_HFILL_INSERT, "hfill-insert", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_OPTIONAL_INSERT
+ * \li Action: Inserts an optional-argument (short title) inset.
+ * \li Syntax: optional-insert
+ * \li Origin: Martin, 12 Aug 2002
+ */
{ LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_LINE_INSERT
+ * \li Action: Inserts a horizontal line.
+ * \li Syntax: line-insert
+ * \li Origin: poenitz, Oct 27 2003
+ */
{ LFUN_LINE_INSERT, "line-insert", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_NEWPAGE_INSERT
+ * \li Action: Inserts a new page.
+ * \li Syntax: newpage-insert
+ * \li Origin: uwestoehr, 24 Nov 2007
+ */
{ LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_PAGEBREAK_INSERT
+ * \li Action: Inserts a pagebreak.
+ * \li Syntax: pagebreak-insert
+ * \li Origin: poenitz, Oct 27 2003
+ */
{ LFUN_PAGEBREAK_INSERT, "pagebreak-insert", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_MARGINALNOTE_INSERT
+ * \li Action: Inserts a marginal note.
+ * \li Syntax: marginalnote-insert
+ * \li Origin: Lgb, 26 Jun 2000
+ */
{ LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_UNICODE_INSERT
+ * \li Action: Inserts a single unicode character.
+ * \li Syntax: unicode-insert <CHAR>
+ * \li Params: <CHAR>: The character to insert, given as its code
+ point, in hexadecimal, e.g.: unicode-insert 0x0100.
+ * \li Origin: Lgb, 22 Oct 2006
+ */
{ LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
+/**
+ * \var lyx::kb_action lyx::LFUN_LISTING_INSERT
+ * \li Action: Inserts a new listings inset.
+ * \li Syntax: listing-insert
+ * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
+ */
{ LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
{ LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
{ LFUN_INFO_INSERT, "info-insert", Noop, Edit },
{ LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
/**
* \var lyx::kb_action lyx::LFUN_MARK_TOGGLE
- * \li Action: Toggle between MARK_ON and MARK_OFF
+ * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
* \li Syntax: mark-toggle
* \li Origin: poenitz, May 5 2006
*/
* \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
- to be executed (see e.g. command-sequence LFUN).
- \\def_file "FileName" allows to include another .def file.
+ 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. #LFUN_COMMAND_SEQUENCE).
+ \\def_file "FileName" allows to include another .def file. \n
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 },
projects / lyx.git / blobdiff