MBS Plugin Documentation
Statistics - FAQ - Plugin Parts (All, Dependencies) - Class hierarchie
New in Version 7.0 7.1 7.2 7.3 7.4 7.5 7.6 7.7 7.8 8.0 8.1 8.2 8.3 8.4 8.5 8.6 8.7 9.0
The list of the themes, classes, controls, modules, global methods by category, global methods by name, screenshots, licenses and examples.
Platforms to show: All Mac Windows Linux Cross-Platform
WebUIDelegateMBS.AreToolbarsVisible as boolean
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Determine whether the window's toolbars are currently visible.
Notes:
This method should return true if the window has any toolbars that are currently on, besides the status bar. If the app has more than one toolbar per window, for example a regular command toolbar and a favorites bar, it should return true from this method if at least one is on.
If you place code in this event, return a value.
If no code is in the event, the default delegate will be called.
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Determine whether the window's toolbars are currently visible.
Notes:
This method should return true if the window has any toolbars that are currently on, besides the status bar. If the app has more than one toolbar per window, for example a regular command toolbar and a favorites bar, it should return true from this method if at least one is on.
If you place code in this event, return a value.
If no code is in the event, the default delegate will be called.
class WebUIDelegateMBS
class, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Console safe, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: A class to handle user interface requests.
Notes:
The plugin is very careful on which events it registers.
All events where you don't have code inside (not even comments), is not registered with the system and you get the default behavior.
All methods in this class will catch exceptions from Cocoa and raise a NSExceptionMBS instead. Using the message, name and reason properties you can see what was the reason for this exception. Please report if you find a method which does not handle exceptions correct.
class, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Console safe, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: A class to handle user interface requests.
Notes:
The plugin is very careful on which events it registers.
All events where you don't have code inside (not even comments), is not registered with the system and you get the default behavior.
All methods in this class will catch exceptions from Cocoa and raise a NSExceptionMBS instead. Using the message, name and reason properties you can see what was the reason for this exception. Please report if you find a method which does not handle exceptions correct.
WebUIDelegateMBS.Close
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.5, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: The close event.
Notes: Called when the delegate is destroyed.
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.5, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: The close event.
Notes: Called when the delegate is destroyed.
WebUIDelegateMBS.CreateWithRequest(URL as string, CachePolicy as integer, TimeOutInterval as double, mainDocumentURL as string) as object
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Create a new window and begin to load the specified request.
Notes:
The newly created window is hidden, and the window operations delegate on the new WebViews will get a webViewShow call.
If no value is returned or no code is in the event, the default delegate is called.
Return nil, nothing or a valid htmlviewer.
Your application will certainly crash if you return something different.
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Create a new window and begin to load the specified request.
Notes:
The newly created window is hidden, and the window operations delegate on the new WebViews will get a webViewShow call.
If no value is returned or no code is in the event, the default delegate is called.
Return nil, nothing or a valid htmlviewer.
Your application will certainly crash if you return something different.
WebUIDelegateMBS.DisableContextMenu as Boolean
property, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Console safe, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Whether the plugin should disable contextual menus completely.
Notes:
Set to true to disabled the context menu.
(Read and Write property)
property, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Console safe, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Whether the plugin should disable contextual menus completely.
Notes:
Set to true to disabled the context menu.
(Read and Write property)
WebUIDelegateMBS.DisableNewWindow as Boolean
property, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Console safe, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Whether the plugin should block new window requests.
Notes:
Set to true to block all requests.
(Read and Write property)
property, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Console safe, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Whether the plugin should block new window requests.
Notes:
Set to true to block all requests.
(Read and Write property)
WebUIDelegateMBS.GetContentRect(byref left as double, byref top as double, byref width as double, byref height as double) as boolean
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Return the window's content rect.
Notes: If you want to return values, return true, else return false and the default delegate will be called for this.
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Return the window's content rect.
Notes: If you want to return values, return true, else return false and the default delegate will be called for this.
WebUIDelegateMBS.GetFrame(byref left as double, byref top as double, byref width as double, byref height as double) as boolean
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Return the window's frame rect.
Notes: If you want to return values, return true, else return false and the default delegate will be called for this.
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Return the window's frame rect.
Notes: If you want to return values, return true, else return false and the default delegate will be called for this.
WebUIDelegateMBS.GetStatusText as String
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Get the currently displayed status text.
Notes:
If you place code in this event, return a value.
If no code is in the event, the default delegate will be called.
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Get the currently displayed status text.
Notes:
If you place code in this event, return a value.
If no code is in the event, the default delegate will be called.
WebUIDelegateMBS.IsResizable as boolean
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Determine whether the window is resizable or not.
Notes:
If there are multiple views in the same window, they have have their own separate resize controls and this may need to be handled specially.
If you place code in this event, return a value.
If no code is in the event, the default delegate will be called.
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Determine whether the window is resizable or not.
Notes:
If there are multiple views in the same window, they have have their own separate resize controls and this may need to be handled specially.
If you place code in this event, return a value.
If no code is in the event, the default delegate will be called.
WebUIDelegateMBS.IsStatusBarVisible as boolean
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Determine whether the status bar is visible.
Notes:
true if the status bar is visible, otherwise false.
If you place code in this event, return a value.
If no code is in the event, the default delegate will be called.
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Determine whether the status bar is visible.
Notes:
true if the status bar is visible, otherwise false.
If you place code in this event, return a value.
If no code is in the event, the default delegate will be called.
WebUIDelegateMBS.Open
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.5, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: The open event.
Notes:
Called just after the delegate has been installed in a htmlviewer control.
This allows you to initialize your stuff before the first event is called.
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.5, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: The open event.
Notes:
Called just after the delegate has been installed in a htmlviewer control.
This allows you to initialize your stuff before the first event is called.
WebUIDelegateMBS.RunJavaScriptAlertPanelWithMessage(message as String)
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Display a JavaScript alert panel.
Notes: Clients should visually indicate that this panel comes from JavaScript. The panel should have a single OK button.
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Display a JavaScript alert panel.
Notes: Clients should visually indicate that this panel comes from JavaScript. The panel should have a single OK button.
WebUIDelegateMBS.RunJavaScriptConfirmPanelWithMessage(message as String) as boolean
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Display a JavaScript confirm panel.
Notes:
Return true if the user hit OK, false if the user chose Cancel.
Clients should visually indicate that this panel comes from JavaScript. The panel should have two buttons, e.g. "OK" and "Cancel".
If you place code in this event, return a value.
If no code is in the event, the default delegate will be called.
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Display a JavaScript confirm panel.
Notes:
Return true if the user hit OK, false if the user chose Cancel.
Clients should visually indicate that this panel comes from JavaScript. The panel should have two buttons, e.g. "OK" and "Cancel".
If you place code in this event, return a value.
If no code is in the event, the default delegate will be called.
WebUIDelegateMBS.RunJavaScriptTextInputPanelWithPrompt(prompt as String, defaultText as String) as String
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Display a JavaScript text input panel.
Notes:
Return the typed text if the user hit OK, otherwise an empty string.
Clients should visually indicate that this panel comes from JavaScript. The panel should have two buttons, e.g. "OK" and "Cancel", and an area to type text.
If you place code in this event, return a value.
If no code is in the event, the default delegate will be called.
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Display a JavaScript text input panel.
Notes:
Return the typed text if the user hit OK, otherwise an empty string.
Clients should visually indicate that this panel comes from JavaScript. The panel should have two buttons, e.g. "OK" and "Cancel", and an area to type text.
If you place code in this event, return a value.
If no code is in the event, the default delegate will be called.
WebUIDelegateMBS.runOpenPanelForFileButtonWithResultListener(listener as WebOpenPanelResultListenerMBS) as boolean
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 8.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Called when an open panel should be showed.
Notes:
Return true if you handled this event.
Call chooseFilename or cancel on the listener to inform about the result.
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 8.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Called when an open panel should be showed.
Notes:
Return true if you handled this event.
Call chooseFilename or cancel on the listener to inform about the result.
WebUIDelegateMBS.SetContentRect(left as double, top as double, width as double, height as double) as boolean
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Set the window's content rect.
Notes:
Even though a plugin could set the frame directly using the Window, this method is provided so implementors of this protocol can do special things on programmatic move/resize, like avoiding autosaving of the size.
If you return true the default delegate will not be called for this.
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Set the window's content rect.
Notes:
Even though a plugin could set the frame directly using the Window, this method is provided so implementors of this protocol can do special things on programmatic move/resize, like avoiding autosaving of the size.
If you return true the default delegate will not be called for this.
WebUIDelegateMBS.SetFrame(left as double, top as double, width as double, height as double) as boolean
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Set the window's frame rect.
Notes:
Even though a plugin could set the frame directly using the Window, this method is provided so implementors of this protocol can do special things on programmatic move/resize, like avoiding autosaving of the size.
If you return true the default delegate will not be called for this.
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Set the window's frame rect.
Notes:
Even though a plugin could set the frame directly using the Window, this method is provided so implementors of this protocol can do special things on programmatic move/resize, like avoiding autosaving of the size.
If you return true the default delegate will not be called for this.
WebUIDelegateMBS.SetResizable(resizeable as boolean)
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Set the window to resizable or not.
Notes:
If there are multiple views in the same window, they have have their own separate resize controls and this may need to be handled specially.
If you return true the default delegate will not be called for this.
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Set the window to resizable or not.
Notes:
If there are multiple views in the same window, they have have their own separate resize controls and this may need to be handled specially.
If you return true the default delegate will not be called for this.
WebUIDelegateMBS.SetStatusBarVisible(visible as boolean) as boolean
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Set whether the status bar is currently visible.
Notes:
Setting this to true should show the status bar, setting it to false should hide it.
If you return true the default delegate will not be called for this.
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Set whether the status bar is currently visible.
Notes:
Setting this to true should show the status bar, setting it to false should hide it.
If you return true the default delegate will not be called for this.
WebUIDelegateMBS.SetStatusText(text as String) as boolean
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Set the window's status display, if any, to the specified string.
Notes: If you return true the default delegate will not be called for this.
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Set the window's status display, if any, to the specified string.
Notes: If you return true the default delegate will not be called for this.
WebUIDelegateMBS.SetToolbarsVisible(visible as boolean) as boolean
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Set whether the window's toolbars are currently visible.
Notes:
Setting this to true should turn on all toolbars (except for a possible status bar). Setting it to false should turn off all toolbars (with the same exception).
If you return true the default delegate will not be called for this.
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Set whether the window's toolbars are currently visible.
Notes:
Setting this to true should turn on all toolbars (except for a possible status bar). Setting it to false should turn off all toolbars (with the same exception).
If you return true the default delegate will not be called for this.
WebUIDelegateMBS.WindowClose as boolean
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Close the current window.
Notes:
Clients showing multiple views in one window may choose to close only the one corresponding to this WebView. Other clients may choose to ignore this method entirely.
If this event returns false the control is handled to the default delegate.
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Close the current window.
Notes:
Clients showing multiple views in one window may choose to close only the one corresponding to this WebView. Other clients may choose to ignore this method entirely.
If this event returns false the control is handled to the default delegate.
WebUIDelegateMBS.WindowFocus as boolean
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Focus the current window.
Notes:
Clients showing multiple views in one window may want to also do something to focus the one corresponding to this WebView.
If this event returns false the control is handled to the default delegate.
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Focus the current window.
Notes:
Clients showing multiple views in one window may want to also do something to focus the one corresponding to this WebView.
If this event returns false the control is handled to the default delegate.
WebUIDelegateMBS.WindowShow as boolean
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Show the window that contains the top level view of the WebView, ordering it frontmost.
Notes:
This will only be called just after CreateWithRequest is used to create a new window.
If this event returns false the control is handled to the default delegate.
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Show the window that contains the top level view of the WebView, ordering it frontmost.
Notes:
This will only be called just after CreateWithRequest is used to create a new window.
If this event returns false the control is handled to the default delegate.
WebUIDelegateMBS.WindowUnfocus as boolean
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Unfocus the current window.
Notes:
Clients showing multiple views in one window may want to also do something to unfocus the one corresponding to this WebView.
If this event returns false the control is handled to the default delegate.
event, HTMLViewer, MBS Cocoa Plugin (HTMLViewerDelegate), class WebUIDelegateMBS, Plugin version: 7.2, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: Unfocus the current window.
Notes:
Clients showing multiple views in one window may want to also do something to unfocus the one corresponding to this WebView.
If this event returns false the control is handled to the default delegate.
The items on this page are in the following plugins: MBS Cocoa Plugin.
Monkeybread Software Realbasic Plugins - Messdiener Nickenich