libjuce-doc 4.3.0~repack-1 / usr / share / doc / libjuce / apiref / classCallbackMessage.html

This file is indexed.

/usr/share/doc/libjuce/apiref/classCallbackMessage.html is in libjuce-doc 4.3.0~repack-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
<!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.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: CallbackMessage 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">JUCE
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</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><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classCallbackMessage-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">CallbackMessage Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>A message that invokes a callback method when it gets delivered.  
 <a href="classCallbackMessage.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for CallbackMessage:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
 <div class="center">
  <img src="classCallbackMessage.png" usemap="#CallbackMessage_map" alt=""/>
  <map id="CallbackMessage_map" name="CallbackMessage_map">
<area href="classMessageManager_1_1MessageBase.html" title="Internal class used as the base class for all message objects. " alt="MessageManager::MessageBase" shape="rect" coords="0,56,199,80"/>
<area href="classReferenceCountedObject.html" title="A base class which provides methods for reference-counting. " alt="ReferenceCountedObject" shape="rect" coords="0,0,199,24"/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a670d5e9feb62e19814b1dfc25c00e9f7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCallbackMessage.html#a670d5e9feb62e19814b1dfc25c00e9f7">CallbackMessage</a> () noexcept</td></tr>
<tr class="separator:a670d5e9feb62e19814b1dfc25c00e9f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa4bb7bd8f5962edcc53c5df37cd8b25"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCallbackMessage.html#afa4bb7bd8f5962edcc53c5df37cd8b25">~CallbackMessage</a> ()</td></tr>
<tr class="memdesc:afa4bb7bd8f5962edcc53c5df37cd8b25"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#afa4bb7bd8f5962edcc53c5df37cd8b25">More...</a><br /></td></tr>
<tr class="separator:afa4bb7bd8f5962edcc53c5df37cd8b25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f72c1e680e26f44780ac9437f3450de"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCallbackMessage.html#a1f72c1e680e26f44780ac9437f3450de">messageCallback</a> ()=0</td></tr>
<tr class="memdesc:a1f72c1e680e26f44780ac9437f3450de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when the message is delivered.  <a href="#a1f72c1e680e26f44780ac9437f3450de">More...</a><br /></td></tr>
<tr class="separator:a1f72c1e680e26f44780ac9437f3450de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classMessageManager_1_1MessageBase"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classMessageManager_1_1MessageBase')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classMessageManager_1_1MessageBase.html">MessageManager::MessageBase</a></td></tr>
<tr class="memitem:aa6778b8af6b43e189e8e9d5136609bdc inherit pub_methods_classMessageManager_1_1MessageBase"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageManager_1_1MessageBase.html#aa6778b8af6b43e189e8e9d5136609bdc">MessageBase</a> () noexcept</td></tr>
<tr class="separator:aa6778b8af6b43e189e8e9d5136609bdc inherit pub_methods_classMessageManager_1_1MessageBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68a883d493b6ae46b030b9f51bbc2dce inherit pub_methods_classMessageManager_1_1MessageBase"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageManager_1_1MessageBase.html#a68a883d493b6ae46b030b9f51bbc2dce">~MessageBase</a> ()</td></tr>
<tr class="separator:a68a883d493b6ae46b030b9f51bbc2dce inherit pub_methods_classMessageManager_1_1MessageBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2bcdf57123967a59650bd46543906796 inherit pub_methods_classMessageManager_1_1MessageBase"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageManager_1_1MessageBase.html#a2bcdf57123967a59650bd46543906796">post</a> ()</td></tr>
<tr class="separator:a2bcdf57123967a59650bd46543906796 inherit pub_methods_classMessageManager_1_1MessageBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classReferenceCountedObject"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classReferenceCountedObject')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classReferenceCountedObject.html">ReferenceCountedObject</a></td></tr>
<tr class="memitem:a878ca594f89f757d29af5a42ee51161f inherit pub_methods_classReferenceCountedObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReferenceCountedObject.html#a878ca594f89f757d29af5a42ee51161f">incReferenceCount</a> () noexcept</td></tr>
<tr class="memdesc:a878ca594f89f757d29af5a42ee51161f inherit pub_methods_classReferenceCountedObject"><td class="mdescLeft">&#160;</td><td class="mdescRight">Increments the object's reference count.  <a href="classReferenceCountedObject.html#a878ca594f89f757d29af5a42ee51161f">More...</a><br /></td></tr>
<tr class="separator:a878ca594f89f757d29af5a42ee51161f inherit pub_methods_classReferenceCountedObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a523f06d996130f24b36996b28b83d802 inherit pub_methods_classReferenceCountedObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReferenceCountedObject.html#a523f06d996130f24b36996b28b83d802">decReferenceCount</a> () noexcept</td></tr>
<tr class="memdesc:a523f06d996130f24b36996b28b83d802 inherit pub_methods_classReferenceCountedObject"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decreases the object's reference count.  <a href="classReferenceCountedObject.html#a523f06d996130f24b36996b28b83d802">More...</a><br /></td></tr>
<tr class="separator:a523f06d996130f24b36996b28b83d802 inherit pub_methods_classReferenceCountedObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2355316960a6bf2e9691fded43249254 inherit pub_methods_classReferenceCountedObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReferenceCountedObject.html#a2355316960a6bf2e9691fded43249254">decReferenceCountWithoutDeleting</a> () noexcept</td></tr>
<tr class="memdesc:a2355316960a6bf2e9691fded43249254 inherit pub_methods_classReferenceCountedObject"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decreases the object's reference count.  <a href="classReferenceCountedObject.html#a2355316960a6bf2e9691fded43249254">More...</a><br /></td></tr>
<tr class="separator:a2355316960a6bf2e9691fded43249254 inherit pub_methods_classReferenceCountedObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0111caf12d101fc74abd832d44fbfa4f inherit pub_methods_classReferenceCountedObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReferenceCountedObject.html#a0111caf12d101fc74abd832d44fbfa4f">getReferenceCount</a> () const noexcept</td></tr>
<tr class="memdesc:a0111caf12d101fc74abd832d44fbfa4f inherit pub_methods_classReferenceCountedObject"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the object's current reference count.  <a href="classReferenceCountedObject.html#a0111caf12d101fc74abd832d44fbfa4f">More...</a><br /></td></tr>
<tr class="separator:a0111caf12d101fc74abd832d44fbfa4f inherit pub_methods_classReferenceCountedObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_classMessageManager_1_1MessageBase"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classMessageManager_1_1MessageBase')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classMessageManager_1_1MessageBase.html">MessageManager::MessageBase</a></td></tr>
<tr class="memitem:a0f00522db88c06d0dae02759f197dfa9 inherit pub_types_classMessageManager_1_1MessageBase"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classReferenceCountedObjectPtr.html">ReferenceCountedObjectPtr</a>&lt; <a class="el" href="classMessageManager_1_1MessageBase.html">MessageBase</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageManager_1_1MessageBase.html#a0f00522db88c06d0dae02759f197dfa9">Ptr</a></td></tr>
<tr class="separator:a0f00522db88c06d0dae02759f197dfa9 inherit pub_types_classMessageManager_1_1MessageBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_classReferenceCountedObject"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classReferenceCountedObject')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classReferenceCountedObject.html">ReferenceCountedObject</a></td></tr>
<tr class="memitem:a86c1a0791cb6e98e63f7c1f7812c6eb5 inherit pro_methods_classReferenceCountedObject"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReferenceCountedObject.html#a86c1a0791cb6e98e63f7c1f7812c6eb5">ReferenceCountedObject</a> ()</td></tr>
<tr class="memdesc:a86c1a0791cb6e98e63f7c1f7812c6eb5 inherit pro_methods_classReferenceCountedObject"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates the reference-counted object (with an initial ref count of zero).  <a href="classReferenceCountedObject.html#a86c1a0791cb6e98e63f7c1f7812c6eb5">More...</a><br /></td></tr>
<tr class="separator:a86c1a0791cb6e98e63f7c1f7812c6eb5 inherit pro_methods_classReferenceCountedObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ed87d7f91e5ae51c620947c61291375 inherit pro_methods_classReferenceCountedObject"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReferenceCountedObject.html#a7ed87d7f91e5ae51c620947c61291375">~ReferenceCountedObject</a> ()</td></tr>
<tr class="memdesc:a7ed87d7f91e5ae51c620947c61291375 inherit pro_methods_classReferenceCountedObject"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="classReferenceCountedObject.html#a7ed87d7f91e5ae51c620947c61291375">More...</a><br /></td></tr>
<tr class="separator:a7ed87d7f91e5ae51c620947c61291375 inherit pro_methods_classReferenceCountedObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9bbeeab431755e2be8ff09dfe9ea4c4d inherit pro_methods_classReferenceCountedObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReferenceCountedObject.html#a9bbeeab431755e2be8ff09dfe9ea4c4d">resetReferenceCount</a> () noexcept</td></tr>
<tr class="memdesc:a9bbeeab431755e2be8ff09dfe9ea4c4d inherit pro_methods_classReferenceCountedObject"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resets the reference count to zero without deleting the object.  <a href="classReferenceCountedObject.html#a9bbeeab431755e2be8ff09dfe9ea4c4d">More...</a><br /></td></tr>
<tr class="separator:a9bbeeab431755e2be8ff09dfe9ea4c4d inherit pro_methods_classReferenceCountedObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A message that invokes a callback method when it gets delivered. </p>
<p>You can use this class to fire off actions that you want to be performed later on the message thread.</p>
<p>To use it, create a subclass of <a class="el" href="classCallbackMessage.html" title="A message that invokes a callback method when it gets delivered. ">CallbackMessage</a> which implements the <a class="el" href="classCallbackMessage.html#a1f72c1e680e26f44780ac9437f3450de" title="Called when the message is delivered. ">messageCallback()</a> method, then call <a class="el" href="classMessageManager_1_1MessageBase.html#a2bcdf57123967a59650bd46543906796">post()</a> to dispatch it. The event thread will then invoke your <a class="el" href="classCallbackMessage.html#a1f72c1e680e26f44780ac9437f3450de" title="Called when the message is delivered. ">messageCallback()</a> method later on, and will automatically delete the message object afterwards.</p>
<p>Always create a new instance of a <a class="el" href="classCallbackMessage.html" title="A message that invokes a callback method when it gets delivered. ">CallbackMessage</a> on the heap, as it will be deleted automatically after the message has been delivered.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classMessageManager.html" title="This class is in charge of the application&#39;s event-dispatch loop. ">MessageManager</a>, <a class="el" href="classMessageListener.html" title="MessageListener subclasses can post and receive Message objects. ">MessageListener</a>, <a class="el" href="classActionListener.html" title="Interface class for delivery of events that are sent by an ActionBroadcaster. ">ActionListener</a>, <a class="el" href="classChangeListener.html" title="Receives change event callbacks that are sent out by a ChangeBroadcaster. ">ChangeListener</a> </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a670d5e9feb62e19814b1dfc25c00e9f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a670d5e9feb62e19814b1dfc25c00e9f7">&sect;&nbsp;</a></span>CallbackMessage()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">CallbackMessage::CallbackMessage </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="afa4bb7bd8f5962edcc53c5df37cd8b25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa4bb7bd8f5962edcc53c5df37cd8b25">&sect;&nbsp;</a></span>~CallbackMessage()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CallbackMessage::~CallbackMessage </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Destructor. </p>

<p>References <a class="el" href="juce__PlatformDefs_8h.html#a6ab7a603bf4435c7cb286b1744366eb2">JUCE_DECLARE_NON_COPYABLE</a>, and <a class="el" href="classMessageManager_1_1MessageBase.html#a3cbc8f5a0aa7496a7653fa3c0fd49232">MessageManager::MessageBase::messageCallback()</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a1f72c1e680e26f44780ac9437f3450de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f72c1e680e26f44780ac9437f3450de">&sect;&nbsp;</a></span>messageCallback()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void CallbackMessage::messageCallback </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Called when the message is delivered. </p>
<p>You should implement this method and make it do whatever action you want to perform.</p>
<p>Note that like all other messages, this object will be deleted immediately after this method has been invoked. </p>

<p>Implements <a class="el" href="classMessageManager_1_1MessageBase.html#a3cbc8f5a0aa7496a7653fa3c0fd49232">MessageManager::MessageBase</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__CallbackMessage_8h.html">juce_CallbackMessage.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content &copy ROLI Ltd.</small></address><br/>
</body>
</html>

APT Browse - Built by Thomas Orozco.