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 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 CTRL_IMAGE_HPP
  26 #define CTRL_IMAGE_HPP
  27
  28 #include "../commands/cmd_generic.hpp"
  29 #include "../utils/observer.hpp"
  30 #include "ctrl_flat.hpp"
  31
  32 class GenericBitmap;
  33 class OSGraphics;
  34 class CmdGeneric;
  35 class VarString;
  36
  37
  38 /// Control image
  39 class CtrlImage: public CtrlFlat, public Observer<VarString>
  40 {
  41 public:
  42     /// Resize methods
  43     enum resize_t
  44     {
  45         kMosaic,                // Repeat the base image in a mosaic
  46         kScale,                 // Scale the base image
  47         kScaleAndRatioPreserved // Scale image (aspect ratio preserved)
  48     };
  49
  50     // Create an image with the given bitmap (which is NOT copied)
  51     CtrlImage( intf_thread_t *pIntf, GenericBitmap &rBitmap,
  52                CmdGeneric &rCommand, resize_t resizeMethod,
  53                const UString &rHelp, VarBool *pVisible, bool art );
  54     virtual ~CtrlImage();
  55
  56     /// Handle an event on the control
  57     virtual void handleEvent( EvtGeneric &rEvent );
  58
  59     /// Check whether coordinates are inside the control
  60     virtual bool mouseOver( int x, int y ) const;
  61
  62     /// Draw the control on the given graphics
  63     virtual void draw( OSGraphics &rImage, int xDest, int yDest, int w, int h );
  64
  65     /// Get the type of control (custom RTTI)
  66     virtual string getType() const { return "image"; }
  67
  68 private:
  69     /// Bitmap
  70     GenericBitmap* m_pBitmap;
  71     /// original Bitmap
  72     GenericBitmap* m_pOriginalBitmap;
  73     /// Buffer to stored the rendered bitmap
  74     OSGraphics *m_pImage;
  75     /// Command triggered by a double-click on the image
  76     CmdGeneric &m_rCommand;
  77     /// Resize method
  78     resize_t m_resizeMethod;
  79     /// does the image get updated as art
  80     bool m_art;
  81     /// offset for image inside the control
  82     int m_x;
  83     int m_y;
  84
  85     /// Method called when the observed variable is modified
  86     virtual void onUpdate( Subject<VarString> &rVariable, void* );
  87
  88
  89 };
  90
  91 #endif