display_window_provider.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
**    Kenneth Gangstoe
*/


#pragma once

#include "../api_display.h"
#include "../../Core/System/sharedptr.h"
#include "../../Core/System/weakptr.h"
#include "../../Core/Text/string_types.h"
#include "../../Core/Signals/signal_v0.h"
#include "../../Core/Signals/signal_v1.h"
#include "../../Core/Signals/signal_v2.h"
#include "../../Core/Signals/callback_v1.h"
#include "../Window/display_window.h"

class CL_Point;
class CL_DisplayWindowDescription;
class CL_GraphicContext;
class CL_InputContext;
class CL_CursorProvider;
class CL_PixelBufferRef;
class CL_SpriteDescription;

class CL_API_DISPLAY CL_DisplayWindowSite
{
public:
        CL_Signal_v0 *sig_lost_focus;

        CL_Signal_v0 *sig_got_focus;

        CL_Signal_v2<int, int> *sig_resize;

        CL_Signal_v1<const CL_Rect &> *sig_paint;

        CL_Signal_v0 *sig_window_close;

        CL_Signal_v0 *sig_window_minimized;

        CL_Signal_v0 *sig_window_maximized;

        CL_Callback_v1<CL_Rect &> *func_window_resize;
};

class CL_API_DISPLAY CL_DisplayWindowProvider
{
public:
        virtual ~CL_DisplayWindowProvider() { return; }

public:
        virtual CL_Rect get_geometry() const = 0;

        virtual CL_Rect get_viewport() const = 0;

        virtual bool has_focus() const = 0;

        virtual bool is_minimized() const = 0;

        virtual bool is_maximized() const = 0;

        virtual bool is_visible() const = 0;

        virtual bool is_fullscreen() const = 0;

        virtual CL_GraphicContext& get_gc() = 0;

        virtual CL_InputContext& get_ic() = 0;

#ifdef WIN32

        virtual HWND get_hwnd() const = 0;
#endif

        virtual bool is_clipboard_text_available() const = 0;

        virtual bool is_clipboard_image_available() const = 0;

        virtual CL_String get_clipboard_text() const = 0;

        virtual CL_PixelBuffer get_clipboard_image() const = 0;

public:
        virtual CL_Point client_to_screen(const CL_Point &client) = 0;

        virtual CL_Point screen_to_client(const CL_Point &screen) = 0;

        virtual void capture_mouse(bool capture) = 0;

        virtual void request_repaint(const CL_Rect &rect) = 0;

        virtual void destroy() = 0;

        virtual void create(CL_DisplayWindowSite *site, const CL_DisplayWindowDescription &description) = 0;

        virtual void show_system_cursor() = 0;

        virtual CL_CursorProvider *create_cursor(const CL_SpriteDescription &sprite_description, const CL_Point &hotspot) = 0;

        virtual void set_cursor(CL_CursorProvider *cursor) = 0;

        virtual void set_cursor(enum CL_StandardCursor type) = 0;

        virtual void hide_system_cursor() = 0;

        virtual void set_title(const CL_StringRef &new_title) = 0;

        virtual void set_position(const CL_Rect &pos, bool client_area) = 0;

        virtual void set_size(int width, int height, bool client_area) = 0;

        virtual void set_minimum_size(int width, int height, bool client_area) = 0;

        virtual void set_maximum_size(int width, int height, bool client_area) = 0;

        virtual void set_enabled(bool enable) = 0;

        virtual void minimize() = 0;

        virtual void restore() = 0;

        virtual void maximize() = 0;

        virtual void show(bool activate) = 0;

        virtual void hide() = 0;

        virtual void bring_to_front() = 0;

        virtual void flip(int interval) = 0;

        virtual void update(const CL_Rect &rect) = 0;

        virtual void set_clipboard_text(const CL_StringRef &text) = 0;

        virtual void set_clipboard_image(const CL_PixelBuffer &buf) = 0;

        virtual void set_large_icon(const CL_PixelBuffer &image) = 0;

        virtual void set_small_icon(const CL_PixelBuffer &image) = 0;

private:
};

---