Merge pull request #500 from Protectator/master

Adding option to configure cursor blinking
microsoft · Dec 4, 2015 · 4383c34 · 4383c34
2 parents 483ffb3 + 5568b56
commit 4383c34
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 1 deletion.
diff --git a/src/vs/editor/browser/viewParts/viewCursors/viewCursors.ts b/src/vs/editor/browser/viewParts/viewCursors/viewCursors.ts
@@ -136,6 +136,7 @@ export class ViewCursors extends ViewPart {
 	}
 	public onConfigurationChanged(e:EditorCommon.IConfigurationChangedEvent): boolean {
 		this._primaryCursor.onConfigurationChanged(e);
+		this._updateBlinking();
 		for (var i = 0, len = this._secondaryCursors.length; i < len; i++) {
 			this._secondaryCursors[i].onConfigurationChanged(e);
 		}
@@ -172,7 +173,16 @@ export class ViewCursors extends ViewPart {
 	private _getRenderType(): RenderType {
 		if (this._editorHasFocus) {
 			if (this._primaryCursor.getIsInEditableRange() && !this._context.configuration.editor.readOnly) {
-				return RenderType.Blink;
+				switch (this._context.configuration.editor.cursorBlinking) {
+					case ("blink"):
+						return RenderType.Blink;
+					case ("visible"):
+						return RenderType.Visible;
+					case ("hidden"):
+						return RenderType.Hidden;
+					default:
+						return RenderType.Blink;
+				}
 			}
 			return RenderType.Visible;
 		}

diff --git a/src/vs/editor/common/config/commonEditorConfig.ts b/src/vs/editor/common/config/commonEditorConfig.ts
@@ -141,6 +141,7 @@ class InternalEditorOptionsHelper {
 			readOnly: toBoolean(opts.readOnly),
 			scrollbar: scrollbar,
 			overviewRulerLanes: toInteger(opts.overviewRulerLanes, 0, 3),
+			cursorBlinking: opts.cursorBlinking,
 			hideCursorInOverviewRuler: toBoolean(opts.hideCursorInOverviewRuler),
 			scrollBeyondLastLine: toBoolean(opts.scrollBeyondLastLine),
 			wrappingIndent: opts.wrappingIndent,
@@ -236,6 +237,7 @@ class InternalEditorOptionsHelper {
 			readOnly:						(prevOpts.readOnly !== newOpts.readOnly),
 			scrollbar:						(!this._scrollbarOptsEqual(prevOpts.scrollbar, newOpts.scrollbar)),
 			overviewRulerLanes:				(prevOpts.overviewRulerLanes !== newOpts.overviewRulerLanes),
+			cursorBlinking:					(prevOpts.cursorBlinking !== newOpts.cursorBlinking),
 			hideCursorInOverviewRuler:		(prevOpts.hideCursorInOverviewRuler !== newOpts.hideCursorInOverviewRuler),
 			scrollBeyondLastLine:			(prevOpts.scrollBeyondLastLine !== newOpts.scrollBeyondLastLine),
 			wrappingIndent:					(prevOpts.wrappingIndent !== newOpts.wrappingIndent),
@@ -794,6 +796,12 @@ configurationRegistry.registerConfiguration({
 			'default': 3,
 			'description': nls.localize('overviewRulerLanes', "Controls the number of decorations that can show up at the same position in the overview ruler")
 		},
+		'editor.cursorBlinking' : {
+			'type': 'string',
+			'enum': ['blink', 'visible', 'hidden'],
+			'default': DefaultConfig.editor.cursorBlinking,
+			'description': nls.localize('cursorBlinking', "Controls the cursor blinking animation.")
+		},
 		'editor.hideCursorInOverviewRuler' : {
 			'type': 'boolean',
 			'default': DefaultConfig.editor.hideCursorInOverviewRuler,

diff --git a/src/vs/editor/common/config/defaultConfig.ts b/src/vs/editor/common/config/defaultConfig.ts
@@ -33,6 +33,7 @@ class ConfigClass implements IConfiguration {
 				horizontalHasArrows: false
 			},
 			overviewRulerLanes: 2,
+			cursorBlinking: 'blink',
 			hideCursorInOverviewRuler: false,
 			scrollBeyondLastLine: true,
 			automaticLayout: false,

diff --git a/src/vs/editor/common/editorCommon.ts b/src/vs/editor/common/editorCommon.ts
@@ -333,6 +333,11 @@ export interface ICommonEditorOptions {
 	 * Defaults to 2.
 	 */
 	overviewRulerLanes?:number;
+	/**
+	 * Control the cursor blinking animation.
+	 * Defaults to 'blink'.
+	 */
+	cursorBlinking?:string;
 	/**
 	 * Should the cursor be hidden in the overview ruler.
 	 * Defaults to false.
@@ -577,6 +582,7 @@ export interface IInternalEditorOptions {
 	readOnly:boolean;
 	scrollbar:IInternalEditorScrollbarOptions;
 	overviewRulerLanes:number;
+	cursorBlinking:string;
 	hideCursorInOverviewRuler:boolean;
 	scrollBeyondLastLine:boolean;
 	wrappingIndent: string;
@@ -667,6 +673,7 @@ export interface IConfigurationChangedEvent {
 	readOnly:boolean;
 	scrollbar:boolean;
 	overviewRulerLanes:boolean;
+	cursorBlinking:boolean;
 	hideCursorInOverviewRuler:boolean;
 	scrollBeyondLastLine:boolean;
 	wrappingIndent:boolean;