SharpDevelop/ICSharpCode.NRefactory/Completion/IParameterDataProvider.cs

// 
// IParameterDataProvider.cs
//  
// Author:
//       Mike Krüger <mkrueger@xamarin.com>
// 
// Copyright (c) 2011 Xamarin Inc. (http://xamarin.com)
// 
// 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 ICSharpCode.NRefactory.Editor;

namespace ICSharpCode.NRefactory.Completion
{
	/// <summary>
	/// Provides intellisense information for a collection of parametrized members.
	/// </summary>
	public interface IParameterDataProvider
	{
		/// <summary>
		/// Gets the overload count.
		/// </summary>
		int Count { 
			get; 
		}
		
		/// <summary>
		/// Gets the start offset of the parameter expression node.
		/// </summary>
		int StartOffset { 
			get; 
		}
		
		/// <summary>
		/// Returns the markup to use to represent the specified method overload
		/// in the parameter information window.
		/// </summary>
		string GetHeading (int overload, string[] parameterDescription, int currentParameter);
		
		/// <summary>
		/// Returns the markup for the description to use to represent the specified method overload
		/// in the parameter information window.
		/// </summary>
		string GetDescription (int overload, int currentParameter);
		
		/// <summary>
		/// Returns the text to use to represent the specified parameter
		/// </summary>
		string GetParameterDescription (int overload, int paramIndex);
		
		/// <summary>
		/// Gets the name of the parameter.
		/// </summary>
		string GetParameterName (int overload, int currentParameter);

		/// <summary>
		/// Returns the number of parameters of the specified method
		/// </summary>
		int GetParameterCount (int overload);
		
		/// <summary>
		/// Used for the params lists. (for example "params" in c#).
		/// </summary>
		bool AllowParameterList (int overload);
	}
}