#region CPL License
/*
Nuclex Framework
Copyright (C) 2002-2009 Nuclex Development Labs

This library is free software; you can redistribute it and/or
modify it under the terms of the IBM Common Public License as
published by the IBM Corporation; either version 1.0 of the
License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
IBM Common Public License for more details.

You should have received a copy of the IBM Common Public
License along with this library
*/
#endregion

using System;
using System.Collections.Generic;

using Microsoft.Xna.Framework;
using Microsoft.Xna.Framework.Content;

namespace Nuclex.Ninject.Xna {

  /// <summary>Common services offered by the XNA Game class</summary>
  public interface IGame : IDisposable {

    /// <summary>Raised when the game gains focus</summary>
    event EventHandler<EventArgs> Activated;

    /// <summary>Raised when the game loses focus</summary>
    event EventHandler<EventArgs> Deactivated;

    /// <summary>Raised when the game is being disposed</summary>
    event EventHandler<EventArgs> Disposed;

    /// <summary>Raised when the game is exiting</summary>
    event EventHandler<EventArgs> Exiting;

    /// <summary>The underlying operating system window</summary>
    GameWindow Window { get; }

    /// <summary>Resets the elapsed time counter</summary>
    void ResetElapsedTime();

    /// <summary>Exits the game</summary>
    void Exit();

    /// <summary>
    ///   Call this method to initialize the game, begin running the game loop, and
    ///   start processing events for the game. Reference page contains code sample.
    /// </summary>
    void Run();

    /// <summary>
    ///   Controls whether the mouse cursor is visible on top of the game window
    /// </summary>
    bool IsMouseVisible { get; set; }

    /// <summary>
    ///   Suppresses calls to <see cref="Game.Draw" /> until the next
    ///   <see cref="Game.Update" /> ran through</summary>
    void SuppressDraw();

    /// <summary>
    ///   Updates the game's clock and calls <see cref="Game.Update" />
    ///   and <see cref="Game.Draw" />
    /// </summary>
    void Tick();

  }

} // namespace Nuclex.Ninject.Xna