Skip to content

Commit

Permalink
Doc added for both loadUi methods.
Browse files Browse the repository at this point in the history
  • Loading branch information
Isaac Saito committed Mar 15, 2013
1 parent d2b6c88 commit 192c138
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions src/python_qt_binding/binding_helper.py
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,17 @@ def _load_pyqt(required_modules, optional_modules):
global loadUi

def loadUi(uifile, baseinstance=None, custom_widgets=None):
"""
@type uifile: str
@param uifile: Absolute path of .ui file
@type baseinstance: QWidget
@param baseinstance: the optional instance of the Qt base class.
If specified then the user interface is created in
it. Otherwise a new instance of the base class is
automatically created.
@param custom_widgets: Unlike pyside binding, this argument won't be
used. Ref: http://answers.ros.org/question/56382/what-does-python_qt_bindingloaduis-3rd-arg-do-in-pyqt-binding/
"""
from PyQt4 import uic
return uic.loadUi(uifile, baseinstance=baseinstance)

Expand Down Expand Up @@ -183,6 +194,19 @@ def _load_pyside(required_modules, optional_modules):
global loadUi

def loadUi(uifile, baseinstance=None, custom_widgets=None):
"""
@type uifile: str
@param uifile: Absolute path of .ui file
@type baseinstance: QWidget
@param baseinstance: the optional instance of the Qt base class.
If specified then the user interface is created in
it. Otherwise a new instance of the base class is
automatically created.
@type custom_widgets: dict of {str:QWidget}
@param custom_widgets: Class name and type of the custom classes used
in uifile if any. This can be None if no custom
class is in use.
"""
from PySide.QtUiTools import QUiLoader
from PySide.QtCore import QMetaObject

Expand Down

0 comments on commit 192c138

Please sign in to comment.