/* Network-Integrated Multimedia Middleware (NMM)
 * http://www.motama.com/nmm.html
 *
 * Copyright (C) 2006-2007
 * Motama GmbH, Saarbruecken, Germany
 * http://www.motama.com
 *
 * This file is part of NMM. 
 * 
 * NMM is free software; you can redistribute it and/or modify it    
 * under the terms of the GNU General Public License as published by 
 * the Free Software Foundation; only version 2 of the License.      
 * 
 * NMM 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 GNU General Public 
 * License for more details.  
 * 
 * You should have received a copy of the GNU General Public License 
 * along with NMM; if not, write to the Free Software Foundation,    
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 */

#include "nmm/multimedia/INode.idl"

module NMM{
  
  /**
   * General display interface.
   * This interface provides all general display methods.
   */
  interface IVideoDisplay {
    /**
     * Enable/disable presentation of fps on title of display/window
     * @param value true for enabling presentation, else false 
     */
    void setBenchmarkingEnabled(in nmm_bool value);

    /**
     * Set fullscreen mode.
     * @param value true for fullscreen, false for windowed display mode
     */
    void setFullscreen(in nmm_bool value);
    
    /**
     * Get fullscreen mode.
     * @return true if the display is in fullscreen mode, false if it is in windowed mode
     */
    nmm_bool getFullscreen() const;
    
    /**
     * test if display has fullscreen support.
     * @return true if fullscreen mode can be turned on, false otherwise
     */
    nmm_bool hasFullscreen() const;
    
    /**
     * Test if display is fullscreen only.
     * @return true if fullscren mode is the default and cannot be turned off.
     */
    nmm_bool isFullscreenOnly() const;
    
    nmm_bool makeScreenshot(in string filename) const;
    
    /**
     * Set window alignment.
     */
    void setDisplayPosition(in nmm_int32 xPos, in nmm_int32 yPos) limited(INode::CONSTRUCTED) limited(INode::INITIALIZED);
    void setLeftWindowAlignment() limited(INode::CONSTRUCTED) limited(INode::INITIALIZED);
    void setRightWindowAlignment() limited(INode::CONSTRUCTED) limited(INode::INITIALIZED);
    void setCenterWindowAlignment() limited(INode::CONSTRUCTED) limited(INode::INITIALIZED);
  };
}
