BOOKMARK

bookmark      

Function

Creates a bookmark for use with the UNDO/REDO command structure.  The bookmark is the point to which or from which the system may be restored.

Parameters

none

Creates a bookmark.

Examples

BOOKMARK

Notes

This command only works if UndoMode is enabled (i.e. UNDO ON is set).

 

This command should be called by the application in order to set the required break-points (bookmarks) for the UNDO and REDO mechanism. 

 

Developers or users who use command at keyboard level can use the UNDO and REDO mechanism but are recommended to use in conjunction with the EVENT command.  The An event string is a set of commands to be executed before and/or after a command is issued.

 

If for example the following commands are issued:
EVENT ON
EVENT <EAGLE_COMMAND>,BEFORE='BOOKMARK'
Then before executing the specified <EAGLE_COMMAND> a BOOKMARK is automatically inserted by the program thereby avoiding having to explicitly invoke the BOOKMARK command.

 

The option to disable the automatic bookmark is driven by configuration variable setting (Version 12.3.0b14):
UNDO_AUTOBOOKMARK=no.

The default is 'yes'

 

The maximum number of undo BOOKMARKS can be set with the variable BOOKMARKS_MAX_VALUE (default=16). .

 

See also

redo, undo, event