/doc/modules/mod_signal/mod_signal.html

https://code.google.com/p/zotonic/ · HTML · 140 lines · 118 code · 22 blank · 0 comment · 0 complexity · eeda0c36f5135be1f5f1398f41954559 MD5 · raw file 

    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4. <title>Module mod_signal</title>
    5. 

  5. <link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
    6. 

  6. </head>
    7. 

  7. <body bgcolor="white">
    8. 

  8. <div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
    9. 

  9. <hr>
    10. 

  10. 

  11. <h1>Module mod_signal</h1>
    12. 

  12. <ul class="index"><li><a href="#description">Description</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>Signal and slot mechanism for use in templates.
    13. 

  13. <p>Copyright Š 2010 Maas-Maarten Zeeman
    14. 

  14.   Date: 2010-12-03</p>
    15. 

  15. 

  16. <p><b>Behaviours:</b> <a href="gen_server.html"><tt>gen_server</tt></a>.</p>
    17. 

  17. <p><b>Authors:</b> Maas-Maarten Zeeman (<a href="mailto:mmzeeman@xs4all.nl"><tt>mmzeeman@xs4all.nl</tt></a>).</p>
    18. 

  18. 

  19. <h2><a name="description">Description</a></h2>Signal and slot mechanism for use in templates.
    20. 

  20. <h2><a name="index">Function Index</a></h2>
    21. 

  21. <table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#code_change-3">code_change/3</a></td><td></td></tr>
    22. 

  22. <tr><td valign="top"><a href="#connect-3">connect/3</a></td><td>Connect signal to slot.</td></tr>
    23. 

  23. <tr><td valign="top"><a href="#disconnect-3">disconnect/3</a></td><td>Disconnect signal and slot.</td></tr>
    24. 

  24. <tr><td valign="top"><a href="#emit-2">emit/2</a></td><td>Emit the signal.</td></tr>
    25. 

  25. <tr><td valign="top"><a href="#emit_signal-3">emit_signal/3</a></td><td>Emit a single signal.</td></tr>
    26. 

  26. <tr><td valign="top"><a href="#handle_call-3">handle_call/3</a></td><td></td></tr>
    27. 

  27. <tr><td valign="top"><a href="#handle_cast-2">handle_cast/2</a></td><td></td></tr>
    28. 

  28. <tr><td valign="top"><a href="#handle_info-2">handle_info/2</a></td><td></td></tr>
    29. 

  29. <tr><td valign="top"><a href="#init-1">init/1</a></td><td></td></tr>
    30. 

  30. <tr><td valign="top"><a href="#item_count-1">item_count/1</a></td><td>Return how many items there.</td></tr>
    31. 

  31. <tr><td valign="top"><a href="#key-1">key/1</a></td><td></td></tr>
    32. 

  32. <tr><td valign="top"><a href="#key-2">key/2</a></td><td></td></tr>
    33. 

  33. <tr><td valign="top"><a href="#slot_count-1">slot_count/1</a></td><td>Return how many slots there are connected.</td></tr>
    34. 

  34. <tr><td valign="top"><a href="#slots-2">slots/2</a></td><td>Return the slots connected to this signal.</td></tr>
    35. 

  35. <tr><td valign="top"><a href="#start_link-1">start_link/1</a></td><td>.</td></tr>
    36. 

  36. <tr><td valign="top"><a href="#stop-1">stop/1</a></td><td>Stop the module..</td></tr>
    37. 

  37. <tr><td valign="top"><a href="#terminate-2">terminate/2</a></td><td></td></tr>
    38. 

  38. </table>
    39. 

  39. 

  40. <h2><a name="functions">Function Details</a></h2>
    41. 

  41. 

  42. <h3 class="function"><a name="code_change-3">code_change/3</a></h3>
    43. 

  43. <div class="spec">
    44. 

  44. <p><tt>code_change(OldVsn, State, Extra) -&gt; any()</tt></p>
    45. 

  45. </div>
    46. 

  46. 

  47. <h3 class="function"><a name="connect-3">connect/3</a></h3>
    48. 

  48. <div class="spec">
    49. 

  49. <p><tt>connect(Signal, Slot, Context) -&gt; any()</tt></p>
    50. 

  50. </div><p>Connect signal to slot
    51. 

  51. </p>
    52. 

  52. 

  53. <h3 class="function"><a name="disconnect-3">disconnect/3</a></h3>
    54. 

  54. <div class="spec">
    55. 

  55. <p><tt>disconnect(Signal, Slot, Context) -&gt; any()</tt></p>
    56. 

  56. </div><p>Disconnect signal and slot
    57. 

  57. </p>
    58. 

  58. 

  59. <h3 class="function"><a name="emit-2">emit/2</a></h3>
    60. 

  60. <div class="spec">
    61. 

  61. <p><tt>emit(Signal, Context) -&gt; any()</tt></p>
    62. 

  62. </div><p>Emit the signal. Calls the connected slots..
    63. 

  63. </p>
    64. 

  64. 

  65. <h3 class="function"><a name="emit_signal-3">emit_signal/3</a></h3>
    66. 

  66. <div class="spec">
    67. 

  67. <p><tt>emit_signal(Signal, Slot, Context) -&gt; any()</tt></p>
    68. 

  68. </div><p>Emit a single signal
    69. 

  69. </p>
    70. 

  70. 

  71. <h3 class="function"><a name="handle_call-3">handle_call/3</a></h3>
    72. 

  72. <div class="spec">
    73. 

  73. <p><tt>handle_call(Message, From, State) -&gt; any()</tt></p>
    74. 

  74. </div>
    75. 

  75. 

  76. <h3 class="function"><a name="handle_cast-2">handle_cast/2</a></h3>
    77. 

  77. <div class="spec">
    78. 

  78. <p><tt>handle_cast(Message, State) -&gt; any()</tt></p>
    79. 

  79. </div>
    80. 

  80. 

  81. <h3 class="function"><a name="handle_info-2">handle_info/2</a></h3>
    82. 

  82. <div class="spec">
    83. 

  83. <p><tt>handle_info(Info, State) -&gt; any()</tt></p>
    84. 

  84. </div>
    85. 

  85. 

  86. <h3 class="function"><a name="init-1">init/1</a></h3>
    87. 

  87. <div class="spec">
    88. 

  88. <p><tt>init(Args) -&gt; any()</tt></p>
    89. 

  89. </div>
    90. 

  90. 

  91. <h3 class="function"><a name="item_count-1">item_count/1</a></h3>
    92. 

  92. <div class="spec">
    93. 

  93. <p><tt>item_count(Context) -&gt; any()</tt></p>
    94. 

  94. </div><p>Return how many items there
    95. 

  95. </p>
    96. 

  96. 

  97. <h3 class="function"><a name="key-1">key/1</a></h3>
    98. 

  98. <div class="spec">
    99. 

  99. <p><tt>key(Signal) -&gt; any()</tt></p>
    100. 

  100. </div>
    101. 

  101. 

  102. <h3 class="function"><a name="key-2">key/2</a></h3>
    103. 

  103. <div class="spec">
    104. 

  104. <p><tt>key(X1, Tags) -&gt; any()</tt></p>
    105. 

  105. </div>
    106. 

  106. 

  107. <h3 class="function"><a name="slot_count-1">slot_count/1</a></h3>
    108. 

  108. <div class="spec">
    109. 

  109. <p><tt>slot_count(Context) -&gt; any()</tt></p>
    110. 

  110. </div><p>Return how many slots there are connected
    111. 

  111. </p>
    112. 

  112. 

  113. <h3 class="function"><a name="slots-2">slots/2</a></h3>
    114. 

  114. <div class="spec">
    115. 

  115. <p><tt>slots(Signal, Context) -&gt; any()</tt></p>
    116. 

  116. </div><p>Return the slots connected to this signal
    117. 

  117. </p>
    118. 

  118. 

  119. <h3 class="function"><a name="start_link-1">start_link/1</a></h3>
    120. 

  120. <div class="spec">
    121. 

  121. <p><tt>start_link(Args) -&gt; any()</tt></p>
    122. 

  122. </div><p>
    123. 

  123. </p>
    124. 

  124. 

  125. <h3 class="function"><a name="stop-1">stop/1</a></h3>
    126. 

  126. <div class="spec">
    127. 

  127. <p><tt>stop(Context) -&gt; any()</tt></p>
    128. 

  128. </div><p>Stop the module..
    129. 

  129. </p>
    130. 

  130. 

  131. <h3 class="function"><a name="terminate-2">terminate/2</a></h3>
    132. 

  132. <div class="spec">
    133. 

  133. <p><tt>terminate(Reason, State) -&gt; any()</tt></p>
    134. 

  134. </div>
    135. 

  135. <hr>
    136. 

  136. 

  137. <div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
    138. 

  138. <p><i>Generated by EDoc, Aug 12 2011, 19:36:12.</i></p>
    139. 

  139. </body>
    140. 

  140. </html>
    141.