pycrossword  0.2
Pure-Python implementation of a crossword puzzle generator and editor
Public Member Functions | Public Attributes | List of all members
pycross.forms.WordSuggestDialog Class Reference
Inheritance diagram for pycross.forms.WordSuggestDialog:
pycross.forms.BasicDialog

Public Member Functions

def __init__ (self, mainwindow, word='', word_editable=False, getresults=None, parent=None, flags=QtCore.Qt.WindowFlags())
 
def addMainLayout (self)
 Creates the main (central) layout for controls. More...
 
def showEvent (self, event)
 
def closeEvent (self, event)
 
def init (self, word='', word_editable=False)
 
def validate (self)
 Validates user input (reimplemented in child classes). More...
 
def fill_words (self)
 
def update_actions (self)
 
def sort_words (self, order='')
 
def on_ch_truncate (self, checked)
 
def on_word_edited (self, text)
 
def on_word_dblclick (self, item)
 
def on_act_refresh (self, checked)
 
def on_act_sort (self, checked)
 
def on_act_shuffle (self, checked)
 
def on_act_source_config (self, checked)
 
- Public Member Functions inherited from pycross.forms.BasicDialog
def initUI (self, geometry=None, title=None, icon=None)
 Creates the core controls: OK and Cancel buttons and layouts. More...
 
def on_btn_OK_clicked (self)
 Fires when the OK button is clicked. More...
 
def on_btn_cancel_clicked (self)
 Fires when the Cancel button is clicked: rejects input and closes window. More...
 

Public Attributes

 mainwindow
 
 sortdir
 
 word
 
 word_editable
 
 getresults
 
 results
 
 selected
 
 layout_controls
 
 layout_top
 
 l_word
 
 le_word
 
 layout_center
 
 lw_words
 
 tb_actions
 
 act_refresh
 
 act_sort
 
 act_shuffle
 
 act_source_config
 
 l_count
 
 ch_truncate
 
 layout_lower
 
 old_truncate
 
- Public Attributes inherited from pycross.forms.BasicDialog
 layout_controls
 QtWidgets.QFormLayout central layout for controls More...
 
 btn_OK
 QtWidgets.QPushButton OK button More...
 
 btn_cancel
 QtWidgets.QPushButton Cancel button More...
 
 layout_bottom
 QtWidgets.QHBoxLayout bottom layout for OK and Cancel buttons More...
 
 layout_main
 QtWidgets.QVBoxLayout window layout More...
 

Constructor & Destructor Documentation

◆ __init__()

def pycross.forms.WordSuggestDialog.__init__ (   self,
  mainwindow,
  word = '',
  word_editable = False,
  getresults = None,
  parent = None,
  flags = QtCore.Qt.WindowFlags() 
)
Params:
* mainwindow [QWidget]: the main application window
* word [str]: the word string to look up in suggestions
* word_editable [bool]: if the word string can be edited directly in the dialog
* getresults [callable]: pointer to function that retrieves suggestions;
    this function takes one argument - the word string, and returns suggestions as a list of strings
* parent, flags: see BasicDialog

Reimplemented from pycross.forms.BasicDialog.

Member Function Documentation

◆ addMainLayout()

def pycross.forms.WordSuggestDialog.addMainLayout (   self)

Creates the main (central) layout for controls.

Must be overridden by child classes to change the layout type (default = QtWidgets.QFormLayout) and add controls.

Reimplemented from pycross.forms.BasicDialog.

◆ closeEvent()

def pycross.forms.WordSuggestDialog.closeEvent (   self,
  event 
)

◆ fill_words()

def pycross.forms.WordSuggestDialog.fill_words (   self)

◆ init()

def pycross.forms.WordSuggestDialog.init (   self,
  word = '',
  word_editable = False 
)

◆ on_act_refresh()

def pycross.forms.WordSuggestDialog.on_act_refresh (   self,
  checked 
)

◆ on_act_shuffle()

def pycross.forms.WordSuggestDialog.on_act_shuffle (   self,
  checked 
)

◆ on_act_sort()

def pycross.forms.WordSuggestDialog.on_act_sort (   self,
  checked 
)

◆ on_act_source_config()

def pycross.forms.WordSuggestDialog.on_act_source_config (   self,
  checked 
)

◆ on_ch_truncate()

def pycross.forms.WordSuggestDialog.on_ch_truncate (   self,
  checked 
)

◆ on_word_dblclick()

def pycross.forms.WordSuggestDialog.on_word_dblclick (   self,
  item 
)

◆ on_word_edited()

def pycross.forms.WordSuggestDialog.on_word_edited (   self,
  text 
)

◆ showEvent()

def pycross.forms.WordSuggestDialog.showEvent (   self,
  event 
)

◆ sort_words()

def pycross.forms.WordSuggestDialog.sort_words (   self,
  order = '' 
)

◆ update_actions()

def pycross.forms.WordSuggestDialog.update_actions (   self)

◆ validate()

def pycross.forms.WordSuggestDialog.validate (   self)

Validates user input (reimplemented in child classes).

Returns
bool True if user input is valid, False otherwise
See also
on_btn_OK_clicked()

Reimplemented from pycross.forms.BasicDialog.

Member Data Documentation

◆ act_refresh

pycross.forms.WordSuggestDialog.act_refresh

◆ act_shuffle

pycross.forms.WordSuggestDialog.act_shuffle

◆ act_sort

pycross.forms.WordSuggestDialog.act_sort

◆ act_source_config

pycross.forms.WordSuggestDialog.act_source_config

◆ ch_truncate

pycross.forms.WordSuggestDialog.ch_truncate

◆ getresults

pycross.forms.WordSuggestDialog.getresults

◆ l_count

pycross.forms.WordSuggestDialog.l_count

◆ l_word

pycross.forms.WordSuggestDialog.l_word

◆ layout_center

pycross.forms.WordSuggestDialog.layout_center

◆ layout_controls

pycross.forms.WordSuggestDialog.layout_controls

◆ layout_lower

pycross.forms.WordSuggestDialog.layout_lower

◆ layout_top

pycross.forms.WordSuggestDialog.layout_top

◆ le_word

pycross.forms.WordSuggestDialog.le_word

◆ lw_words

pycross.forms.WordSuggestDialog.lw_words

◆ mainwindow

pycross.forms.WordSuggestDialog.mainwindow

◆ old_truncate

pycross.forms.WordSuggestDialog.old_truncate

◆ results

pycross.forms.WordSuggestDialog.results

◆ selected

pycross.forms.WordSuggestDialog.selected

◆ sortdir

pycross.forms.WordSuggestDialog.sortdir

◆ tb_actions

pycross.forms.WordSuggestDialog.tb_actions

◆ word

pycross.forms.WordSuggestDialog.word

◆ word_editable

pycross.forms.WordSuggestDialog.word_editable

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