1 /*****************************************************************************
3 *****************************************************************************
4 * Copyright (C) 2003 the VideoLAN team
7 * Authors: Cyril Deguet <asmax@via.ecp.fr>
8 * Olivier Teulière <ipkiss@via.ecp.fr>
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.
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.
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 *****************************************************************************/
25 #ifndef GENERIC_WINDOW_HPP
26 #define GENERIC_WINDOW_HPP
28 #include "skin_common.hpp"
29 #include "../utils/var_bool.hpp"
43 /// Generic window class
44 class GenericWindow: public SkinObject, public Observer<VarBool>
47 friend class WindowManager;
49 GenericWindow( intf_thread_t *pIntf, int xPos, int yPos,
50 bool dragDrop, bool playOnDrop,
51 GenericWindow *pParent = NULL );
52 virtual ~GenericWindow();
54 /// Methods to process OS events.
55 virtual void processEvent( EvtFocus &rEvtFocus ) {}
56 virtual void processEvent( EvtMotion &rEvtMotion ) {}
57 virtual void processEvent( EvtMouse &rEvtMouse ) {}
58 virtual void processEvent( EvtLeave &rEvtLeave ) {}
59 virtual void processEvent( EvtKey &rEvtKey ) {}
60 virtual void processEvent( EvtScroll &rEvtScroll ) {}
62 virtual void processEvent( EvtRefresh &rEvtRefresh );
65 virtual void resize( int width, int height );
67 /// Refresh an area of the window
68 virtual void refresh( int left, int top, int width, int height ) {}
70 /// Get the coordinates of the window
71 int getLeft() const { return m_left; }
72 int getTop() const { return m_top; }
73 int getWidth() const { return m_width; }
74 int getHeight() const { return m_height; }
76 /// Give access to the visibility variable
77 VarBool &getVisibleVar() { return m_varVisible; }
79 /// Window type, mainly useful when overloaded (for VoutWindow)
80 virtual string getType() const { return "Generic"; }
84 OSWindow *getOSWindow() const { return m_pOsWindow; }
86 /// These methods do not need to be public since they are accessed
87 /// only by the window manager or by inheritant classes.
90 virtual void show() const;
93 virtual void hide() const;
96 virtual void move( int left, int top );
98 /// Bring the window on top
99 virtual void raise() const;
101 /// Set the opacity of the window (0 = transparent, 255 = opaque)
102 virtual void setOpacity( uint8_t value );
104 /// Toggle the window on top
105 virtual void toggleOnTop( bool onTop ) const;
108 /// Actually show the window
109 virtual void innerShow();
111 /// Actually hide the window
112 virtual void innerHide();
115 /// Window position and size
116 int m_left, m_top, m_width, m_height;
117 /// OS specific implementation
118 OSWindow *m_pOsWindow;
119 /// Variable for the visibility of the window
120 mutable VarBoolImpl m_varVisible;
122 /// Method called when the observed variable is modified
123 virtual void onUpdate( Subject<VarBool> &rVariable );