Sophie

Sophie

distrib > Fedora > 18 > x86_64 > by-pkgid > b3a1f4d91c26f535919e39e25606614a > files > 1236

wt-doc-3.2.3-1.fc18.noarch.rpm

<!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"/>
<title>Wt: Wt::EventSignalBase Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">Wt
   &#160;<span id="projectnumber">3.2.3</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
<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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</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&#160;List</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="namespaceWt.html">Wt</a>      </li>
      <li class="navelem"><a class="el" href="classWt_1_1EventSignalBase.html">EventSignalBase</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">Wt::EventSignalBase Class Reference<div class="ingroups"><a class="el" href="group__signalslot.html">Signal/slot system</a></div></div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::EventSignalBase" --><!-- doxytag: inherits="Wt::SignalBase" -->
<p>Abstract base class of an event signal.  
 <a href="classWt_1_1EventSignalBase.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for Wt::EventSignalBase:</div>
<div class="dyncontent">
<div class="center"><img src="classWt_1_1EventSignalBase__inherit__graph.png" border="0" usemap="#Wt_1_1EventSignalBase_inherit__map" alt="Inheritance graph"/></div>
<map name="Wt_1_1EventSignalBase_inherit__map" id="Wt_1_1EventSignalBase_inherit__map">
<area shape="rect" href="classWt_1_1JSignal.html" title="Wt::JSignal\&lt; bool \&gt;" alt="" coords="595,16,731,43"/><area shape="rect" href="classWt_1_1JSignal.html" title="Wt::JSignal\&lt; Coordinate \&gt;" alt="" coords="576,67,749,93"/><area shape="rect" href="classWt_1_1JSignal.html" title="Wt::JSignal\&lt; int \&gt;" alt="" coords="600,117,725,144"/><area shape="rect" href="classWt_1_1JSignal.html" title="Wt::JSignal\&lt; int, int \&gt;" alt="" coords="589,168,736,195"/><area shape="rect" href="classWt_1_1JSignal.html" title="Wt::JSignal\&lt; int, int, int, int \&gt;" alt="" coords="567,219,759,245"/><area shape="rect" href="classWt_1_1JSignal.html" title="Wt::JSignal\&lt; int, int, std::string, std::string, WMouseEvent \&gt;" alt="" coords="477,269,848,296"/><area shape="rect" href="classWt_1_1JSignal.html" title="Wt::JSignal\&lt; std::string \&gt;" alt="" coords="577,320,748,347"/><area shape="rect" href="classWt_1_1JSignal.html" title="Wt::JSignal\&lt; std::string, int \&gt;" alt="" coords="567,371,759,397"/><area shape="rect" href="classWt_1_1JSignal.html" title="Wt::JSignal\&lt; std::string, int, std::string \&gt;" alt="" coords="533,421,792,448"/><area shape="rect" href="classWt_1_1JSignal.html" title="Wt::JSignal\&lt; std::string, int, std::string, std::string, std::string, WMouseEvent \&gt;" alt="" coords="421,472,904,499"/><area shape="rect" href="classWt_1_1JSignal.html" title="Wt::JSignal\&lt; std::string, std::string \&gt;" alt="" coords="545,523,780,549"/><area shape="rect" href="classWt_1_1JSignal.html" title="Wt::JSignal\&lt; std::string, std::string, WMouseEvent, struct NoClass, struct NoClass, struct NoClass \&gt;" alt="" coords="357,573,968,600"/><area shape="rect" href="classWt_1_1JSignal.html" title="Wt::JSignal\&lt; void \&gt;" alt="" coords="596,624,729,651"/><area shape="rect" href="classWt_1_1JSignal.html" title="Wt::JSignal\&lt;\&gt;" alt="" coords="611,675,715,701"/><area shape="rect" href="classWt_1_1EventSignal.html" title="A signal that conveys user&#45;interface events." alt="" coords="589,725,736,752"/><area shape="rect" href="classWt_1_1JSignal.html" title="A signal to relay JavaScript to C++ calls." alt="" coords="539,776,787,803"/><area shape="rect" href="classWt_1_1SignalBase.html" title="Abstract base class of a signal." alt="" coords="5,396,117,423"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classWt_1_1EventSignalBase-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1EventSignalBase.html#a1ef1b9ac79778e98e703ec3a2de30a1f">name</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the event name.  <a href="#a1ef1b9ac79778e98e703ec3a2de30a1f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1EventSignalBase.html#a9abebc3c61cade46272159698960e214">isConnected</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether this signal is connected.  <a href="#a9abebc3c61cade46272159698960e214"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1EventSignalBase.html#afd8983929683ffc4c6dda8a91a7bda7b">preventDefaultAction</a> (bool prevent=true)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevents the default browser action.  <a href="#afd8983929683ffc4c6dda8a91a7bda7b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1EventSignalBase.html#ac840555229d96847ffb11960958e0fff">defaultActionPrevented</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether the default browser action is prevented.  <a href="#ac840555229d96847ffb11960958e0fff"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1EventSignalBase.html#a63f088978e6dd375b3a329f458f9db3f">preventPropagation</a> (bool prevent=true)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevents event propagation.  <a href="#a63f088978e6dd375b3a329f458f9db3f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1EventSignalBase.html#a0660648ca23b59a30ddc3226ad4a55b3">propagationPrevented</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether event propagation is prevented.  <a href="#a0660648ca23b59a30ddc3226ad4a55b3"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Abstract base class of an event signal. </p>
<p>An event signal is directly associated with a user-interface generated event. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac840555229d96847ffb11960958e0fff"></a><!-- doxytag: member="Wt::EventSignalBase::defaultActionPrevented" ref="ac840555229d96847ffb11960958e0fff" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Wt::EventSignalBase::defaultActionPrevented </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns whether the default browser action is prevented. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1EventSignalBase.html#afd8983929683ffc4c6dda8a91a7bda7b" title="Prevents the default browser action.">preventDefaultAction()</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a9abebc3c61cade46272159698960e214"></a><!-- doxytag: member="Wt::EventSignalBase::isConnected" ref="a9abebc3c61cade46272159698960e214" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Wt::EventSignalBase::isConnected </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns whether this signal is connected. </p>
<p>Returns true when the signal was connected to to at least one slot. </p>

<p>Implements <a class="el" href="classWt_1_1SignalBase.html#a13a3106be8949b273edc74aa61be14ce">Wt::SignalBase</a>.</p>

<p>Reimplemented in <a class="el" href="classWt_1_1EventSignal.html#aba826d0b0c74751fed4ab8eb9b05732b">Wt::EventSignal&lt; E &gt;</a>, <a class="el" href="classWt_1_1JSignal.html#a401ed9f5d5e0611b6dbd6eb28022f65f">Wt::JSignal&lt; A1, A2, A3, A4, A5, A6 &gt;</a>, <a class="el" href="classWt_1_1JSignal.html#a401ed9f5d5e0611b6dbd6eb28022f65f">Wt::JSignal&lt; Coordinate &gt;</a>, <a class="el" href="classWt_1_1JSignal.html#a401ed9f5d5e0611b6dbd6eb28022f65f">Wt::JSignal&lt;&gt;</a>, <a class="el" href="classWt_1_1JSignal.html#a401ed9f5d5e0611b6dbd6eb28022f65f">Wt::JSignal&lt; std::string, int &gt;</a>, <a class="el" href="classWt_1_1JSignal.html#a401ed9f5d5e0611b6dbd6eb28022f65f">Wt::JSignal&lt; std::string &gt;</a>, <a class="el" href="classWt_1_1JSignal.html#a401ed9f5d5e0611b6dbd6eb28022f65f">Wt::JSignal&lt; std::string, std::string, WMouseEvent, struct NoClass, struct NoClass, struct NoClass &gt;</a>, <a class="el" href="classWt_1_1JSignal.html#a401ed9f5d5e0611b6dbd6eb28022f65f">Wt::JSignal&lt; int, int &gt;</a>, <a class="el" href="classWt_1_1JSignal.html#a401ed9f5d5e0611b6dbd6eb28022f65f">Wt::JSignal&lt; int &gt;</a>, <a class="el" href="classWt_1_1JSignal.html#a401ed9f5d5e0611b6dbd6eb28022f65f">Wt::JSignal&lt; void &gt;</a>, <a class="el" href="classWt_1_1JSignal.html#a401ed9f5d5e0611b6dbd6eb28022f65f">Wt::JSignal&lt; int, int, std::string, std::string, WMouseEvent &gt;</a>, <a class="el" href="classWt_1_1JSignal.html#a401ed9f5d5e0611b6dbd6eb28022f65f">Wt::JSignal&lt; std::string, int, std::string, std::string, std::string, WMouseEvent &gt;</a>, <a class="el" href="classWt_1_1JSignal.html#a401ed9f5d5e0611b6dbd6eb28022f65f">Wt::JSignal&lt; std::string, int, std::string &gt;</a>, <a class="el" href="classWt_1_1JSignal.html#a401ed9f5d5e0611b6dbd6eb28022f65f">Wt::JSignal&lt; bool &gt;</a>, <a class="el" href="classWt_1_1JSignal.html#a401ed9f5d5e0611b6dbd6eb28022f65f">Wt::JSignal&lt; int, int, int, int &gt;</a>, and <a class="el" href="classWt_1_1JSignal.html#a401ed9f5d5e0611b6dbd6eb28022f65f">Wt::JSignal&lt; std::string, std::string &gt;</a>.</p>

</div>
</div>
<a class="anchor" id="a1ef1b9ac79778e98e703ec3a2de30a1f"></a><!-- doxytag: member="Wt::EventSignalBase::name" ref="a1ef1b9ac79778e98e703ec3a2de30a1f" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* Wt::EventSignalBase::name </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the event name. </p>
<p>The event name is implementation-defined. </p>

<p>Reimplemented in <a class="el" href="classWt_1_1JSignal.html#aba4f375bcfd61c8938ceeafedd1b79b9">Wt::JSignal&lt; A1, A2, A3, A4, A5, A6 &gt;</a>, <a class="el" href="classWt_1_1JSignal.html#aba4f375bcfd61c8938ceeafedd1b79b9">Wt::JSignal&lt; Coordinate &gt;</a>, <a class="el" href="classWt_1_1JSignal.html#aba4f375bcfd61c8938ceeafedd1b79b9">Wt::JSignal&lt;&gt;</a>, <a class="el" href="classWt_1_1JSignal.html#aba4f375bcfd61c8938ceeafedd1b79b9">Wt::JSignal&lt; std::string, int &gt;</a>, <a class="el" href="classWt_1_1JSignal.html#aba4f375bcfd61c8938ceeafedd1b79b9">Wt::JSignal&lt; std::string &gt;</a>, <a class="el" href="classWt_1_1JSignal.html#aba4f375bcfd61c8938ceeafedd1b79b9">Wt::JSignal&lt; std::string, std::string, WMouseEvent, struct NoClass, struct NoClass, struct NoClass &gt;</a>, <a class="el" href="classWt_1_1JSignal.html#aba4f375bcfd61c8938ceeafedd1b79b9">Wt::JSignal&lt; int, int &gt;</a>, <a class="el" href="classWt_1_1JSignal.html#aba4f375bcfd61c8938ceeafedd1b79b9">Wt::JSignal&lt; int &gt;</a>, <a class="el" href="classWt_1_1JSignal.html#aba4f375bcfd61c8938ceeafedd1b79b9">Wt::JSignal&lt; void &gt;</a>, <a class="el" href="classWt_1_1JSignal.html#aba4f375bcfd61c8938ceeafedd1b79b9">Wt::JSignal&lt; int, int, std::string, std::string, WMouseEvent &gt;</a>, <a class="el" href="classWt_1_1JSignal.html#aba4f375bcfd61c8938ceeafedd1b79b9">Wt::JSignal&lt; std::string, int, std::string, std::string, std::string, WMouseEvent &gt;</a>, <a class="el" href="classWt_1_1JSignal.html#aba4f375bcfd61c8938ceeafedd1b79b9">Wt::JSignal&lt; std::string, int, std::string &gt;</a>, <a class="el" href="classWt_1_1JSignal.html#aba4f375bcfd61c8938ceeafedd1b79b9">Wt::JSignal&lt; bool &gt;</a>, <a class="el" href="classWt_1_1JSignal.html#aba4f375bcfd61c8938ceeafedd1b79b9">Wt::JSignal&lt; int, int, int, int &gt;</a>, and <a class="el" href="classWt_1_1JSignal.html#aba4f375bcfd61c8938ceeafedd1b79b9">Wt::JSignal&lt; std::string, std::string &gt;</a>.</p>

</div>
</div>
<a class="anchor" id="afd8983929683ffc4c6dda8a91a7bda7b"></a><!-- doxytag: member="Wt::EventSignalBase::preventDefaultAction" ref="afd8983929683ffc4c6dda8a91a7bda7b" args="(bool prevent=true)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Wt::EventSignalBase::preventDefaultAction </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>prevent</em> = <code>true</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Prevents the default browser action. </p>
<p>Use this method to prevent the default browser action associated with this event.</p>
<dl class="see"><dt><b>See also:</b></dt><dd>setPreventPropagation() </dd></dl>

</div>
</div>
<a class="anchor" id="a63f088978e6dd375b3a329f458f9db3f"></a><!-- doxytag: member="Wt::EventSignalBase::preventPropagation" ref="a63f088978e6dd375b3a329f458f9db3f" args="(bool prevent=true)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Wt::EventSignalBase::preventPropagation </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>prevent</em> = <code>true</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Prevents event propagation. </p>
<p>Use this method to prevent that the event propagates further to its ancestors.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1EventSignalBase.html#afd8983929683ffc4c6dda8a91a7bda7b" title="Prevents the default browser action.">preventDefaultAction()</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a0660648ca23b59a30ddc3226ad4a55b3"></a><!-- doxytag: member="Wt::EventSignalBase::propagationPrevented" ref="a0660648ca23b59a30ddc3226ad4a55b3" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Wt::EventSignalBase::propagationPrevented </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns whether event propagation is prevented. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1EventSignalBase.html#a63f088978e6dd375b3a329f458f9db3f" title="Prevents event propagation.">preventPropagation()</a> </dd></dl>

</div>
</div>
</div>
<!-- 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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</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>

<hr size="1"><address style="text-align: right; margin: 3px"><small>
Generated on Thu Nov 1 2012 for <a href="http://www.webtoolkit.eu/wt">the
C++ Web Toolkit (Wt)</a> by&nbsp;<a
href="http://www.doxygen.org/index.html"><img src="doxygen.png"
alt="doxygen" border="0" style="vertical-align: middle; display:
inline-block; height: 2em"></a> 1.7.5.1</small></address>
</body>
</html>