display_window_description.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/Text/string_types.h"
#include "../../Core/System/sharedptr.h"

class CL_Size;
class CL_Rect;
class CL_DisplayWindow;
class CL_DisplayWindowDescription_Impl;

class CL_API_DISPLAY CL_DisplayWindowDescription
{
public:
        CL_DisplayWindowDescription();

        CL_DisplayWindowDescription(const CL_String &title);

        CL_DisplayWindowDescription(const CL_String &title, const CL_Rect &position, bool client_area);

        CL_DisplayWindowDescription(const CL_Rect &position, bool client_area);

        CL_DisplayWindowDescription(const CL_DisplayWindowDescription &copy);

        virtual ~CL_DisplayWindowDescription();

public:
        const CL_String &get_title() const;

        bool get_decorations() const;

        CL_Size get_size() const;

        CL_Rect get_position() const;

        bool get_position_client_area() const;

        bool is_fullscreen() const;

        int get_flipping_buffers() const;

        bool get_allow_resize() const;

        int get_bpp() const;


        int get_refresh_rate() const;

        bool is_layered() const;

#ifdef WIN32

        HWND get_handle() const;
#endif

        bool has_caption() const;

        bool has_sysmenu() const;

        bool has_minimize_button() const;

        bool has_maximize_button() const;

        bool has_border() const;

        bool is_tool_window() const;

        bool is_visible() const;

        bool is_topmost() const;


        bool get_using_gui_window_cache() const;

        bool has_drop_shadow() const;

        CL_DisplayWindow get_owner() const;

        bool get_tablet_context() const;

        CL_UnknownSharedPtr get_data(const CL_String &data_name) const;

        int get_depth_size() const;

        int get_stencil_size() const;

public:
        CL_DisplayWindowDescription &operator =(const CL_DisplayWindowDescription &copy);

        void show_caption(bool value = true);

        void show_sysmenu(bool value = true);

        void show_minimize_button(bool value = true);

        void show_maximize_button(bool value = true);

        void show_border(bool value = true);

        void set_decorations(bool decorations);

        void set_visible(bool value = true);

        void set_topmost(bool value = true);

        void set_tool_window(bool value = true);

        void set_drop_shadow(bool value = true);

        void set_owner_window(const CL_DisplayWindow &owner);

        void set_title(const CL_String &title);

        void set_size(const CL_Size &size, bool client_area);

        void set_position(const CL_Rect &position, bool client_area);

        void set_fullscreen(bool fullscreen = true);

        void set_flipping_buffers(int num_buffers = 2);

        void set_allow_resize(bool allow_resize);

        void set_bpp(int bpp);


        void set_refresh_rate(int refresh_rate);

        void set_tablet_context(bool create);


        void set_using_gui_window_cache(bool value);

        void set_layered(bool layered);

#ifdef WIN32

        void set_handle(HWND handle);
#endif

        void set_data(const CL_String &data_name, const CL_UnknownSharedPtr &ptr);


        void set_depth_size(int value);


        void set_stencil_size(int value);

private:
        CL_SharedPtr<CL_DisplayWindowDescription_Impl> impl;
};

---