<!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: YMacro Class Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><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="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</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('classYMacro.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="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classYMacro-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">YMacro Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="YMacro_8h_source.html">YMacro.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:abee42b14aaf93256c5dbeb4b3a5b75f6"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classYMacro.html#abee42b14aaf93256c5dbeb4b3a5b75f6">setRecorder</a> (<a class="el" href="classYMacroRecorder.html">YMacroRecorder</a> *<a class="el" href="classYMacro.html#ab185c0d7b8bb85d0992afdbbdb7950de">recorder</a>)</td></tr>
<tr class="separator:abee42b14aaf93256c5dbeb4b3a5b75f6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2a786ce6d560391c78db74dc823b52f7"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classYMacro.html#a2a786ce6d560391c78db74dc823b52f7">setPlayer</a> (<a class="el" href="classYMacroPlayer.html">YMacroPlayer</a> *<a class="el" href="classYMacro.html#acbc7b03dd8c1e44a8bad6c47a818d78f">player</a>)</td></tr>
<tr class="separator:a2a786ce6d560391c78db74dc823b52f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af50546780973d3ce12372cf1c85d3163"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classYMacro.html#af50546780973d3ce12372cf1c85d3163">record</a> (const std::string &macroFile)</td></tr>
<tr class="separator:af50546780973d3ce12372cf1c85d3163"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af3f20dd1228ef9a7e9dfe6c3406248a4"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classYMacro.html#af3f20dd1228ef9a7e9dfe6c3406248a4">endRecording</a> ()</td></tr>
<tr class="separator:af3f20dd1228ef9a7e9dfe6c3406248a4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae6c7b4e6491ae370a25dada2b5d247fb"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classYMacro.html#ae6c7b4e6491ae370a25dada2b5d247fb">recording</a> ()</td></tr>
<tr class="separator:ae6c7b4e6491ae370a25dada2b5d247fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5460247071850a5a2e871557cbe6442a"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classYMacro.html#a5460247071850a5a2e871557cbe6442a">play</a> (const std::string &macroFile)</td></tr>
<tr class="separator:a5460247071850a5a2e871557cbe6442a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a32fcc69a6aa1d8cd1d8ecf88b5a0c00b"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classYMacro.html#a32fcc69a6aa1d8cd1d8ecf88b5a0c00b">playNextBlock</a> ()</td></tr>
<tr class="separator:a32fcc69a6aa1d8cd1d8ecf88b5a0c00b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7c965fd28f4c2d5a370f6b63e98e531f"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classYMacro.html#a7c965fd28f4c2d5a370f6b63e98e531f">playing</a> ()</td></tr>
<tr class="separator:a7c965fd28f4c2d5a370f6b63e98e531f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab185c0d7b8bb85d0992afdbbdb7950de"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classYMacroRecorder.html">YMacroRecorder</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classYMacro.html#ab185c0d7b8bb85d0992afdbbdb7950de">recorder</a> ()</td></tr>
<tr class="separator:ab185c0d7b8bb85d0992afdbbdb7950de"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acbc7b03dd8c1e44a8bad6c47a818d78f"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classYMacroPlayer.html">YMacroPlayer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classYMacro.html#acbc7b03dd8c1e44a8bad6c47a818d78f">player</a> ()</td></tr>
<tr class="separator:acbc7b03dd8c1e44a8bad6c47a818d78f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6d74cd379e4c4c59eef7a6e05669e0d2"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classYMacro.html#a6d74cd379e4c4c59eef7a6e05669e0d2">deleteRecorder</a> ()</td></tr>
<tr class="separator:a6d74cd379e4c4c59eef7a6e05669e0d2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af84bf1aeb4d73cf202bce9c9b4a1e886"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classYMacro.html#af84bf1aeb4d73cf202bce9c9b4a1e886">deletePlayer</a> ()</td></tr>
<tr class="separator:af84bf1aeb4d73cf202bce9c9b4a1e886"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Simple access to macro recording and playing.</p>
<p>This class stores an instance of a macro recorder and a macro player. Since both <a class="el" href="classYMacroRecorder.html">YMacroRecorder</a> and <a class="el" href="classYMacroPlayer.html">YMacroPlayer</a> are abstract base classes, derived classes from either of them have to be instantiated and set (<a class="el" href="classYMacro.html#abee42b14aaf93256c5dbeb4b3a5b75f6">setRecorder()</a>, <a class="el" href="classYMacro.html#a2a786ce6d560391c78db74dc823b52f7">setPlayer()</a>) from the outside for anything to happen. Until that point, none of the macro operations here do anything (but also don't throw any error or exception). </p>
<p>Definition at line <a class="el" href="YMacro_8h_source.html#l00044">44</a> of file <a class="el" href="YMacro_8h_source.html">YMacro.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="af84bf1aeb4d73cf202bce9c9b4a1e886"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void YMacro::deletePlayer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete the current macro player if there is one. </p>
<p>Definition at line <a class="el" href="YMacro_8cc_source.html#l00105">105</a> of file <a class="el" href="YMacro_8cc_source.html">YMacro.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a6d74cd379e4c4c59eef7a6e05669e0d2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void YMacro::deleteRecorder </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete the current macro recorder if there is one. </p>
<p>Definition at line <a class="el" href="YMacro_8cc_source.html#l00098">98</a> of file <a class="el" href="YMacro_8cc_source.html">YMacro.cc</a>.</p>
</div>
</div>
<a class="anchor" id="af3f20dd1228ef9a7e9dfe6c3406248a4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void YMacro::endRecording </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>End macro recording. </p>
<p>Definition at line <a class="el" href="YMacro_8cc_source.html#l00059">59</a> of file <a class="el" href="YMacro_8cc_source.html">YMacro.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a5460247071850a5a2e871557cbe6442a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void YMacro::play </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>macroFile</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Play a macro from the specified macro file. </p>
<p>Definition at line <a class="el" href="YMacro_8cc_source.html#l00075">75</a> of file <a class="el" href="YMacro_8cc_source.html">YMacro.cc</a>.</p>
</div>
</div>
<a class="anchor" id="acbc7b03dd8c1e44a8bad6c47a818d78f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classYMacroPlayer.html">YMacroPlayer</a>* YMacro::player </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the current macro player or 0 if there is none. </p>
<p>Definition at line <a class="el" href="YMacro_8h_source.html#l00106">106</a> of file <a class="el" href="YMacro_8h_source.html">YMacro.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7c965fd28f4c2d5a370f6b63e98e531f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool YMacro::playing </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return 'true' if a macro is currently being played. </p>
<p>Definition at line <a class="el" href="YMacro_8cc_source.html#l00089">89</a> of file <a class="el" href="YMacro_8cc_source.html">YMacro.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a32fcc69a6aa1d8cd1d8ecf88b5a0c00b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void YMacro::playNextBlock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Play the next block from the current macro, if there is one playing. </p>
<p>Definition at line <a class="el" href="YMacro_8cc_source.html#l00082">82</a> of file <a class="el" href="YMacro_8cc_source.html">YMacro.cc</a>.</p>
</div>
</div>
<a class="anchor" id="af50546780973d3ce12372cf1c85d3163"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void YMacro::record </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>macroFile</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Record a macro to the specified macro file. </p>
<p>Definition at line <a class="el" href="YMacro_8cc_source.html#l00052">52</a> of file <a class="el" href="YMacro_8cc_source.html">YMacro.cc</a>.</p>
</div>
</div>
<a class="anchor" id="ab185c0d7b8bb85d0992afdbbdb7950de"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classYMacroRecorder.html">YMacroRecorder</a>* YMacro::recorder </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the current macro recorder or 0 if there is none. </p>
<p>Definition at line <a class="el" href="YMacro_8h_source.html#l00101">101</a> of file <a class="el" href="YMacro_8h_source.html">YMacro.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae6c7b4e6491ae370a25dada2b5d247fb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool YMacro::recording </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return 'true' if a macro is currently being recorded. </p>
<p>Definition at line <a class="el" href="YMacro_8cc_source.html#l00066">66</a> of file <a class="el" href="YMacro_8cc_source.html">YMacro.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a2a786ce6d560391c78db74dc823b52f7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void YMacro::setPlayer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classYMacroPlayer.html">YMacroPlayer</a> * </td>
<td class="paramname"><em>player</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a macro player.</p>
<p>This needs to be done from the outside since <a class="el" href="classYMacroRecorder.html">YMacroRecorder</a> is an abstract base class, i.e., it needs to be derived to be instantiated. </p>
<p>Definition at line <a class="el" href="YMacro_8cc_source.html#l00043">43</a> of file <a class="el" href="YMacro_8cc_source.html">YMacro.cc</a>.</p>
</div>
</div>
<a class="anchor" id="abee42b14aaf93256c5dbeb4b3a5b75f6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void YMacro::setRecorder </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classYMacroRecorder.html">YMacroRecorder</a> * </td>
<td class="paramname"><em>recorder</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a macro recorder.</p>
<p>This needs to be done from the outside since <a class="el" href="classYMacroRecorder.html">YMacroRecorder</a> is an abstract base class, i.e., it needs to be derived to be instantiated. </p>
<p>Definition at line <a class="el" href="YMacro_8cc_source.html#l00034">34</a> of file <a class="el" href="YMacro_8cc_source.html">YMacro.cc</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/home/iurt/rpmbuild/BUILD/libyui-3.0.10-b316a3f/src/<a class="el" href="YMacro_8h_source.html">YMacro.h</a></li>
<li>/home/iurt/rpmbuild/BUILD/libyui-3.0.10-b316a3f/src/<a class="el" href="YMacro_8cc_source.html">YMacro.cc</a></li>
</ul>
</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="classYMacro.html">YMacro</a></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>
distrib
>
Mageia
>
4
>
i586
>
media
>
core-release
>
by-pkgid
>
c44927308c1c3b2e6eb97a3e8e6f0c4d
>
files
>
379
