git.sesse.net Git - vlc/blob - modules/gui/skins2/src/top_window.hpp

   1 /*****************************************************************************
   2  * top_window.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 TOP_WINDOW_HPP
  26 #define TOP_WINDOW_HPP
  27
  28 #include "generic_window.hpp"
  29 #include "../utils/pointer.hpp"
  30 #include <list>
  31
  32 class OSWindow;
  33 class OSGraphics;
  34 class GenericLayout;
  35 class CtrlGeneric;
  36 class WindowManager;
  37
  38
  39 /// Class to handle top-level windows
  40 class TopWindow: public GenericWindow
  41 {
  42 private:
  43     friend class WindowManager;
  44 public:
  45     TopWindow( intf_thread_t *pIntf, int xPos, int yPos,
  46                WindowManager &rWindowManager,
  47                bool dragDrop, bool playOnDrop, bool visible );
  48     virtual ~TopWindow();
  49
  50     /// Methods to process OS events.
  51     virtual void processEvent( EvtFocus &rEvtFocus );
  52     virtual void processEvent( EvtMenu &rEvtMenu );
  53     virtual void processEvent( EvtMotion &rEvtMotion );
  54     virtual void processEvent( EvtMouse &rEvtMouse );
  55     virtual void processEvent( EvtLeave &rEvtLeave );
  56     virtual void processEvent( EvtKey &rEvtKey );
  57     virtual void processEvent( EvtScroll &rEvtScroll );
  58
  59     /// Forward an event to a control
  60     virtual void forwardEvent( EvtGeneric &rEvt, CtrlGeneric &rCtrl );
  61
  62     // Refresh an area of the window
  63     virtual void refresh( int left, int top, int width, int height );
  64
  65     /// Get the active layout
  66     virtual const GenericLayout& getActiveLayout() const;
  67
  68     /// Update the shape of the window from the active layout
  69     virtual void updateShape();
  70
  71     /// Called by a control that wants to capture the mouse
  72     virtual void onControlCapture( const CtrlGeneric &rCtrl );
  73
  74     /// Called by a control that wants to release the mouse
  75     virtual void onControlRelease( const CtrlGeneric &rCtrl );
  76
  77     /// Called by a control when its tooltip changed
  78     virtual void onTooltipChange( const CtrlGeneric &rCtrl );
  79
  80     /// Get the "maximized" variable
  81     VarBool &getMaximizedVar() { return *m_pVarMaximized; }
  82
  83     /// Get the initial visibility status
  84     bool isVisible() const { return m_visible; }
  85
  86 protected:
  87     /// Actually show the window
  88     virtual void innerShow();
  89
  90     /// Actually hide the window
  91     virtual void innerHide();
  92
  93 private:
  94     /**
  95      * These methods are only used by the window manager
  96      */
  97     //@{
  98     /// Change the active layout
  99     virtual void setActiveLayout( GenericLayout *pLayout );
 100     //@}
 101
 102     /// Initial visibility status
 103     bool m_visible;
 104     /// Window manager
 105     WindowManager &m_rWindowManager;
 106     /// Current active layout of the window
 107     GenericLayout *m_pActiveLayout;
 108     /// Last control on which the mouse was over
 109     CtrlGeneric *m_pLastHitControl;
 110     /// Control that has captured the mouse
 111     CtrlGeneric *m_pCapturingControl;
 112     /// Control that has the focus
 113     CtrlGeneric *m_pFocusControl;
 114     /// Current key modifier (also used for mouse)
 115     int m_currModifier;
 116
 117     /// Variable for the visibility of the window
 118     VarBoolImpl *m_pVarMaximized;
 119
 120     /**
 121      * Find the uppest control in the layout hit by the mouse, and send
 122      * it an enter event if needed
 123      */
 124     CtrlGeneric *findHitControl( int xPos, int yPos );
 125
 126     /**
 127      * Update the lastHitControl pointer and send a leave event to the
 128      * right control
 129      */
 130     void setLastHit( CtrlGeneric *pNewHitControl );
 131 };
 132
 133 typedef CountedPtr<TopWindow> TopWindowPtr;
 134
 135
 136 #endif