-
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathconsole_window.html
More file actions
147 lines (143 loc) · 7.57 KB
/
console_window.html
File metadata and controls
147 lines (143 loc) · 7.57 KB
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-C2YXLNQ21C"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag() { dataLayer.push(arguments); }
gtag('js', new Date());
gtag('config', 'G-C2YXLNQ21C');
</script>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
<title>libtcod documentation | Communicate with the window manager</title>
<script type="text/javascript" src="../js/doctcod.js"></script>
<link href="../css/style.css" rel="stylesheet" type="text/css">
</head>
<link type="text/css" rel="stylesheet" href="../css/shCore.css">
</link>
<link type="text/css" rel="stylesheet" href="../css/shThemeDefault.css">
</link>
<script language="javascript" src="../js/shCore.js"></script>
<script language="javascript" src="../js/shBrushBash.js"></script>
<body>
<div class="header">
<p><span class="title1">libtcod</span><span class="title2">documentation</span></p>
</div>
<div class="breadcrumb">
<div class="breadcrumbtext">
<p>
you are here: <a onclick="link('../index2.html')">Index</a> > <a onclick="link('console.html')">2.
Console</a> > <a onclick="link('console_init.html')">2.1. Initializing the console</a> > <a
onclick="link('console_window.html')">2.1.5. Communicate with the window manager</a><br>
<a class="prev" onclick="link('console_fullscreen.html')">2.1.4. Fullscreen mode</a> | <a class="next"
onclick="link('console_credits.html')">2.1.6. libtcod's credits</a>
</p>
</div>
</div>
<div class="filter"><input type="checkbox" id="chk_c" name="chk_c" onchange="enable('c',this.checked)"
checked='checked'><label for='chk_c'> C </label><input type="checkbox" id="chk_cpp" name="chk_cpp"
onchange="enable('cpp',this.checked)" checked='checked'><label for='chk_cpp'> C++ </label><input type="checkbox"
id="chk_py" name="chk_py" onchange="enable('py',this.checked)" checked='checked'><label for='chk_py'> Py
</label><input type="checkbox" id="chk_lua" name="chk_lua" onchange="enable('lua',this.checked)"
disabled='disabled'><label class='disabled' for='chk_lua'> Lua </label><input type="checkbox" id="chk_cs"
name="chk_cs" onchange="enable('cs',this.checked)" disabled='disabled'><label class='disabled' for='chk_cs'> C#
</label></div>
<div class="main">
<div class="maintext">
<h1>2.1.5. Communicate with the window manager</h1>
<div id="toc">
<ul>
<li><a href="#0">Changing the window title</a></li>
<li><a href="#1">Handling "close window" events</a></li>
<li><a href="#2">Check if the mouse cursor is inside the game window</a></li>
<li><a href="#3">Check if the game application is active</a></li>
</ul>
</div>
<a name="0"></a>
<h3>Changing the window title</h3>
<p>This function dynamically changes the title of the game window.<br /> Note that the window title is not visible
while in fullscreen.<br /> </p>
<div class="code">
<p class="cpp"><span class="code-keyword">static</span><span class="code-keyword"> void</span> TCODConsole<span
class="code-symbol">::</span>setWindowTitle<span class="code-symbol">(</span><span
class="code-keyword">const</span><span class="code-keyword"> char</span><span class="code-symbol">
*</span>title<span class="code-symbol">)</span></p>
<p class="c"><span class="code-keyword">void</span> TCOD_console_set_window_title<span
class="code-symbol">(</span><span class="code-keyword">const</span><span class="code-keyword">
char</span><span class="code-symbol"> *</span>title<span class="code-symbol">)</span></p>
<p class="py">console_set_window_title<span class="code-symbol">(</span>title<span class="code-symbol">)</span>
</p>
</div>
<table class="param">
<tbody>
<tr>
<th>Parameter</th>
<th>Description</th>
</tr>
<tr class="hilite">
<td>title</td>
<td>New title of the game window<br /> </td>
</tr>
</tbody>
</table><a name="1"></a>
<h3>Handling "close window" events</h3>
<p>When you start the program, this returns false. Once a "close window" event has been sent by the window
manager, it will always return true. You're supposed to exit cleanly the game.<br /> </p>
<div class="code">
<p class="cpp"><span class="code-keyword">static</span><span class="code-keyword"> bool</span> TCODConsole<span
class="code-symbol">::</span>isWindowClosed<span class="code-symbol">(</span><span
class="code-symbol">)</span></p>
<p class="c"><span class="code-keyword">bool</span> TCOD_console_is_window_closed<span
class="code-symbol">(</span><span class="code-symbol">)</span></p>
<p class="py">console_is_window_closed<span class="code-symbol">(</span><span class="code-symbol">)</span></p>
</div>
<a name="2"></a>
<h3>Check if the mouse cursor is inside the game window</h3>
<p>Returns true if the mouse cursor is inside the game window area and the game window is the active
application.<br /> </p>
<div class="code">
<p class="cpp"><span class="code-keyword">static</span><span class="code-keyword"> bool</span> TCODConsole<span
class="code-symbol">::</span>hasMouseFocus<span class="code-symbol">(</span><span
class="code-symbol">)</span></p>
<p class="c"><span class="code-keyword">bool</span> TCOD_console_has_mouse_focus<span
class="code-symbol">(</span><span class="code-symbol">)</span></p>
<p class="py">console_has_mouse_focus<span class="code-symbol">(</span><span class="code-symbol">)</span></p>
</div>
<a name="3"></a>
<h3>Check if the game application is active</h3>
<p>Returns false if the game window is not the active window or is iconified.<br /> </p>
<div class="code">
<p class="cpp"><span class="code-keyword">static</span><span class="code-keyword"> bool</span> TCODConsole<span
class="code-symbol">::</span>isActive<span class="code-symbol">(</span><span class="code-symbol">)</span>
</p>
<p class="c"><span class="code-keyword">bool</span> TCOD_console_is_active<span
class="code-symbol">(</span><span class="code-symbol">)</span></p>
<p class="py">console_is_active<span class="code-symbol">(</span><span class="code-symbol">)</span></p>
</div>
</div>
</div>
<div class="footer">
<div class="footertext">
<p>libtcod 1.6.4, © 2008, 2009, 2010, 2012, 2017 Jice, Mingos & rmtew<br>
This file has been generated by doctcod.</p>
<p>
<table width='100%'>
<tr>
<td width="33%"><a href="https://github.com/libtcod/libtcod">libtcod website</a></td>
<td width="33%"><a href="https://www.reddit.com/r/roguelikedev">libtcod on /r/roguelikedev</a></td>
<td width="33%">libtcod tutorials [ <a
href="http://www.roguebasin.com/index.php?title=Complete_Roguelike_Tutorial,_using_python%2Blibtcod">Python</a> | <a
href="http://www.roguebasin.com/index.php?title=Complete_roguelike_tutorial_using_C%2B%2B_and_libtcod_-_part_1:_setting_up">C++</a> ]
</td>
</tr>
</table>
</p>
</div>
</div>
</body>
<script>
initFilter();
SyntaxHighlighter.all();
</script>
</html>