<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.4"/>
<title>ClanLib: accelerator_key.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ClanLib
 <span id="projectnumber">2.3.7</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.4 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_14852d208b69b5a1926f5d908b4903da.html">Sources</a></li><li class="navelem"><a class="el" href="dir_66cde9167ab84f7398e86467706d8b82.html">API</a></li><li class="navelem"><a class="el" href="dir_581c4848279b3493f1289a6380f599b2.html">GUI</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">accelerator_key.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="accelerator__key_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">** ClanLib SDK</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">** Copyright (c) 1997-2011 The ClanLib Team</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">**</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">** This software is provided 'as-is', without any express or implied</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">** warranty. In no event will the authors be held liable for any damages</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">** arising from the use of this software.</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">**</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">** Permission is granted to anyone to use this software for any purpose,</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">** including commercial applications, and to alter it and redistribute it</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">** freely, subject to the following restrictions:</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">**</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">** 1. The origin of this software must not be misrepresented; you must not</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">** claim that you wrote the original software. If you use this software</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">** in a product, an acknowledgment in the product documentation would be</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">** appreciated but is not required.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">** 2. Altered source versions must be plainly marked as such, and must not be</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">** misrepresented as being the original software.</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">** 3. This notice may not be removed or altered from any source distribution.</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">**</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">** Note: Some of the libraries ClanLib may link to may have additional</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">** requirements or restrictions.</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">**</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">** File Author(s):</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">**</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">** Harry Storbacka</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include "<a class="code" href="api__gui_8h.html">api_gui.h</a>"</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include "../Core/System/sharedptr.h"</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#include "../Core/Signals/callback_v2.h"</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#include "../GUI/gui_message.h"</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#include "../GUI/gui_message_input.h"</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#include <vector></span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">class </span>CL_AcceleratorKey_Impl;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="code" href="classCL__AcceleratorKey.html"> 46</a></span> <span class="keyword">class </span><a class="code" href="classCL__AcceleratorKey.html" title="GUI Accelerator Table Entry. ">CL_AcceleratorKey</a></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> {</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <a class="code" href="classCL__AcceleratorKey.html#a8098756aa01bbf8a37686f27e5845cc0" title="Constructs a null instance. ">CL_AcceleratorKey</a>();</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <a class="code" href="classCL__AcceleratorKey.html#a8098756aa01bbf8a37686f27e5845cc0" title="Constructs a null instance. ">CL_AcceleratorKey</a>(<span class="keywordtype">int</span> <span class="keywordtype">id</span>, <span class="keywordtype">int</span> mod1=-1, <span class="keywordtype">int</span> mod2=-1, <span class="keywordtype">int</span> mod3=-1);</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <a class="code" href="classCL__AcceleratorKey.html#a43b4298e58fc3b53d3c20a59f90caa59">~CL_AcceleratorKey</a>();</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <a class="code" href="classCL__Callback__v2.html" title="CL_Callback_v2. ">CL_Callback_v2<CL_GUIMessage, CL_AcceleratorKey></a> &<a class="code" href="classCL__AcceleratorKey.html#a508db50bd0358ef88beab4da7af7fca4">func_pressed</a>();</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">bool</span> <a class="code" href="classCL__AcceleratorKey.html#ad9774e17d1890a7d0a560a748680dc9d" title="Get Shift. ">get_shift</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordtype">bool</span> <a class="code" href="classCL__AcceleratorKey.html#aab4c6c5983db600030353c17e5d9ee96" title="Get Alt. ">get_alt</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">bool</span> <a class="code" href="classCL__AcceleratorKey.html#a2353947c71f4b1e586f07d1c67357136" title="Get Ctrl. ">get_ctrl</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordtype">int</span> <a class="code" href="classCL__AcceleratorKey.html#a6f682b4fa79a7c6082f9757287eb779e" title="Get Id. ">get_id</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a name="l00093"></a><span class="lineno"><a class="code" href="classCL__AcceleratorKey.html#ada9e695e5a49668e1730f54f5db08212"> 93</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classCL__AcceleratorKey.html#ada9e695e5a49668e1730f54f5db08212" title="Returns true if this object is invalid. ">is_null</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> impl ? <span class="keyword">true</span> : <span class="keyword">false</span>; }</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordtype">void</span> <a class="code" href="classCL__AcceleratorKey.html#a5bde6cec1ac489b17f681202347efd61" title="Throw an exception if this object is invalid. ">throw_if_null</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keywordtype">void</span> <a class="code" href="classCL__AcceleratorKey.html#a9eda8a54a3f83f5a5474e8654b029126" title="Set Shift. ">set_shift</a>(<span class="keywordtype">bool</span>);</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keywordtype">void</span> <a class="code" href="classCL__AcceleratorKey.html#a043a162ccf81dfc22cb0f93cf15272ca" title="Set Alt. ">set_alt</a>(<span class="keywordtype">bool</span>);</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keywordtype">void</span> <a class="code" href="classCL__AcceleratorKey.html#a6dc7364a8834c77bc8f48cc06133d3b4" title="Set Ctrl. ">set_ctrl</a>(<span class="keywordtype">bool</span>);</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keywordtype">void</span> <a class="code" href="classCL__AcceleratorKey.html#ad29470211314c4370a7c1ed50c553178" title="Set Id. ">set_id</a>(<span class="keywordtype">int</span>);</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  CL_SharedPtr<CL_AcceleratorKey_Impl> impl;</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> };</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> </div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jun 14 2013 13:05:44 for ClanLib by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.4
</small></address>
</body>
</html>
