ctrl_generic.hpp
上传用户:kjfoods
上传日期:2020-07-06
资源大小:29949k
文件大小:5k
源码类别:

midi

开发平台:

Unix_Linux

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