HelpSource/Classes/WebView.schelp

   1 class:: WebView
   2 redirect:: implClass
   3 summary:: Web page display and browser
   4 categories:: GUI>Views
   5
   6 DESCRIPTION::
   7
   8 WebView displays web pages and provides all the standard browsing functionality.
   9
  10 CLASSMETHODS::
  11
  12 PRIVATE:: key
  13
  14 METHOD:: clearCache
  15
  16   Clears all the memory caches, so that link::#-reload#reloading:: a page is ensured to reload all the resources.
  17
  18
  19 INSTANCEMETHODS::
  20
  21
  22 SUBSECTION:: Navigation
  23
  24 METHOD:: url
  25
  26     Gets the current URL, or navigates to a new one.
  27
  28 METHOD:: reload
  29
  30     Reloads the current page.
  31
  32 METHOD:: back
  33
  34     Navigates to the previous page in history.
  35
  36 METHOD:: forward
  37
  38     Navigates to the next page in history.
  39
  40 METHOD:: findText
  41
  42     Finds and selects the next instance of given text on the current page. When the given text changes, the search starts anew.
  43
  44     Argument:: string
  45         The text to find; a String.
  46
  47     Argument:: reverse
  48         Whether to search in reverse direction; a Boolean.
  49
  50
  51 SUBSECTION:: Data
  52
  53 METHOD:: html
  54
  55     Gets or sets the displayed html content.
  56
  57     Argument::
  58         A String.
  59
  60 METHOD:: plainText
  61
  62     Tries to extract plain text from the displayed content, and returns it.
  63     Returns:: A String.
  64
  65 METHOD:: title
  66
  67     The title of the current page.
  68     Returns:: A String.
  69
  70 METHOD:: selectedText
  71
  72     The currently selected text.
  73     Returns:: A String.
  74
  75
  76 SUBSECTION:: Behavior and appearance
  77
  78 METHOD:: enterInterpretsSelection
  79     Whether pressing Ctrl+Return or Ctrl+Enter while some text is selected should evaluate the selection as SuperCollider code.
  80     Argument::
  81         A Boolean.
  82
  83 METHOD:: setFontFamily
  84     Sets a specific font family to be used in place of a CSS-specified generic font family.
  85     Argument:: generic
  86         The CSS generic font family to assign a font to; one of the following symbols: code::\standard, \fixed, \serif, \sansSerif, \cursive, \fantasy::.
  87     Argument:: specific
  88         A font family name to be assigned to the generic family; a String.
  89
  90
  91 SUBSECTION:: Actions
  92
  93 METHOD:: onLoadFinished
  94     Sets the object to be evaluated when a page has loaded successfully, passing the view as the argument.
  95
  96 METHOD:: onLoadFailed
  97     Sets the object to be evaluated when a page has failed to load, passing the view as the argument.
  98
  99 METHOD:: onLinkActivated
 100     Sets the object to be evaluated when the user triggers a link, passing the view and the URL of the link (as String) as the arguments.
 101
 102     When this is set to other than nil, WebView will stop handling links altogether. Setting this to nil will restore WebView link handling again.
 103
 104 METHOD:: onReload
 105     Sets the object to be evaluated whenever a page reload is requested, passing the view and the URL to be reloaded (as String) as the arguments.
 106
 107     When this is set to other than nil, WebView will do nothing on reload requests. Setting this to nil will restore WebView reload handling again.
 108
 109
 110 SUBSECTION:: JavaScript
 111
 112 METHOD:: evaluateJavaScript
 113     Evaluates the given JavaScript code in the context of the current page.
 114     Argument::
 115         A String.