Class BrowserDialog (version 0.18)

Description: The HTML browser dialog

The HTML browser displays HTML code in a browser panel. It receives the code by retrieving it from a given URL.

URL's with the special scheme "int" are retrieved from a BrowserSource object. This will act as a kind of server for these URL's.

Class overview

Index

Method Overview

hideHide the HTML browser window
showShow the HTML browser window in a non-modal way
int execExecute the HTML browser dialog as a modal window
load( string )Load the given URL into the browser dialog
set_source( ref BrowserSource source )Connect to a source object
set_size( int width, int height )Set the size of the dialog window
set_caption( string caption )Set the caption of the window
reloadReload the current page
set_home( string home_url )Set the browser's initial and current URL which is selected if the "home" location is choosen
closedCallback when the dialog is closed
destroyExplicitly destroy the object
[const] bool destroyedTell, if the object was destroyed

closed

Description: Callback when the dialog is closed

This callback can be reimplemented to implement cleanup functionality when the dialog is closed.

destroy

Description: Explicitly destroy the object

Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, this method will do nothing.

[const] bool destroyed

Description: Tell, if the object was destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

int exec

Description: Execute the HTML browser dialog as a modal window

hide

Description: Hide the HTML browser window

load( string )

Description: Load the given URL into the browser dialog

reload

Description: Reload the current page

set_caption( string caption )

Description: Set the caption of the window

set_home( string home_url )

Description: Set the browser's initial and current URL which is selected if the "home" location is choosen

set_size( int width, int height )

Description: Set the size of the dialog window

set_source( ref BrowserSource source )

Description: Connect to a source object

Caution: this will use the object as the source but not hold a reference to that object. In order not to loose the source object (i.e. in RBA), a separate reference is required.

show

Description: Show the HTML browser window in a non-modal way