qtmobility/src/multimedia/qvideowidgetcontrol.cpp
changeset 1 2b40d63a9c3d
child 4 90517678cc4f
equal deleted inserted replaced
0:cfcbf08528c4 1:2b40d63a9c3d
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     4 ** All rights reserved.
       
     5 ** Contact: Nokia Corporation (qt-info@nokia.com)
       
     6 **
       
     7 ** This file is part of the Qt Mobility Components.
       
     8 **
       
     9 ** $QT_BEGIN_LICENSE:LGPL$
       
    10 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    32 **
       
    33 **
       
    34 **
       
    35 **
       
    36 **
       
    37 **
       
    38 ** $QT_END_LICENSE$
       
    39 **
       
    40 ****************************************************************************/
       
    41 
       
    42 #include <qvideowidgetcontrol.h>
       
    43 #include <qmediacontrol_p.h>
       
    44 
       
    45 QTM_BEGIN_NAMESPACE
       
    46 
       
    47 /*!
       
    48     \class QVideoWidgetControl
       
    49     \preliminary
       
    50 
       
    51     \brief The QVideoWidgetControl class provides a media control which
       
    52     implements a video widget.
       
    53 
       
    54     \ingroup multimedia-serv
       
    55 
       
    56     The videoWidget() property of QVideoWidgetControl provides a pointer to
       
    57     a video widget implemented by the control's media service.  This widget
       
    58     is owned by the media service and so care should be taken not to delete it.
       
    59 
       
    60     \code
       
    61     QVideoWidgetControl *widgetControl = mediaService->control<QVideoWidgetControl *>();
       
    62 
       
    63     layout->addWidget(widgetControl->widget());
       
    64     \endcode
       
    65 
       
    66     QVideoWidgetControl is one of number of possible video output controls,
       
    67     in order to receive video it must be made the active video output
       
    68     control by setting the output property of QVideoOutputControl to \l {QVideoOutputControl::WidgetOutput}{WidgetOutput}. Consequently any
       
    69     QMediaService that implements QVideoWidgetControl must also implement
       
    70     QVideoOutputControl.
       
    71 
       
    72     The interface name of QVideoWidgetControl is \c com.nokia.Qt.QVideoWidgetControl/1.0 as
       
    73     defined in QVideoWidgetControl_iid.
       
    74 
       
    75     \sa QMediaService::control(), QVideoOutputControl, QVideoWidget
       
    76 */
       
    77 
       
    78 /*!
       
    79     \macro QVideoWidgetControl_iid
       
    80 
       
    81     \c com.nokia.Qt.QVideoWidgetControl/1.0
       
    82 
       
    83     Defines the interface name of the QVideoWidgetControl class.
       
    84 
       
    85     \relates QVideoWidgetControl
       
    86 */
       
    87 
       
    88 /*!
       
    89     Constructs a new video widget control with the given \a parent.
       
    90 */
       
    91 QVideoWidgetControl::QVideoWidgetControl(QObject *parent)
       
    92     :QMediaControl(parent)
       
    93 {
       
    94 }
       
    95 
       
    96 /*!
       
    97     Destroys a video widget control.
       
    98 */
       
    99 QVideoWidgetControl::~QVideoWidgetControl()
       
   100 {
       
   101 }
       
   102 
       
   103 /*!
       
   104     \fn QVideoWidgetControl::isFullScreen() const
       
   105 
       
   106     Returns true if the video is shown using the complete screen.
       
   107 */
       
   108 
       
   109 /*!
       
   110     \fn QVideoWidgetControl::setFullScreen(bool fullScreen)
       
   111 
       
   112     Sets whether a video widget is in \a fullScreen mode.
       
   113 */
       
   114 
       
   115 /*!
       
   116     \fn QVideoWidgetControl::fullScreenChanged(bool fullScreen)
       
   117 
       
   118     Signals that the \a fullScreen state of a video widget has changed.
       
   119 */
       
   120 
       
   121 /*!
       
   122     \fn QVideoWidgetControl::aspectRatioMode() const
       
   123 
       
   124     Returns how video is scaled to fit the widget with respect to its aspect ratio.
       
   125 */
       
   126 
       
   127 /*!
       
   128     \fn QVideoWidgetControl::setAspectRatioMode(QVideoWidget::AspectRatioMode mode)
       
   129 
       
   130     Sets the aspect ratio \a mode which determines how video is scaled to the fit the widget with
       
   131     respect to its aspect ratio.
       
   132 */
       
   133 
       
   134 /*!
       
   135     \fn QVideoWidgetControl::brightness() const
       
   136 
       
   137     Returns the brightness adjustment applied to a video.
       
   138 
       
   139     Valid brightness values range between -100 and 100, the default is 0.
       
   140 */
       
   141 
       
   142 /*!
       
   143     \fn QVideoWidgetControl::setBrightness(int brightness)
       
   144 
       
   145     Sets a \a brightness adjustment for a video.
       
   146 
       
   147     Valid brightness values range between -100 and 100, the default is 0.
       
   148 */
       
   149 
       
   150 /*!
       
   151     \fn QVideoWidgetControl::brightnessChanged(int brightness)
       
   152 
       
   153     Signals that a video widget's \a brightness adjustment has changed.
       
   154 */
       
   155 
       
   156 /*!
       
   157     \fn QVideoWidgetControl::contrast() const
       
   158 
       
   159     Returns the contrast adjustment applied to a video.
       
   160 
       
   161     Valid contrast values range between -100 and 100, the default is 0.
       
   162 */
       
   163 
       
   164 /*!
       
   165     \fn QVideoWidgetControl::setContrast(int contrast)
       
   166 
       
   167     Sets the contrast adjustment for a video widget to \a contrast.
       
   168 
       
   169     Valid contrast values range between -100 and 100, the default is 0.
       
   170 */
       
   171 
       
   172 
       
   173 /*!
       
   174     \fn QVideoWidgetControl::contrastChanged(int contrast)
       
   175 
       
   176     Signals that a video widget's \a contrast adjustment has changed.
       
   177 */
       
   178 
       
   179 /*!
       
   180     \fn QVideoWidgetControl::hue() const
       
   181 
       
   182     Returns the hue adjustment applied to a video widget.
       
   183 
       
   184     Value hue values range between -100 and 100, the default is 0.
       
   185 */
       
   186 
       
   187 /*!
       
   188     \fn QVideoWidgetControl::setHue(int hue)
       
   189 
       
   190     Sets a \a hue adjustment for a video widget.
       
   191 
       
   192     Valid hue values range between -100 and 100, the default is 0.
       
   193 */
       
   194 
       
   195 
       
   196 /*!
       
   197     \fn QVideoWidgetControl::hueChanged(int hue)
       
   198 
       
   199     Signals that a video widget's \a hue adjustment has changed.
       
   200 */
       
   201 
       
   202 /*!
       
   203     \fn QVideoWidgetControl::saturation() const
       
   204 
       
   205     Returns the saturation adjustment applied to a video widget.
       
   206 
       
   207     Value saturation values range between -100 and 100, the default is 0.
       
   208 */
       
   209 
       
   210 
       
   211 /*!
       
   212     \fn QVideoWidgetControl::setSaturation(int saturation)
       
   213 
       
   214     Sets a \a saturation adjustment for a video widget.
       
   215 
       
   216     Valid saturation values range between -100 and 100, the default is 0.
       
   217 */
       
   218 
       
   219 /*!
       
   220     \fn QVideoWidgetControl::saturationChanged(int saturation)
       
   221 
       
   222     Signals that a video widget's \a saturation adjustment has changed.
       
   223 */
       
   224 
       
   225 /*!
       
   226     \fn QVideoWidgetControl::videoWidget()
       
   227 
       
   228     Returns the QWidget.
       
   229 */
       
   230 
       
   231 #include "moc_qvideowidgetcontrol.cpp"
       
   232 QTM_END_NAMESPACE
       
   233