summaryrefslogtreecommitdiff
path: root/plugingui/nativewindow.h
blob: 33e0ca8e2354a62fbcf20d9cd186bcd5fa0601bf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/***************************************************************************
 *            nativewindow.h
 *
 *  Fri Dec 28 18:46:01 CET 2012
 *  Copyright 2012 Bent Bisballe Nyeng
 *  deva@aasimon.org
 ****************************************************************************/

/*
 *  This file is part of DrumGizmo.
 *
 *  DrumGizmo is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  DrumGizmo is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with DrumGizmo; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.
 */
#pragma once

#include <string>

#include "guievent.h"

namespace GUI {

//! \brief Interface class for native window implementations.
class NativeWindow {
public:
	NativeWindow() {}
	virtual ~NativeWindow() {}

	//! \brief Set a fixed size to the window.
	//! It resizes the window and disallows user resizing.
	virtual void setFixedSize(int width, int height) = 0;

	// TODO: setScalable(bool) ??

	//! \brief Set a new size of the window.
	virtual void resize(int width, int height) = 0;

	//! \brief Move the window to a new position.
	virtual void move(int x, int y) = 0;

	//! \brief Show the window if it is hidden.
	virtual void show() = 0;

	//! \brief Hides the window.
	virtual void hide() = 0;

	//! \brief Sets the window caption in the title bar (if it has one).
	virtual void setCaption(const std::string &caption) = 0;

	//! \brief Recreate a window render buffer based on the internal buffer.
	//! This need to be called whenever the internal buffer size has changed.
	virtual void handleBuffer() = 0;

	//! \brief Draw the internal rendering buffer to the window buffer.
	virtual void redraw() = 0;

	//! \brief Toggle capture mouse mode.
	virtual void grabMouse(bool grab) = 0;

	//! \brief Query if the event queue contains any events.
	virtual bool hasEvent() = 0;

	//! \brief Read a single event from the event queue.
	//! \return A pointer to the event or nullptr is none exists.
	virtual Event *getNextEvent() = 0;

	//! \brief Read next event without popping it from the event queue.
	//! \return A pointer to the event or nullptr is none exists.
	virtual Event* peekNextEvent() = 0;
};

} // GUI::