import { IRegionBehaviorCollection } from './IRegionBehaviorCollection';
import { IRegionManager } from './IRegionManager';
import { IViewsCollection } from './IViewsCollection';

/**
 * IRegion interface.
 *
 * @export
 * @interface IRegion
 * @wInterface Microsoft.Practices.Prism.Regions.IRegion
 */
export interface IRegion {
  /**
   *  Region manager
   *
   * @type {IRegionManager}
   * @memberof IRegion
   */
  RegionManager: IRegionManager;

  /**
   * The region name
   *
   * @type {string}
   * @memberof IRegion
   */
  Name: string;

  /**
   * The active view collection
   *
   * @type {IViewsCollection}
   * @memberof IRegion
   */
  ActiveViews: IViewsCollection;

  /**
   * The view collection
   *
   * @type {IViewsCollection}
   * @memberof IRegion
   */
  Views: IViewsCollection;

  /**
   * The region behaviors collection
   *
   * @type {IRegionBehaviorCollection}
   * @memberof IRegion
   */
  Behaviors: IRegionBehaviorCollection;

  /**
   * Activate the view in the region
   *
   * @param {unknown} view
   * @memberof IRegion
   */
  Activate(view: unknown): void;

  /**
   * Add a view to the region
   *
   * @param {unknown} view
   * @param {string} [str]
   * @param {boolean} [flag]
   * @return {*}  {IRegionManager}
   * @memberof IRegion
   */
  Add(view: unknown, str?: string, flag?: boolean): IRegionManager;

  /**
   * Deactivate a view from the region
   *
   * @param {unknown} view
   * @memberof IRegion
   */
  Deactivate(view: unknown): void;

  /**
   * Gets a view by the name registered
   *
   * @param {string} name
   * @returns {*}
   * @memberof IRegion
   */
  GetView(name: string): any;

  /**
   * Remove a view from the region
   *
   * @param {unknown} view
   * @memberof IRegion
   */
  Remove(view: unknown): void;
}