Monkeybread Realbasic plugin - Documentation

MBS Plugin Documentation

HTMLViewer.ApplicationNameForUserAgentMBS as String
method, HTMLViewer, MBS Cocoa Plugin (HTMLViewer), class HTMLViewer, Console safe, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The application name.
Example:

htmlviewer.ApplicationNameForUserAgentMBS="test"
// useragent is now "Mozilla/5.0 (Macintosh; U; PPC Mac OS X; de-de) AppleWebKit/417.9 (KHTML, like Gecko) test"

Notes:
This name will be used in user-agent strings that are chosen for best results in rendering web pages.
(Read and Write runtime property)

HTMLViewer.backForwardListMBS as WebBackForwardListMBS
method, HTMLViewer, MBS Cocoa Plugin (HTMLViewerWeb), class HTMLViewer, Console safe, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The backforward list for this webView.
Notes: Nil on failure.

HTMLViewer.BoundsHeightMBS as integer
method, HTMLViewer, MBS Cocoa Plugin (HTMLViewer), class HTMLViewer, Console safe, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The height of the htmlviewer control.
Notes:
Bounds is the width and height of the controls area, but visible is only a part depending on the window size. So if Bounds are equal to the visible part, there is no scrollbar.
(Read and Write runtime property)

HTMLViewer.BoundsLeftMBS as integer
method, HTMLViewer, MBS Cocoa Plugin (HTMLViewer), class HTMLViewer, Console safe, Plugin version: 7.5, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The left position of the control size.
Notes:
Should be 0.
(Read and Write runtime property)

HTMLViewer.BoundsTopMBS as integer
method, HTMLViewer, MBS Cocoa Plugin (HTMLViewer), class HTMLViewer, Console safe, Plugin version: 7.5, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The top position of the view size.
Notes:
Should be 0.
(Read and Write runtime property)

HTMLViewer.BoundsWidthMBS as integer
method, HTMLViewer, MBS Cocoa Plugin (HTMLViewer), class HTMLViewer, Console safe, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The width of the htmlviewer control.
Notes:
Bounds is the width and height of the controls area, but visible is only a part depending on the window size. So if Bounds are equal to the visible part, there is no scrollbar.
(Read and Write runtime property)

HTMLViewer.canGoBackMBS as boolean
method, HTMLViewer, MBS Cocoa Plugin (HTMLViewer), class HTMLViewer, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Whether the history can be used to move back one website.

HTMLViewer.canGoForwardMBS as boolean
method, HTMLViewer, MBS Cocoa Plugin (HTMLViewer), class HTMLViewer, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Whether the history can be used to move forward one website.

HTMLViewer.canMakeTextLargerMBS as boolean
method, HTMLViewer, MBS Cocoa Plugin (HTMLViewer), class HTMLViewer, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Whether the text size can be increased.

HTMLViewer.canMakeTextSmallerMBS as boolean
method, HTMLViewer, MBS Cocoa Plugin (HTMLViewer), class HTMLViewer, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Whether the text size can be decreased.

HTMLViewer.CanShowMIMETypeAsHTMLMBS(mime as string) as boolean
method, HTMLViewer, MBS Cocoa Plugin (HTMLViewer), class HTMLViewer, Console safe, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Checks if the the MIME type is a type that the WebKit will interpret as HTML.
Notes: Returns false on any error and true on success.

HTMLViewer.CanShowMIMETypeMBS(mime as string) as boolean
method, HTMLViewer, MBS Cocoa Plugin (HTMLViewer), class HTMLViewer, Console safe, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Checks if the WebKit can show content of a certain MIME type.
Notes: Returns false on any error and true on success.

class HTMLViewer
class, HTMLViewer, MBS Win Plugin (WindowsHTMLViewer), class HTMLViewer, Console safe, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Class in Realbasic 2005 for HTML rendering.
Notes: The class itself is available on all platforms, but all the plugin methods are currently only working on Mac OS X.

HTMLViewer.ClearFocusMBS
method, HTMLViewer, MBS Cocoa Plugin (HTMLViewer), class HTMLViewer, Console safe, Plugin version: 7.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Clears the focus.
Example:

htmlviewer1.ClearFocusMBS

Notes: If the focus is on the webpage, it will be cleared so there is no focus on the window. Useful if you want to workaround a focus bug in the htmlviewer control.

HTMLViewer.ContinuousSpellCheckingEnabledMBS as boolean
method, HTMLViewer, MBS Cocoa Plugin (HTMLViewer), class HTMLViewer, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Whether continuous spell checking is enabled.
Example:

htmlviewer1.ContinuousSpellCheckingEnabledMBS=True

Notes: (Read and Write runtime property)

HTMLViewer.CustomTextEncodingNameMBS as String
method, HTMLViewer, MBS Cocoa Plugin (HTMLViewer), class HTMLViewer, Console safe, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The custom text encoding name.
Notes:
On getting:
The custom text encoding name or "" if no custom text encoding name has been set.

On setting:
Make the page display with a different text encoding; stops any load in progress.
The text encoding passed in overrides the normal text encoding smarts including what's specified in a web page's header or HTTP response.
The text encoding automatically goes back to the default when the top level frame changes to a new location.
Setting the text encoding name to nil makes the webView use default encoding rules.
(Read and Write runtime property)

HTMLViewer.CustomUserAgentMBS as String
method, HTMLViewer, MBS Cocoa Plugin (HTMLViewer), class HTMLViewer, Console safe, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The custom user-agent string or nil if no custom user-agent string has been set.
Example:

htmlviewer1.CustomUserAgentMBS=NewCFStringMBS("HelloWorldBrowser")

Notes: (Read and Write runtime property)

HTMLViewer.dashboardBehaviorMBS(behavior as integer) as boolean
method, HTMLViewer, MBS Cocoa Plugin (HTMLViewer), class HTMLViewer, Console safe, Plugin version: 7.8, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Get or set the htmlviewer behavior.
Notes:
This is a private API from Apple which may break in the future.
It seems to exist for the dashboard application to switch some flags for event handling.

Behavior constants:
const WebDashboardBehaviorAlwaysSendMouseEventsToAllWindows = 0
const WebDashboardBehaviorAlwaysSendActiveNullEventsToPlugIns = 1
const WebDashboardBehaviorAlwaysAcceptsFirstMouse = 2
const WebDashboardBehaviorAllowWheelScrolling = 3
const WebDashboardBehaviorUseBackwardCompatibilityMode = 4
(Read and Write runtime property)

HTMLViewer.DrawsBackgroundMBS as Boolean
method, HTMLViewer, MBS Cocoa Plugin (HTMLViewer), class HTMLViewer, Console safe, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Enable or disable the background drawing.
Notes:
Works only with Webkit on Mac OS X 10.3.9 and newer.
Returns false on unsupported Webkit versions.
If you set it to false, the background is not drawn and you can have transparent websites like the Dashboard widgets.
(Read and Write runtime property)

HTMLViewer.EstimatedProgressMBS as double
method, HTMLViewer, MBS Cocoa Plugin (HTMLViewer), class HTMLViewer, Console safe, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: An estimate of the percent complete for a document load.
Notes: This value will range from 0 to 1.0 and, once a load completes, will remain at 1.0 until a new load starts, at which point it will be reset to 0. The value is an estimate based on the total number of bytes expected to be received for a document, including all it's possible subresources. For more accurate progress indication it is recommended that you implement a WebFrameLoadDelegate and a WebResourceLoadDelegate.

HTMLViewer.EvaluateJavaScriptMBS(code as string) as string
method, HTMLViewer, MBS Cocoa Plugin (HTMLViewer), class HTMLViewer, Console safe, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Runs the given java script and returns the result.
Example:

// shows current user agent string which the control sends to website
MsgBox htmlviewer1.EvaluateJavaScriptMBS("navigator.userAgent")

Notes:
Returns "" on any error.

In Safari 2 we used "return 1+2;" while in Safari 3 we only need "1+2;". The return is no longer needed.

HTMLViewer.FrameHeightMBS as integer
method, HTMLViewer, MBS Cocoa Plugin (HTMLViewer), class HTMLViewer, Console safe, Plugin version: 7.5, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The height of the view frame.
Notes: (Read and Write runtime property)

HTMLViewer.FrameLeftMBS as integer
method, HTMLViewer, MBS Cocoa Plugin (HTMLViewer), class HTMLViewer, Console safe, Plugin version: 7.5, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The left position of the view frame.
Notes: (Read and Write runtime property)

HTMLViewer.FrameTopMBS as integer
method, HTMLViewer, MBS Cocoa Plugin (HTMLViewer), class HTMLViewer, Console safe, Plugin version: 7.5, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The top position of the view frame.
Notes: (Read and Write runtime property)

HTMLViewer.FrameWidthMBS as integer
method, HTMLViewer, MBS Cocoa Plugin (HTMLViewer), class HTMLViewer, Console safe, Plugin version: 7.5, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The width of the view frame.
Notes: (Read and Write runtime property)

HTMLViewer.GetPageFormatMBS as string
method, HTMLViewer, MBS Cocoa Plugin (HTMLViewerPrint), class HTMLViewer, Console safe, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The current page format settings as a string.
Notes:
Can be used to save current printer settings to a preferences file.
Value is an empty string until a page format is defined.

HTMLViewer.GoBackMBS
method, HTMLViewer, MBS Cocoa Plugin (HTMLViewer), class HTMLViewer, Console safe, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Go back to the previous URL in the backforward list.
Notes: Returns true if able to go back in the backforward list, false otherwise.

HTMLViewer.GoForwardMBS
method, HTMLViewer, MBS Cocoa Plugin (HTMLViewer), class HTMLViewer, Console safe, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Go forward to the next URL in the backforward list.
Notes: Returns true if able to go forward in the backforward list, false otherwise.

HTMLViewer.goToBackForwardItemMBS(item as WebHistoryItemMBS) as boolean
method, HTMLViewer, MBS Cocoa Plugin (HTMLViewerWeb), class HTMLViewer, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Moves on the history to the given item.
Notes: Returns true on success or false on failure.

HTMLViewer.GroupNameMBS as string
method, HTMLViewer, MBS Cocoa Plugin (HTMLViewer), class HTMLViewer, Console safe, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The group name for this WebView.
Notes:
JavaScript may access named frames within the same group.
(Read and Write runtime property)

HTMLViewer.HandleMBS as integer
method, HTMLViewer, MBS Cocoa Plugin (HTMLViewer), class HTMLViewer, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The Handle of the WebView behind the HTMLViewer control.
Notes: Must be non zero for the plugin functions to work.

HTMLViewer.IECharSetMBS as string
method, HTMLViewer, MBS Win Plugin (WindowsHTMLViewer), class HTMLViewer, Console safe, Plugin version: 7.8, Mac OS X: Does nothing, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Sets or retrieves the character set used to encode the object.
Notes:
Example value: "utf-8"
(Read and Write runtime property)