1+ #region BSD 3-Clause License
2+ // <copyright file="IEditorGuide.cs" company="Edgerunner.org">
3+ // Copyright 2020
4+ // </copyright>
5+ //
6+ // BSD 3-Clause License
7+ //
8+ // Copyright (c) 2020,
9+ // All rights reserved.
10+ //
11+ // Redistribution and use in source and binary forms, with or without
12+ // modification, are permitted provided that the following conditions are met:
13+ //
14+ // 1. Redistributions of source code must retain the above copyright notice, this
15+ // list of conditions and the following disclaimer.
16+ //
17+ // 2. Redistributions in binary form must reproduce the above copyright notice,
18+ // this list of conditions and the following disclaimer in the documentation
19+ // and/or other materials provided with the distribution.
20+ //
21+ // 3. Neither the name of the copyright holder nor the names of its
22+ // contributors may be used to endorse or promote products derived from
23+ // this software without specific prior written permission.
24+ //
25+ // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
26+ // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27+ // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
28+ // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
29+ // FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30+ // DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
31+ // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
32+ // CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
33+ // OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34+ // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35+ #endregion
36+
37+ using System . Drawing ;
38+
39+ namespace Org . Edgerunner . ANTLR4 . Tools . Common
40+ {
41+ public interface IEditorGuide
42+ {
43+ /// <summary>
44+ /// Gets the name of the grammar.
45+ /// </summary>
46+ /// <value>The name of the grammar.</value>
47+ string GrammarName { get ; }
48+
49+ /// <summary>
50+ /// Gets a value indicating whether to enable automatic indent.
51+ /// </summary>
52+ /// <value><c>true</c> if automatic indentation enabled; otherwise, <c>false</c>.</value>
53+ bool EnableAutoIndent { get ; }
54+
55+ /// <summary>
56+ /// Gets a value indicating whether to enable bracket autocomplete.
57+ /// </summary>
58+ /// <value><c>true</c> if bracket autocomplete is enabled; otherwise, <c>false</c>.</value>
59+ bool EnableBracketAutocomplete { get ; }
60+
61+ /// <summary>
62+ /// Gets a value indicating whether to enable word wrap.
63+ /// </summary>
64+ /// <value><c>true</c> if word wrap is enabled; otherwise, <c>false</c>.</value>
65+ bool EnableWordWrap { get ; }
66+
67+ /// <summary>
68+ /// Gets the color of the line number.
69+ /// </summary>
70+ /// <value>The color of the line number.</value>
71+ Color LineNumberColor { get ; }
72+
73+ /// <summary>
74+ /// Gets the color of the foreground text.
75+ /// </summary>
76+ /// <value>The color of the foreground text.</value>
77+ Color ForeColor { get ; }
78+
79+ /// <summary>
80+ /// Gets the color of the background.
81+ /// </summary>
82+ /// <value>The color of the background.</value>
83+ Color BackColor { get ; }
84+
85+ /// <summary>
86+ /// Gets the color of the caret.
87+ /// </summary>
88+ /// <value>The color of the caret.</value>
89+ Color CaretColor { get ; }
90+
91+ /// <summary>
92+ /// Gets the color of the selected text blocks.
93+ /// </summary>
94+ /// <value>The color of the selected text blocks.</value>
95+ Color SelectionColor { get ; }
96+
97+ /// <summary>
98+ /// Gets the color to use for parsing errors.
99+ /// </summary>
100+ /// <value>The color of the error.</value>
101+ Color ErrorColor { get ; }
102+
103+ /// <summary>
104+ /// Gets the foreground brush to use for the token.
105+ /// </summary>
106+ /// <param name="tokenTypeName">Name of the token type.</param>
107+ /// <returns>The <see cref="Brush"/> to use.</returns>
108+ Brush GetTokenForegroundBrush ( string tokenTypeName ) ;
109+
110+ /// <summary>
111+ /// Gets the background brush to use for the token.
112+ /// </summary>
113+ /// <param name="tokenTypeName">Name of the token type.</param>
114+ /// <returns>The <see cref="Brush"/> to use.</returns>
115+ Brush GetTokenBackgroundBrush ( string tokenTypeName ) ;
116+
117+ /// <summary>
118+ /// Gets the FontStyle to use for the token.
119+ /// </summary>
120+ /// <param name="tokenTypeName">Name of the token type.</param>
121+ /// <returns>The <see cref="FontStyle"/> to use.</returns>
122+ FontStyle GetTokenFontStyle ( string tokenTypeName ) ;
123+ }
124+ }
0 commit comments