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

   1 /*****************************************************************************
   2  * window_manager.hpp
   3  *****************************************************************************
   4  * Copyright (C) 2003 VideoLAN
   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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  23  *****************************************************************************/
  24
  25 #ifndef WINDOW_MANAGER_HPP
  26 #define WINDOW_MANAGER_HPP
  27
  28 #include "skin_common.hpp"
  29 #include "top_window.hpp"
  30 #include <list>
  31 #include <map>
  32 #include <set>
  33 #include <utility>
  34
  35
  36 class GenericFont;
  37 class GenericLayout;
  38 class Anchor;
  39 class Tooltip;
  40
  41
  42 /// Window manager for skin windows
  43 class WindowManager: public SkinObject
  44 {
  45     public:
  46         /// Constructor
  47         WindowManager( intf_thread_t *pIntf);
  48
  49         /// Destructor
  50         virtual ~WindowManager();
  51
  52         /// Add a window to the list of known windows. Necessary if you want
  53         /// your window to be movable...
  54         void registerWindow( TopWindow &rWindow );
  55
  56         /// Remove a previously registered window
  57         void unregisterWindow( TopWindow &rWindow );
  58
  59         /// Tell the window manager that a move is initiated for pWindow.
  60         void startMove( TopWindow &rWindow );
  61
  62         /// Tell the window manager that the current move ended.
  63         void stopMove();
  64
  65         /// Move the pWindow window to (left, top), and move all its
  66         /// anchored windows.
  67         /// If a new anchoring is detected, the windows will move accordingly.
  68         void move( TopWindow &rWindow, int left, int top ) const;
  69
  70         /// Raise all the registered windows
  71         void raiseAll() const;
  72
  73         /// Show all the registered windows
  74         void showAll() const;
  75
  76         /// Hide all the registered windows
  77         void hideAll() const;
  78
  79         /// Synchronize the windows with their visibility variable
  80         void synchVisibility() const;
  81
  82         /// Raise the given window
  83         void raise( TopWindow &rWindow ) const { rWindow.raise(); }
  84
  85         /// Show the given window
  86         void show( TopWindow &rWindow ) const { rWindow.show(); }
  87
  88         /// Hide the given window
  89         void hide( TopWindow &rWindow ) const { rWindow.hide(); }
  90
  91         /// Toggle all the windows on top
  92         void toggleOnTop();
  93
  94         /// Set the magnetism of screen edges
  95         void setMagnetValue( int magnet ) { m_magnet = magnet; }
  96
  97         /// Set the alpha value of the static windows
  98         void setAlphaValue( int alpha ) { m_alpha = alpha; }
  99
 100         /// Set the alpha value of the moving windows
 101         void setMoveAlphaValue( int moveAlpha ) { m_moveAlpha = moveAlpha; }
 102
 103         /// Create the tooltip window
 104         void createTooltip( const GenericFont &rTipFont );
 105
 106         /// Show the tooltip window
 107         void showTooltip();
 108
 109         /// Hide the tooltip window
 110         void hideTooltip();
 111
 112         /// Add a layout of the given window. This new layout will be the
 113         /// active one.
 114         void addLayout( TopWindow &rWindow, GenericLayout &rLayout );
 115
 116         /// Change the active layout of the given window
 117         void setActiveLayout( TopWindow &rWindow, GenericLayout &rLayout );
 118
 119     private:
 120         /// Some useful typedefs for lazy people like me
 121         typedef set<TopWindow*> WinSet_t;
 122         typedef list<Anchor*> AncList_t;
 123
 124         /// This map represents the graph of anchored windows: it associates
 125         /// to a given window all the windows that are directly anchored by it.
 126         /// This is not transitive, i.e. if a is in m_dep[b] and if b is in
 127         /// m_dep[c], it doesn't mean that a is in m_dep[c] (in fact, it
 128         /// would be extremely rare...)
 129         map<TopWindow*, WinSet_t> m_dependencies;
 130         /// Store all the windows
 131         WinSet_t m_allWindows;
 132         /// Store the moving windows; this set is updated at every start of
 133         /// move.
 134         WinSet_t m_movingWindows;
 135         /// Indicate whether the windows are currently on top
 136         VariablePtr m_cVarOnTop;
 137         /// Magnetism of the screen edges (= scope of action)
 138         int m_magnet;
 139         /// Alpha value of the static windows
 140         int m_alpha;
 141         /// Alpha value of the moving windows
 142         int m_moveAlpha;
 143         /// Tooltip
 144         Tooltip *m_pTooltip;
 145
 146         /// Recursively build a set of windows anchored to the one given.
 147         void buildDependSet( WinSet_t &rWinSet, TopWindow *pWindow );
 148
 149         /// Check anchoring: this function updates xOffset and yOffset,
 150         /// to take care of a new anchoring (if any)
 151         void checkAnchors( TopWindow *pWindow,
 152                            int &xOffset, int &yOffset ) const;
 153 };
 154
 155
 156 #endif