rcEndRunDlgImpl.py

Go to the documentation of this file.

#!/usr/local/bin/python
#
#                               Copyright 2005
#                                     by
#                        The Board of Trustees of the
#                     Leland Stanford Junior University.
#                            All rights reserved.
#

__facility__ = "Online"
__abstract__ = "End Run Comments dialog"
__author__   = "S. Tuvi <STuvi@SLAC.Stanford.edu>"
__date__     = "2005/07/23 00:08:27"
__updated__  = "$Date: 2005/09/22 00:29:30 $"
__version__  = "$Revision: 1.5 $"
__release__  = "$Name: HEAD $"
__credits__  = "SLAC"

import LICOS.copyright_SLAC

from qt import *
import sys
from rcEndRunDlg   import rcEndRunDlg
from rcComplStatus import rcCompletionStatus


class rcEndRunDlgImpl(rcEndRunDlg):
  """!\brief End run dialog class.

  This class is based on the rcCommentPanel class
  (the import is done in rcEndRunDlg.ui) which provides
  the operator with the means of entering comments at the
  end of the run.

  The operator can also override the completion status here.
  """

  Accepted = QDialog.Accepted

  def __init__(self, parent = None, name = None, fl = 0):
    """!\brief rcEndRunDlgImpl constructor.

    \param parent Parent GUI
    \param name   GUI name
    \param fl     GUI flags
    """
    rcEndRunDlg.__init__(self, parent, name, fl)
    QObject.connect(self.comboComplStatus, SIGNAL("activated(const QString&)"), self.complStatusChanged)
    QObject.connect(self.CANCEL,SIGNAL("clicked()"),self.cancel)
    QObject.connect(self.OK,SIGNAL("clicked()"),self.ok)

    self.__parent = parent
    self.__compl = rcCompletionStatus()

  def initialize(self, secMan, loginId, app):
    """!\brief Initialize the dialog.

    \param secMan  Security manager
    \param loginId Operator's login id.
    """
    self.__secMan  = secMan
    self.__loginId = loginId
    self.__app     = app
    combo = self.comboComplStatus
    combo.clear()
    csDict = self.__compl.getAll()
    csStrList = csDict.values()
    csStrList.sort()
    for csStr in csStrList:
      combo.insertItem(csStr)
    curComplStatusStr = self.__app.getCompletionStatusStr()
    combo.setCurrentText(curComplStatusStr)
    self.comments.getWidget().clearDisplay()
    self.comments.getWidget().clearHistory()
    self.comments.getWidget().setReadOnly(0)
    self.txtPassword.setEnabled(0)
    self.txtPassword.clear()

  def complStatusChanged(self, complStatusStr):
    """!\brief Signal that the completion status has been changed by the operator.

    \param complStatusStr The new completion status string.
    """
    curComplStatus = self.__app.getCompletionStatusStr()
    if curComplStatus != complStatusStr:
      self.txtPassword.setEnabled(1)
    else:
      self.txtPassword.setEnabled(0)

  def getNewCompletionStatus(self, curComplStatusStr):
    """!\brief Retrieve the new completion status value and string.

    \param curComplStatusStr Current completion status string

    \return A tuple of new completion status value and string or
            A tuple of two Nones if the completion status have
            not been modified.
    """
    csStr = self.getCompletionStatusStr()
    for (cv, cs) in self.__compl.getAll().items():
      if cs == csStr:
        if cs != curComplStatusStr:
          return (cv, cs)
    return (None, None)

  def ok(self):
    """!\brief The user accepted the dialog.

    """
    if self.txtPassword.isEnabled():
      res = self.__secMan.authenticateUser(self.__loginId, str(self.txtPassword.text()).strip())
      if res != 0:
        QMessageBox.critical( self, "Authentication Error",
                        "Incorrect Password",
                        QMessageBox.Ok + QMessageBox.Default )
        return
    self.comments.getWidget().flushComment()
    QDialog.done(self, QDialog.Accepted)

  def cancel(self):
    """!\brief The user rejected the dialog.

    """
    self.comments.getWidget().clearHistory()
    QDialog.done(self, QDialog.Rejected)

  def getCompletionStatusStr(self):
    """!\brief Retrieve the completion status selected in the dialog.

    \return Selected completion status string.
    """
    return str(self.comboComplStatus.currentText())

  def enterComment(self, comment, addToHistory=0, source='system'):
    """!\brief Enter a comment programmatically.

    This can be called from a user script to add to comments.
    The text is prepended with \a source to indicate that it is a
    machine generated comment.

    \param comment      The text of the comment to be entered
    \param addtoHistory Whether this comment will be persistent or not
    \param source       The text to be prepended before the comment

    """
    self.comments.getWidget().enterComment(comment, addToHistory, source)

  def clearHistory(self):
    """!\brief Clear the comment history.

    """
    self.comments.getWidget().clearHistory()

---