display_window_description.h

/*
**  UICore
**  Copyright (c) 1997-2015 The UICore 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 UICore may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Magnus Norddahl
**    Harry Storbacka
**    Kenneth Gangstoe
*/

#pragma once

#include <memory>

namespace uicore
{
    class Sizef;
    class Rectf;
    class DisplayWindow;
    typedef std::shared_ptr<DisplayWindow> DisplayWindowPtr;
    class DisplayWindowDescription_Impl;
    struct DisplayWindowHandle;

    class DisplayWindowDescription
    {
    public:
        DisplayWindowDescription();

        DisplayWindowDescription(const std::string &title);

        DisplayWindowDescription(const std::string &title, const Rectf &position, bool client_area);

        DisplayWindowDescription(const std::string &title, const Sizef &size, bool client_area);

        DisplayWindowDescription(const Rectf &position, bool client_area);

        DisplayWindowDescription(const DisplayWindowDescription &copy);

        ~DisplayWindowDescription();

        const std::string &title() const;

        Sizef size() const;

        Rectf position() const;

        bool position_client_area() const;

        bool is_fullscreen() const;

        int flipping_buffers() const;

        int swap_interval() const;

        bool allow_resize() const;

        bool allow_alt_enter() const;

        int bpp() const;

        int refresh_rate() const;

        bool is_layered() const;

        DisplayWindowHandle handle() const;

        bool has_caption() const;

        bool has_sysmenu() const;

        bool has_minimize_button() const;

        bool has_maximize_button() const;

        bool is_visible() const;

        bool is_topmost() const;

        bool has_no_activate() const;

        bool has_drop_shadow() const;

        DisplayWindowPtr owner() const;

        int depth_size() const;

        int stencil_size() const;

        int fullscreen_monitor() const;

        bool allow_screensaver() const;

        bool is_update_supported() const;

        int multisampling() const;

        bool is_main() const;

        bool is_dialog() const;

        bool is_popup() const;

        DisplayWindowDescription &operator =(const DisplayWindowDescription &copy);

        void set_main_window();

        void set_dialog_window();

        void set_popup_window();

        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 set_visible(bool value = true);

        void set_topmost(bool value = true);

        void set_no_activate(bool value = true);

        void set_drop_shadow(bool value = true);

        void set_owner_window(const DisplayWindowPtr &owner);

        void set_title(const std::string &title);

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

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

        void set_fullscreen(bool fullscreen = true, int monitor = 0);

        void set_flipping_buffers(int num_buffers = 2);

        void set_swap_interval(int interval = -1);

        void set_allow_resize(bool allow_resize = true);

        void set_allow_alt_enter(bool value = true);

        void set_bpp(int bpp);

        void set_refresh_rate(int refresh_rate);

        void set_layered(bool layered);

        void set_allow_screensaver(bool allow_screensaver = true);

        void set_handle(DisplayWindowHandle handle);


        void set_depth_size(int value);


        void set_stencil_size(int value);

        void set_update_supported(bool value) const;

        void set_multisampling(int value);

    private:
        std::unique_ptr<DisplayWindowDescription_Impl> impl;
    };
}