Keyboard Mapping Macros

This set of macros enables you to define key functions, from those elementary to the most complex ones, under certain syntax rules.

BackSpace() Deletes the character to the left of the text insertion point. If the text insertion point is positioned in the first column, appends the insertion point line to the previous one.

BlockClipAppend() Appends the selected block to the Clipboard text.

BlockClipCopy() Copies the selected block to Clipboard.

BlockClipPaste() Pastes the Clipboard text to the current text insertion point position.

BlockCopy() Copies the selected block to the current text insertion point position.

BlockDelete() Deletes the selected block.

BlockFormat() Formats the selected block. For compatibility with V3.0 the BlockAlign() is supported.

BlockHide() Hides lines containing the selected block.

BlockIndent() Indents the selected block.

BlockMove() Moves the selected block to the current text insertion point position.

BlockPrint() Prints the selected block.

BlockReverseCase() Reverses the case of all characters in the selected block.

BlockToLower() Converts all characters in the selected block to lower case.

BlockToUpper() Converts all characters in the selected block to upper case.

BlockUnhide() Exposes the hidden text in the Editor. The insertion point must be in a hidden line which is to be exposed.

BlockUnindent() Unindents the selected block.

BookMarkClearAll() Removes all bookmarks in the file

CaretBackTab() Moves the text insertion point one tab stop to the left.

CaretBlockBegin() Moves the text insertion point to the beginning of the C language block.

CaretBlockEnd() Moves the text insertion point to the end of the C language block.

CaretColNo(n) Moves the insertion point to the n-th letter position in a line (column).

CaretColumnLeft() Moves the text insertion point one column to the left.

CaretColumnRight() Moves the text insertion point one column to the right.

CaretDown() Moves the text insertion point one row down. If a new insertion point position is on a TAB character, the insertion point will jump according to Options > Editor / Source/ insertion point through Tabs or Options > Editor /Text / insertion point through Tabs.

CaretFileBeg() Moves the text insertion point to the beginning of the file.

CaretFileEnd() Moves the text insertion point to the end of the file.

CaretForeTab() Moves the text insertion point one tab stop to the right.

CaretJumpDown() Moves the text insertion point one row down. If a new insertion point position is on a TAB character, the insertion point will jump to the current tab stop.

CaretJumpLeft() Moves the text insertion point one column to the left. If the insertion point is positioned on a TAB character, the insertion point will jump to the next tab stop.

CaretJumpRight() Moves the text insertion point one column to the right. If the insertion point is positioned on a TAB character, the insertion point will jump to the next tab stop.

CaretJumpUp() Moves the text insertion point one row up. If a new insertion point position is on a TAB character, the insertion point will jump to the current tab stop.

CaretLeft() Moves the text insertion point one column to the left. If the insertion point is positioned on a TAB character, the insertion point will jump according to Options > Editor / Source/ insertion point through Tabs or Options > Editor /Text / insertion point through Tabs.

CaretLeftSkipNonWhite() Moves the text insertion point to the left, skipping non-white spaces.

CaretLeftSkipNonWord() Moves the text insertion point to the left, skipping non-word characters.

CaretLeftSkipWhite() Moves the text insertion point to the left, skipping white spaces including new line characters.

CaretLeftSkipWord() Moves the text insertion point to the left, skipping word characters.

CaretLineBeg() Moves the text insertion point to the beginning of the line.

CaretLineEnd() Moves the text insertion point to the end of the line.

CaretLineNo( n ) Moves the insertion point to the n-th line.

CaretLineToBottom() Scrolls the Editor so that the text insertion point is positioned at the bottom of the page.

CaretLineToCenter() Scrolls the Editor so that the text insertion point is positioned at the center of the page.

CaretLineToTop() Scrolls the Editor so that the text insertion point is positioned at the top of the page.

CaretPageBeg() Moves the text insertion point to the left side of the page.

CaretPageBottom() Moves the text insertion point to the bottom of the page.

CaretPageEnd() Moves the text insertion point to the right side of the page.

CaretPageTop() Moves the text insertion point to the top of the page.

CaretPgDown() Moves the text insertion point one page down.

CaretPgLeft() Move 1 screen width left

CaretPgRight() Move 1 screen width right

CaretPgUp() Moves the text insertion point one page up.

CaretRight() Moves the text insertion point one column to the right. If the text insertion point is positioned on a TAB character, it will jump according to Options > Editor / Source/ insertion point through Tabs or Options > Editor /Text / insertion point through Tabs.

CaretRightSkipNonWhite() Moves the text insertion point to the right, skipping non-white spaces.

CaretRightSkipNonWord() Moves the text insertion point to the right, skipping non-word characters.

CaretRightSkipWhite() Moves the text insertion point to the right, skipping white spaces, including new line characters.

CaretRightSkipWord() Moves the text insertion point to the right, skipping word characters.

CaretRowDown() Moves the text insertion point one row down.

CaretRowUp() Moves the text insertion point one row up.

CaretUp() Moves the text insertion point one row up. If the new text insertion point position is on a TAB character, the text insertion point will jump according to Options > Editor / Source/ insertion point through Tabs or Options > Editor /Text / insertion point through Tabs.

ClearLineColor() Sets current line background color to one specified for the source background color (BKG color) in the Source/Colors & Font dialogbox.

Close() Closes the Editor currently active.

Delete() Deletes the character under the text insertion point. If the text insertion point is positioned at the end of a line, appends the insertion point line to the next one.

DeleteTempBlock() Deletes the temporary block defined using SetTempPos() and SetTempEndPos() macros.

DelLine() Deletes the line in which the text insertion point is positioned.

GotoLine() Opens the Go To Line dialog box.

HideAllInactivePPG() Hides or shades all parts of the code bordered by preprocessor directives for if compilation which have not been included in the last symbol analysis.

HideAllUnanalyzedBlocks()
Hides all unanalyzed parts of the code of one file.

HideFlowChart() Hides Flowchart.

HideStructureHighlighting()
Hides structure highiligting in the Editor.

HideThisPPG() Hides or shades the part of the code bordered by preprocessor directives for if compilation which has not been included in the last symbol analysis. It is assumed that the insertion point is positioned in that part of the code, otherwise, nothing happens.

HideThisPreprocessorBlock()
Hides the unanalyzed part of the code at insertion point position.

InsChar( char ) Inserts a character at the current text insertion point position.

InsertConstruct(string) Inserts the C language construction in the insertion point position or around the selected block. The macro parameter is a character string marking the construction type. Parameter values can be: if, case, for, switch, do, while, else.

Example: InsertConstruct( "While" )
inserts the while construction and positions the insertion point within the parentheses for the condition of the while cycle.

InsertIndent() Inserts white space characters at insertion point position. If the Options > Editor / C Source / Use TAB character option has been selected, inserts TAB characters. The number of characters inserted is defined by the Options > Editor / C Source / Indent length option.

InsertTab() Inserts the TAB character at insertion point position, regardless of the value of the Options > Editor / Use Tabs option.

InsertText( string ) Inserts text at the current text insertion point position.

InsLine( string ) Inserts a new line containing the string before the current one and moves the text insertion point to it. The string may contain a special format specifier:

%d inserts a date at this position

%c positions the text insertion point at this position

%i[num] indents the line num indent levels past the current level

%f<char> fills the line from the current position to Text Width position with character char

%n inserts the file name at this position. This option must be given at the beginning of the string, otherwise will be ignored.

IsAutoIndent() Returns "TRUE" if Editor is in Auto Indent mode.

IsBlockActive() Returns "TRUE" if the selected block exists.

IsBlockLine() Returns "TRUE" if the line block exists.

IsBlockMarked() Returns "TRUE" if the selected block exists.

IsBlockMultiLine() Returns "TRUE" if the selected block is two or more lines long.

IsBlockNormal() Returns "TRUE" if the normal block exists.

IsBlockPersistant() Returns "TRUE" if the active Editor option is Persistent Blocks

IsBlockValid() Returns "TRUE" if the selected visible block exists.

IsBlockVertical() Returns "TRUE" if the vertical block exists.

IsCaretAtBOL() Returns "TRUE" if the text insertion point is at the beginning of the line.

IsCaretAtBOS() Returns "TRUE" if the text insertion point is at the bottom of the window.

IsCaretAtEOL() Returns "TRUE" if the text insertion point is at the end of the line.

IsCaretAtTOS() Returns "TRUE" if the text insertion point is at the top of the window.

IsCaretOnChar( char ) Returns "TRUE" if the text insertion point is on the character char.

IsCaretPastEOF() Returns "TRUE" if the text insertion point is past the end of the file.

IsCaretPastEOL() Returns "TRUE" if the text insertion point is past the end of the line.

IsFlowChartShown() Returns "TRUE" if Flowchart is shown

IsLineColored() Returns "TRUE" if the line is colored as a result of the SetLineColor macro call or as a result of syntax coloring. If the line is colored by default text color, it returns FALSE.

IsLineEmpty() True if line is empty

IsOnHidden() Returns "TRUE" if the insertion point is on a hidden line.

IsOverWrite() Returns "TRUE" if Editor is in overwrite mode.

IsStructureHighlightingShown()Returns "TRUE" if structure highlighting is shown in Editor.

MarkBegin() Starts marking from the current text insertion point position. If the position is at the beginning or ending of the previously selected block, continues marking; otherwise, starts a new block.

MarkBeginNew() Starts marking a new block from the current text insertion point position.

MarkEnd() Ends marking.

MatchPairBackward() If the text insertion point is positioned on one of the following characters: ")", "}" or "]", searches backward for the closest instance of matching parentheses.

MatchPairForward() If the text insertion point is positioned on one of these characters: "(", "{" or "[", searches forward for the closest instance of matching parentheses.

MoveToBlockBegin() Moves the text insertion point to the beginning of the selected block.

MoveToBlockEnd() Moves the text insertion point to the end of the selected block.

MoveToMark( n ) Moves the text insertion point to the n-th position previously saved by the SetMark() macro, where n is a whole number, ranging from 0 to 9.

MoveToPrevPos() Moves the text insertion point to the position previously saved by the SetPrevPos() macro, usually the previous position.

MoveToTempEndPos() Moves the text insertion point to the position saved by SetTempEndPos() macro, usually the end of the temporary block.

MoveToTempPos() Moves the text insertion point to the position previously saved by the SetTempPos() macro, usually the beginning of the temporary block.

NewerSourcePos() If OlderSourcePos() has been performed, moves the text insertion point to the position from which the corresponding source-locating jump was made. These jumps occur when you double-click in a Browser or Graph, or when a symbol definition is searched for using the Editor or Browser shortcut menus.

NextBookmark() Sets the insertion point in the line with the next bookmark

NextEditWindow() If you want to simply switch from one open Editor to another, use this macro instead of the Ctrl+Tab key combination, but only for Editors.

Null() Does nothing. It may be used to suppress using any shortcut key combination.

OlderSourcePos() Moves the text insertion point to the position from which the previous source-locating jump was made. These jumps occur when you double-click in a Browser or Graph, or when a symbol definition is searched using the Editor or Browser shortcut menus.

OpenFileAtCursor() If the text insertion point is positioned on the file name, opens the file. Otherwise, opens the File Open dialog box.

PrevBookMark() Sets the insertion point in the line with the previous bookmark.

QuickSearch () Quick word search. Find first shown of marked text. If nothing selected, search the word under current cursor position.

Replace() Opens the Replace dialog box.

ReverseSearchDirection() Reverses search direction from Forward to Backward and conversely.

RotateFlowChart() Rotate flowchart in negative direction

Save() Unconditionally saves the contents of the Editor.

SaveAs() Opens the Save As dialog box.

ScrollDown() Scrolls the contents of the Editor one row down.

ScrollUp() Scrolls the contents of the Editor one row up.

Search() Opens the Search dialog box.

SearchAgain() Proceeds with the previous search or replace action.

SetBlockBegin() Sets the beginning of the selected block to the current text insertion point position.

SetBlockEnd() Sets the end of the selected block to the current text insertion point position.

SetBreakpoint() Sets a breakpoint on the line on which the insertion point is positioned.

SetInclusiveBlocks() Sets Inclusive marking mode.

SetLineBlocks() Sets Line marking mode.

SetLineColor(string, string) Changes the color of the line where the insertion point is positioned. Macro parameters, letter and background color, are respectively specified in the form of a character string. Possible values of these character strings are: BLACK, GRAY, BLUE, CYAN, LTGREEN, MAGENTA, RED, YELLOW, WHITE.

For example: SetLineColor( "RED", "WHITE" )
colors the line where the insertion point is positioned in the following way: the background is colored white, while the letters are colored red.

SetMark( n ) Saves the current text insertion point position so that the subsequent MoveToMark() can restore it. Number n is a whole number, ranging from 0 to 9.

SetNonInclusiveBlocks() Sets Non-Inclusive marking mode.

SetNormalBlocks() Sets Normal marking mode.

SetPrevPos() Saves the current position and regards it as the previous position.

SetSearchBackward() Sets Backward searching mode.

SetSearchForward() Sets Forward searching mode.

SetTempEndPos() Saves the current position and regards it as the end of the temporary block.

SetTempPos() Saves the current position and regards it as the beginning of the temporary block.

SetVerticalBlocks() Sets Vertical marking mode.

ShowFlowChart() Shows Flowchart.

ShowStructureHighlighting()Shows the structure highlighting in Editor.

ShutdownBlock() Shuts down the currently selected block .

SwapPrevPos() Swaps the current text position with the one previously saved by the SetPrevPos() macro.

ToggleAutoIndent() Auto indent on/off

ToggleBookMark() Changes the bookmark status (On/Off). If the line has a bookmark, the bookmark is deleted, but if it does not, the bookmark is set

ToggleInsert() Toggles the Insert mode.

ToggleInvisibleChars() Turns on/off the mode which hides characters otherwise hidden (Tab, Space, EOL, EOF ).

ToggleUseTABCharacter() Tab usage on/off

TurnBlockOff() Inactivates the selected block.

TurnBlockOn() Activates the selected block.

UDA(string) Carries out the User-Defined Action script with the specified name.

Undo() Restores the Editor file to the way it was prior to the most recent action.

UnhideAllInactivePPG() Displays or removes shading from all parts of the code bordered by preprocessor directives for if compilation which have not been included in the last symbol analysis.

UnhideAllUnanalyzedBlocks()Unhides all unanalyzed parts of the code of one file.

UserHelp() Opens the user-defined Help file.

UserInsertMenu(string) Activates the specified Editor macro.

Example: the execution of the macro
UserInsertMenu( "CaretLeft" )
has the same results as the execution of the macro
CaretLeft()
that is, it moves the insertion point one position to the left.


Copyright 1993-2017, RistanCASE GmbH