/AvalonEdit/ICSharpCode.AvalonEdit/Snippets/IActiveElement.cs

 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 ICSharpCode.NRefactory.Editor;
21using ICSharpCode.AvalonEdit.Document;
22
23namespace ICSharpCode.AvalonEdit.Snippets
24{
25	/// <summary>
26	/// Represents an active element that allows the snippet to stay interactive after insertion.
27	/// </summary>
28	public interface IActiveElement
29	{
30		/// <summary>
31		/// Called when the all snippet elements have been inserted.
32		/// </summary>
33		void OnInsertionCompleted();
34		
35		/// <summary>
36		/// Called when the interactive mode is deactivated.
37		/// </summary>
38		void Deactivate(SnippetEventArgs e);
39		
40		/// <summary>
41		/// Gets whether this element is editable (the user will be able to select it with Tab).
42		/// </summary>
43		bool IsEditable { get; }
44		
45		/// <summary>
46		/// Gets the segment associated with this element. May be null.
47		/// </summary>
48		ISegment Segment { get; }
49	}
50}