root/lang/csharp/iTunesCOMWrap/trunk/iTunesCOMWrap/Interfaces/IOperationStatus.cs @ 11175

using System;
using Clovery.iTunesHelper.COMWrap.Interfaces;

namespace Clovery.iTunesHelper.COMWrap.Interfaces
{
    /// <summary>
    /// Represents the status of an asynchronous add or convert operation.
    /// </summary>
    public interface IOperationStatus : IITFactory
    {
        /// <summary>
        /// Returns true if the operation is still in progress. 
        /// </summary>
        /// <remarks>
        /// You cannot retrieve the <see cref="Tracks"/> property until the operation completes.
        /// </remarks>
        bool InProgress { get; }

        /// <summary>
        /// Returns a collection containing the tracks that were generated by the operation. 
        /// </summary>
        /// <remarks>
        /// You cannot retrieve this property until <see cref="InProgress"/> returns false.
        /// </remarks>
        ITrackCollection Tracks { get; }
    }

    /// <summary>
    /// Represents the status of an asynchronous convert operation. 
    /// </summary>
    /// <remarks>
    /// Note: This interface is available in iTunes 4.6 and later (iTunes type library 1.1 and later).
    /// </remarks>
    public interface IConvertOperationStatus : IOperationStatus
    {
        /// <summary>
        /// Returns status about the track currently being converted.
        /// </summary>
        /// <param name="trackName">Returns the name of the track currently being converted.
        /// May return NULL if no track is currently being converted. </param>
        /// <param name="progressValue">Returns the conversion progress value for the track currently being converted.
        /// This number will always be in the range 0 through maxProgressValue. </param>
        /// <param name="maxProgressValue">Returns the maximum conversion progress value for the track currently being converted.
        /// The conversion of the current track is complete when progressValue reaches maxProgressValue.
        /// Note that maxProgressValue will be different for each track being converted.</param>
        void GetConversionStatus(out string trackName, out int progressValue, out int maxProgressValue);

        /// <summary>
        /// Returns the maximum conversion progress value for the track currently being converted.
        /// </summary>
        int maxProgressValue { get; }

        /// <summary>
        /// Returns the conversion progress value for the track currently being converted.
        /// </summary>
        int progressValue { get; }

        /// <summary>
        /// Returns the name of the track currently being converted.
        /// </summary>
        string trackName { get; }

        /// <summary>
        /// Stops the current conversion operation.
        /// </summary>
        void StopConversion();
    }

    /// <summary>
    /// Represents the status of an asynchronous convert operation with events. 
    /// </summary>
    public interface IConvertOperationStatusWithEvents : IConvertOperationStatus
    {
        bool EventAttached { get; }
        event EventHandler<ConvertOperationStatusChangedEventArgs> ConvertOperationStatusChangedEvent;
        event EventHandler<EventArgs> ConvertOperationCompleteEvent;
        void AttachEvents();
        void DetachEvents();
        event EventHandler<EventAttachStatusChangedEventArgs> EventAttachStatusChangedEvent;
    }
}