CControlPanel.hpp

Go to the documentation of this file.

#ifndef __CControlPanel__
#define __CControlPanel__

#include "CControlRoot.hpp"
#include "CControl.hpp"

//  ===========================================================================

using Exponent::GUI::Controls::CControlRoot;
using Exponent::GUI::Controls::CControl;

//  ===========================================================================

namespace Exponent
{
    namespace GUI
    {
        namespace Controls
        {
            class CControlPanel : public CControlRoot, public CControl
            {
                EXPONENT_CLASS_DECLARATION;
//  ===========================================================================
        
            public:

//  ===========================================================================

                CControlPanel(IWindow *parent, IControlRoot *root, const long uniqueId, const CRect &area, IActionListener *listener = NULL);

                virtual ~CControlPanel();

//  ===========================================================================

                virtual void addControl(IControl *control);

                virtual void lockControl(IControl *control);

                virtual void unlockControl();
                
                virtual CPoint getWindowOffset();

                virtual bool isContainer() const { return true; }

//  ===========================================================================

                virtual void getGlobalCoordinatesOfControl(IControl *control, CPoint &point);

                virtual void setArea(const CRect &area);

//  ===========================================================================

                virtual void drawRootControl(CGraphics &graphics);

//  ===========================================================================

                virtual void handleLeftButtonDown(CMouseEvent &event);

                virtual void handleLeftButtonUp(CMouseEvent &event);

                virtual void handleRightButtonDown(CMouseEvent &event);

                virtual void handleRightButtonUp(CMouseEvent &event);

                virtual void handleDoubleClick(CMouseEvent &event);

                virtual void handleMouseScroll(CMouseEvent &event);

                virtual void handleMouseMovement(CMouseEvent &event);

                virtual void handleMouseLeavingArea(CMouseEvent &event);

//  ===========================================================================

                virtual bool handleKeyDown(const CKeyboardEvent &event);
                
                virtual bool handleKeyUp(const CKeyboardEvent &event);

//  ===========================================================================

                virtual void handleFileDrop(const CDropEvent &event);

//  ===========================================================================

                virtual void setControlRoot(IControlRoot *controlRoot);

                virtual void drawControl(CGraphics &graphics);

                virtual void updateControl(IControl *control);

                virtual void updateArea(const CRect &area);
                
                virtual void enableControl() ;

                virtual void disableControl();

                virtual void onDrawDrawThePanelBounds(const bool draw = true) { m_drawPanelBounds = draw; }

                void shouldClip(const bool clip = true);

                virtual void setBoundsColour(const CAlphaColour &boundsColour) { m_boundsColour = boundsColour; }

//  ===========================================================================

                virtual void referenced()
                {
                    CControl::referenced();
                }

                virtual void dereference()
                {
                    CControl::dereference();
                }

//  ===========================================================================

                virtual void getWindowCoordinatesOfControl(IControl *control, CPoint &point);

//  ===========================================================================

            protected:

//  ===========================================================================

                virtual bool drawEnabledControl(CGraphics &graphics);

                void flushSizeChange();

//  ===========================================================================

                bool m_drawPanelBounds;                 
                CAlphaColour m_boundsColour;            
            };
        }
    }
}
#endif  // End of CControlPanel.hpp

---