.. 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.WebViewHandlerRequest:

==========================================================================================================================================
|phoenix_title|  **wx.html2.WebViewHandlerRequest**
==========================================================================================================================================

A class giving access to various parameters of a webview request. 
         

:ref:`wx.html2.WebView` 




         



.. versionadded:: 4.3/wxWidgets-3.3.0  
     







.. seealso:: :meth:`wx.html2.WebViewHandler.StartRequest`     







|

|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>WebViewHandlerRequest</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.WebViewHandlerRequest_inheritance.svg" alt="Inheritance diagram of WebViewHandlerRequest" 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.WebViewHandlerRequest.html" title="A class giving access to various parameters of a webview request." alt="" coords="5,5,286,34"/> </map> 
   </p>
   </div>

|


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

================================================================================ ================================================================================
:meth:`~wx.html2.WebViewHandlerRequest.GetData`                                  
:meth:`~wx.html2.WebViewHandlerRequest.GetHeader`                                Returns a header from the request or an empty string if the header could not be found.
:meth:`~wx.html2.WebViewHandlerRequest.GetMethod`                                
:meth:`~wx.html2.WebViewHandlerRequest.GetRawURI`                                
:meth:`~wx.html2.WebViewHandlerRequest.GetURI`                                   
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:attr:`~wx.html2.WebViewHandlerRequest.Data`                                     See :meth:`~wx.html2.WebViewHandlerRequest.GetData`
:attr:`~wx.html2.WebViewHandlerRequest.Method`                                   See :meth:`~wx.html2.WebViewHandlerRequest.GetMethod`
:attr:`~wx.html2.WebViewHandlerRequest.RawURI`                                   See :meth:`~wx.html2.WebViewHandlerRequest.GetRawURI`
:attr:`~wx.html2.WebViewHandlerRequest.URI`                                      See :meth:`~wx.html2.WebViewHandlerRequest.GetURI`
================================================================================ ================================================================================


|


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


.. class:: wx.html2.WebViewHandlerRequest(object)

   A class giving access to various parameters of a webview request.



   .. method:: GetData(self)




                

      :rtype: `InputStream`     







      :returns: 

         The body data of the request of  ``null``   if nothing was posted.    








   .. method:: GetHeader(self, name)

      Returns a header from the request or an empty string if the header could not be found. 
                 




      :param `name`: Name of the header field   
      :type `name`: string






      :rtype: `str`




                  





   .. method:: GetMethod(self)




                

      :rtype: `str`







      :returns: 

         The requests ``HTTP`` method (e.g. ``POST``, ``GET``, ``OPTIONS``).   








   .. method:: GetRawURI(self)




                

      :rtype: `str`







      :returns: 

         The unmodified url of the request.   








   .. method:: GetURI(self)




                

      :rtype: `str`







      :returns: 

         The url of the request. Can be modified by the backend for compatibility.   








   .. attribute:: Data

      See :meth:`~wx.html2.WebViewHandlerRequest.GetData`


   .. attribute:: Method

      See :meth:`~wx.html2.WebViewHandlerRequest.GetMethod`


   .. attribute:: RawURI

      See :meth:`~wx.html2.WebViewHandlerRequest.GetRawURI`


   .. attribute:: URI

      See :meth:`~wx.html2.WebViewHandlerRequest.GetURI`