window_view.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2015 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 */
28
29 #pragma once
30
31 #include "../View/root_view.h"
32 #include "../../Display/Window/display_window.h"
33 #include "../../Display/Window/keys.h"
34
35 namespace clan
36 {
37 enum class WindowShowType
38 {
39 hide,
40 show,
41 show_no_activate,
42 normal,
43 maximized,
44 minimized,
45 maximize,
46 minimize,
47 minimize_no_activate,
48 restore,
49 show_default
50 };
51
52 class InputEvent;
53 class WindowView_Impl;
54
55 class WindowView : public RootView
56 {
57 public:
58 WindowView(const DisplayWindowDescription &desc);
59
60 void show(WindowShowType type = WindowShowType::show);
61 void hide();
62
63 DisplayWindow get_display_window();
64
65 protected:
66 bool root_hidden() const override;
67 void set_root_hidden(bool value) override;
68
69 Canvas get_root_canvas() const override;
70
71 void set_root_needs_render() override;
72 void layout_local() override;
73
74 Pointf root_to_screen_pos(const Pointf &pos) override;
75 Pointf root_from_screen_pos(const Pointf &pos) override;
76
77 private:
78 std::shared_ptr<WindowView_Impl> impl;
79
80 friend class WindowView_Impl;
81 };
82 }
clan::WindowShowType::hide
clan::WindowView::root_from_screen_pos
Pointf root_from_screen_pos(const Pointf &pos) override
Map from screen to local content coordinates.
clan
Definition: clanapp.h:35
clan::WindowShowType::show
clan::Canvas
2D Graphics Canvas
Definition: canvas.h:72
clan::WindowView
Definition: window_view.h:55
clan::WindowView::get_display_window
DisplayWindow get_display_window()
clan::WindowShowType::maximized
clan::WindowShowType::minimized
clan::WindowView::hide
void hide()
clan::WindowShowType::restore
clan::WindowView::WindowView
WindowView(const DisplayWindowDescription &desc)
clan::WindowShowType::normal
clan::WindowView::show
void show(WindowShowType type=WindowShowType::show)
clan::WindowShowType::show_default
clan::WindowView::get_root_canvas
Canvas get_root_canvas() const override
clan::WindowView::root_hidden
bool root_hidden() const override
Test if view is set to hidden.
clan::WindowShowType::maximize
clan::WindowShowType::show_no_activate
clan::WindowView::layout_local
void layout_local() override
Layout local root.
clan::WindowShowType
WindowShowType
Definition: window_view.h:37
clan::WindowView::root_to_screen_pos
Pointf root_to_screen_pos(const Pointf &pos) override
Map from local content to screen coordinates.
clan::WindowShowType::minimize_no_activate
clan::WindowView::set_root_needs_render
void set_root_needs_render() override
Signals this view needs to be rendered again.
clan::DisplayWindowDescription
Display window description class.
Definition: display_window_description.h:62
clan::WindowShowType::minimize
clan::RootView
Base class for views participating as a root view in the user interface.
Definition: root_view.h:37
clan::WindowView::WindowView_Impl
friend class WindowView_Impl
Definition: window_view.h:80
clan::Pointf
2D (x,y) point structure - Float
Definition: point.h:72
clan::DisplayWindow
Top-level window class.
Definition: display_window.h:101
clan::WindowView::set_root_hidden
void set_root_hidden(bool value) override
Hides a view from layout and rendering.