rqt_web.web_widget.WebWidget Class Reference

Inheritance diagram for rqt_web.web_widget.WebWidget:

Public Member Functions
def	__init__ (self, url=None)
def	restore_settings (self, settings)
def	save_settings (self, settings)
def	set_show_url_input (self, showinput)
def	set_url (self, url, showinput=False)

Private Member Functions
def	_add_completer_list_item (self, url)
def	_handle_link_clicked (self, url)
def	_handle_load_finished (self, ok)
def	_handle_reload_clicked (self)
def	_handle_url_change (self)
def	_handle_url_changed (self, url)

Static Private Member Functions
def	_pack (data)
def	_unpack (data)

Private Attributes
	_completer
	_completer_word_list
	_loading
	_reload_icon
	_show_url_input
	_stop_icon
	_url
	_view
	_working_icon

Detailed Description

Definition at line 61 of file web_widget.py.

Constructor & Destructor Documentation

__init__()

def rqt_web.web_widget.WebWidget.__init__	(		self,
			url = None
	)

Class to load a webpage in a widget.

:param url: If url is empty then a navigation bar is shown otherwise the url is loaded and the navigation bar is hidden, ''str''

Definition at line 63 of file web_widget.py.

Member Function Documentation

_add_completer_list_item()

def rqt_web.web_widget.WebWidget._add_completer_list_item (   self,   url  )

private

Definition at line 163 of file web_widget.py.

_handle_link_clicked()

def rqt_web.web_widget.WebWidget._handle_link_clicked (   self,   url  )

private

Definition at line 132 of file web_widget.py.

_handle_load_finished()

def rqt_web.web_widget.WebWidget._handle_load_finished (   self,   ok  )

private

Definition at line 151 of file web_widget.py.

_handle_reload_clicked()

def rqt_web.web_widget.WebWidget._handle_reload_clicked (   self )

private

Definition at line 135 of file web_widget.py.

_handle_url_change()

def rqt_web.web_widget.WebWidget._handle_url_change (   self )

private

Definition at line 129 of file web_widget.py.

_handle_url_changed()

def rqt_web.web_widget.WebWidget._handle_url_changed (   self,   url  )

private

Definition at line 145 of file web_widget.py.

_pack()

def rqt_web.web_widget.WebWidget._pack (   data )

staticprivate

Packs 'data' into a form that can be easily and readably written to an ini file
:param data: A list of strings to be flattened into a string ''list''
:return: A string suitable for output to ini files ''str''

Definition at line 172 of file web_widget.py.

_unpack()

def rqt_web.web_widget.WebWidget._unpack (   data )

staticprivate

Unpacks the values read from an ini file
:param data: An entry taken from an ini file ''list or string''
:return: A list of strings ''list''

Definition at line 185 of file web_widget.py.

restore_settings()

def rqt_web.web_widget.WebWidget.restore_settings	(		self,
			settings
	)

Definition at line 122 of file web_widget.py.

save_settings()

def rqt_web.web_widget.WebWidget.save_settings	(		self,
			settings
	)

Definition at line 118 of file web_widget.py.

set_show_url_input()

def rqt_web.web_widget.WebWidget.set_show_url_input	(		self,
			showinput
	)

Sets the value of the show_url_input flag and hides/shows the widgets as required
:param showinput: true - show inputbar false - hide , ''bool''

Definition at line 105 of file web_widget.py.

set_url()

def rqt_web.web_widget.WebWidget.set_url	(		self,
			url,
			showinput = False
	)

Sets the url and begins loading that page
:param url: url to load in the webview, ''str or QUrl''
:param showinput: if true the input bar will be shown, else hidden, ''bool''

Definition at line 94 of file web_widget.py.

Member Data Documentation

_completer

rqt_web.web_widget.WebWidget._completer

private

Definition at line 166 of file web_widget.py.

_completer_word_list

rqt_web.web_widget.WebWidget._completer_word_list

private

Definition at line 80 of file web_widget.py.

_loading

rqt_web.web_widget.WebWidget._loading

private

Definition at line 75 of file web_widget.py.

_reload_icon

rqt_web.web_widget.WebWidget._reload_icon

private

Definition at line 77 of file web_widget.py.

_show_url_input

rqt_web.web_widget.WebWidget._show_url_input

private

Definition at line 110 of file web_widget.py.

_stop_icon

rqt_web.web_widget.WebWidget._stop_icon

private

Definition at line 76 of file web_widget.py.

_url

rqt_web.web_widget.WebWidget._url

private

Definition at line 101 of file web_widget.py.

_view

rqt_web.web_widget.WebWidget._view

private

Definition at line 81 of file web_widget.py.

_working_icon

rqt_web.web_widget.WebWidget._working_icon

private

Definition at line 78 of file web_widget.py.

---

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

• web_widget.py