//------------------------------------------------------------------------------
// <copyright file="IUIService.cs" company="Microsoft">
//     Copyright (c) Microsoft Corporation.  All rights reserved.
// </copyright>                                                                
//------------------------------------------------------------------------------
 
/*
 */
namespace System.Windows.Forms.Design {
    
    using System;    
    using Microsoft.Win32;
    using System.Collections;
    using System.ComponentModel;
    using System.Diagnostics;
    using System.Drawing;
    using System.Runtime.Remoting;
    using System.Runtime.InteropServices;
    using System.Windows.Forms;
 
    /// <include file='doc\IUIService.uex' path='docs/doc[@for="IUIService"]/*' />
    /// <devdoc>
    ///    <para> 
    ///       Provides support
    ///       for interaction with the user
    ///       interface of the development environment object that is hosting the designer.</para>
    /// </devdoc>
    [Guid("06A9C74B-5E32-4561-BE73-381B37869F4F")]
    public interface IUIService {
        /// <include file='doc\IUIService.uex' path='docs/doc[@for="IUIService.Styles"]/*' />
        /// <devdoc>
        ///    <para> Gets or sets the collections of
        ///       styles that are specific to the host's environment.</para>
        /// </devdoc>
        IDictionary Styles {get;}
        
        /// <include file='doc\IUIService.uex' path='docs/doc[@for="IUIService.CanShowComponentEditor"]/*' />
        /// <devdoc>
        ///    <para> Indicates whether the component can 
        ///       display a ComponentDesigner.</para>
        /// </devdoc>
        bool CanShowComponentEditor(object component);
 
        /// <include file='doc\IUIService.uex' path='docs/doc[@for="IUIService.GetDialogOwnerWindow"]/*' />
        /// <devdoc>
        ///    <para>Gets the window that should be used for dialog parenting.</para>
        /// </devdoc>
        IWin32Window GetDialogOwnerWindow();
        
 
        /// <include file='doc\IUIService.uex' path='docs/doc[@for="IUIService.SetUIDirty"]/*' />
        /// <devdoc>
        ///    <para>Sets a flag indicating the UI is dirty.</para>
        /// </devdoc>
        void SetUIDirty();
                
        /// <include file='doc\IUIService.uex' path='docs/doc[@for="IUIService.ShowComponentEditor"]/*' />
        /// <devdoc>
        /// <para>Attempts to display a ComponentEditor for a component.</para>
        /// </devdoc>
        bool ShowComponentEditor(object component, IWin32Window parent);
        /// <include file='doc\IUIService.uex' path='docs/doc[@for="IUIService.ShowDialog"]/*' />
        /// <devdoc>
        ///    <para>Attempts to display the specified form in a dialog box.</para>
        /// </devdoc>
        
        DialogResult ShowDialog(Form form);
 
        /// <include file='doc\IUIService.uex' path='docs/doc[@for="IUIService.ShowError"]/*' />
        /// <devdoc>
        ///    <para>Displays the specified error message in a message box.</para>
        /// </devdoc>
        void ShowError(string message);
 
        /// <include file='doc\IUIService.uex' path='docs/doc[@for="IUIService.ShowError1"]/*' />
        /// <devdoc>
        ///    <para> Displays the specified exception
        ///       and its information in a message box.</para>
        /// </devdoc>
        void ShowError(Exception ex);
 
        /// <include file='doc\IUIService.uex' path='docs/doc[@for="IUIService.ShowError2"]/*' />
        /// <devdoc>
        ///    <para> Displays the specified exception
        ///       and its information in a message box.</para>
        /// </devdoc>
        void ShowError(Exception ex, string message);
        
        /// <include file='doc\IUIService.uex' path='docs/doc[@for="IUIService.ShowMessage"]/*' />
        /// <devdoc>
        ///    <para>Displays the specified message in a message box.</para>
        /// </devdoc>
        void ShowMessage(string message);
 
        /// <include file='doc\IUIService.uex' path='docs/doc[@for="IUIService.ShowMessage1"]/*' />
        /// <devdoc>
        ///    <para> Displays the specified message in
        ///       a message box with the specified caption.</para>
        /// </devdoc>
        void ShowMessage(string message, string caption);
 
        /// <include file='doc\IUIService.uex' path='docs/doc[@for="IUIService.ShowMessage2"]/*' />
        /// <devdoc>
        ///    <para> Displays the specified message in a message box with the specified caption and
        ///       buttons to place on the dialog box.</para>
        /// </devdoc>
        DialogResult ShowMessage(string message, string caption, MessageBoxButtons buttons);
 
        /// <include file='doc\IUIService.uex' path='docs/doc[@for="IUIService.ShowToolWindow"]/*' />
        /// <devdoc>
        ///    <para>Displays the specified tool window.</para>
        /// </devdoc>
        bool ShowToolWindow(Guid toolWindow);
    }
}