Free cookie consent management tool by TermsFeed Policy Generator

source: branches/2845_EnhancedProgress/HeuristicLab.ExtLibs/HeuristicLab.AvalonEdit/5.0.1/AvalonEdit-5.0.1/Highlighting/IHighlightingDefinition.cs @ 16317

Last change on this file since 16317 was 11700, checked in by jkarder, 10 years ago

#2077: created branch and added first version

File size: 2.3 KB
Line 
1// Copyright (c) 2014 AlphaSierraPapa for the SharpDevelop Team
2//
3// Permission is hereby granted, free of charge, to any person obtaining a copy of this
4// software and associated documentation files (the "Software"), to deal in the Software
5// without restriction, including without limitation the rights to use, copy, modify, merge,
6// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
7// to whom the Software is furnished to do so, subject to the following conditions:
8//
9// The above copyright notice and this permission notice shall be included in all copies or
10// substantial portions of the Software.
11//
12// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
13// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
14// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
15// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
16// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
17// DEALINGS IN THE SOFTWARE.
18
19using System;
20using System.Collections.Generic;
21using System.ComponentModel;
22
23namespace ICSharpCode.AvalonEdit.Highlighting
24{
25  /// <summary>
26  /// A highlighting definition.
27  /// </summary>
28  [TypeConverter(typeof(HighlightingDefinitionTypeConverter))]
29  public interface IHighlightingDefinition
30  {
31    /// <summary>
32    /// Gets the name of the highlighting definition.
33    /// </summary>
34    string Name { get; }
35   
36    /// <summary>
37    /// Gets the main rule set.
38    /// </summary>
39    HighlightingRuleSet MainRuleSet { get; }
40   
41    /// <summary>
42    /// Gets a rule set by name.
43    /// </summary>
44    /// <returns>The rule set, or null if it is not found.</returns>
45    HighlightingRuleSet GetNamedRuleSet(string name);
46   
47    /// <summary>
48    /// Gets a named highlighting color.
49    /// </summary>
50    /// <returns>The highlighting color, or null if it is not found.</returns>
51    HighlightingColor GetNamedColor(string name);
52   
53    /// <summary>
54    /// Gets the list of named highlighting colors.
55    /// </summary>
56    IEnumerable<HighlightingColor> NamedHighlightingColors { get; }
57   
58    /// <summary>
59    /// Gets the list of properties.
60    /// </summary>
61    IDictionary<string, string> Properties { get; }
62  }
63}
Note: See TracBrowser for help on using the repository browser.