KLayout Manual: Main Index » Class Index » API reference - Class BrowserDialogAPI reference - Class BrowserDialogNotation used in Ruby API documentation 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. Public constructors
Public methods
Deprecated methods (protected, public, static, non-static and constructors)
Detailed descriptionvoid caption=(string caption)Description: Set the caption of the window [virtual] void closedDescription: Callback when the dialog is closed This callback can be reimplemented to implement cleanup functionality when the dialog is closed. 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. int execDescription: Execute the HTML browser dialog as a modal window void hideDescription: Hide the HTML browser window void home=(string home_url)Description: Set the browser's initial and current URL which is selected if the "home" location is choosen [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. void load(string arg1)Description: Load the given URL into the browser dialog [static] BrowserDialog newDescription: Creates a new object of this class void reloadDescription: Reload the current page void resize(int width,int height)Description: Set the size of the dialog window void set_caption(string caption)Description: Set the caption of the window This method is deprecated. Use method 'caption=' instead void set_home(string home_url)Description: Set the browser's initial and current URL which is selected if the "home" location is choosen This method is deprecated. Use method 'home=' instead void set_size(int width,int height)Description: Set the size of the dialog window This method is deprecated. Use method 'resize' instead void set_source(BrowserSource ptr source)Description: Connect to a source object This method is deprecated. Use method 'source=' instead void showDescription: Show the HTML browser window in a non-modal way void source=(BrowserSource ptr source)Description: Connect to a source object Setting the source should be the first thing done after the BrowserDialog object is created. It will not have any effect after the browser has loaded the first page. In particular, home= should be called after the source was set. |