HtmlDock Class Reference

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

Public Member Functions
None	Show ()
None	Hide ()
None	SetUrl (str url)
None	Reload ()
None	Tabify (str title)
None	MoveToDockWidgetArea (DockWidgetArea area, str targetDockName)
None	SetTitle (str title)
None	Destroy ()
tuple	GetScrollPosition ()
None	SetScrollPosition (float x, float y)

Detailed Description

common editor interface HtmlDock

Member Enumeration Documentation

DockWidgetArea

enum HtmlDock::DockWidgetArea

Enumerator
LeftDockWidgetArea
RightDockWidgetArea
TopDockWidgetArea
BottomDockWidgetArea

Member Function Documentation

Destroy()

None HtmlDock::Destroy

(

)

Destroys the html dock.

Docks persist until manually destroyed using this method

GetScrollPosition()

tuple HtmlDock::GetScrollPosition

(

)

Gets the current scroll position of the html dock return a pair of x and y positions of the scroll area.

Hide()

None HtmlDock::Hide

(

)

Hides the dock.

MoveToDockWidgetArea()

None HtmlDock::MoveToDockWidgetArea	(	DockWidgetArea	area,
		str	targetDockName
	)

Moves the dock widget to the dock widget area.

Parameters

area	The area to move it to.
targetDockName	The name of the dock to move it to.

Reload()

None HtmlDock::Reload

(

)

Reloads the current web page.

SetScrollPosition()

None HtmlDock::SetScrollPosition	(	float	x,
		float	y
	)

Sets the scroll position of the html dock param x the x position of the scroll area param y the y position of the scroll area.

SetTitle()

None HtmlDock::SetTitle

(

str

title

)

Sets the title of the html dialog.

Parameters

title

the title

SetUrl()

None HtmlDock::SetUrl

(

str

url

)

Sets the url of the web page currently viewed.

Setting the url clears the view and loads the url

Parameters

url

the url

Show()

None HtmlDock::Show

(

)

Shows the dock.

Tabify()

None HtmlDock::Tabify

(

str

title

)

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

Parameters

title

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

---

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

• HtmlDock.i