ibookmarkmanager.cs

c#源代码

// <file>
//     <copyright see="prj:///doc/copyright.txt"/>
//     <license see="prj:///doc/license.txt"/>
//     <owner name="Mike Krüger" email="[e-mail]"/>
//     <version value="$version"/>
// </file>

using System;
using System.Collections;

namespace ICSharpCode.TextEditor.Document
{
	/// <summary>
	/// This class handles the bookmarks for a buffer
	/// </summary>
	public interface IBookMarkManager
	{
		/// <value>
		/// Contains all bookmarks as int values
		/// </value>
		ArrayList Marks {
			get;
		}
		
		/// <value>
		/// The lowest mark, if no marks exists it returns -1
		/// </value>
		int FirstMark {
			get;
		}
		
		/// <value>
		/// The highest mark, if no marks exists it returns -1
		/// </value>
		int LastMark {
			get;
		}
		
		/// <remarks>
		/// Sets the mark at the line <code>lineNr</code> if it is not set, if the
		/// line is already marked the mark is cleared.
		/// </remarks>
		void ToggleMarkAt(int lineNr);
		
		/// <remarks>
		/// Returns true if the line <code>lineNr</code> is marked
		/// </remarks>
		bool IsMarked(int lineNr);
		
		/// <remarks>
		/// Clears all bookmarks
		/// </remarks>
		void Clear();
		
		/// <remarks>
		/// returns first mark higher than <code>lineNr</code>
		/// </remarks>
		/// <returns>
		/// returns the next mark > cur, if it not exists it returns FirstMark()
		/// </returns>
		int GetNextMark(int lineNr);
		
		/// <remarks>
		/// returns first mark lower than <code>lineNr</code>
		/// </remarks>
		/// <returns>
		/// returns the next mark lower than cur, if it not exists it returns LastMark()
		/// </returns>
		int GetPrevMark(int lineNr);
		
		
		/// <remarks>
		/// Is fired before the bookmarks change
		/// </remarks>
		event EventHandler BeforeChanged;
		
		/// <remarks>
		/// Is fired after the bookmarks change
		/// </remarks>
		event EventHandler Changed;
	}
}