<!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/YMacroRecorder.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('YMacroRecorder_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">YMacroRecorder.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: YMacroRecorder.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 YMacroRecorder_h</span></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor"></span><span class="preprocessor">#define YMacroRecorder_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> <span class="preprocessor">#include <string></span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">class </span><a class="code" href="classYWidget.html">YWidget</a>;</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="comment"></span></div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">/**</span></div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> * Abstract base class for macro recorders.</span></div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> *</span></div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * Applications should not use this directly, but the static methods in YMacro.</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"><a class="line" href="classYMacroRecorder.html"> 38</a></span> <span class="keyword">class </span><a class="code" href="classYMacroRecorder.html">YMacroRecorder</a></div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> {</div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classYMacro.html">YMacro</a>;</div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">protected</span>:</div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"></span></div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> /**</span></div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * Constructor</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"><a class="line" href="classYMacroRecorder.html#a8aba87a6ad9f9cc71a4bdd0af4009287"> 47</a></span>  <a class="code" href="classYMacroRecorder.html#a8aba87a6ad9f9cc71a4bdd0af4009287">YMacroRecorder</a>() {}</div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">public</span>:<span class="comment"></span></div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> /**</span></div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * Destructor</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"><a class="line" href="classYMacroRecorder.html#acc5fecea39ed7b0b4a6e2d9f7eeef7cb"> 53</a></span>  <span class="keyword">virtual</span> <a class="code" href="classYMacroRecorder.html#acc5fecea39ed7b0b4a6e2d9f7eeef7cb">~YMacroRecorder</a>() {}</div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"></span></div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> /**</span></div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * Start recording a macro to the specified file.</span></div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> **/</span></div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classYMacroRecorder.html#a1178a9e9e59a9ad78bbf4cbfdf142faf">record</a>( <span class="keyword">const</span> std::string & macroFileName ) = 0;</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"> /**</span></div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * End recording and close the current macro file (if there is any).</span></div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> **/</span></div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classYMacroRecorder.html#aa733cfd592817898119be2ae6994c7e8">endRecording</a>() = 0;</div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</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"> * Return 'true' if a macro is currently being recorded.</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="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classYMacroRecorder.html#a24a2a7a36d72f123538ca7fac136e361">recording</a>() <span class="keyword">const</span> = 0;</div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"></span></div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> /**</span></div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * Record one widget property.</span></div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> **/</span></div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classYMacroRecorder.html#a6802de77a1ac1294175bcf9ffe1acfd7">recordWidgetProperty</a>( <a class="code" href="classYWidget.html">YWidget</a> * widget,</div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> * propertyName ) = 0;</div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"></span></div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> /**</span></div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> * Record a "UI::MakeScreenShot()" statement.</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"> * If 'enabled' is 'false', this statement will be commented out.</span></div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * If no file name is given, a default file name (with auto-increment) will</span></div> <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * be used.</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> <span class="keywordtype">void</span> <a class="code" href="classYMacroRecorder.html#a8c51271287b74f076461c5293c25bce6">recordMakeScreenShot</a>( <span class="keywordtype">bool</span> enabled = <span class="keyword">false</span>,</div> <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keyword">const</span> std::string & filename = std::string() ) = 0;</div> <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> };</div> <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div> <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="preprocessor">#endif // YMacroRecorder_h</span></div> <div class="ttc" id="classYMacroRecorder_html"><div class="ttname"><a href="classYMacroRecorder.html">YMacroRecorder</a></div><div class="ttdef"><b>Definition:</b> <a href="YMacroRecorder_8h_source.html#l00038">YMacroRecorder.h:38</a></div></div> <div class="ttc" id="classYMacroRecorder_html_a1178a9e9e59a9ad78bbf4cbfdf142faf"><div class="ttname"><a href="classYMacroRecorder.html#a1178a9e9e59a9ad78bbf4cbfdf142faf">YMacroRecorder::record</a></div><div class="ttdeci">virtual void record(const std::string &macroFileName)=0</div></div> <div class="ttc" id="classYMacroRecorder_html_a8aba87a6ad9f9cc71a4bdd0af4009287"><div class="ttname"><a href="classYMacroRecorder.html#a8aba87a6ad9f9cc71a4bdd0af4009287">YMacroRecorder::YMacroRecorder</a></div><div class="ttdeci">YMacroRecorder()</div><div class="ttdef"><b>Definition:</b> <a href="YMacroRecorder_8h_source.html#l00047">YMacroRecorder.h:47</a></div></div> <div class="ttc" id="classYMacroRecorder_html_aa733cfd592817898119be2ae6994c7e8"><div class="ttname"><a href="classYMacroRecorder.html#aa733cfd592817898119be2ae6994c7e8">YMacroRecorder::endRecording</a></div><div class="ttdeci">virtual void endRecording()=0</div></div> <div class="ttc" id="classYMacroRecorder_html_acc5fecea39ed7b0b4a6e2d9f7eeef7cb"><div class="ttname"><a href="classYMacroRecorder.html#acc5fecea39ed7b0b4a6e2d9f7eeef7cb">YMacroRecorder::~YMacroRecorder</a></div><div class="ttdeci">virtual ~YMacroRecorder()</div><div class="ttdef"><b>Definition:</b> <a href="YMacroRecorder_8h_source.html#l00053">YMacroRecorder.h:53</a></div></div> <div class="ttc" id="classYMacroRecorder_html_a8c51271287b74f076461c5293c25bce6"><div class="ttname"><a href="classYMacroRecorder.html#a8c51271287b74f076461c5293c25bce6">YMacroRecorder::recordMakeScreenShot</a></div><div class="ttdeci">virtual void recordMakeScreenShot(bool enabled=false, const std::string &filename=std::string())=0</div></div> <div class="ttc" id="classYMacroRecorder_html_a6802de77a1ac1294175bcf9ffe1acfd7"><div class="ttname"><a href="classYMacroRecorder.html#a6802de77a1ac1294175bcf9ffe1acfd7">YMacroRecorder::recordWidgetProperty</a></div><div class="ttdeci">virtual void recordWidgetProperty(YWidget *widget, const char *propertyName)=0</div></div> <div class="ttc" id="classYMacro_html"><div class="ttname"><a href="classYMacro.html">YMacro</a></div><div class="ttdef"><b>Definition:</b> <a href="YMacro_8h_source.html#l00044">YMacro.h:44</a></div></div> <div class="ttc" id="classYMacroRecorder_html_a24a2a7a36d72f123538ca7fac136e361"><div class="ttname"><a href="classYMacroRecorder.html#a24a2a7a36d72f123538ca7fac136e361">YMacroRecorder::recording</a></div><div class="ttdeci">virtual bool recording() const =0</div></div> <div class="ttc" id="classYWidget_html"><div class="ttname"><a href="classYWidget.html">YWidget</a></div><div class="ttdef"><b>Definition:</b> <a href="YWidget_8h_source.html#l00054">YWidget.h:54</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>YMacroRecorder.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>