source: branches/2708_ScopedAlgorithms/HeuristicLab.ExtLibs/HeuristicLab.AvalonEdit/5.0.1/AvalonEdit-5.0.1/Folding/NewFolding.cs @ 16111

// 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;
#if NREFACTORY
using ICSharpCode.NRefactory.Editor;
#else
using ICSharpCode.AvalonEdit.Document;
#endif

namespace ICSharpCode.AvalonEdit.Folding
{
  /// <summary>
  /// Helper class used for <see cref="FoldingManager.UpdateFoldings"/>.
  /// </summary>
  public class NewFolding : ISegment
  {
    /// <summary>
    /// Gets/Sets the start offset.
    /// </summary>
    public int StartOffset { get; set; }
    
    /// <summary>
    /// Gets/Sets the end offset.
    /// </summary>
    public int EndOffset { get; set; }
    
    /// <summary>
    /// Gets/Sets the name displayed for the folding.
    /// </summary>
    public string Name { get; set; }
    
    /// <summary>
    /// Gets/Sets whether the folding is closed by default.
    /// </summary>
    public bool DefaultClosed { get; set; }
    
    /// <summary>
    /// Gets/Sets whether the folding is considered to be a definition.
    /// This has an effect on the 'Show Definitions only' command.
    /// </summary>
    public bool IsDefinition { get; set; }
    
    /// <summary>
    /// Creates a new NewFolding instance.
    /// </summary>
    public NewFolding()
    {
    }
    
    /// <summary>
    /// Creates a new NewFolding instance.
    /// </summary>
    public NewFolding(int start, int end)
    {
      if (!(start <= end))
        throw new ArgumentException("'start' must be less than 'end'");
      this.StartOffset = start;
      this.EndOffset = end;
      this.Name = null;
      this.DefaultClosed = false;
    }
    
    int ISegment.Offset {
      get { return this.StartOffset; }
    }
    
    int ISegment.Length {
      get { return this.EndOffset - this.StartOffset; }
    }
  }
}