source: trunk/sources/HeuristicLab.ExtLibs/HeuristicLab.AvalonEdit/5.0.1/AvalonEdit-5.0.1/Highlighting/IHighlightingDefinition.cs @ 13522

// Copyright (c) 2014 AlphaSierraPapa for the SharpDevelop Team
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy of this
// software and associated documentation files (the "Software"), to deal in the Software
// without restriction, including without limitation the rights to use, copy, modify, merge,
// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
// to whom the Software is furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in all copies or
// substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.

using System;
using System.Collections.Generic;
using System.ComponentModel;

namespace ICSharpCode.AvalonEdit.Highlighting
{
  /// <summary>
  /// A highlighting definition.
  /// </summary>
  [TypeConverter(typeof(HighlightingDefinitionTypeConverter))]
  public interface IHighlightingDefinition
  {
    /// <summary>
    /// Gets the name of the highlighting definition.
    /// </summary>
    string Name { get; }
    
    /// <summary>
    /// Gets the main rule set.
    /// </summary>
    HighlightingRuleSet MainRuleSet { get; }
    
    /// <summary>
    /// Gets a rule set by name.
    /// </summary>
    /// <returns>The rule set, or null if it is not found.</returns>
    HighlightingRuleSet GetNamedRuleSet(string name);
    
    /// <summary>
    /// Gets a named highlighting color.
    /// </summary>
    /// <returns>The highlighting color, or null if it is not found.</returns>
    HighlightingColor GetNamedColor(string name);
    
    /// <summary>
    /// Gets the list of named highlighting colors.
    /// </summary>
    IEnumerable<HighlightingColor> NamedHighlightingColors { get; }
    
    /// <summary>
    /// Gets the list of properties.
    /// </summary>
    IDictionary<string, string> Properties { get; }
  }
}