CommentEntryWidget Class Reference

Comment entry widget. More...

List of all members.

Public Member Functions
def	__init__
	CommentEntryWidget constructor.
def	getHistory
def	getTimestamps
	Return the timestamps of the comments entered so far.
def	clearHistory
	Clear the comment history.
def	clearDisplay
	Clear the display buffer.
def	setPrompt
	Set the prompt for comment entry.
def	getPrompt
	Retrieve the current prompt.
def	flush
	Simulate stdin, stdout, and stderr.
def	isatty
	Simulate stdin, stdout, and stderr.
def	readline
	Simulate stdin, stdout, and stderr.
def	write
	Simulate stdin, stdout, and stderr.
def	writelines
	Simulate stdin, stdout, and stderr.
def	enterComment
	Enter a comment programmatically.
def	flushComment
	Force comment entry if the user hasn't pressed the Enter key yet.
def	__run
	Display/store the comment.
def	__clearLine
	Clear input line buffer.
def	insertText
	Insert text at a given position.
def	__insertText
	Insert text at the current cursor position.
def	keyPressEvent
	Handle user input a key at a time.
def	__deleteLine
	Delete a line.
def	__recall
	Display the current item from the command history.
def	focusNextPrevChild
	Suppress tabbing to the next window in multi-line commands.
def	handleClicked
	Save the selected text to the clipboard.
def	contentsContextMenuEvent
	Paste the contents of the clipboard to the cursor position.

---

Detailed Description

Comment entry widget.

This widget is based on the QTextEdit widget and allows the entry and storage of comments entered by an operator.

Definition at line 65 of file rcCommentPanel.py.

---

Member Function Documentation

def __clearLine (    self  )

Clear input line buffer. Definition at line 258 of file rcCommentPanel.py.

def __deleteLine (    self  )

Delete a line. Definition at line 363 of file rcCommentPanel.py.

def __init__ (    self,   parent = None )

CommentEntryWidget constructor. Parameters: parent  Parent GUI Definition at line 67 of file rcCommentPanel.py.

def __insertText (    self,   text,   posY = 0,   posX = 0 )

Insert text at the current cursor position. Parameters: text  Text to be inserted posY  Relative Y position posX  Relative X position Definition at line 281 of file rcCommentPanel.py.

def __recall (    self  )

Display the current item from the command history. Definition at line 373 of file rcCommentPanel.py.

def __run (    self,   addToHistory = 1 )

Display/store the comment. Display the comment in the textedit window and based on addHistory value store it in the history. Parameters: addToHistory  If 1, store the comment in the history (default). If 0, do not store the comment in the history. Definition at line 234 of file rcCommentPanel.py.

def clearDisplay (    self  )

Clear the display buffer. Definition at line 133 of file rcCommentPanel.py.

def clearHistory (    self  )

Clear the comment history. Definition at line 126 of file rcCommentPanel.py.

def contentsContextMenuEvent (    self,   ev )

Paste the contents of the clipboard to the cursor position. Definition at line 397 of file rcCommentPanel.py.

def enterComment (    self,   comment,   addToHistory = 0,   source = 'system' )

Enter a comment programmatically. This can be called from a user script to add to comments. The text is prepended with source to indicate that it is a machine generated comment. Parameters: comment  The text of the comment to be entered addtoHistory  Whether this comment will be persistent or not source  The text to be prepended before the comment Definition at line 204 of file rcCommentPanel.py.

def flush (    self  )

Simulate stdin, stdout, and stderr. Definition at line 158 of file rcCommentPanel.py.

def flushComment (    self  )

Force comment entry if the user hasn't pressed the Enter key yet. Definition at line 226 of file rcCommentPanel.py.

def focusNextPrevChild (    self,   next )

Suppress tabbing to the next window in multi-line commands. Definition at line 381 of file rcCommentPanel.py.

def getHistory (    self  )

Definition at line 116 of file rcCommentPanel.py.

def getPrompt (    self  )

Retrieve the current prompt. Returns: Prompt string Definition at line 151 of file rcCommentPanel.py.

def getTimestamps (    self  )

Return the timestamps of the comments entered so far. Returns: A list of timestamps. Definition at line 119 of file rcCommentPanel.py.

def handleClicked (    self,   para,   pos )

Save the selected text to the clipboard. Definition at line 387 of file rcCommentPanel.py.

def insertText (    self,   text,   offsetY = 0,   absX = 0,   overwrite = 0 )

Insert text at a given position. Parameters: text  Text to be inserted offsetY  The position of the comment text relative to the current position absX  The absolute position of the comment text overwrite  Overwrite flag Definition at line 265 of file rcCommentPanel.py.

def isatty (    self  )

Simulate stdin, stdout, and stderr. Definition at line 164 of file rcCommentPanel.py.

def keyPressEvent (    self,   e )

Handle user input a key at a time. Parameters: e  Key event Definition at line 296 of file rcCommentPanel.py.

def readline (    self  )

Simulate stdin, stdout, and stderr. Definition at line 170 of file rcCommentPanel.py.

def setPrompt (    self,   prompt )

Set the prompt for comment entry. Parameters: prompt  Prompt string Definition at line 144 of file rcCommentPanel.py.

def write (    self,   text )

Simulate stdin, stdout, and stderr. Definition at line 184 of file rcCommentPanel.py.

def writelines (    self,   text )

Simulate stdin, stdout, and stderr. Definition at line 197 of file rcCommentPanel.py.

---

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

• rcCommentPanel.py

---