Plugin_Refactoring_Rope.RefactoringRope.HelpDialog

Module implementing a dialog to show help about rope.

Classes

HelpDialog Class implementing a dialog to show help about rope.

Functions

None

HelpDialog

Class implementing a dialog to show help about rope.

Derived from

QDialog, Ui_HelpDialog

Methods

HelpDialog Constructor
findNextPrev Public slot to find the next occurrence of a text.
helpWidget Public method to get a reference to the help widget.
on_buttonBox_clicked Private slot called by a button of the button box clicked.

HelpDialog (Constructor)

HelpDialog(title, helpfile, parent = None)

Constructor

title
window title (string or QString)
helpfile
filename of the helpfile (string)
parent
reference to the parent widget (QWidget)

HelpDialog.findNextPrev

findNextPrev(txt, case, word, backwards)

Public slot to find the next occurrence of a text.

txt
text to search for (QString)
case
flag indicating a case sensitive search (boolean)
word
flag indicating a word based search (boolean)
backwards
flag indicating a backwards search (boolean)

HelpDialog.helpWidget

helpWidget()

Public method to get a reference to the help widget.

Returns:
reference to the help widget (QTextEdit)

HelpDialog.on_buttonBox_clicked

on_buttonBox_clicked(button)

Private slot called by a button of the button box clicked.

button
button that was clicked (QAbstractButton)
Up