/*=============================================================================

  Project:   SharpImage
  Module:    siIApplication.cs
  Language:  C#
  Author:    Dan Mueller
  Date:      $Date: 2008-01-09 16:23:10 +1000 (Wed, 09 Jan 2008) $
  Revision:  $Revision: 29 $

  Copyright (c) Queensland University of Technology (QUT) 2007.
  All rights reserved.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.  See the above copyright notices for more information.
  
=============================================================================*/

using System;
using System.Collections.Generic;
using System.Text;
using System.Windows.Forms;

using SharpImage.Rendering;
using SharpImage.Script;
using SharpImage.Forms;

namespace SharpImage.Main
{
    public interface IApplication
    {
        #region Properties
        //=====================================================================
        /// <summary>
        /// Gets the name-value pair Metadata variables of the Application.
        /// </summary>
        Dictionary<string, object> Metadata
        {
            get;
        }

        /// <summary>
        /// Gets the console to display script feedback/info.
        /// </summary>
        siFormScriptConsole ScriptConsole
        {
            get;
        }

        /// <summary>
        /// Gets the current RendererBase selected in the Application.
        /// </summary>
        siRenderer CurrentRenderer
        {
            get;
        }

        /// <summary>
        /// Gets the list of RendererBase objects.
        /// </summary>
        List<siRenderer> Renderers
        {
            get;
        }
        //=====================================================================
        #endregion

        #region Methods
        //=====================================================================
        // Invoke methods
        // NOTE: IronPython can not use the params method, so explicit declarations are exposed.
        bool InvokeRequired { get; }
        object Invoke(Delegate method);
        object Invoke(Delegate method, params object[] args);
        object InvokeArg0(Delegate method);
        object InvokeArg1(Delegate method, object arg1);
        object InvokeArg2(Delegate method, object arg1, object arg2);
        object InvokeArg3(Delegate method, object arg1, object arg2, object arg3);
        object InvokeArg4(Delegate method, object arg1, object arg2, object arg3, object arg4);
        
        // Thread-safe MessageBox.Show methods
        void ShowMessageBox(string text);
        void ShowMessageBox(string text, string caption);
        void ShowMessageBox(string text, string caption, MessageBoxButtons buttons);
        void ShowMessageBox(string text, string caption, MessageBoxButtons buttons, MessageBoxIcon icon);

        /// <summary>
        /// Refresh the application
        /// </summary>
        void Refresh();

        /// <summary>
        /// Shows a Renderer in the Application.
        /// </summary>
        /// <remarks>
        /// This method is thread-safe.
        /// </remarks>
        /// <param name="renderer"></param>
        void ShowRenderer(siRenderer renderer);

        /// <summary>
        /// Shows the given image in a new siGdiSliceRenderer.
        /// </summary>
        /// <remarks>
        /// This method is thread-safe.
        /// </remarks>
        /// <param name="image"></param>
        siRenderer ShowImageInNewRenderer(itk.itkImageBase image);

        /// <summary>
        /// Adds a FormToolBase to the Application. This method allows the 
        /// Application to control the addition of forms for different
        /// tools.
        /// </summary>
        /// <remarks>
        /// This method is thread-safe.
        /// </remarks>
        /// <param name="form"></param>
        void AddTool(siFormTool form);

        /// <summary>
        /// Sets the Application as working (make cursor hourglass, etc.).
        /// </summary>
        /// <remarks>
        /// This method is thread-safe.
        /// </remarks>
        void SetApplicationAsWorking();

        /// <summary>
        /// Sets the total or partial progress of the script.
        /// </summary>
        /// <remarks>
        /// This method is thread-safe.
        /// </remarks>
        /// <param name="progress">The progress percentage in the range [0-100].</param>
        void SetApplicationProgress(int progress);

        /// <summary>
        /// Sets the status label of the Application.
        /// </summary>
        /// <remarks>
        /// This method is thread-safe.
        /// </remarks>
        /// <param name="status">The new value to display in the status box.</param>
        void SetApplicationStatusLabel(string status);

        /// <summary>
        /// Sets the application as ready and clears any status messages 
        /// after waiting for the given pause (in milliseconds).
        /// </summary>
        /// <remarks>
        /// This method is thread-safe.
        /// </remarks>
        /// <param name="pause">The amount of time to wait before clearing the 
        ///                     status label. If negative, then set immediately</param>
        void SetApplicationAsReady(int pause);

        /// <summary>
        /// Show the open image dialog with the given title.
        /// The image is read and returned on success.
        /// </summary>
        /// <param name="display">True and the image is displayed in a default renderer, otherwise the image is not displayed.</param>
        /// <param name="title">The title of the dialog. If the title is null or empty, the default title is used.</param>
        /// <returns>The opened image or null on cancel/failure.</returns>
        itk.itkImageBase OpenImage(bool display, string title);

        /// <summary>
        /// Show the open image dialog with the given title, pixeltype and dimension.
        /// The image is read and returned on success.
        /// </summary>
        /// <param name="display">True and the image is displayed in a default renderer, otherwise the image is not displayed.</param>
        /// <param name="title">The title of the dialog. If the title is null or empty, the default title is used.</param>
        /// <param name="pixelType">The pixel type of the image to open. The pixel type combobox is NOT displayed.</param>
        /// <param name="dim">The dimension of the image to open. The dimension combobox is NOT displayed.</param>
        /// <returns></returns>
        itk.itkImageBase OpenImage(bool display, string title, itk.itkPixelType pixelType, int dim);

        /// <summary>
        /// Show the open image dialog with the given title, pixeltype and dimension.
        /// The image is read and returned on success.
        /// </summary>
        /// <param name="display">True and the image is displayed in a default renderer, otherwise the image is not displayed.</param>
        /// <param name="title">The title of the dialog. If the title is null or empty, the default title is used.</param>
        /// <param name="image">The type of the image to open.</param>
        /// <returns></returns>
        itk.itkImageBase OpenImage(bool display, string title, itk.itkImageBase image);

        /// <summary>
        /// Open an image in a new renderer from a given path and type string.
        /// For example: "C:/Temp/test1.png#F2"
        /// </summary>
        /// <param name="pathAndTypeString">The path and type of the image to open.</param>
        /// <returns></returns>
        itk.itkImageBase OpenImage(string pathAndTypeString);

        /// <summary>
        /// Saves the first input of the current renderer.
        /// </summary>
        void SaveImage();

        /// <summary>
        /// Saves the first input of the current renderer to the given path.
        /// </summary>
        /// <param name="fullPath"></param>
        void SaveImageAs(string fullpath);

        //=====================================================================
        #endregion
    }
}