Some documentation updates.
[MUtilities.git] / docs / da / d5d / _g_u_i_8h_source.html
blob073fbebd2eaafa5f355779bdba8df5791cd1c8cf
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.12"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>MuldeR&#39;s Utilities for Qt: include/MUtils/GUI.h Source File</title>
9 <link href="../../tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="../../jquery.js"></script>
11 <script type="text/javascript" src="../../dynsections.js"></script>
12 <link href="../../search/search.css" rel="stylesheet" type="text/css"/>
13 <script type="text/javascript" src="../../search/searchdata.js"></script>
14 <script type="text/javascript" src="../../search/search.js"></script>
15 <link href="../../doxygen.css" rel="stylesheet" type="text/css" />
16 </head>
17 <body>
18 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19 <div id="titlearea">
20 <table cellspacing="0" cellpadding="0">
21 <tbody>
22 <tr style="height: 56px;">
23 <td id="projectalign" style="padding-left: 0.5em;">
24 <div id="projectname">MuldeR&#39;s Utilities for Qt
25 </div>
26 <div id="projectbrief">MUtilities</div>
27 </td>
28 </tr>
29 </tbody>
30 </table>
31 </div>
32 <!-- end header part -->
33 <!-- Generated by Doxygen 1.8.12 -->
34 <script type="text/javascript">
35 var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
36 </script>
37 <script type="text/javascript" src="../../menudata.js"></script>
38 <script type="text/javascript" src="../../menu.js"></script>
39 <script type="text/javascript">
40 $(function() {
41 initMenu('../../',true,false,'search.php','Search');
42 $(document).ready(function() { init_search(); });
43 });
44 </script>
45 <div id="main-nav"></div>
46 <!-- window showing the filter options -->
47 <div id="MSearchSelectWindow"
48 onmouseover="return searchBox.OnSearchSelectShow()"
49 onmouseout="return searchBox.OnSearchSelectHide()"
50 onkeydown="return searchBox.OnSearchSelectKey(event)">
51 </div>
53 <!-- iframe showing the search results (closed by default) -->
54 <div id="MSearchResultsWindow">
55 <iframe src="javascript:void(0)" frameborder="0"
56 name="MSearchResults" id="MSearchResults">
57 </iframe>
58 </div>
60 <div id="nav-path" class="navpath">
61 <ul>
62 <li class="navelem"><a class="el" href="../../dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="../../dir_b076b53667bc06ebb413a190e197fc7b.html">MUtils</a></li> </ul>
63 </div>
64 </div><!-- top -->
65 <div class="header">
66 <div class="headertitle">
67 <div class="title">GUI.h</div> </div>
68 </div><!--header-->
69 <div class="contents">
70 <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// MuldeR&#39;s Utilities for Qt</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// Copyright (C) 2004-2016 LoRd_MuldeR &lt;MuldeR2@GMX.de&gt;</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// This library is free software; you can redistribute it and/or</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// modify it under the terms of the GNU Lesser General Public</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// License as published by the Free Software Foundation; either</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// version 2.1 of the License, or (at your option) any later version.</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// This library is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">// Lesser General Public License for more details.</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">// You should have received a copy of the GNU Lesser General Public</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment">// License along with this library; if not, write to the Free Software</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment">// http://www.gnu.org/licenses/lgpl-2.1.txt</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment">//MUtils</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="../../d5/d3b/_global_8h.html">MUtils/Global.h</a>&gt;</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment">//Qt</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &lt;QColor&gt;</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment">//Forward Declaration</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="keyword">class </span>QIcon;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="keyword">class </span>QWidget;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="keyword">namespace </span><a class="code" href="../../d3/da6/namespace_m_utils.html">MUtils</a></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;{</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">namespace </span>GUI</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keyword">typedef</span> <span class="keyword">enum</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; {</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; USER_EVENT = 1000, <span class="comment">/*QEvent::User*/</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; USER_EVENT_QUERYENDSESSION = USER_EVENT + 666,</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; USER_EVENT_ENDSESSION = USER_EVENT + 667</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; }</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; user_events_t;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">typedef</span> <span class="keyword">enum</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; {</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; SYSCOLOR_TEXT = 1,</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; SYSCOLOR_BACKGROUND = 2,</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; SYSCOLOR_CAPTION = 3</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; }</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; system_color_t;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="comment">//Broadcast message</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; MUTILS_API <span class="keywordtype">bool</span> broadcast(<span class="keywordtype">int</span> eventType, <span class="keyword">const</span> <span class="keywordtype">bool</span> &amp;onlyToVisible);</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="comment">//Window icon</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; MUTILS_API <span class="keywordtype">bool</span> set_window_icon(QWidget *<span class="keyword">const</span> window, <span class="keyword">const</span> QIcon &amp;icon, <span class="keyword">const</span> <span class="keywordtype">bool</span> bIsBigIcon);</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="comment">//Theme support</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; MUTILS_API <span class="keywordtype">bool</span> themes_enabled(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="comment">//System menu</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; MUTILS_API <span class="keywordtype">bool</span> sysmenu_append(<span class="keyword">const</span> QWidget *<span class="keyword">const</span> win, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> identifier, <span class="keyword">const</span> QString &amp;text);</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; MUTILS_API <span class="keywordtype">bool</span> sysmenu_update(<span class="keyword">const</span> QWidget *<span class="keyword">const</span> win, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> identifier, <span class="keyword">const</span> QString &amp;text);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; MUTILS_API <span class="keywordtype">bool</span> sysmenu_check_msg(<span class="keywordtype">void</span> *<span class="keyword">const</span> message, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> &amp;identifier);</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="comment">//Close button</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; MUTILS_API <span class="keywordtype">bool</span> enable_close_button(<span class="keyword">const</span> QWidget *<span class="keyword">const</span> win, <span class="keyword">const</span> <span class="keywordtype">bool</span> &amp;bEnable);</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="comment">//Bring to front</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; MUTILS_API <span class="keywordtype">bool</span> bring_to_front(<span class="keyword">const</span> QWidget *<span class="keyword">const</span> window);</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; MUTILS_API <span class="keywordtype">bool</span> bring_to_front(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> pid);</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="comment">//Sheet of glass</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; MUTILS_API <span class="keywordtype">bool</span> sheet_of_glass(QWidget *<span class="keyword">const</span> window);</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; MUTILS_API <span class="keywordtype">bool</span> sheet_of_glass_update(QWidget *<span class="keyword">const</span> window);</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="comment">//System colors</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; MUTILS_API QColor system_color(<span class="keyword">const</span> <span class="keywordtype">int</span> &amp;color_id);</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="comment">//Blink window</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; MUTILS_API <span class="keywordtype">void</span> blink_window(QWidget *<span class="keyword">const</span> poWindow, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> &amp;count = 10, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> &amp;delay = 150);</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="comment">//Force quit application</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; MUTILS_API <span class="keywordtype">void</span> force_quit(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; }</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;}</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;</div><div class="ttc" id="_global_8h_html"><div class="ttname"><a href="../../d5/d3b/_global_8h.html">Global.h</a></div><div class="ttdoc">This file contains miscellaneous functions that are generally useful for Qt-based applications...</div></div>
71 <div class="ttc" id="namespace_m_utils_html"><div class="ttname"><a href="../../d3/da6/namespace_m_utils.html">MUtils</a></div><div class="ttdef"><b>Definition:</b> CPUFeatures.h:30</div></div>
72 </div><!-- fragment --></div><!-- contents -->
73 <!-- start footer part -->
74 <hr class="footer"/><address class="footer"><small>
75 Generated by &#160;<a href="http://www.doxygen.org/index.html">
76 <img class="footer" src="../../doxygen.png" alt="doxygen"/>
77 </a> 1.8.12
78 </small></address>
79 </body>
80 </html>