globalCommands module

class globalCommands.GlobalCommands(*args, **kwargs)

Bases: ScriptableObject

Commands that are available at all times, regardless of the current focus.

script_cycleAudioDuckingMode(gesture)

Cycles through audio ducking modes which determine when NVDA lowers the volume of other sounds

script_toggleInputHelp(gesture)

Turns input help on or off. When on, any input such as pressing a key on the keyboard will tell you what script is associated with that input, if any.

script_toggleCurrentAppSleepMode(gesture)

Toggles sleep mode on and off for the active application.

script_reportCurrentLine(gesture)

Reports the current line under the application cursor. Pressing this key twice will spell the current line. Pressing three times will spell the line using character descriptions.

script_leftMouseClick(gesture)

Clicks the left mouse button once at the current mouse position

script_rightMouseClick(gesture)

Clicks the right mouse button once at the current mouse position

script_toggleLeftMouseButton(gesture)

Locks or unlocks the left mouse button

script_toggleRightMouseButton(gesture)

Locks or unlocks the right mouse button

script_mouseScrollUp(gesture: InputGesture) None

Scroll up at the mouse position

script_mouseScrollDown(gesture: InputGesture) None

Scroll down at the mouse position

script_mouseScrollLeft(gesture: InputGesture) None

Scroll left at the mouse position

script_mouseScrollRight(gesture: InputGesture) None

Scroll right at the mouse position

script_reportCurrentSelection(gesture)

Announces the current selection in edit controls and documents. Pressing twice spells this information. Pressing three times spells it using character descriptions. Pressing four times shows it in a browsable message.

script_dateTime(gesture)

If pressed once, reports the current time. If pressed twice, reports the current date

script_firstValueSynthRing(gesture: InputGesture)

Set the first value of the current setting in the synth settings ring

script_lastValueSynthRing(gesture: InputGesture)

Set the last value of the current setting in the synth settings ring

script_increaseSynthSetting(gesture)

Increases the currently active setting in the synth settings ring

script_increaseLargeSynthSetting(gesture: InputGesture)

Increases the currently active setting in the synth settings ring in a larger step

script_decreaseSynthSetting(gesture)

Decreases the currently active setting in the synth settings ring

script_decreaseLargeSynthSetting(gesture: InputGesture)

Decreases the currently active setting in the synth settings ring in a larger step

script_nextSynthSetting(gesture)

Moves to the next available setting in the synth settings ring

script_previousSynthSetting(gesture)

Moves to the previous available setting in the synth settings ring

script_toggleSpeakTypedCharacters(gesture)

Toggles on and off the speaking of typed characters

script_toggleSpeakTypedWords(gesture)

Toggles on and off the speaking of typed words

script_toggleSpeakCommandKeys(gesture)

Toggles on and off the speaking of typed keys, that are not specifically characters

script_toggleReportFontName(gesture)

Toggles on and off the reporting of font changes

script_toggleReportFontSize(gesture)

Toggles on and off the reporting of font size changes

script_toggleReportFontAttributes(gesture: InputGesture)

Cycles font attribute reporting between speech, braille, speech and braille, and off.

script_toggleReportSuperscriptsAndSubscripts(gesture)

Toggles on and off the reporting of superscripts and subscripts

script_toggleReportRevisions(gesture)

Toggles on and off the reporting of revisions

script_toggleReportEmphasis(gesture)

Toggles on and off the reporting of emphasis

script_toggleReportHighlightedText(gesture)

Toggles on and off the reporting of highlighted text

script_toggleReportColor(gesture)

Toggles on and off the reporting of colors

script_toggleReportAlignment(gesture)

Toggles on and off the reporting of text alignment

script_toggleReportStyle(gesture)

Toggles on and off the reporting of style changes

script_toggleReportSpellingErrors(gesture)

Toggles on and off the reporting of spelling errors

script_toggleReportPage(gesture)

Toggles on and off the reporting of pages

script_toggleReportLineNumber(gesture)

Toggles on and off the reporting of line numbers

script_toggleReportLineIndentation(gesture: InputGesture)

Cycles through line indentation settings

script_toggleignoreBlankLinesForReportLineIndentation(gesture: InputGesture) None

Toggles on and off the ignoring of blank lines for line indentation reporting

script_toggleReportParagraphIndentation(gesture)

Toggles on and off the reporting of paragraph indentation

script_toggleReportLineSpacing(gesture)

Toggles on and off the reporting of line spacing

script_toggleReportTables(gesture)

Toggles on and off the reporting of tables

script_toggleReportTableHeaders(gesture)

Cycle through the possible modes to report table row and column headers

script_toggleReportTableCellCoords(gesture)

Toggles on and off the reporting of table cell coordinates

script_toggleReportCellBorders(gesture: InputGesture)

Cycles through the cell border reporting settings

Toggles on and off the reporting of links

script_toggleReportGraphics(gesture)

Toggles on and off the reporting of graphics

script_toggleReportComments(gesture)

Toggles on and off the reporting of comments

script_toggleReportLists(gesture)

Toggles on and off the reporting of lists

script_toggleReportHeadings(gesture)

Toggles on and off the reporting of headings

script_toggleReportGroupings(gesture)

Toggles on and off the reporting of groupings

script_toggleReportBlockQuotes(gesture)

Toggles on and off the reporting of block quotes

script_toggleReportLandmarks(gesture)

Toggles on and off the reporting of landmarks

script_toggleReportArticles(gesture)

Toggles on and off the reporting of articles

script_toggleReportFrames(gesture)

Toggles on and off the reporting of frames

script_toggleReportClickable(gesture)

Toggles on and off reporting if clickable

script_toggleReportFigures(gesture: InputGesture)

Toggles on and off the reporting of figures and captions

script_cycleSpeechAutomaticLanguageSwitching(gesture)

Cycles through the possible choices for automatic language switching: off, language only and language and dialect.

script_cycleSpeechSymbolLevel(gesture)

Cycles through speech symbol levels which determine what symbols are spoken

script_toggleDelayedCharacterDescriptions(gesture: InputGesture) None

Toggles on and off delayed descriptions for characters on cursor movement

script_moveMouseToNavigatorObject(gesture: InputGesture)

Moves the mouse pointer to the current navigator object

script_moveNavigatorObjectToMouse(gesture: InputGesture)

Sets the navigator object to the current object under the mouse pointer and speaks it

script_reviewMode_next(gesture)

Switches to the next review mode (e.g. object, document or screen) and positions the review position at the point of the navigator object

script_reviewMode_previous(gesture)

Switches to the previous review mode (e.g. object, document or screen) and positions the review position at the point of the navigator object

script_toggleSimpleReviewMode(gesture)

Toggles simple review mode on and off

script_navigatorObject_current(gesture: InputGesture)

Reports the current navigator object. Pressing twice spells this information, and pressing three times Copies name and value of this object to the clipboard

static _reportLocationText(objs: Tuple[None | NVDAObject | TextInfo, ...]) None
script_reportReviewCursorLocation(gesture)

Reports information about the location of the text at the review cursor, or location of the navigator object if there is no text under review cursor.

script_reportCurrentNavigatorObjectLocation(gesture)

Reports information about the location of the current navigator object.

script_reportCaretLocation(gesture)

Reports information about the location of the text at the caret, or location of the currently focused object if there is no caret.

script_reportFocusObjectLocation(gesture)

Reports information about the location of the currently focused object.

script_navigatorObject_currentDimensions(gesture)

Reports information about the location of the text or object at the review cursor. Pressing twice may provide further detail.

script_caretPos_currentDimensions(gesture)

Reports information about the location of the text or object at the position of system caret. Pressing twice may provide further detail.

script_navigatorObject_toFocus(gesture: InputGesture)

Sets the navigator object to the current focus, and the review cursor to the position of the caret inside it, if possible.

script_navigatorObject_moveFocus(gesture: InputGesture)

Pressed once sets the keyboard focus to the navigator object, pressed twice sets the system caret to the position of the review cursor

script_navigatorObject_parent(gesture: InputGesture)

Moves the navigator object to the object containing it

script_navigatorObject_next(gesture: InputGesture)

Moves the navigator object to the next object

script_navigatorObject_previous(gesture: InputGesture)

Moves the navigator object to the previous object

script_navigatorObject_firstChild(gesture: InputGesture)

Moves the navigator object to the first object inside it

script_review_activate(gesture: InputGesture)

Performs the default action on the current navigator object (example: presses it if it is a button).

script_review_top(gesture: InputGesture)

Moves the review cursor to the top line of the current navigator object and speaks it

script_review_previousLine(gesture: InputGesture)

Moves the review cursor to the previous line of the current navigator object and speaks it

script_review_currentLine(gesture: InputGesture)

Reports the line of the current navigator object where the review cursor is situated. If this key is pressed twice, the current line will be spelled. Pressing three times will spell the line using character descriptions.

script_review_nextLine(gesture: InputGesture)

Moves the review cursor to the next line of the current navigator object and speaks it

script_review_previousPage(gesture: InputGesture) None

Moves the review cursor to the previous page of the current navigator object and speaks it

script_review_nextPage(gesture: InputGesture) None

Moves the review cursor to the next page of the current navigator object and speaks it

script_review_bottom(gesture: InputGesture)

Moves the review cursor to the bottom line of the current navigator object and speaks it

script_review_previousWord(gesture: InputGesture)

Moves the review cursor to the previous word of the current navigator object and speaks it

script_review_currentWord(gesture: InputGesture)

Speaks the word of the current navigator object where the review cursor is situated. Pressing twice spells the word. Pressing three times spells the word using character descriptions

script_review_nextWord(gesture: InputGesture)

Moves the review cursor to the next word of the current navigator object and speaks it

script_review_startOfLine(gesture: InputGesture)

Moves the review cursor to the first character of the line where it is situated in the current navigator object and speaks it

script_review_previousCharacter(gesture: InputGesture)

Moves the review cursor to the previous character of the current navigator object and speaks it

script_review_currentCharacter(gesture: InputGesture)

Reports the character of the current navigator object where the review cursor is situated. Pressing twice reports a description or example of that character. Pressing three times reports the numeric value of the character in decimal and hexadecimal

script_review_nextCharacter(gesture: InputGesture)

Moves the review cursor to the next character of the current navigator object and speaks it

script_review_endOfLine(gesture: InputGesture)

Moves the review cursor to the last character of the line where it is situated in the current navigator object and speaks it

_getCurrentLanguageForTextInfo(info)
script_review_currentSymbol(gesture)

Reports the symbol where the review cursor is positioned. Pressed twice, shows the symbol and the text used to speak it in browse mode

script_speechMode(gesture: InputGesture) None

Cycles between speech modes.

script_moveToParentTreeInterceptor(gesture)

Moves the focus out of the current embedded object and into the document that contains it

script_toggleVirtualBufferPassThrough(gesture)

Toggles between browse mode and focus mode. When in focus mode, keys will pass straight through to the application, allowing you to interact directly with a control. When in browse mode, you can navigate the document with the cursor, quick navigation keys, etc.

script_quit(gesture)

Quits NVDA!

script_restart(gesture)

Restarts NVDA!

script_showGui(gesture)

Shows the NVDA menu

script_review_sayAll(gesture: InputGesture)

Reads from the review cursor up to the end of the current text, moving the review cursor as it goes

script_sayAll(gesture: InputGesture)

Reads from the system caret up to the end of the text, moving the caret as it goes

_reportFormattingHelper(info, browseable=False)
static _getTIAtCaret(fallbackToPOSITION_FIRST: bool = False, reportFailure: bool = True) TextInfo | None
script_reportFormattingAtReview(gesture)

Reports formatting info for the current review cursor position.

script_showFormattingAtReview(gesture)

Presents, in browse mode, formatting info for the current review cursor position.

script_reportFormatting(gesture)

Reports formatting info for the current review cursor position. If pressed twice, presents the information in browse mode

script_reportFormattingAtCaret(gesture)

Reports formatting info for the text under the caret.

script_showFormattingAtCaret(gesture)

Presents, in browse mode, formatting info for the text under the caret.

script_reportOrShowFormattingAtCaret(gesture)

Reports formatting info for the text under the caret. If pressed twice, presents the information in browse mode

_getNvdaObjWithAnnotationUnderCaret() NVDAObject | None

If it has an annotation, get the NVDA object for the single character under the caret or the object with system focus. @note: It is tempting to try to report any annotation details that exists in the range formed by prior

and current location. This would be a new paradigm in NVDA, and may feel natural when moving by line to be able to more quickly have the ‘details’ reported. However, there may be more than one ‘details relation’ in that range, and we don’t yet have a way for the user to select which one to report. For now, we minimise this risk by only reporting details at the current location.

_annotationNav = <annotation._AnnotationNavigation object>
script_reportDetailsSummary(gesture: InputGesture)

Report summary of any annotation details at the system caret.

script_reportCurrentFocus(gesture: InputGesture)

Reports the object with focus. If pressed twice, spells the information. Pressing three times spells it using character descriptions.

static _getStatusBarText(setReviewCursor: bool = False) str | None

Returns text of the current status bar and optionally sets review cursor to it. If no status bar has been found None is returned and this fact is announced in speech and braille.

script_readStatusLine(gesture)

Reads the current application status bar.

script_spellStatusLine(gesture)

Spells the current application status bar.

script_copyStatusLine(gesture)

Copies content of the status bar of current application to the clipboard.

script_reviewCursorToStatusLine(gesture)

Reads the current application status bar and moves navigator object into it.

script_reportStatusLine(gesture)

Reads the current application status bar. If pressed twice, spells the information. If pressed three times, copies the status bar to the clipboard

script_reportFocusObjectAccelerator(gesture: InputGesture) None

Reports the shortcut key of the currently focused object

script_toggleMouseTracking(gesture)

Toggles the reporting of information as the mouse moves

script_toggleMouseTextResolution(gesture)

Toggles how much text will be spoken when the mouse moves

script_title(gesture: InputGesture)

Reports the title of the current application or foreground window. If pressed twice, spells the title. If pressed three times, copies the title to the clipboard

script_speakForeground(gesture)

Reads all controls in the active window

script_test_navigatorDisplayModelText(gesture)
script_startWxInspectionTool(gesture)

Opens the WX GUI inspection tool. Used to get more information about the state of GUI components.

script_navigatorObject_devInfo(gesture)

Logs information about the current navigator object which is useful to developers and activates the log viewer so the information can be examined.

script_log_markStartThenCopy(gesture)

Mark the current end of the log as the start of the fragment to be copied to clipboard by pressing again.

script_openUserConfigurationDirectory(gesture)

Opens NVDA configuration directory for the current user.

script_toggleProgressBarOutput(gesture)

Toggles between beeps, speech, beeps and speech, and off, for reporting progress bar updates

script_toggleReportDynamicContentChanges(gesture)

Toggles on and off the reporting of dynamic content changes, such as new text in dos console windows

script_toggleCaretMovesReviewCursor(gesture)

Toggles on and off the movement of the review cursor due to the caret moving.

script_toggleFocusMovesNavigatorObject(gesture)

Toggles on and off the movement of the navigator object due to focus changes

script_toggleAutoFocusFocusableElements(gesture)

Toggles on and off automatic movement of the system focus due to browse mode commands

script_say_battery_status(gesture: InputGesture) None

Reports battery status and time remaining if AC is not plugged in

script_passNextKeyThrough(gesture)

The next key that is pressed will not be handled at all by NVDA, it will be passed directly through to Windows.

script_reportAppModuleInfo(gesture)

Speaks the filename of the active application along with the name of the currently loaded appModule

script_activateGeneralSettingsDialog(gesture)

Shows NVDA’s general settings

script_activateSynthesizerDialog(gesture)

Shows the NVDA synthesizer selection dialog

script_activateVoiceDialog(gesture)

Shows NVDA’s speech settings

script_activateBrailleDisplayDialog(gesture)

Shows the NVDA braille display selection dialog

script_activateBrailleSettingsDialog(gesture)

Shows NVDA’s braille settings

script_activateAudioSettingsDialog(gesture)

Shows NVDA’s audio settings

script_activateKeyboardSettingsDialog(gesture)

Shows NVDA’s keyboard settings

script_activateMouseSettingsDialog(gesture)

Shows NVDA’s mouse settings

script_activateReviewCursorDialog(gesture)

Shows NVDA’s review cursor settings

script_activateInputCompositionDialog(gesture)

Shows NVDA’s input composition settings

script_activateObjectPresentationDialog(gesture)

Shows NVDA’s object presentation settings

script_activateBrowseModeDialog(gesture)

Shows NVDA’s browse mode settings

script_activateDocumentFormattingDialog(gesture)

Shows NVDA’s document formatting settings

script_activateDefaultDictionaryDialog(gesture)

Shows the NVDA default dictionary dialog

script_activateVoiceDictionaryDialog(gesture)

Shows the NVDA voice-specific dictionary dialog

script_activateTemporaryDictionaryDialog(gesture)

Shows the NVDA temporary dictionary dialog

script_activateSpeechSymbolsDialog(gesture)

Shows the NVDA symbol pronunciation dialog

script_activateInputGesturesDialog(gesture)

Shows the NVDA input gestures dialog

script_reportActiveConfigurationProfile(gesture)

Reports the name of the current NVDA configuration profile

script_saveConfiguration(gesture)

Saves the current NVDA configuration

script_revertConfiguration(gesture)

Pressing once reverts the current configuration to the most recently saved state. Pressing three times resets to factory defaults.

script_activatePythonConsole(gesture)

Activates the NVDA Python Console, primarily useful for development

script_activateAddonsManager(gesture: InputGesture)

Activates the Add-on Store to browse and manage add-on packages for NVDA

script_toggleSpeechViewer(gesture: InputGesture)

Toggles the NVDA Speech viewer, a floating window that allows you to view all the text that NVDA is currently speaking

script_toggleBrailleViewer(gesture: InputGesture)

Toggles the NVDA Braille viewer, a floating window that allows you to view braille output, and the text equivalent for each braille character

script_braille_toggleTether(gesture)

Toggle tethering of braille between the focus and the review position

script_toggleBrailleMode(gesture: InputGesture)

Toggles braille mode

script_braille_cycleReviewRoutingMovesSystemCaret(gesture: InputGesture) None

Cycle through the braille move system caret when routing review cursor states

script_braille_toggleFocusContextPresentation(gesture)

Toggle the way context information is presented in braille

script_braille_toggleShowCursor(gesture)

Toggle the braille cursor on and off

script_braille_toggleSpeakOnRouting(gesture)

Toggles speaking the character under the cursor when routing cursor in text

script_braille_cycleCursorShape(gesture)

Cycle through the braille cursor shapes

script_braille_cycleShowMessages(gesture: InputGesture) None

Cycle through the braille show messages modes

script_braille_cycleShowSelection(gesture: InputGesture) None

Cycle through the braille show selection states

script_braille_cycleUnicodeNormalization(gesture: InputGesture) None

Cycle through the braille Unicode normalization states

script_reportClipboardText(gesture)

Reports the text on the Windows clipboard. Pressing twice spells this information. Pressing three times spells it using character descriptions.

script_review_markStartForCopy(gesture)

Marks the current position of the review cursor as the start of text to be selected or copied

script_review_moveToStartMarkedForCopy(gesture: InputGesture)

Move the review cursor to the position marked as the start of text to be selected or copied

script_review_copy(gesture)

If pressed once, the text from the previously set start marker up to and including the current position of the review cursor is selected. If pressed twice, the text is copied to the clipboard

script_braille_scrollBack(gesture)

Scrolls the braille display back

script_braille_scrollForward(gesture)

Scrolls the braille display forward

script_braille_routeTo(gesture)

Routes the cursor to or activates the object under this braille cell

script_braille_reportFormatting(gesture)

Reports formatting info for the text under this braille cell

script_braille_previousLine(gesture)

Moves the braille display to the previous line

script_braille_nextLine(gesture)

Moves the braille display to the next line

script_braille_dots(gesture)

Inputs braille dots via the braille keyboard

script_braille_toFocus(gesture)

Moves the braille display to the current focus

script_braille_eraseLastCell(gesture)

Erases the last entered braille cell or character

script_braille_enter(gesture)

Translates any braille input and presses the enter key

script_braille_translate(gesture)

Translates any braille input

script_braille_toggleShift(gesture)

Virtually toggles the shift key to emulate a keyboard shortcut with braille input

script_braille_toggleControl(gesture)

Virtually toggles the control key to emulate a keyboard shortcut with braille input

script_braille_toggleAlt(gesture)

Virtually toggles the alt key to emulate a keyboard shortcut with braille input

script_braille_toggleWindows(gesture)

Virtually toggles the left windows key to emulate a keyboard shortcut with braille input

script_braille_toggleNVDAKey(gesture)

Virtually toggles the NVDA key to emulate a keyboard shortcut with braille input

script_braille_toggleControlShift(gesture)

Virtually toggles the control and shift keys to emulate a keyboard shortcut with braille input

script_braille_toggleAltShift(gesture)

Virtually toggles the alt and shift keys to emulate a keyboard shortcut with braille input

script_braille_toggleWindowsShift(gesture)

Virtually toggles the left windows and shift keys to emulate a keyboard shortcut with braille input

script_braille_toggleNVDAKeyShift(gesture)

Virtually toggles the NVDA and shift keys to emulate a keyboard shortcut with braille input

script_braille_toggleControlAlt(gesture)

Virtually toggles the control and alt keys to emulate a keyboard shortcut with braille input

script_braille_toggleControlAltShift(gesture)

Virtually toggles the control, alt, and shift keys to emulate a keyboard shortcut with braille input

script_reloadPlugins(gesture)

Reloads app modules and global plugins without restarting NVDA, which can be Useful for developers

script_reportLinkDestination(gesture: InputGesture, forceBrowseable: bool = False) None

Report the destination URL of the link at the position of caret or focus. If pressed twice, shows the URL in a window for easier review.

script_reportLinkDestinationInWindow(gesture: InputGesture) None

Displays the destination URL of the link at the position of caret or focus in a window, instead of just speaking it. May be preferred by braille users.

script_navigatorObject_nextInFlow(gesture: InputGesture)

Moves to the next object in a flattened view of the object navigation hierarchy

script_navigatorObject_previousInFlow(gesture: InputGesture)

Moves to the previous object in a flattened view of the object navigation hierarchy

script_toggleTouchSupport(gesture)

Toggles the support of touch interaction

script_touch_changeMode(gesture)

Cycles between available touch modes

script_touch_newExplore(gesture)

Reports the object and content directly under your finger

script_touch_explore(gesture)

Reports the new object or content under your finger if different to where your finger was last

script_touch_hoverUp(gesture)
script_touch_rightClick(gesture)

Clicks the right mouse button at the current touch position. This is generally used to activate a context menu.

script_activateConfigProfilesDialog(gesture)

Shows the NVDA Configuration Profiles dialog

script_toggleConfigProfileTriggers(gesture)

Toggles disabling of all configuration profile triggers. Disabling remains in effect until NVDA is restarted

script_interactWithMath(gesture)

Begins interaction with math content

script_recognizeWithUwpOcr(gesture)

Recognizes the content of the current navigator object with Windows OCR

script_cycleOcrLanguage(gesture: InputGesture) None

Cycles through the available languages for Windows OCR

script_toggleReportCLDR(gesture)

Toggles on and off the reporting of CLDR characters, such as emojis

script_speech_cycleUnicodeNormalization(gesture: InputGesture) None

Cycle through the speech Unicode normalization states

_tempEnableScreenCurtain = True
_waitingOnScreenCurtainWarningDialog: Dialog | None = None
_toggleScreenCurtainMessage: str | None = None
script_toggleScreenCurtain(gesture)

Toggles the state of the screen curtain, enable to make the screen black or disable to show the contents of the screen. Pressed once, screen curtain is enabled until you restart NVDA. Pressed twice, screen curtain is enabled until you disable it

script_cycleParagraphStyle(gesture: InputGesture) None

Cycles through paragraph navigation styles

script_cycleSoundSplit(gesture: InputGesture) None

Cycles through sound split modes

__gestures = {'bk:dot7': 'braille_eraseLastCell', 'bk:dot7+dot8': 'braille_translate', 'bk:dot8': 'braille_enter', 'bk:dots': 'braille_dots', 'kb(desktop):NVDA+control+downArrow': 'decreaseSynthSetting', 'kb(desktop):NVDA+control+f2': 'test_navigatorDisplayModelText', 'kb(desktop):NVDA+control+leftArrow': 'previousSynthSetting', 'kb(desktop):NVDA+control+pageDown': 'decreaseLargeSynthSetting', 'kb(desktop):NVDA+control+pageUp': 'increaseLargeSynthSetting', 'kb(desktop):NVDA+control+rightArrow': 'nextSynthSetting', 'kb(desktop):NVDA+control+upArrow': 'increaseSynthSetting', 'kb(desktop):NVDA+downArrow': 'sayAll', 'kb(desktop):NVDA+end': 'reportStatusLine', 'kb(desktop):NVDA+shift+s': 'toggleCurrentAppSleepMode', 'kb(desktop):NVDA+shift+upArrow': 'reportCurrentSelection', 'kb(desktop):NVDA+upArrow': 'reportCurrentLine', 'kb(laptop):NVDA+.': 'review_currentCharacter', 'kb(laptop):NVDA+[': 'leftMouseClick', 'kb(laptop):NVDA+]': 'rightMouseClick', 'kb(laptop):NVDA+a': 'sayAll', 'kb(laptop):NVDA+backspace': 'navigatorObject_toFocus', 'kb(laptop):NVDA+control+.': 'review_currentWord', 'kb(laptop):NVDA+control+[': 'toggleLeftMouseButton', 'kb(laptop):NVDA+control+]': 'toggleRightMouseButton', 'kb(laptop):NVDA+control+end': 'review_bottom', 'kb(laptop):NVDA+control+home': 'review_top', 'kb(laptop):NVDA+control+leftArrow': 'review_previousWord', 'kb(laptop):NVDA+control+rightArrow': 'review_nextWord', 'kb(laptop):NVDA+control+shift+.': 'reportFocusObjectAccelerator', 'kb(laptop):NVDA+control+shift+downArrow': 'decreaseSynthSetting', 'kb(laptop):NVDA+control+shift+pageDown': 'decreaseLargeSynthSetting', 'kb(laptop):NVDA+delete': 'caretPos_currentDimensions', 'kb(laptop):NVDA+downArrow': 'review_nextLine', 'kb(laptop):NVDA+end': 'review_endOfLine', 'kb(laptop):NVDA+enter': 'review_activate', 'kb(laptop):NVDA+home': 'review_startOfLine', 'kb(laptop):NVDA+l': 'reportCurrentLine', 'kb(laptop):NVDA+leftArrow': 'review_previousCharacter', 'kb(laptop):NVDA+pageDown': 'reviewMode_previous', 'kb(laptop):NVDA+pageUp': 'reviewMode_next', 'kb(laptop):NVDA+rightArrow': 'review_nextCharacter', 'kb(laptop):NVDA+shift+.': 'review_currentLine', 'kb(laptop):NVDA+shift+a': 'review_sayAll', 'kb(laptop):NVDA+shift+backspace': 'navigatorObject_moveFocus', 'kb(laptop):NVDA+shift+control+leftArrow': 'previousSynthSetting', 'kb(laptop):NVDA+shift+control+pageUp': 'increaseLargeSynthSetting', 'kb(laptop):NVDA+shift+control+rightArrow': 'nextSynthSetting', 'kb(laptop):NVDA+shift+control+upArrow': 'increaseSynthSetting', 'kb(laptop):NVDA+shift+delete': 'navigatorObject_currentDimensions', 'kb(laptop):NVDA+shift+downArrow': 'navigatorObject_firstChild', 'kb(laptop):NVDA+shift+end': 'reportStatusLine', 'kb(laptop):NVDA+shift+leftArrow': 'navigatorObject_previous', 'kb(laptop):NVDA+shift+m': 'moveMouseToNavigatorObject', 'kb(laptop):NVDA+shift+n': 'moveNavigatorObjectToMouse', 'kb(laptop):NVDA+shift+o': 'navigatorObject_current', 'kb(laptop):NVDA+shift+pageDown': 'review_nextPage', 'kb(laptop):NVDA+shift+pageUp': 'review_previousPage', 'kb(laptop):NVDA+shift+rightArrow': 'navigatorObject_next', 'kb(laptop):NVDA+shift+s': 'reportCurrentSelection', 'kb(laptop):NVDA+shift+upArrow': 'navigatorObject_parent', 'kb(laptop):NVDA+shift+z': 'toggleCurrentAppSleepMode', 'kb(laptop):NVDA+upArrow': 'review_previousLine', 'kb(laptop):shift+NVDA+[': 'navigatorObject_previousInFlow', 'kb(laptop):shift+NVDA+]': 'navigatorObject_nextInFlow', 'kb:NVDA+1': 'toggleInputHelp', 'kb:NVDA+2': 'toggleSpeakTypedCharacters', 'kb:NVDA+3': 'toggleSpeakTypedWords', 'kb:NVDA+4': 'toggleSpeakCommandKeys', 'kb:NVDA+5': 'toggleReportDynamicContentChanges', 'kb:NVDA+6': 'toggleCaretMovesReviewCursor', 'kb:NVDA+7': 'toggleFocusMovesNavigatorObject', 'kb:NVDA+8': 'toggleAutoFocusFocusableElements', 'kb:NVDA+alt+m': 'interactWithMath', 'kb:NVDA+alt+s': 'cycleSoundSplit', 'kb:NVDA+b': 'speakForeground', 'kb:NVDA+c': 'reportClipboardText', 'kb:NVDA+control+a': 'activateBrailleDisplayDialog', 'kb:NVDA+control+alt+t': 'toggleTouchSupport', 'kb:NVDA+control+b': 'activateBrowseModeDialog', 'kb:NVDA+control+c': 'saveConfiguration', 'kb:NVDA+control+d': 'activateDocumentFormattingDialog', 'kb:NVDA+control+escape': 'toggleScreenCurtain', 'kb:NVDA+control+f1': 'reportAppModuleInfo', 'kb:NVDA+control+f3': 'reloadPlugins', 'kb:NVDA+control+g': 'activateGeneralSettingsDialog', 'kb:NVDA+control+k': 'activateKeyboardSettingsDialog', 'kb:NVDA+control+m': 'activateMouseSettingsDialog', 'kb:NVDA+control+o': 'activateObjectPresentationDialog', 'kb:NVDA+control+p': 'activateConfigProfilesDialog', 'kb:NVDA+control+r': 'revertConfiguration', 'kb:NVDA+control+s': 'activateSynthesizerDialog', 'kb:NVDA+control+shift+f1': 'log_markStartThenCopy', 'kb:NVDA+control+space': 'moveToParentTreeInterceptor', 'kb:NVDA+control+t': 'braille_toggleTether', 'kb:NVDA+control+u': 'activateAudioSettingsDialog', 'kb:NVDA+control+v': 'activateVoiceDialog', 'kb:NVDA+control+z': 'activatePythonConsole', 'kb:NVDA+d': 'reportDetailsSummary', 'kb:NVDA+f': 'reportOrShowFormattingAtCaret', 'kb:NVDA+f1': 'navigatorObject_devInfo', 'kb:NVDA+f10': 'review_copy', 'kb:NVDA+f12': 'dateTime', 'kb:NVDA+f2': 'passNextKeyThrough', 'kb:NVDA+f9': 'review_markStartForCopy', 'kb:NVDA+k': 'reportLinkDestination', 'kb:NVDA+m': 'toggleMouseTracking', 'kb:NVDA+n': 'showGui', 'kb:NVDA+numpad1': 'reviewMode_previous', 'kb:NVDA+numpad2': 'navigatorObject_firstChild', 'kb:NVDA+numpad3': 'navigatorObject_nextInFlow', 'kb:NVDA+numpad4': 'navigatorObject_previous', 'kb:NVDA+numpad5': 'navigatorObject_current', 'kb:NVDA+numpad6': 'navigatorObject_next', 'kb:NVDA+numpad7': 'reviewMode_next', 'kb:NVDA+numpad8': 'navigatorObject_parent', 'kb:NVDA+numpad9': 'navigatorObject_previousInFlow', 'kb:NVDA+numpadDelete': 'caretPos_currentDimensions', 'kb:NVDA+numpadDivide': 'moveMouseToNavigatorObject', 'kb:NVDA+numpadEnter': 'review_activate', 'kb:NVDA+numpadMinus': 'navigatorObject_toFocus', 'kb:NVDA+numpadMultiply': 'moveNavigatorObjectToMouse', 'kb:NVDA+p': 'cycleSpeechSymbolLevel', 'kb:NVDA+pageDown': 'review_nextPage', 'kb:NVDA+pageUp': 'review_previousPage', 'kb:NVDA+q': 'quit', 'kb:NVDA+r': 'recognizeWithUwpOcr', 'kb:NVDA+s': 'speechMode', 'kb:NVDA+shift+F9': 'review_moveToStartMarkedForCopy', 'kb:NVDA+shift+b': 'say_battery_status', 'kb:NVDA+shift+d': 'cycleAudioDuckingMode', 'kb:NVDA+shift+f': 'reportFormatting', 'kb:NVDA+shift+numpadDelete': 'navigatorObject_currentDimensions', 'kb:NVDA+shift+numpadMinus': 'navigatorObject_moveFocus', 'kb:NVDA+space': 'toggleVirtualBufferPassThrough', 'kb:NVDA+t': 'title', 'kb:NVDA+tab': 'reportCurrentFocus', 'kb:NVDA+u': 'toggleProgressBarOutput', 'kb:numpad1': 'review_previousCharacter', 'kb:numpad2': 'review_currentCharacter', 'kb:numpad3': 'review_nextCharacter', 'kb:numpad4': 'review_previousWord', 'kb:numpad5': 'review_currentWord', 'kb:numpad6': 'review_nextWord', 'kb:numpad7': 'review_previousLine', 'kb:numpad8': 'review_currentLine', 'kb:numpad9': 'review_nextLine', 'kb:numpadDivide': 'leftMouseClick', 'kb:numpadMultiply': 'rightMouseClick', 'kb:numpadPlus': 'review_sayAll', 'kb:nvda+alt+t': 'toggleBrailleMode', 'kb:shift+numpad1': 'review_startOfLine', 'kb:shift+numpad2': 'reportFocusObjectAccelerator', 'kb:shift+numpad3': 'review_endOfLine', 'kb:shift+numpad7': 'review_top', 'kb:shift+numpad9': 'review_bottom', 'kb:shift+numpadDivide': 'toggleLeftMouseButton', 'kb:shift+numpadMultiply': 'toggleRightMouseButton', 'ts(object):2finger_flickDown': 'reviewMode_previous', 'ts(object):2finger_flickUp': 'reviewMode_next', 'ts(object):2finger_flickleft': 'navigatorObject_previous', 'ts(object):2finger_flickright': 'navigatorObject_next', 'ts(object):flickdown': 'navigatorObject_firstChild', 'ts(object):flickleft': 'navigatorObject_previousInFlow', 'ts(object):flickright': 'navigatorObject_nextInFlow', 'ts(object):flickup': 'navigatorObject_parent', 'ts(text):2finger_flickLeft': 'review_previousWord', 'ts(text):2finger_flickRight': 'review_nextWord', 'ts(text):3finger_flickDown': 'review_sayAll', 'ts(text):flickDown': 'review_nextLine', 'ts(text):flickLeft': 'review_previousCharacter', 'ts(text):flickRight': 'review_nextCharacter', 'ts(text):flickUp': 'review_previousLine', 'ts(text):hoverUp': 'review_currentWord', 'ts:2finger_double_tap': 'showGui', 'ts:3finger_tap': 'touch_changeMode', 'ts:double_tap': 'review_activate', 'ts:hover': 'touch_explore', 'ts:hoverDown': 'touch_newExplore', 'ts:hoverUp': 'touch_hoverUp', 'ts:tap': 'touch_newExplore', 'ts:tapAndHold': 'touch_rightClick'}
_abc_impl = <_abc._abc_data object>
globalCommands.commands = <globalCommands.GlobalCommands object>

The single global commands instance. @type: L{GlobalCommands}

class globalCommands.ConfigProfileActivationCommands(*args, **kwargs)

Bases: ScriptableObject

Singleton scriptable object that collects scripts for available configuration profiles.

scriptCategory = 'Configuration profiles'
classmethod _getScriptNameForProfile(name)
classmethod _profileScript(name)
classmethod addScriptForProfile(name)

Adds a script for the given configuration profile. This method will not check a profile’s existence. @param name: The name of the profile to add a script for. @type name: str

classmethod removeScriptForProfile(name)

Removes a script for the given configuration profile. @param name: The name of the profile to remove a script for. @type name: str

classmethod _moveGesturesForProfileActivationScript(oldScriptName, newScriptName=None)

Patches the user gesture map to reflect updates to profile scripts. @param oldScriptName: The current name of the profile activation script. @type oldScriptName: str @param newScriptName: The new name for the profile activation script, if any.

if C{None}, the gestures are only removed for the current profile script.

@type newScriptName: str

classmethod updateScriptForRenamedProfile(oldName, newName)

Removes a script for the oldName configuration profile, and adds a new script for newName. Existing gestures in the gesture map are moved from the oldName to the newName profile. @param oldName: The current name of the profile. @type oldName: str @param newName: The new name for the profile. @type newName: str

_abc_impl = <_abc._abc_data object>
_propertyCache: Set[Callable[[AutoPropertyObject], Any]]
globalCommands.configProfileActivationCommands = <globalCommands.ConfigProfileActivationCommands object>

The single instance for the configuration profile activation commands. @type: L{ConfigProfileActivationCommands}