git.sesse.net Git - vlc/blob - modules/gui/skins2/vars/volume.hpp

   1 /*****************************************************************************
   2  * volume.hpp
   3  *****************************************************************************
   4  * Copyright (C) 2003 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Cyril Deguet     <asmax@via.ecp.fr>
   8  *          Olivier Teulière <ipkiss@via.ecp.fr>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #ifndef VOLUME_HPP
  26 #define VOLUME_HPP
  27
  28
  29 #include "../utils/var_percent.hpp"
  30 #include <string>
  31
  32
  33 /// Variable for VLC volume
  34 class Volume: public VarPercent
  35 {
  36 public:
  37     Volume( intf_thread_t *pIntf );
  38     virtual ~Volume() { }
  39
  40     virtual void set( float percentage, bool updateVLC );
  41     virtual void set( float percentage ) { set( percentage, true ); }
  42
  43     virtual float getVolume() const;
  44     virtual void setVolume( float volume, bool updateVLC );
  45
  46     virtual float getStep() const { return m_step; }
  47
  48     virtual string getAsStringPercent() const;
  49
  50 private:
  51     // preferred volume step on [0., 1.]
  52     float m_step;
  53 };
  54
  55
  56 #endif