Python Script Engine  8.0
GL Studio Editor Python Script API
HtmlDock Class Reference

Public Types

enum  DockWidgetArea {
  LeftDockWidgetArea = 0x1,
  RightDockWidgetArea = 0x2,
  TopDockWidgetArea = 0x4,
  BottomDockWidgetArea = 0x8
}
 

Public Member Functions

void Show ()
 
void Hide ()
 
void SetUrl (String url)
 
void Reload ()
 
void Tabify (String title)
 
void MoveToDockWidgetArea (DockWidgetArea area, String targetDockName)
 
void SetTitle (String title)
 
void Destroy ()
 

Detailed Description

common editor interface HtmlDock

Member Enumeration Documentation

Enumerator
LeftDockWidgetArea 
RightDockWidgetArea 
TopDockWidgetArea 
BottomDockWidgetArea 

Member Function Documentation

void HtmlDock::Destroy ( )

Destroys the html dock.

Docks persist until manually destroyed using this method

void HtmlDock::Hide ( )

Hides the dock.

void HtmlDock::MoveToDockWidgetArea ( DockWidgetArea  area,
String  targetDockName 
)

Moves the dock widget to the dock widget area.

Parameters
areathe area to move it to
void HtmlDock::Reload ( )

Reloads the current web page.

void HtmlDock::SetTitle ( String  title)

Sets the title of the html dialog.

Parameters
titlethe title
void HtmlDock::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 HtmlDock::Show ( )

Shows the dock.

void HtmlDock::Tabify ( String  title)

Tabifies the dock in the same location as the specified dock.

Parameters
titlethe title of the dock to tabify next to, e.g. "Object Properties"

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