<!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.5"/> <title>libyui: /home/iurt/rpmbuild/BUILD/libyui-3.0.10-b316a3f/src/YEventFilter.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="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); $(window).load(resizeHeight); </script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </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">libyui  <span id="projectnumber">3.0.10</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</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> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> </ul> </div> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('YEventFilter_8h_source.html','');}); </script> <div id="doc-content"> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Friends</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div class="header"> <div class="headertitle"> <div class="title">YEventFilter.h</div> </div> </div><!--header--> <div class="contents"> <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"> Copyright (C) 2000-2012 Novell, Inc</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> This library is free software; you can redistribute it and/or modify</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> it under the terms of the GNU Lesser General Public License as</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> published by the Free Software Foundation; either version 2.1 of the</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> License, or (at your option) version 3.0 of the License. This library</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> is distributed in the hope that it will be useful, but WITHOUT ANY</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> WARRANTY; without even the implied warranty of MERCHANTABILITY or </span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> License for more details. You should have received a copy of the GNU</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> Lesser General Public License along with this library; if not, write</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> to the Free Software Foundation, Inc., 51 Franklin Street, Fifth</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> Floor, Boston, MA 02110-1301 USA</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">*/</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">/*-/</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"></span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> File: YEventFilter.h</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"> Author: Stefan Hundhammer <sh@suse.de></span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"></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> </div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#ifndef YEventFilter_h</span></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor"></span><span class="preprocessor">#define YEventFilter_h</span></div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "ImplPtr.h"</span></div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</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="keyword">class </span><a class="code" href="classYEvent.html">YEvent</a>;</div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">class </span><a class="code" href="classYDialog.html">YDialog</a>;</div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">class </span><a class="code" href="structYEventFilterPrivate.html">YEventFilterPrivate</a>;</div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"></span></div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">/**</span></div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * Abstract base class to filter events.</span></div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> *</span></div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * This class can be used to examine events just before they are delivered to</span></div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * the application. This is most useful for higher-level widgets or for</span></div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> * libraries that need to react to certain events and either consume them, have</span></div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * them delivered unchanged to the application, or exchange an event with</span></div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * another one.</span></div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> *</span></div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * A YEventFilter belongs to one specific dialog. Each dialog can have any</span></div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * number of event filters. Each of those event filters is called (its</span></div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * YEventFilter::filter() method) for each event inside</span></div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * YDialog::waitForEvent(). The order in which event filters are called is</span></div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * undefined.</span></div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> *</span></div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * YEventFilter objects should be created with 'new' (on the heap). Since an</span></div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * YEventFilter registers itself with its dialog, the dialog will delete it in</span></div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * its destructor if it still exists after all child widgets are deleted.</span></div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> *</span></div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> * Thus, it is safe to store a pointer to an YEventFilter until the</span></div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * corresponding dialog is deleted. After that, the pointer becomes invalid.</span></div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> *</span></div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * See YHelpButtonHandler in YDialog.cc for an example.</span></div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> **/</span></div> <div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="classYEventFilter.html"> 62</a></span> <span class="keyword">class </span><a class="code" href="classYEventFilter.html">YEventFilter</a></div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> {</div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="keyword">protected</span>:<span class="comment"></span></div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> /**</span></div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * Constructor.</span></div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> *</span></div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> * This registers the event filter with the specified dialog. The dialog</span></div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> * assumes ownership of this object and will delete it in its destructor</span></div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> * (unless this object is destroyed before that time).</span></div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> *</span></div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * If 'dialog' is 0, YDialog::currentDialog() is used (which can throw a</span></div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> * YUINoDialogException if there is no dialog).</span></div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> **/</span></div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <a class="code" href="classYEventFilter.html#a924c3f6d3f2fe7b57b8382d2a13c521e">YEventFilter</a>( <a class="code" href="classYDialog.html">YDialog</a> * <a class="code" href="classYEventFilter.html#a8b945bc8ed7b62858fe165976f7a2c62">dialog</a> = 0 );</div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="keyword">public</span>:<span class="comment"></span></div> <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> /**</span></div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * Destructor.</span></div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> *</span></div> <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * This will unregister this object with its dialog.</span></div> <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> **/</span></div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keyword">virtual</span> <a class="code" href="classYEventFilter.html#af3340b80999ed9198cb0e99e024c004b">~YEventFilter</a>();</div> <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"></span></div> <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> /**</span></div> <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> * The heart of the matter: The event filter function.</span></div> <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> * Derived classes are required to implement this.</span></div> <div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> *</span></div> <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> * This method can inspect the event it receives. Hint: event->widget()</span></div> <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> * is typically the most interesting information.</span></div> <div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> *</span></div> <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> * This method can react on individual events and</span></div> <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> *</span></div> <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> * - consume the event (i.e., return 0)</span></div> <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> * - pass the event through unchanged (simply return the event)</span></div> <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> * - create a new event (typically based on data in the received event).</span></div> <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> *</span></div> <div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> * If 0 or a new event (another value than 'event') is returned, the old</span></div> <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> * event is deleted. If a value different from 'event' or 0 is returned,</span></div> <div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> * that value is assumed to be a pointer to a newly created event. The</span></div> <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> * dialog will assume ownership of that event and delete it when</span></div> <div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> * appropriate.</span></div> <div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> *</span></div> <div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * Note: Never delete 'event' in this method! Return 0 or a new event</span></div> <div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> * instead; the caller will take care of deleting the old event.</span></div> <div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> **/</span></div> <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keyword">virtual</span> <a class="code" href="classYEvent.html">YEvent</a> * <a class="code" href="classYEventFilter.html#a6f9c45e882f6915546a381f48e72219f">filter</a>( <a class="code" href="classYEvent.html">YEvent</a> * event ) = 0;</div> <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"></span></div> <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> /**</span></div> <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * Return the dialog this event filter belongs to.</span></div> <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> **/</span></div> <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <a class="code" href="classYDialog.html">YDialog</a> * <a class="code" href="classYEventFilter.html#a8b945bc8ed7b62858fe165976f7a2c62">dialog</a>() <span class="keyword">const</span>;</div> <div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div> <div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="keyword">private</span>:</div> <div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div> <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <a class="code" href="classImplPtr.html">ImplPtr<YEventFilterPrivate></a> priv;</div> <div class="line"><a name="l00117"></a><span class="lineno"> 117</span> };</div> <div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div> <div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div> <div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="preprocessor">#endif // YEventFilter_h</span></div> <div class="ttc" id="classYEventFilter_html_af3340b80999ed9198cb0e99e024c004b"><div class="ttname"><a href="classYEventFilter.html#af3340b80999ed9198cb0e99e024c004b">YEventFilter::~YEventFilter</a></div><div class="ttdeci">virtual ~YEventFilter()</div><div class="ttdef"><b>Definition:</b> <a href="YEventFilter_8cc_source.html#l00056">YEventFilter.cc:56</a></div></div> <div class="ttc" id="classYEventFilter_html_a924c3f6d3f2fe7b57b8382d2a13c521e"><div class="ttname"><a href="classYEventFilter.html#a924c3f6d3f2fe7b57b8382d2a13c521e">YEventFilter::YEventFilter</a></div><div class="ttdeci">YEventFilter(YDialog *dialog=0)</div><div class="ttdef"><b>Definition:</b> <a href="YEventFilter_8cc_source.html#l00044">YEventFilter.cc:44</a></div></div> <div class="ttc" id="classYEventFilter_html_a8b945bc8ed7b62858fe165976f7a2c62"><div class="ttname"><a href="classYEventFilter.html#a8b945bc8ed7b62858fe165976f7a2c62">YEventFilter::dialog</a></div><div class="ttdeci">YDialog * dialog() const </div><div class="ttdef"><b>Definition:</b> <a href="YEventFilter_8cc_source.html#l00063">YEventFilter.cc:63</a></div></div> <div class="ttc" id="classYEventFilter_html"><div class="ttname"><a href="classYEventFilter.html">YEventFilter</a></div><div class="ttdef"><b>Definition:</b> <a href="YEventFilter_8h_source.html#l00062">YEventFilter.h:62</a></div></div> <div class="ttc" id="classYEvent_html"><div class="ttname"><a href="classYEvent.html">YEvent</a></div><div class="ttdef"><b>Definition:</b> <a href="YEvent_8h_source.html#l00043">YEvent.h:43</a></div></div> <div class="ttc" id="structYEventFilterPrivate_html"><div class="ttname"><a href="structYEventFilterPrivate.html">YEventFilterPrivate</a></div><div class="ttdef"><b>Definition:</b> <a href="YEventFilter_8cc_source.html#l00032">YEventFilter.cc:32</a></div></div> <div class="ttc" id="classYEventFilter_html_a6f9c45e882f6915546a381f48e72219f"><div class="ttname"><a href="classYEventFilter.html#a6f9c45e882f6915546a381f48e72219f">YEventFilter::filter</a></div><div class="ttdeci">virtual YEvent * filter(YEvent *event)=0</div></div> <div class="ttc" id="classImplPtr_html"><div class="ttname"><a href="classImplPtr.html">ImplPtr< YEventFilterPrivate ></a></div></div> <div class="ttc" id="classYDialog_html"><div class="ttname"><a href="classYDialog.html">YDialog</a></div><div class="ttdef"><b>Definition:</b> <a href="YDialog_8h_source.html#l00041">YDialog.h:41</a></div></div> </div><!-- fragment --></div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><b>YEventFilter.h</b></li> <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li> </ul> </div> </body> </html>