kworship/media/KwMediaPreferencesVisual.h

   1 /***************************************************************************
   2  *   This file is part of KWorship.                                        *
   3  *   Copyright 2008 James Hogan <james@albanarts.com>                      *
   4  *                                                                         *
   5  *   KWorship is free software: you can redistribute it and/or modify      *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation, either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   KWorship is distributed in the hope that it will be useful,           *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with KWorship.  If not, write to the Free Software Foundation,  *
  17  *   Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.   *
  18  ***************************************************************************/
  19
  20 #ifndef _KwMediaPreferencesVisual_h_
  21 #define _KwMediaPreferencesVisual_h_
  22
  23 /**
  24  * @file KwMediaPreferencesVisual.h
  25  * @brief A media item's visual preferences.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include "KwAbstractMediaPreferences.h"
  30
  31 #include <QtGlobal>
  32
  33 /// A media item's visual preferences.
  34 /**
  35  * Basically this is visual based preferences such as brightness etc.
  36  */
  37 class KwMediaPreferencesVisual : public KwAbstractMediaPreferences
  38 {
  39   public:
  40
  41     /*
  42      * Types
  43      */
  44
  45     /// The type for visual parameters.
  46     typedef qreal Parameter;
  47
  48     /// Scaling modes.
  49     enum ScaleMode
  50     {
  51       Unscaled,
  52       FitInView,
  53       Stretch,
  54       ScaleAndCrop
  55     };
  56
  57     /*
  58      * Constructors + destructors
  59      */
  60
  61     /// Default constructor.
  62     KwMediaPreferencesVisual();
  63
  64     /// Destructor.
  65     virtual ~KwMediaPreferencesVisual();
  66
  67     /*
  68      * Accessors
  69      */
  70
  71     /// Get the brightness value.
  72     Parameter getBrightness() const;
  73
  74     /// Get the contrast value.
  75     Parameter getContrast() const;
  76
  77     /// Get the hue value.
  78     Parameter getHue() const;
  79
  80     /// Get the saturation value.
  81     Parameter getSaturation() const;
  82
  83     /// Get the scale mode.
  84     ScaleMode getScaleMode() const;
  85
  86     /*
  87      * Mutators
  88      */
  89
  90     /// Set the brightness value.
  91     void setBrightness(Parameter brightness);
  92
  93     /// Set the contrast value.
  94     void setContrast(Parameter contrast);
  95
  96     /// Set the hue value.
  97     void setHue(Parameter hue);
  98
  99     /// Set the saturation value.
 100     void setSaturation(Parameter saturation);
 101
 102     /// Set the scale mode.
 103     void setScaleMode(ScaleMode scaleMode);
 104
 105   private:
 106
 107     /*
 108      * Variables
 109      */
 110
 111     /// Brightness value.
 112     Parameter m_brightness;
 113
 114     /// Contrast value.
 115     Parameter m_contrast;
 116
 117     /// Hue value.
 118     Parameter m_hue;
 119
 120     /// Saturation value.
 121     Parameter m_saturation;
 122
 123     /// Scale mode.
 124     ScaleMode m_scaleMode;
 125 };
 126
 127 #endif // _KwMediaPreferencesVisual_h_
 128