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

   1 /*****************************************************************************
   2  * ctrl_image.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
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, 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 class CmdGeneric;
  34
  35
  36 /// Control image
  37 class CtrlImage: public CtrlFlat
  38 {
  39     public:
  40         /// Resize methods
  41         enum resize_t
  42         {
  43             kMosaic,  // Repeat the base image in a mosaic
  44             kScale    // Scale the base image
  45         };
  46
  47         // Create an image with the given bitmap (which is NOT copied)
  48         CtrlImage( intf_thread_t *pIntf, const GenericBitmap &rBitmap,
  49                    CmdGeneric &rCommand, resize_t resizeMethod,
  50                    const UString &rHelp, VarBool *pVisible );
  51         virtual ~CtrlImage();
  52
  53         /// Handle an event on the control
  54         virtual void handleEvent( EvtGeneric &rEvent );
  55
  56         /// Check whether coordinates are inside the control
  57         virtual bool mouseOver( int x, int y ) const;
  58
  59         /// Draw the control on the given graphics
  60         virtual void draw( OSGraphics &rImage, int xDest, int yDest );
  61
  62         /// Get the type of control (custom RTTI)
  63         virtual string getType() const { return "image"; }
  64
  65     private:
  66         /// Bitmap
  67         const GenericBitmap &m_rBitmap;
  68         /// Buffer to stored the rendered bitmap
  69         OSGraphics *m_pImage;
  70         /// Command triggered by a double-click on the image
  71         CmdGeneric &m_rCommand;
  72         /// Resize method
  73         resize_t m_resizeMethod;
  74 };
  75
  76 #endif