Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

wxWebViewEvent (3erl)

Name

wxWebViewEvent - Functions for wxWebViewEvent class

Synopsis

Please see following description for synopsis

Description

wxWebViewEvent(3)          Erlang Module Definition          wxWebViewEvent(3)



NAME
       wxWebViewEvent - Functions for wxWebViewEvent class

DESCRIPTION
       A navigation event holds information about events associated with wxWe-
       bView objects.

       Since: 2.9.3

       See: wxWebView

       This class is derived  (and  can  use  functions)  from:  wxNotifyEvent
       wxCommandEvent wxEvent

       wxWidgets docs: wxWebViewEvent

EVENTS
       Use  wxEvtHandler:connect/3  with  wxWebViewEventType  to  subscribe to
       events of this type.

DATA TYPES
       wxWebViewEvent() = wx:wx_object()

       wxWebView() =
           #wxWebView{type = wxWebViewEvent:wxWebViewEventType(),
                      string = unicode:chardata(),
                      int = integer(),
                      target = unicode:chardata(),
                      url = unicode:chardata()}

       wxWebViewEventType() =
           webview_navigating | webview_navigated | webview_loaded |
           webview_error | webview_newwindow | webview_title_changed

EXPORTS
       getString(This) -> unicode:charlist()

              Types:

                 This = wxWebViewEvent()

              Returns item string for a listbox or choice selection event.

              If one or several items have been deselected, returns the  index
              of  the  first deselected item. If some items have been selected
              and others deselected at the same time, it will return the index
              of the first selected item.

       getInt(This) -> integer()

              Types:

                 This = wxWebViewEvent()

              Returns  the  integer  identifier  corresponding  to  a listbox,
              choice or radiobox selection (only if the event was a selection,
              not a deselection), or a boolean value representing the value of
              a checkbox.

              For a menu item, this method returns  -1  if  the  item  is  not
              checkable or a boolean value (true or false) for checkable items
              indicating the new state of the item.

       getTarget(This) -> unicode:charlist()

              Types:

                 This = wxWebViewEvent()

              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.

       getURL(This) -> unicode:charlist()

              Types:

                 This = wxWebViewEvent()

              Get the URL being visited.



wxWidgets team.                    wx 2.1.1                  wxWebViewEvent(3)