KLayout Manual: Main Index » Class Index » API reference - Class BrowserSourceAPI reference - Class BrowserSourceNotation used in Ruby API documentation Description: The BrowserDialog's 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. Public constructors
Public methods
Detailed description[const] void assign(const 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. void createDescription: Ensures the C++ object is created Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created. void destroyDescription: 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: Returns a value indicating whether the object was already 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 dupDescription: Creates a copy of self [virtual] 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. [const] bool is_const_object?Description: Returns a value indicating whether the reference is a const reference This method returns true, if self is a const reference. In that case, only const methods may be called on self. [static] BrowserSource newDescription: Creates a new object of this class [static] new BrowserSource new_html(string arg1)Description: construct a BrowserSource object with a default HTML string The default HTML string is sent when no specific implementation is provided. |