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 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 *****************************************************************************/
25 #ifndef GENERIC_LAYOUT_HPP
26 #define GENERIC_LAYOUT_HPP
28 #include "skin_common.hpp"
29 #include "top_window.hpp"
30 #include "../utils/pointer.hpp"
31 #include "../utils/position.hpp"
42 /// Control and its associated layer
45 LayeredControl( CtrlGeneric *pControl, int layer ):
46 m_pControl( pControl ), m_layer( layer ) { }
48 /// Pointer on the control
49 CtrlGeneric *m_pControl;
55 /// Base class for layouts
56 class GenericLayout: public SkinObject
59 GenericLayout( intf_thread_t *pIntf, int width, int height,
60 int minWidth, int maxWidth, int minHeight, int maxHeight );
62 virtual ~GenericLayout();
64 /// Attach the layout to a window
65 virtual void setWindow( TopWindow *pWindow );
67 /// Get the associated window, if any
68 virtual TopWindow *getWindow() const { return m_pWindow; }
70 /// Called by a control which wants to capture the mouse
71 virtual void onControlCapture( const CtrlGeneric &rCtrl );
73 /// Called by a control which wants to release the mouse
74 virtual void onControlRelease( const CtrlGeneric &rCtrl );
76 /// Refresh the window
77 virtual void refreshAll();
79 /// Refresh a rectangular portion of the window
80 virtual void refreshRect( int x, int y, int width, int height );
82 /// Get the image of the layout
83 virtual OSGraphics *getImage() const { return m_pImage; }
85 /// Get the position of the layout (relative to the screen)
87 * Note: These values are different from the m_rect.getLeft() and
88 * m_rect.getTop(), which always return 0.
89 * The latter methods are there as a "root rect" for the panels and
90 * controls, since each control knows its parent rect, but returns
91 * coordinates relative to the root rect.
93 virtual int getLeft() const { return m_pWindow->getLeft(); }
94 virtual int getTop() const { return m_pWindow->getTop(); }
96 /// Get the size of the layout
97 virtual int getWidth() const { return m_rect.getWidth(); }
98 virtual int getHeight() const { return m_rect.getHeight(); }
99 virtual const GenericRect &getRect() const { return m_rect; }
101 /// Get the minimum and maximum size of the layout
102 virtual int getMinWidth() const { return m_minWidth; }
103 virtual int getMaxWidth() const { return m_maxWidth; }
104 virtual int getMinHeight() const { return m_minHeight; }
105 virtual int getMaxHeight() const { return m_maxHeight; }
107 /// specific refresh window (if video controls)
108 virtual void computeRefresh( int x, int y, int width, int height );
110 /// Resize the layout
111 virtual void resize( int width, int height );
114 * Add a control in the layout at the given position, and
115 * the optional given layer
117 virtual void addControl( CtrlGeneric *pControl,
118 const Position &rPosition,
121 /// Get the list of the controls in this layout, by layer order
122 virtual const list<LayeredControl> &getControlList() const;
124 /// Called by a control when its image has changed
126 * The arguments indicate the size of the rectangle to refresh,
127 * and the offset (from the control position) of this rectangle.
128 * Use a negative width or height to refresh the layout completely
130 virtual void onControlUpdate( const CtrlGeneric &rCtrl,
131 int width, int height,
132 int xOffSet, int yOffSet );
134 /// Get the list of the anchors of this layout
135 virtual const list<Anchor*>& getAnchorList() const;
137 /// Add an anchor to this layout
138 virtual void addAnchor( Anchor *pAnchor );
140 /// Called when the layout is shown
141 virtual void onShow();
143 /// Called when the layout is hidden
144 virtual void onHide();
146 /// Give access to the "active layout" variable
147 // FIXME: we give read/write access
148 VarBoolImpl &getActiveVar() { return *m_pVarActive; }
151 /// Parent window of the layout
152 TopWindow *m_pWindow;
155 int m_minWidth, m_maxWidth;
156 int m_minHeight, m_maxHeight;
157 /// Image of the layout
158 OSGraphics *m_pImage;
159 /// List of the controls in the layout
160 list<LayeredControl> m_controlList;
162 set<CtrlVideo *> m_pVideoCtrlSet;
163 /// List of the anchors in the layout
164 list<Anchor*> m_anchorList;
165 /// Flag to know if the layout is visible
167 /// Variable for the "active state" of the layout
169 * Note: the layout is not an observer on this variable, because it
170 * cannot be changed externally (i.e. without an explicit change of
171 * layout). This way, we avoid using a setActiveLayoutInner method.
173 mutable VarBoolImpl *m_pVarActive;
177 typedef CountedPtr<GenericLayout> GenericLayoutPtr;