/* 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 "IWidget.idl"
#include "IWidgetComposite.idl"

#include "IProgressBar.idl"
#include "ITextView.idl"
#include "ITimeView.idl"
#include "IImageView.idl"
#include "IRadioButtons.idl"
#include "IButtons.idl"

#include "IBorderDecorator.idl"
#include "IHeaderDecorator.idl"
#include "IPlaneDecorator.idl"
#include "IScrollDecorator.idl"

module NMM {
  
  /**
   * Widget factory.
   * This interface, which is implemented by the OSD manager, is used
   * for creating widget objects. I wrote a seperate interface for this for the
   * following reasons:
   * - It has a lot of methods only for creating widgets that would inflate IOSDManager
   * - It depends on all the widget interfaces. I don't want IOSDManager to include them all
   */
  interface IWidgetFactory {

    /**
     * Create a widget composite.
     * Creates a new widget and returns an interface for it.
     * @return an interface for this widget
     */
    IWidgetComposite* createWidgetComposite();
    
    /**
     * Create a progress bar.
     * Creates a new widget and returns an interface for it.
     * @return an interface for this widget
     */
    IProgressBar* createProgressBar();
    
    /**
     * Create a text view.
     * Creates a new widget and returns an interface for it.
     * @return an interface for this widget
     */
    ITextView* createTextView();

    /**
     * Create a time view.
     * Creates a new widget and returns an interface for it.
     * @return an interface for this widget
     */
    ITimeView* createTimeView();

    /**
     * Create an image view.
     * Creates a new widget and returns an interface for it.
     * @return an interface for this widget
     */
    IImageView* createImageView();

    /**
     * Create radio buttons.
     * Creates a new widget and returns an interface for it.
     * @return an interface for this widget
     */
    IRadioButtons* createRadioButtons();

    /**
     * Create buttons.
     * Creates a new widget and returns an interface for it.
     * @return an interface for this widget
     */
    IButtons* createButtons();
    
    
    /**
     * Create border decorator.
     * Creates a new widget and returns an interface for it.
     * @param internal the internal widget of the decorator
     * @return an interface for this widget
     */
    IBorderDecorator* createBorderDecorator(in IWidget internal);

    /**
     * Create border decorator.
     * Creates a new widget and returns an interface for it.
     * @param internal the internal widget of the decorator
     * @return an interface for this widget
     */
    IHeaderDecorator* createHeaderDecorator(in IWidget internal);

    /**
     * Create plane decorator.
     * Creates a new widget and returns an interface for it.
     * @param internal the internal widget of the decorator
     * @return an interface for this widget
     */
    IPlaneDecorator* createPlaneDecorator(in IWidget internal);

    /**
     * Create scroll decorator.
     * Creates a new widget and returns an interface for it.
     * @param internal the internal widget of the decorator
     * @return an interface for this widget
     */
    IScrollDecorator* createScrollDecorator(in IWidget internal);
  };
  
}
