Class BrowserSource (version 0.18)

Description: The BrowserDialog source for "int" URL's

The source object basically acts as a "server" for special URL's using "int" as the scheme. Classes that want to implement such functionality must derive from BrowserSource and reimplement the get method. This method is supposed to deliver a HTML page for the given URL.

Alternatively to implementing this functionality, a source object may be instantiated using the new_html constructor. This will create a source object that simply displays the given string as the initial and only page.

Class overview

Index

Method Overview

[static] BrowserSource new_html( string )construct a BrowserSource object with a default HTML string
string get( string url )Get the HTML code for a given "int" URL.
assign( BrowserSource other )Assign the contents of another object to self
[const] BrowserSource dupCreates a copy of self.
destroyExplicitly destroy the object
[const] bool destroyedTell, if the object was destroyed

assign( BrowserSource other )

Description: Assign the contents of another object to self

This method assigns the contents of another object to self. This is a deep copy that does not only copy the reference but the actual content.

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.

[const] BrowserSource dup

Description: Creates a copy of self.

string get( string url )

Description: Get the HTML code for a given "int" URL.

If this method returns an empty string, the browser will not be set to a new location. This allows to implement any functionality behind such links. If the method returns a string, the content of this string is displayed in the HTML browser page.

[static] BrowserSource new_html( string )

Description: construct a BrowserSource object with a default HTML string

The default HTML string is sent when no specific implementation is provided.