Python Script Engine  7.1
GL Studio Editor Python Script API
HtmlDialog Class Reference

Public Member Functions

void Show ()
 
void Hide ()
 
bool Exec ()
 
void SetUrl (String url)
 
void Reload ()
 
void SetTitle (String title)
 
void Destroy ()
 
void SetSize (unsigned int width, unsigned int height)
 
void SetResizeable (bool isResizeable)
 

Detailed Description

common editor interface HtmlDialog

Member Function Documentation

void HtmlDialog::Destroy ( )

Destroys the html dialog.

Dialogs persist until manually destroyed using this method

bool HtmlDialog::Exec ( )

Shows the dialog as a modal dialog, blocking until the user closes it.

Returns
true if the javascript method "GlStudioHtmlDialog.ok()" is called, false if the javascript method "GlStudioHtmlDialog.cancel()" is called, or false if the user closes the dialog
void HtmlDialog::Hide ( )

Hides the dialog.

void HtmlDialog::Reload ( )

Reloads the current web page.

void HtmlDialog::SetResizeable ( bool  isResizeable)

Sets whether or not the dialog is resizeable.

Parameters
isResizeableif true, the dialog is resizeable, if false, it is not resizeable
void HtmlDialog::SetSize ( unsigned int  width,
unsigned int  height 
)

Sets the size of the html dialog.

Parameters
widththe dialog width
heightthe dialog height
void HtmlDialog::SetTitle ( String  title)

Sets the title of the html dialog.

Parameters
titlethe title
void HtmlDialog::SetUrl ( String  url)

Sets the url of the web page currently viewed.

Setting the url clears the view and loads the url

Parameters
urlthe url
void HtmlDialog::Show ( )

Shows the dialog as a non-modal dialog.


The documentation for this class was generated from the following file: