gui_window_manager.h

Go to the documentation of this file.

/*
**  ClanLib SDK
**  Copyright (c) 1997-2009 The ClanLib Team
**
**  This software is provided 'as-is', without any express or implied
**  warranty.  In no event will the authors be held liable for any damages
**  arising from the use of this software.
**
**  Permission is granted to anyone to use this software for any purpose,
**  including commercial applications, and to alter it and redistribute it
**  freely, subject to the following restrictions:
**
**  1. The origin of this software must not be misrepresented; you must not
**     claim that you wrote the original software. If you use this software
**     in a product, an acknowledgment in the product documentation would be
**     appreciated but is not required.
**  2. Altered source versions must be plainly marked as such, and must not be
**     misrepresented as being the original software.
**  3. This notice may not be removed or altered from any source distribution.
**
**  Note: Some of the libraries ClanLib may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Magnus Norddahl
**    Harry Storbacka
**    Mark Page
*/


#pragma once

#include "api_gui.h"
#include "gui_component.h"
#include "../Core/Signals/signal_v1.h"
#include "../Core/Signals/signal_v2.h"
#include "../Core/Signals/signal_v3.h"
#include <vector>

class CL_GraphicContext;
class CL_InputEvent;
class CL_InputState;
class CL_Cursor;
class CL_DisplayWindow;
class CL_GUITopLevelWindow;
class CL_GUIWindowManagerProvider;
class CL_GUIWindowManager_Impl;

class CL_API_DISPLAY CL_GUIWindowManagerSite
{

public:
        CL_Callback_v1<CL_GUITopLevelWindow *> *func_focus_lost;

        CL_Callback_v1<CL_GUITopLevelWindow *> *func_focus_gained;

        CL_Callback_v2<CL_GUITopLevelWindow *, const CL_Size &> *func_resize;

        CL_Callback_v2<CL_GUITopLevelWindow *, const CL_Rect &> *func_paint;

        CL_Callback_v1<CL_GUITopLevelWindow *> *func_close;

        CL_Callback_v3<CL_GUITopLevelWindow *, const CL_InputEvent &, const CL_InputState &> *func_input_received;
};

class CL_API_GUI CL_GUIWindowManager
{

public:
        enum CL_WindowManagerType
        {
                cl_wm_type_system,
                cl_wm_type_texture
        };

public:
        CL_GUIWindowManager(CL_GUIWindowManagerProvider *provider);

        CL_GUIWindowManager(const CL_GUIWindowManager &copy);

        ~CL_GUIWindowManager();


public:

        bool is_null();

        CL_GUIWindowManagerProvider *get_provider() const;

        CL_WindowManagerType get_window_manager_type() const;

public:

        void set_site(CL_GUIWindowManagerSite *site);
        void create_window(
                CL_GUITopLevelWindow *handle,
                CL_GUITopLevelWindow *owner,
                CL_GUITopLevelDescription description);

        void destroy_window(CL_GUITopLevelWindow *handle);

        void enable_window(CL_GUITopLevelWindow *handle, bool enable);

        bool has_focus(CL_GUITopLevelWindow *handle) const;

        void set_visible(CL_GUITopLevelWindow *handle, bool visible, bool activate_root_win);

        void set_geometry(CL_GUITopLevelWindow *handle, const CL_Rect &geometry, bool client_area);

        CL_Rect get_geometry(CL_GUITopLevelWindow *handle, bool client_area) const;

        CL_Point screen_to_window(CL_GUITopLevelWindow *handle, const CL_Point &screen_point, bool client_area) const;

        CL_Point window_to_screen(CL_GUITopLevelWindow *handle, const CL_Point &window_point, bool client_area) const;

        CL_GraphicContext& get_gc(CL_GUITopLevelWindow *handle) const;

        CL_InputContext& get_ic(CL_GUITopLevelWindow *handle) const;

        CL_GraphicContext begin_paint(CL_GUITopLevelWindow *handle, const CL_Rect &update_region);

        void set_cliprect(CL_GUITopLevelWindow *handle, CL_GraphicContext &gc, const CL_Rect &rect);

        void reset_cliprect(CL_GUITopLevelWindow *handle, CL_GraphicContext &gc);

        void push_cliprect(CL_GUITopLevelWindow *handle, CL_GraphicContext &gc, const CL_Rect &rect);

        void pop_cliprect(CL_GUITopLevelWindow *handle, CL_GraphicContext &gc);

        void end_paint(CL_GUITopLevelWindow *handle, const CL_Rect &update_region);

        void request_repaint(CL_GUITopLevelWindow *handle, const CL_Rect &update_region);

        void bring_to_front(CL_GUITopLevelWindow *handle);

        bool is_minimized(CL_GUITopLevelWindow *handle) const;

        bool is_maximized(CL_GUITopLevelWindow *handle) const;

        void process_message();

        void capture_mouse(CL_GUITopLevelWindow *handle, bool state);

        CL_DisplayWindow get_display_window(CL_GUITopLevelWindow *handle) const;

        void set_cursor(CL_GUITopLevelWindow *handle, const CL_Cursor &cursor);

        void set_cursor(CL_GUITopLevelWindow *handle, enum CL_StandardCursor type);

        void update();

        void setup_painting();

        void complete_painting();


private:
        CL_SharedPtr<CL_GUIWindowManager_Impl> impl;
};

---