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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
25 #ifndef CTRL_GENERIC_HPP
26 #define CTRL_GENERIC_HPP
28 #include "../src/skin_common.hpp"
29 #include "../utils/pointer.hpp"
30 #include "../utils/ustring.hpp"
31 #include "../utils/observer.hpp"
32 #include "../commands/cmd_generic.hpp"
43 /// Base class for controls
44 class CtrlGeneric: public SkinObject, public Observer<VarBool, void*>
47 virtual ~CtrlGeneric();
49 /// Handle an event on the control
50 virtual void handleEvent( EvtGeneric &rEvent ) {}
52 /// Check whether coordinates are inside the control
53 virtual bool mouseOver( int x, int y ) const { return false; }
55 /// Draw the control on the given graphics
56 virtual void draw( OSGraphics &rImage, int xDest, int yDest ) {}
58 /// Set the position and the associated layout of the control
59 virtual void setLayout( GenericLayout *pLayout,
60 const Position &rPosition );
62 /// Get the position of the control in the layout, if any
63 virtual const Position *getPosition() const { return m_pPosition; }
65 /// Get the text of the tooltip
66 virtual UString getTooltipText() const
67 { return UString( getIntf(), "" ); }
69 /// Overload this method if you want to do something special when
70 /// the layout is resized
71 virtual void onResize() {}
74 virtual const UString &getHelpText() const { return m_help; }
76 /// Return true if the control can gain the focus
77 virtual bool isFocusable() const { return false; }
79 /// Return true if the control is visible
80 virtual bool isVisible() const;
82 /// Get the type of control (custom RTTI)
83 virtual string getType() const { return ""; }
86 // If pVisible is NULL, the control is always visible
87 CtrlGeneric( intf_thread_t *pIntf, const UString &rHelp,
88 VarBool *pVisible = NULL );
90 /// Tell the layout when the image has changed, with the size of the
91 /// rectangle to repaint and its offset.
92 /// Use the default values to repaint the whole window
93 virtual void notifyLayout( int witdh = -1, int height = -1,
94 int xOffSet = 0, int yOffSet = 0 ) const;
96 /// Same as notifyLayout(), but takes optional images as parameters.
97 /// The maximum size(s) of the images will be used for repainting.
98 void notifyLayoutMaxSize( const Box *pImg1 = NULL,
99 const Box *pImg2 = NULL );
101 /// Ask the layout to capture the mouse
102 virtual void captureMouse() const;
104 /// Ask the layout to release the mouse
105 virtual void releaseMouse() const;
107 /// Notify the window the tooltip has changed
108 virtual void notifyTooltipChange() const;
110 /// Get the associated window, if any
111 virtual TopWindow *getWindow() const;
113 /// Overload this method if you want to do something special when
114 /// the Position object is set
115 virtual void onPositionChange() {}
117 /// Overload this method to get notified of bool variable changes
118 virtual void onVarBoolUpdate( VarBool &rVar ) {}
121 /// Associated layout
122 GenericLayout *m_pLayout;
123 /// Position in the layout
124 Position *m_pPosition;
127 /// Visibilty variable
130 /// Method called when an observed bool variable is changed
131 virtual void onUpdate( Subject<VarBool, void*> &rVariable , void* );
134 typedef CountedPtr<CtrlGeneric> CtrlGenericPtr;