git.sesse.net Git - vlc/blob - modules/gui/skins2/controls/ctrl_image.hpp

   1 /*****************************************************************************
   2  * ctrl_image.hpp
   3  *****************************************************************************
   4  * Copyright (C) 2003 VideoLAN (Centrale Réseaux) and its contributors
   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
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  23  *****************************************************************************/
  24
  25 #ifndef CTRL_IMAGE_HPP
  26 #define CTRL_IMAGE_HPP
  27
  28 #include "../commands/cmd_generic.hpp"
  29 #include "ctrl_flat.hpp"
  30
  31 class GenericBitmap;
  32 class OSGraphics;
  33
  34
  35 /// Control image
  36 class CtrlImage: public CtrlFlat
  37 {
  38     public:
  39         /// Resize methods
  40         typedef enum
  41         {
  42             kMosaic,  // Repeat the base image in a mosaic
  43             kScale    // Scale the base image
  44         } resize_t;
  45
  46         // Create an image with the given bitmap (which is NOT copied)
  47         CtrlImage( intf_thread_t *pIntf, const GenericBitmap &rBitmap,
  48                    resize_t resizeMethod, const UString &rHelp,
  49                    VarBool *pVisible );
  50         virtual ~CtrlImage();
  51
  52         /// Handle an event on the control
  53         virtual void handleEvent( EvtGeneric &rEvent );
  54
  55         /// Check whether coordinates are inside the control
  56         virtual bool mouseOver( int x, int y ) const;
  57
  58         /// Draw the control on the given graphics
  59         virtual void draw( OSGraphics &rImage, int xDest, int yDest );
  60
  61         /// Get the type of control (custom RTTI)
  62         virtual string getType() const { return "image"; }
  63
  64     private:
  65         /// Bitmap
  66         const GenericBitmap &m_rBitmap;
  67         /// Buffer to stored the rendered bitmap
  68         OSGraphics *m_pImage;
  69         /// Resize method
  70         resize_t m_resizeMethod;
  71 };
  72
  73 #endif