summaryrefslogtreecommitdiff
path: root/src/leap/gui
diff options
context:
space:
mode:
authorTomas Touceda <chiiph@leap.se>2013-05-07 16:08:55 -0300
committerTomas Touceda <chiiph@leap.se>2013-05-07 16:08:55 -0300
commit4cc3c7d3f0d63d97df0d40c3e2d0941c5e069eb9 (patch)
treedfabf2a91cd8466b572539b73d38273eef733339 /src/leap/gui
parent76641e028f4a8b6c5c89ad0e9ff4bfecc075d678 (diff)
parente6b7d52d827109d6fc8d79a28e8d46964e1ad94c (diff)
Merge remote-tracking branch 'kali/feature/update-docs' into develop
Diffstat (limited to 'src/leap/gui')
-rw-r--r--src/leap/gui/mainwindow.py38
-rw-r--r--src/leap/gui/wizard.py56
2 files changed, 47 insertions, 47 deletions
diff --git a/src/leap/gui/mainwindow.py b/src/leap/gui/mainwindow.py
index c9743f95..ccf97672 100644
--- a/src/leap/gui/mainwindow.py
+++ b/src/leap/gui/mainwindow.py
@@ -72,12 +72,12 @@ class MainWindow(QtGui.QMainWindow):
"""
Constructor for the client main window
- @param standalone: Set to true if the app should use configs
+ :param standalone: Set to true if the app should use configs
inside its pwd
- @type standalone: bool
- @param bypass_checks: Set to true if the app should bypass
+ :type standalone: bool
+ :param bypass_checks: Set to true if the app should bypass
first round of checks for CA certificates at bootstrap
- @type bypass_checks: bool
+ :type bypass_checks: bool
"""
QtGui.QMainWindow.__init__(self)
@@ -278,8 +278,8 @@ class MainWindow(QtGui.QMainWindow):
"""
Callback for the new updates event
- @param req: Request type
- @type req: leap.common.events.events_pb2.SignalRequest
+ :param req: Request type
+ :type req: leap.common.events.events_pb2.SignalRequest
"""
self.new_updates.emit(req)
@@ -482,7 +482,7 @@ class MainWindow(QtGui.QMainWindow):
"""
Returns the available providers based on the file structure
- @rtype: list
+ :rtype: list
"""
# TODO: check which providers have a valid certificate among
@@ -503,7 +503,7 @@ class MainWindow(QtGui.QMainWindow):
"""
Returns True if there are no configured providers. False otherwise
- @rtype: bool
+ :rtype: bool
"""
has_provider_on_disk = len(self._configured_providers()) != 0
is_proper_provider = self._settings.get_properprovider()
@@ -519,8 +519,8 @@ class MainWindow(QtGui.QMainWindow):
"""
Sets the status label at the login stage to status
- @param status: status message
- @type status: str
+ :param status: status message
+ :type status: str
"""
if error:
status = "<font color='red'><b>%s</b></font>" % (status,)
@@ -530,8 +530,8 @@ class MainWindow(QtGui.QMainWindow):
"""
Sets the status label at the VPN stage to status
- @param status: status message
- @type status: str
+ :param status: status message
+ :type status: str
"""
self._vpn_systray.setToolTip(status)
if error:
@@ -542,8 +542,8 @@ class MainWindow(QtGui.QMainWindow):
"""
Enables or disables all the login widgets
- @param enabled: wether they should be enabled or not
- @type enabled: bool
+ :param enabled: wether they should be enabled or not
+ :type enabled: bool
"""
self.ui.lnUser.setEnabled(enabled)
self.ui.lnPassword.setEnabled(enabled)
@@ -575,9 +575,9 @@ class MainWindow(QtGui.QMainWindow):
self._provider_config instance with it and starts the second
part of the bootstrapping sequence
- @param data: result from the last stage of the
+ :param data: result from the last stage of the
run_provider_select_checks
- @type data: dict
+ :type data: dict
"""
if data[self._provider_bootstrapper.PASSED_KEY]:
provider = self.ui.cmbProviders.currentText()
@@ -708,7 +708,7 @@ class MainWindow(QtGui.QMainWindow):
"""
Returns the socket and port to be used for VPN
- @rtype: tuple (str, str) (host, port)
+ :rtype: tuple (str, str) (host, port)
"""
# TODO: make this properly multiplatform
@@ -801,8 +801,8 @@ class MainWindow(QtGui.QMainWindow):
"""
Given a status step from the VPN thread, set the icon properly
- @param status: status step
- @type status: str
+ :param status: status step
+ :type status: str
"""
selected_pixmap = self.ERROR_ICON
tray_message = self.tr("Encryption is OFF")
diff --git a/src/leap/gui/wizard.py b/src/leap/gui/wizard.py
index 33c3ed0c..ad45dd8c 100644
--- a/src/leap/gui/wizard.py
+++ b/src/leap/gui/wizard.py
@@ -55,14 +55,14 @@ class Wizard(QtGui.QWizard):
"""
Constructor for the main Wizard.
- @param checker: Checker thread that the wizard should use.
- @type checker: CheckerThread
- @param standalone: If True, the application is running as standalone
+ :param checker: Checker thread that the wizard should use.
+ :type checker: CheckerThread
+ :param standalone: If True, the application is running as standalone
and the wizard should display some messages according to this.
- @type standalone: bool
- @param bypass_checks: Set to true if the app should bypass
+ :type standalone: bool
+ :param bypass_checks: Set to true if the app should bypass
first round of checks for CA certificates at bootstrap
- @type bypass_checks: bool
+ :type bypass_checks: bool
"""
QtGui.QWizard.__init__(self)
@@ -184,15 +184,15 @@ class Wizard(QtGui.QWizard):
"""
Performs basic password checks to avoid really easy passwords.
- @param username: username provided at the registrarion form
- @type username: str
- @param password: password from the registration form
- @type password: str
- @param password2: second password from the registration form
- @type password: str
+ :param username: username provided at the registrarion form
+ :type username: str
+ :param password: password from the registration form
+ :type password: str
+ :param password2: second password from the registration form
+ :type password: str
- @return: returns True if all the checks pass, False otherwise
- @rtype: bool
+ :return: returns True if all the checks pass, False otherwise
+ :rtype: bool
"""
message = None
@@ -266,8 +266,8 @@ class Wizard(QtGui.QWizard):
"""
Sets the status label in the registration page to status
- @param status: status message to display, can be HTML
- @type status: str
+ :param status: status message to display, can be HTML
+ :type status: str
"""
if error:
status = "<font color='red'><b>%s</b></font>" % (status,)
@@ -321,17 +321,17 @@ class Wizard(QtGui.QWizard):
"""
Checks a task and completes a page if specified
- @param data: data as it comes from the bootstrapper thread for
+ :param data: data as it comes from the bootstrapper thread for
a specific check
- @type data: dict
- @param label: label that displays the status icon for a
+ :type data: dict
+ :param label: label that displays the status icon for a
specific check that corresponds to the data
- @type label: QtGui.QLabel
- @param complete: if True, it completes the page specified,
+ :type label: QtGui.QLabel
+ :param complete: if True, it completes the page specified,
which must be of type WizardPage
- @type complete: bool
- @param complete_page: page id to complete
- @type complete_page: int
+ :type complete: bool
+ :param complete_page: page id to complete
+ :type complete_page: int
"""
passed = data[self._provider_bootstrapper.PASSED_KEY]
error = data[self._provider_bootstrapper.ERROR_KEY]
@@ -450,10 +450,10 @@ class Wizard(QtGui.QWizard):
Adds the service to the state if the state is checked, removes
it otherwise
- @param service: service to handle
- @type service: str
- @param state: state of the checkbox
- @type state: int
+ :param service: service to handle
+ :type service: str
+ :param state: state of the checkbox
+ :type state: int
"""
if state == QtCore.Qt.Checked:
self._selected_services = \