Ocean
ApplicationWindow.h
Go to the documentation of this file.
1
/*
2
* Copyright (c) Meta Platforms, Inc. and affiliates.
3
*
4
* This source code is licensed under the MIT license found in the
5
* LICENSE file in the root directory of this source tree.
6
*/
7
8
#ifndef META_OCEAN_PLATFORM_WIN_APPLICATION_WINDOW_H
9
#define META_OCEAN_PLATFORM_WIN_APPLICATION_WINDOW_H
10
11
#include "
ocean/platform/win/Win.h
"
12
#include "
ocean/platform/win/Window.h
"
13
14
#include <string>
15
16
namespace
Ocean
17
{
18
19
namespace
Platform
20
{
21
22
namespace
Win
23
{
24
25
/**
26
* This class implements an application window.
27
* @ingroup platformwin
28
*/
29
class
OCEAN_PLATFORM_WIN_EXPORT
ApplicationWindow
:
virtual
public
Window
30
{
31
public
:
32
33
/**
34
* Creates a new application window.
35
* @param instance Application instance
36
* @param name The name of the application window
37
*/
38
ApplicationWindow
(HINSTANCE instance,
const
std::wstring& name);
39
40
/**
41
* Destructs the application window.
42
*/
43
~ApplicationWindow
()
override
;
44
45
/**
46
* Starts the application.
47
*/
48
int
start
();
49
50
/**
51
* Closes the application explicitly.
52
*/
53
void
close
();
54
55
protected
:
56
57
/**
58
* Function for a destroy event.
59
*/
60
void
onDestroy
()
override
;
61
62
private
:
63
64
/// State determining whether the application is about to be closed.
65
bool
applicationAboutToClosed_ =
false
;
66
};
67
68
}
69
70
}
71
72
}
73
74
#endif
// META_OCEAN_PLATFORM_WIN_APPLICATION_WINDOW_H
Win.h
Window.h
Ocean::Platform::Win::ApplicationWindow
This class implements an application window.
Definition:
ApplicationWindow.h:30
Ocean::Platform::Win::ApplicationWindow::~ApplicationWindow
~ApplicationWindow() override
Destructs the application window.
Ocean::Platform::Win::ApplicationWindow::ApplicationWindow
ApplicationWindow(HINSTANCE instance, const std::wstring &name)
Creates a new application window.
Ocean::Platform::Win::ApplicationWindow::close
void close()
Closes the application explicitly.
Ocean::Platform::Win::ApplicationWindow::start
int start()
Starts the application.
Ocean::Platform::Win::ApplicationWindow::onDestroy
void onDestroy() override
Function for a destroy event.
Ocean::Platform::Win::Window
This class is the base class for all windows.
Definition:
Window.h:31
Ocean
The namespace covering the entire Ocean framework.
Definition:
Accessor.h:15
impl
ocean
platform
win
ApplicationWindow.h
Generated on Wed Nov 13 2024 18:48:16 for Ocean by
1.9.1