source: branches/2893_BNLR/HeuristicLab.ExtLibs/HeuristicLab.AvalonEdit/5.0.1/AvalonEdit-5.0.1/CodeCompletion/ICompletionData.cs @ 18242

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

namespace ICSharpCode.AvalonEdit.CodeCompletion
{
  /// <summary>
  /// Describes an entry in the <see cref="CompletionList"/>.
  /// </summary>
  public interface ICompletionData
  {
    /// <summary>
    /// Gets the image.
    /// </summary>
    ImageSource Image { get; }
    
    /// <summary>
    /// Gets the text. This property is used to filter the list of visible elements.
    /// </summary>
    string Text { get; }
    
    /// <summary>
    /// The displayed content. This can be the same as 'Text', or a WPF UIElement if
    /// you want to display rich content.
    /// </summary>
    object Content { get; }
    
    /// <summary>
    /// Gets the description.
    /// </summary>
    object Description { get; }
    
    /// <summary>
    /// Gets the priority. This property is used in the selection logic. You can use it to prefer selecting those items
    /// which the user is accessing most frequently.
    /// </summary>
    double Priority { get; }
    
    /// <summary>
    /// Perform the completion.
    /// </summary>
    /// <param name="textArea">The text area on which completion is performed.</param>
    /// <param name="completionSegment">The text segment that was used by the completion window if
    /// the user types (segment between CompletionWindow.StartOffset and CompletionWindow.EndOffset).</param>
    /// <param name="insertionRequestEventArgs">The EventArgs used for the insertion request.
    /// These can be TextCompositionEventArgs, KeyEventArgs, MouseEventArgs, depending on how
    /// the insertion was triggered.</param>
    void Complete(TextArea textArea, ISegment completionSegment, EventArgs insertionRequestEventArgs);
  }
}