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

   1 /*****************************************************************************
   2  * ctrl_generic.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_GENERIC_HPP
  26 #define CTRL_GENERIC_HPP
  27
  28 #include "../src/skin_common.hpp"
  29 #include "../utils/pointer.hpp"
  30 #include "../utils/ustring.hpp"
  31 #include "../utils/observer.hpp"
  32 #include "../commands/cmd_generic.hpp"
  33
  34 class Box;
  35 class EvtGeneric;
  36 class OSGraphics;
  37 class GenericLayout;
  38 class Position;
  39 class TopWindow;
  40 class VarBool;
  41
  42
  43 /// Base class for controls
  44 class CtrlGeneric: public SkinObject, public Observer<VarBool>
  45 {
  46     public:
  47         virtual ~CtrlGeneric();
  48
  49         /// Handle an event on the control
  50         virtual void handleEvent( EvtGeneric &rEvent ) {}
  51
  52         /// Check whether coordinates are inside the control
  53         virtual bool mouseOver( int x, int y ) const { return false; }
  54
  55         /// Draw the control on the given graphics
  56         virtual void draw( OSGraphics &rImage, int xDest, int yDest ) {}
  57
  58         /// Set the position and the associated layout of the control
  59         virtual void setLayout( GenericLayout *pLayout,
  60                                 const Position &rPosition );
  61
  62         /// Get the position of the control in the layout, if any
  63         virtual const Position *getPosition() const { return m_pPosition; }
  64
  65         /// Get the text of the tooltip
  66         virtual UString getTooltipText() const
  67             { return UString( getIntf(), "" ); }
  68
  69         /**
  70          * Overload this method if you want to do something special when
  71          * the layout is resized
  72          */
  73         virtual void onResize() {}
  74
  75         /// Get the help text
  76         virtual const UString &getHelpText() const { return m_help; }
  77
  78         /// Return true if the control can gain the focus
  79         virtual bool isFocusable() const { return false; }
  80
  81         /// Return true if the control is visible
  82         virtual bool isVisible() const;
  83
  84         /// Get the type of control (custom RTTI)
  85         virtual string getType() const { return ""; }
  86
  87     protected:
  88         // If pVisible is NULL, the control is always visible
  89         CtrlGeneric( intf_thread_t *pIntf, const UString &rHelp,
  90                      VarBool *pVisible = NULL );
  91
  92         /**
  93          * Tell the layout when the image has changed, with the size of the
  94          * rectangle to repaint and its offset.
  95          * Use the default values to repaint the whole window
  96          */
  97         virtual void notifyLayout( int witdh = -1, int height = -1,
  98                                    int xOffSet = 0, int yOffSet = 0 ) const;
  99
 100         /**
 101          * Same as notifyLayout(), but takes optional images as parameters.
 102          * The maximum size(s) of the images will be used for repainting.
 103          */
 104         void notifyLayoutMaxSize( const Box *pImg1 = NULL,
 105                                   const Box *pImg2 = NULL );
 106
 107         /// Ask the layout to capture the mouse
 108         virtual void captureMouse() const;
 109
 110         /// Ask the layout to release the mouse
 111         virtual void releaseMouse() const;
 112
 113         /// Notify the window the tooltip has changed
 114         virtual void notifyTooltipChange() const;
 115
 116         /// Get the associated window, if any
 117         virtual TopWindow *getWindow() const;
 118
 119         /**
 120          * Overload this method if you want to do something special when
 121          * the Position object is set
 122          */
 123         virtual void onPositionChange() {}
 124
 125         /// Overload this method to get notified of bool variable changes
 126         virtual void onVarBoolUpdate( VarBool &rVar ) {}
 127
 128     private:
 129         /// Associated layout
 130         GenericLayout *m_pLayout;
 131         /// Position in the layout
 132         Position *m_pPosition;
 133         /// Help text
 134         UString m_help;
 135         /// Visibilty variable
 136         VarBool *m_pVisible;
 137
 138         /// Method called when an observed bool variable is changed
 139         virtual void onUpdate( Subject<VarBool> &rVariable , void* );
 140 };
 141
 142 typedef CountedPtr<CtrlGeneric> CtrlGenericPtr;
 143
 144
 145 #endif