File: signal.WebFormManager.will-send-submit-event.html

package info (click to toggle)
webkit2gtk 2.50.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 445,712 kB
  • sloc: cpp: 3,798,329; javascript: 197,914; ansic: 161,339; python: 49,141; asm: 21,987; ruby: 18,540; perl: 16,723; xml: 4,623; yacc: 2,360; sh: 2,246; java: 2,019; lex: 1,327; pascal: 366; makefile: 300
file content (252 lines) | stat: -rw-r--r-- 8,239 bytes parent folder | download
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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
<!--
SPDX-FileCopyrightText: The WebKit GTK and WPE teams

SPDX-License-Identifier: BSD, LGPL-2.1
-->

<!DOCTYPE html>
<html lang="en">
<head>
  <title>WebKitWebProcessExtension.WebFormManager::will-send-submit-event</title>
  <meta name="viewport" content="width=device-width, initial-scale=1">

  <meta charset="utf-8" />

  
  <meta property="og:type" content="website"/>

  

  
  <meta property="og:title" content="WebKitWebProcessExtension.WebFormManager::will-send-submit-event"/>
  <meta property="og:description" content="Reference for signal WebKitWebProcessExtension.WebFormManager::will-send-submit-event"/>
  <meta name="twitter:title" content="WebKitWebProcessExtension.WebFormManager::will-send-submit-event"/>
  <meta name="twitter:description" content="Reference for signal WebKitWebProcessExtension.WebFormManager::will-send-submit-event"/>


  
  <meta name="twitter:card" content="summary"/>

  
  
  
  

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

  

  
  <script src="gtk4-urlmap.js"></script>
  
  
  <script src="fzy.js"></script>
  <script src="search.js"></script>
  
  <script src="main.js"></script>
</head>

<body>
  <div id="body-wrapper" tabindex="-1">

    <nav class="sidebar devhelp-hidden">
      
      
      <div class="search section">
        <form id="search-form" autocomplete="off">
          <input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
        </form>
      </div>
      
      <div class="section namespace">
        <h3><a href="index.html">WebKitWebProcessExtension</a></h3>
        <p>API Version: 6.0</p>
        
        <p>Library Version: 2.50.1</p>
        
      </div>
      
<div class="section">
  <h5>Type</h5>
  <div class="links">
    <a href="class.WebFormManager.html">WebFormManager</a>
  </div>
</div>
<div class="section">
  <h5>Signals</h5>
  <div class="links">
  
    <a class="signal" href="signal.WebFormManager.form-controls-associated.html">form-controls-associated</a>
  
    <a class="signal current" href="signal.WebFormManager.will-send-submit-event.html">will-send-submit-event</a>
  
    <a class="signal" href="signal.WebFormManager.will-submit-form.html">will-submit-form</a>
  
  </div>
</div>

      <div class="section generator">
        <p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.4</p>
      </div>
    </nav>

    <button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>

    
<section id="main" class="content">
  <header>
    <h3>Signal</h3>
    <h1><a href="index.html">WebKitWebProcessExtension</a><span class="sep"></span><a href="class.WebFormManager.html">WebFormManager</a>::will-send-submit-event</h1>
  </header>

  <section>
    <div class="docblock">
      <p><span class="emblem available">since: 2.40</span></p>
    </div>
    <div class="declaration toggle-wrapper">
      <h4 id="declaration">
        Declaration
        <a href="#declaration" class="anchor"></a>
      </h4>

      <div class="docblock">
        <pre><code><div class="highlight"><pre><span></span><span class="kt">void</span>
<span class="n">will_send_submit_event</span><span class="w"> </span><span class="p">(</span>
<span class="w">  </span><span class="n">WebKitWebFormManager</span><span class="o">*</span><span class="w"> </span><span class="n">self</span><span class="p">,</span>
<span class="w">  </span><span class="n">JSCValue</span><span class="o">*</span><span class="w"> </span><span class="n">form</span><span class="p">,</span>
<span class="w">  </span><span class="n">WebKitFrame</span><span class="o">*</span><span class="w"> </span><span class="n">source_frame</span><span class="p">,</span>
<span class="w">  </span><span class="n">WebKitFrame</span><span class="o">*</span><span class="w"> </span><span class="n">target_frame</span><span class="p">,</span>
<span class="w">  </span><span class="n">gpointer</span><span class="w"> </span><span class="n">user_data</span>
<span class="p">)</span>
</pre></div>
</code></pre>
      </div>
    </div>

    <div class="description toggle-wrapper">
      <h4 id="description" style="display:flex;">
        Description
        <a href="#description" class="anchor"></a>
        
        <a class="srclink" title="go to source location" href="https://github.com/WebKit/WebKit/tree/main/Source/WebKit/WebProcess/InjectedBundle/API/glib/WebKitWebFormManager.cpp#L90">[src]</a>
        
      </h4>

      <div class="docblock">
        <p>This signal is emitted when the <span class="caps">DOM</span> submit event is about to be fired for <code>form</code>.
JavaScript code may rely on the submit event to detect that the user has clicked
on a submit button, and to possibly cancel the form submission before
<code>WebKitWebFormManager::will-submit-form</code> signal is emitted.
However, beware that, for historical reasons, the submit event is not emitted at
all if the form submission is triggered by JavaScript. For these reasons,
this signal may not be used to reliably detect whether a form will be submitted.
Instead, use it to detect if a user has clicked on a form&#8217;s submit button even if
JavaScript later cancels the form submission, or to read the values of the form&#8217;s
fields even if JavaScript later clears certain fields before submitting. This may
be needed, for example, to implement a robust browser password manager, as some
misguided websites may use such techniques to attempt to thwart password&nbsp;managers.</p>
      </div>

      <div class="docblock">
        <table>
          <tr><td>Default handler: <p>The default handler is called after the handlers added via <code>g_signal_connect()</code>.</p></td></tr>
          
          
          
          
          
          
          <tr><td>Available since: 2.40</td></tr>
          
          
        </table>
      </div>

      
    </div>

    
    <div class="parameters toggle-wrapper">
      <h4 id="parameters">
        Parameters
        <a href="#parameters" class="anchor"></a>
      </h4>

      <div class="docblock">
        <dl class="arguments">
          
          <dt class="arg-name"><code>form</code></dt>
          <dd class="arg-description">
            <p><em>Type:</em>&nbsp;<a href="javascript:void(0)" data-link="class.Value.html" data-namespace="JavaScriptCore" class="external"><code>JSCValue</code></a></p>
            <p>The <code>JSCValue</code> to be submitted, which will always correspond to an&nbsp;HTMLFormElement.</p>
            <table>
            
            
            
            
            
            
            
            <tr><td title="transfer: none">The data is owned by the caller of the function.</td></tr>
            
            </table>
          </dd>
          
          <dt class="arg-name"><code>source_frame</code></dt>
          <dd class="arg-description">
            <p><em>Type:</em>&nbsp;<a href="class.Frame.html"><code>WebKitFrame</code></a></p>
            <p>The <code>WebKitFrame</code> containing the form to be&nbsp;submitted.</p>
            <table>
            
            
            
            
            
            
            
            <tr><td title="transfer: none">The data is owned by the caller of the function.</td></tr>
            
            </table>
          </dd>
          
          <dt class="arg-name"><code>target_frame</code></dt>
          <dd class="arg-description">
            <p><em>Type:</em>&nbsp;<a href="class.Frame.html"><code>WebKitFrame</code></a></p>
            <p>The <code>WebKitFrame</code> containing the form&#8217;s target,
    which may be the same as <code>source_frame</code> if no target was&nbsp;specified.</p>
            <table>
            
            
            
            
            
            
            
            <tr><td title="transfer: none">The data is owned by the caller of the function.</td></tr>
            
            </table>
          </dd>
          

          
        </dl>
      </div>
    </div>
    

    

  </section>
</section>


    

    <section id="search" class="content hidden"></section>

    <footer>
    
    </footer>
  </div>
</body>
</html>