IControlRoot.hpp

Go to the documentation of this file.

#ifndef __IControlRoot__
#define __IControlRoot__

#include <Basics/CSystemString.hpp>
#include <Basics/CCountedObject.hpp>
#include <MathTools/CDimension.hpp>
#include "../Windowing/IWindow.hpp"
#include "../Graphics/IImage.hpp"
#include "../Graphics/CGraphics.hpp"
#include "../Listeners/IDropFileListener.hpp"
#include "../Listeners/IMouseListener.hpp"
#include "../Listeners/IKeyboardListener.hpp"

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

using Exponent::Basics::CSystemString;
using Exponent::MathTools::CDimension;
using Exponent::GUI::Windowing::IWindow;
using Exponent::GUI::Graphics::IImage;
using Exponent::GUI::Graphics::CGraphics;
using Exponent::Basics::CCountedObject;
using Exponent::GUI::Listeners::IDropFileListener;
using Exponent::GUI::Listeners::IKeyboardListener;
using Exponent::GUI::Listeners::IMouseListener;

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

#ifndef __ICONTROL_GUARD__
#define __ICONTROL_GUARD__
    namespace Exponent { namespace GUI { namespace Controls { interface IControl; } } }
    using Exponent::GUI::Controls::IControl;
#endif

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

namespace Exponent
{
    namespace GUI
    {
        namespace Controls
        {
            interface IControlRoot : public IMouseListener, public IDropFileListener, public IKeyboardListener
            {
            public:

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

                enum EControlRootSerialiseOption
                {
                    e_serialiseToDisk = 0,      
                    e_serialiseFromDisk         
                };

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

                IControlRoot() { }

                virtual ~IControlRoot() { }

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

                virtual void lockControl(IControl *control) = 0;

                virtual void unlockControl() = 0;

                virtual bool controlIsLocked() const = 0;

                virtual IControl *getLockedControl() const = 0;

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

                virtual void setParentWindow(IWindow *parent) = 0;

                virtual IWindow *getParentWindow() const = 0;

                virtual CPoint getWindowOffset() = 0;

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

                virtual IControl *getControlAtPoint(const CPoint &point) = 0;

                virtual IControl *getMouseEnabledControlAtPoint(const CPoint &point) = 0;

                virtual IControl *getDropEnabledControlAtPoint(const CPoint &point) = 0;

                virtual IControl *getKeyEnabledControlAtPoint(const CPoint &point) = 0;

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

                virtual void addControl(IControl *control) = 0;

                virtual void removeControl(IControl *control) = 0;

                virtual void clearControls() = 0;

                virtual IControl *getControlAtIndex(const long index, bool isIndex) = 0;

                virtual long getControlIndex(IControl *control) = 0;

                virtual long getNumberOfControls() = 0;

                virtual long getNumberOfInsertedControls() = 0;

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

                virtual void drawRootControl(CGraphics &graphics) = 0;

                virtual void updateControl(IControl *control) = 0;

                virtual void updateControl(const long index, bool isIndex) = 0;

                virtual void updateArea(const CRect &area) = 0;

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

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

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

                virtual void setBackgroundImage(IImage *image) = 0;

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

                virtual void startToolTipTimer() = 0;

                virtual void stopToolTipTimer()  = 0;

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

                // Save or load a layout of this panel..
                //virtual void serialise(const EControlRootSerialiseOption option);

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

            };
        }
    }
}
#endif  // End of IControlRoot.hpp

---