#region License

// Copyright (c) 2010, Jasper Yeh.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification, 
// are permitted provided that the following conditions are met:
//
//    * Redistributions of source code must retain the above copyright notice, 
//      this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above copyright notice, 
//      this list of conditions and the following disclaimer in the documentation 
//      and/or other materials provided with the distribution.
//    * Neither the name of ClearCanvas Inc. nor the names of its contributors 
//      may be used to endorse or promote products derived from this software without 
//      specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
// THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, 
// OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 
// GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
// HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
// ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
// OF SUCH DAMAGE.

#endregion

using System.Windows.Controls;
using ClearCanvas.Common;
using ClearCanvas.Desktop;

namespace Nullstack.ClearCanvasEx.DesktopEx.View.WpfAdapter
{
	/// <summary>
	/// Abstract base class for all WPF-based views.  Any class that implements a view using
	/// WPF as the underlying GUI toolkit should subclass this class.
	/// </summary>
	[GuiToolkit(WpfGuiToolkit.GuiToolkitId)]
	public abstract class WpfView : IView
	{
		/// <summary>
		/// Gets the toolkit ID, which is always <see cref="WpfGuiToolkit.GuiToolkitId"/>.
		/// </summary>
		public string GuiToolkitId
		{
			get { return WpfGuiToolkit.GuiToolkitId; }
		}

		/// <summary>
		/// Gets the toolkit ID, which is always <see cref="WpfGuiToolkit.GuiToolkitId"/>.
		/// </summary>
		string IView.GuiToolkitID
		{
			get { return GuiToolkitId; }
		}

		/// <summary>
		/// Gets the <see cref="Control"/> that implements this view, allowing
		/// a parent view to insert the control as one of its children.
		/// </summary>
		public abstract object GuiElement { get; }
	}
}