.. wxPython Phoenix documentation

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

   Copyright: (c) 2011-2020 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.   
- EVT_WEBVIEW_FULLSCREEN_CHANGED: Process a  ``wxEVT_WEBVIEW_FULLSCREEN_CHANGED``   event, generated when the page wants to enter or leave fullscreen. Use GetInt to get the status. Not implemented for the IE backend and is only available in wxWidgets 3.1.5 or later.   
- EVT_WEBVIEW_SCRIPT_MESSAGE_RECEIVED: Process a  ``wxEVT_WEBVIEW_SCRIPT_MESSAGE_RECEIVED``   event only available in wxWidgets 3.1.5 or later. For usage details see  :meth:`wx.html2.WebView.AddScriptMessageHandler` .  
- wxEVT_WEBVIEW_SCRIPT_RESULT: Process a  ``wxEVT_WEBVIEW_SCRIPT_RESULT``   event only available in wxWidgets 3.1.6 or later. For usage details see  :meth:`wx.html2.WebView.RunScriptAsync` . ^^ 


: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>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.html2.WebViewEvent.html" title="A navigation event holds information about events associated with wx.html2.WebView  objects." alt="" coords="5,315,180,344"/> <area shape="rect" id="node2" href="wx.NotifyEvent.html" title="This class is not used by the event handlers by itself, but is a base class for other event classes (such as wx.BookCtrlEvent)." alt="" coords="35,237,150,267"/> <area shape="rect" id="node3" href="wx.CommandEvent.html" title="This event class contains information about command events, which originate from a variety of simple controls." alt="" coords="20,160,165,189"/> <area shape="rect" id="node4" href="wx.Event.html" title="An event is a structure holding information about an event passed to a callback or member function." alt="" coords="53,83,132,112"/> <area shape="rect" id="node5" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="51,5,134,35"/> </map> 
   </p>
   </div>

|


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

================================================================================ ================================================================================
:meth:`~wx.html2.WebViewEvent.__init__`                                          
:meth:`~wx.html2.WebViewEvent.GetMessageHandler`                                 Get the name of the script handler.
:meth:`~wx.html2.WebViewEvent.GetNavigationAction`                               Get the type of navigation action.
: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.
:meth:`~wx.html2.WebViewEvent.IsError`                                           Returns ``True`` the script execution failed.
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:attr:`~wx.html2.WebViewEvent.MessageHandler`                                    See :meth:`~wx.html2.WebViewEvent.GetMessageHandler`
:attr:`~wx.html2.WebViewEvent.NavigationAction`                                  See :meth:`~wx.html2.WebViewEvent.GetNavigationAction`
: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, flags=WEBVIEW_NAV_ACTION_NONE,
                    messageHandler="")
       
   
   A navigation event holds information about events associated with
   WebView objects.



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



      |overload| Overloaded Implementations:

      :html:`<hr class="overloadsep" /><br />`

      
      **__init__** `(self)`
      
      
      
      
      
      :html:`<hr class="overloadsep" /><br />`

      
      **__init__** `(self, type, id, href, target, flags=WEBVIEW_NAV_ACTION_NONE, messageHandler="")`
      
      
      
      
      :param `type`: 
      :type `type`: wx.EventType
      :param `id`: 
      :type `id`: int
      :param `href`: 
      :type `href`: string
      :param `target`: 
      :type `target`: string
      :param `flags`: 
      :type `flags`: wx.html2.WebViewNavigationActionFlags
      :param `messageHandler`: 
      :type `messageHandler`: string
      
      
      
      
      
      
      :html:`<hr class="overloadsep" /><br />`






   .. method:: GetMessageHandler(self)

      Get the name of the script handler.                  

      Only valid for events of type  ``wxEVT_WEBVIEW_SCRIPT_MESSAGE_RECEIVED``       

                

      :rtype: `string`







      .. versionadded:: 4.1/wxWidgets-3.1.5  
     








   .. method:: GetNavigationAction(self)

      Get the type of navigation action.                  

      Only valid for events of type  ``wxEVT_WEBVIEW_NEWWINDOW``       

                

      :rtype: :ref:`wx.html2.WebViewNavigationActionFlags`







      .. versionadded:: 4.1/wxWidgets-3.1.2  
     








   .. 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`








   .. method:: IsError(self)

      Returns ``True`` the script execution failed.                  

      Only valid for events of type  ``wxEVT_WEBVIEW_SCRIPT_RESULT``       

                

      :rtype: `bool`







      .. versionadded:: 4.1/wxWidgets-3.1.6  
     








   .. attribute:: MessageHandler

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


   .. attribute:: NavigationAction

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


   .. attribute:: Target

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


   .. attribute:: URL

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