File: wx.html2.WebViewEvent.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (214 lines) | stat: -rw-r--r-- 6,706 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
.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2018 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc



.. _wx.html2.WebViewEvent:

==========================================================================================================================================
|phoenix_title|  **wx.html2.WebViewEvent**
==========================================================================================================================================

A navigation event holds information about events associated with :ref:`wx.html2.WebView`  objects.          







.. _WebViewEvent-events:

|events| Events Emitted by this Class
=====================================

Handlers bound for the following event types will receive a :ref:`wx.html2.WebViewEvent` parameter.


- EVT_WEBVIEW_NAVIGATING: Process a  ``wxEVT_WEBVIEW_NAVIGATING``   event, generated before trying to get a resource. This event may be vetoed to prevent navigating to this resource. Note that if the displayed HTML document has several frames, one such event will be generated per frame.   
- EVT_WEBVIEW_NAVIGATED: Process a  ``wxEVT_WEBVIEW_NAVIGATED``   event generated after it was confirmed that a resource would be requested. This event may not be vetoed. Note that if the displayed HTML document has several frames, one such event will be generated per frame.   
- EVT_WEBVIEW_LOADED: Process a  ``wxEVT_WEBVIEW_LOADED``   event generated when the document is fully loaded and displayed. Note that if the displayed HTML document has several frames, one such event will be generated per frame.   
- EVT_WEBVIEW_ERROR: Process a  ``wxEVT_WEBVIEW_ERROR``   event generated when a navigation error occurs. The integer associated with this event will be a  :ref:`wx.html2.WebViewNavigationError`  item. The string associated with this event may contain a backend-specific more precise error message/code.  
- EVT_WEBVIEW_NEWWINDOW: Process a  ``wxEVT_WEBVIEW_NEWWINDOW``   event, generated when a new window is created. You must handle this event if you want anything to happen, for example to load the page in a new window or tab.   
- EVT_WEBVIEW_TITLE_CHANGED: Process a  ``wxEVT_WEBVIEW_TITLE_CHANGED``   event, generated when the page title changes. Use GetString to get the title.   


:ref:`wx.html2.WebView` 



         



.. versionadded:: 2.9.3 
     







.. seealso:: :ref:`wx.html2.WebView`    







|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>WebViewEvent</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.html2.WebViewEvent_inheritance.png" alt="Inheritance diagram of WebViewEvent" usemap="#dummy" class="inheritance"/></center>
   </div>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Event.html" title="wx.Event" alt="" coords="53,83,131,112"/> <area shape="rect" id="node3" href="wx.CommandEvent.html" title="wx.CommandEvent" alt="" coords="19,160,164,189"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="51,5,132,35"/> <area shape="rect" id="node5" href="wx.NotifyEvent.html" title="wx.NotifyEvent" alt="" coords="35,237,149,267"/> <area shape="rect" id="node4" href="wx.html2.WebViewEvent.html" title="wx.html2.WebViewEvent" alt="" coords="5,315,179,344"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.html2.WebViewEvent.__init__`                                          
:meth:`~wx.html2.WebViewEvent.GetTarget`                                         Get the name of the target frame which the url of this event has been or will be loaded into.
:meth:`~wx.html2.WebViewEvent.GetURL`                                            Get the URL being visited.
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~wx.html2.WebViewEvent.Target`                                            See :meth:`~wx.html2.WebViewEvent.GetTarget`
:attr:`~wx.html2.WebViewEvent.URL`                                               See :meth:`~wx.html2.WebViewEvent.GetURL`
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: wx.html2.WebViewEvent(NotifyEvent)

   **Possible constructors**::

       WebViewEvent()
       
       WebViewEvent(type, id, href, target)
       
   
   A navigation event holds information about events associated with
   WebView objects.



   .. method:: __init__(self, *args, **kw)



      |overload| Overloaded Implementations:

      **~~~**

      
      **__init__** `(self)`
      
      
      
      
      
      **~~~**

      
      **__init__** `(self, type, id, href, target)`
      
      
      
      
      :param `type`: 
      :type `type`: wx.EventType
      :param `id`: 
      :type `id`: int
      :param `href`: 
      :type `href`: string
      :param `target`: 
      :type `target`: string
      
      
      
      
      
      
      **~~~**






   .. method:: GetTarget(self)

      Get the name of the target frame which the url of this event has been or will be loaded into.                  

      This may return an empty string if the frame is not available.                  

      :rtype: `string`








   .. method:: GetURL(self)

      Get the URL being visited.                  

      :rtype: `string`








   .. attribute:: Target

      See :meth:`~wx.html2.WebViewEvent.GetTarget`


   .. attribute:: URL

      See :meth:`~wx.html2.WebViewEvent.GetURL`