38058a7a86
Adds support for setting the cursor visibility in Terminal. Visibility is a property entirely independent from whether the cursor is "on" or not. The cursor blinker _should_ change the "IsOn" property. It was actually changing the "Visible" property, which was incorrect. This PR additionally corrects the naming of the method used by the cursor blinker, and makes it do the right thing. I added a pair of tests, one taken straight from conhost. In copy-pasting that test, I took it a step further and implemented `^[[?12h`, `^[[?12l`, which enables/disables cursor blinking, for the `TerminalCore`. THIS DOES NOT ADD SUPPORT FOR DISABLING BLINKING IN THE APP. Conpty doesn't emit the blinking on/off sequences quite yet, but when it _does_, the Terminal will be ready. ## References * I'd bet this conflicts with #2892 * This isn't a solution for #1379 * There shockingly isn't an issue for cursor blink state via conpty...? ## PR Checklist * [x] Closes #3093 * [x] Closes #3499 * [x] Closes #4644 * [x] I work here * [x] Tests added/passed * [n/a] Requires documentation to be updated
65 lines
3.2 KiB
C++
65 lines
3.2 KiB
C++
// Copyright (c) Microsoft Corporation.
|
|
// Licensed under the MIT license.
|
|
#pragma once
|
|
|
|
#include "../../terminal/adapter/DispatchTypes.hpp"
|
|
|
|
namespace Microsoft::Terminal::Core
|
|
{
|
|
class ITerminalApi
|
|
{
|
|
public:
|
|
virtual ~ITerminalApi() {}
|
|
ITerminalApi(const ITerminalApi&) = default;
|
|
ITerminalApi(ITerminalApi&&) = default;
|
|
ITerminalApi& operator=(const ITerminalApi&) = default;
|
|
ITerminalApi& operator=(ITerminalApi&&) = default;
|
|
|
|
virtual bool PrintString(std::wstring_view string) noexcept = 0;
|
|
virtual bool ExecuteChar(wchar_t wch) noexcept = 0;
|
|
|
|
virtual bool SetTextToDefaults(bool foreground, bool background) noexcept = 0;
|
|
virtual bool SetTextForegroundIndex(BYTE colorIndex) noexcept = 0;
|
|
virtual bool SetTextBackgroundIndex(BYTE colorIndex) noexcept = 0;
|
|
virtual bool SetTextRgbColor(COLORREF color, bool foreground) noexcept = 0;
|
|
virtual bool BoldText(bool boldOn) noexcept = 0;
|
|
virtual bool UnderlineText(bool underlineOn) noexcept = 0;
|
|
virtual bool ReverseText(bool reversed) noexcept = 0;
|
|
|
|
virtual bool SetCursorPosition(short x, short y) noexcept = 0;
|
|
virtual COORD GetCursorPosition() noexcept = 0;
|
|
virtual bool SetCursorVisibility(const bool visible) noexcept = 0;
|
|
virtual bool CursorLineFeed(const bool withReturn) noexcept = 0;
|
|
virtual bool EnableCursorBlinking(const bool enable) noexcept = 0;
|
|
|
|
virtual bool DeleteCharacter(const size_t count) noexcept = 0;
|
|
virtual bool InsertCharacter(const size_t count) noexcept = 0;
|
|
virtual bool EraseCharacters(const size_t numChars) noexcept = 0;
|
|
virtual bool EraseInLine(const ::Microsoft::Console::VirtualTerminal::DispatchTypes::EraseType eraseType) noexcept = 0;
|
|
virtual bool EraseInDisplay(const ::Microsoft::Console::VirtualTerminal::DispatchTypes::EraseType eraseType) noexcept = 0;
|
|
|
|
virtual bool SetWindowTitle(std::wstring_view title) noexcept = 0;
|
|
|
|
virtual bool SetColorTableEntry(const size_t tableIndex, const DWORD color) noexcept = 0;
|
|
|
|
virtual bool SetCursorStyle(const ::Microsoft::Console::VirtualTerminal::DispatchTypes::CursorStyle cursorStyle) noexcept = 0;
|
|
|
|
virtual bool SetDefaultForeground(const DWORD color) noexcept = 0;
|
|
virtual bool SetDefaultBackground(const DWORD color) noexcept = 0;
|
|
|
|
virtual bool SetCursorKeysMode(const bool applicationMode) noexcept = 0;
|
|
virtual bool SetKeypadMode(const bool applicationMode) noexcept = 0;
|
|
virtual bool EnableVT200MouseMode(const bool enabled) noexcept = 0;
|
|
virtual bool EnableUTF8ExtendedMouseMode(const bool enabled) noexcept = 0;
|
|
virtual bool EnableSGRExtendedMouseMode(const bool enabled) noexcept = 0;
|
|
virtual bool EnableButtonEventMouseMode(const bool enabled) noexcept = 0;
|
|
virtual bool EnableAnyEventMouseMode(const bool enabled) noexcept = 0;
|
|
virtual bool EnableAlternateScrollMode(const bool enabled) noexcept = 0;
|
|
|
|
virtual bool IsVtInputEnabled() const = 0;
|
|
|
|
protected:
|
|
ITerminalApi() = default;
|
|
};
|
|
}
|