src/multimedia/qvideowidgetcontrol.cpp
changeset 0 876b1a06bc25
equal deleted inserted replaced
-1:000000000000 0:876b1a06bc25
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2010 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 QT_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
       
    55 
       
    56     The videoWidget() property of QVideoWidgetControl provides a pointer to a
       
    57     video widget implemented by the control's media service.  This widget is
       
    58     owned by the media service and so care should be taken not to delete it.
       
    59 
       
    60     \code
       
    61     QVideoWidgetControl *widgetControl = mediaService->requestControl<QVideoWidgetControl *>();
       
    62     layout->addWidget(widgetControl->widget());
       
    63     \endcode
       
    64 
       
    65     QVideoWidgetControl is one of number of possible video output controls.
       
    66 
       
    67     The interface name of QVideoWidgetControl is \c com.nokia.Qt.QVideoWidgetControl/1.0 as
       
    68     defined in QVideoWidgetControl_iid.
       
    69 
       
    70     \sa QMediaService::requestControl(), QVideoWidget
       
    71 */
       
    72 
       
    73 /*!
       
    74     \macro QVideoWidgetControl_iid
       
    75 
       
    76     \c com.nokia.Qt.QVideoWidgetControl/1.0
       
    77 
       
    78     Defines the interface name of the QVideoWidgetControl class.
       
    79 
       
    80     \relates QVideoWidgetControl
       
    81 */
       
    82 
       
    83 /*!
       
    84     Constructs a new video widget control with the given \a parent.
       
    85 */
       
    86 QVideoWidgetControl::QVideoWidgetControl(QObject *parent)
       
    87     :QMediaControl(parent)
       
    88 {
       
    89 }
       
    90 
       
    91 /*!
       
    92     Destroys a video widget control.
       
    93 */
       
    94 QVideoWidgetControl::~QVideoWidgetControl()
       
    95 {
       
    96 }
       
    97 
       
    98 /*!
       
    99     \fn QVideoWidgetControl::isFullScreen() const
       
   100 
       
   101     Returns true if the video is shown using the complete screen.
       
   102 */
       
   103 
       
   104 /*!
       
   105     \fn QVideoWidgetControl::setFullScreen(bool fullScreen)
       
   106 
       
   107     Sets whether a video widget is in \a fullScreen mode.
       
   108 */
       
   109 
       
   110 /*!
       
   111     \fn QVideoWidgetControl::fullScreenChanged(bool fullScreen)
       
   112 
       
   113     Signals that the \a fullScreen state of a video widget has changed.
       
   114 */
       
   115 
       
   116 /*!
       
   117     \fn QVideoWidgetControl::aspectRatioMode() const
       
   118 
       
   119     Returns how video is scaled to fit the widget with respect to its aspect ratio.
       
   120 */
       
   121 
       
   122 /*!
       
   123     \fn QVideoWidgetControl::setAspectRatioMode(Qt::AspectRatioMode mode)
       
   124 
       
   125     Sets the aspect ratio \a mode which determines how video is scaled to the fit the widget with
       
   126     respect to its aspect ratio.
       
   127 */
       
   128 
       
   129 /*!
       
   130     \fn QVideoWidgetControl::brightness() const
       
   131 
       
   132     Returns the brightness adjustment applied to a video.
       
   133 
       
   134     Valid brightness values range between -100 and 100, the default is 0.
       
   135 */
       
   136 
       
   137 /*!
       
   138     \fn QVideoWidgetControl::setBrightness(int brightness)
       
   139 
       
   140     Sets a \a brightness adjustment for a video.
       
   141 
       
   142     Valid brightness values range between -100 and 100, the default is 0.
       
   143 */
       
   144 
       
   145 /*!
       
   146     \fn QVideoWidgetControl::brightnessChanged(int brightness)
       
   147 
       
   148     Signals that a video widget's \a brightness adjustment has changed.
       
   149 */
       
   150 
       
   151 /*!
       
   152     \fn QVideoWidgetControl::contrast() const
       
   153 
       
   154     Returns the contrast adjustment applied to a video.
       
   155 
       
   156     Valid contrast values range between -100 and 100, the default is 0.
       
   157 */
       
   158 
       
   159 /*!
       
   160     \fn QVideoWidgetControl::setContrast(int contrast)
       
   161 
       
   162     Sets the contrast adjustment for a video widget to \a contrast.
       
   163 
       
   164     Valid contrast values range between -100 and 100, the default is 0.
       
   165 */
       
   166 
       
   167 
       
   168 /*!
       
   169     \fn QVideoWidgetControl::contrastChanged(int contrast)
       
   170 
       
   171     Signals that a video widget's \a contrast adjustment has changed.
       
   172 */
       
   173 
       
   174 /*!
       
   175     \fn QVideoWidgetControl::hue() const
       
   176 
       
   177     Returns the hue adjustment applied to a video widget.
       
   178 
       
   179     Value hue values range between -100 and 100, the default is 0.
       
   180 */
       
   181 
       
   182 /*!
       
   183     \fn QVideoWidgetControl::setHue(int hue)
       
   184 
       
   185     Sets a \a hue adjustment for a video widget.
       
   186 
       
   187     Valid hue values range between -100 and 100, the default is 0.
       
   188 */
       
   189 
       
   190 
       
   191 /*!
       
   192     \fn QVideoWidgetControl::hueChanged(int hue)
       
   193 
       
   194     Signals that a video widget's \a hue adjustment has changed.
       
   195 */
       
   196 
       
   197 /*!
       
   198     \fn QVideoWidgetControl::saturation() const
       
   199 
       
   200     Returns the saturation adjustment applied to a video widget.
       
   201 
       
   202     Value saturation values range between -100 and 100, the default is 0.
       
   203 */
       
   204 
       
   205 
       
   206 /*!
       
   207     \fn QVideoWidgetControl::setSaturation(int saturation)
       
   208 
       
   209     Sets a \a saturation adjustment for a video widget.
       
   210 
       
   211     Valid saturation values range between -100 and 100, the default is 0.
       
   212 */
       
   213 
       
   214 /*!
       
   215     \fn QVideoWidgetControl::saturationChanged(int saturation)
       
   216 
       
   217     Signals that a video widget's \a saturation adjustment has changed.
       
   218 */
       
   219 
       
   220 /*!
       
   221     \fn QVideoWidgetControl::videoWidget()
       
   222 
       
   223     Returns the QWidget.
       
   224 */
       
   225 
       
   226 #include "moc_qvideowidgetcontrol.cpp"
       
   227 QT_END_NAMESPACE
       
   228