pycrossword  0.4
Pure-Python implementation of a crossword puzzle generator and editor
Public Member Functions | Public Attributes | List of all members
pycross.forms.CustomPluginDialog Class Reference

Dialog to add or edit custom plugins. More...

Inheritance diagram for pycross.forms.CustomPluginDialog:
pycross.forms.BasicDialog

Public Member Functions

def __init__ (self, mainwindow, title, plugin_category='', plugin_name='', plugin_desc='', plugin_vers='', plugin_auth='', plugin_copyright='', plugin_website='', plugin_path='', parent=None, flags=QtCore.Qt.WindowFlags())
 Constructor. More...
 
def addMainLayout (self)
 Creates the main (central) layout for controls. More...
 
def validate (self)
 Validates user input (reimplemented in child classes). More...
 
def on_combo_source (self, index)
 Fires when an item in the 'Plugin source' combobox is selected. More...
 
- Public Member Functions inherited from pycross.forms.BasicDialog
def __init__ (self, geometry=None, title=None, icon=None, parent=None, flags=QtCore.Qt.WindowFlags(), sizepolicy=QtWidgets.QSizePolicy(QtWidgets.QSizePolicy.Fixed, QtWidgets.QSizePolicy.Fixed))
 Constructor. More...
 
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
 
 presets
 
 layout_controls
 
 le_name
 
 combo_category
 
 le_author
 
 le_version
 
 le_copyright
 
 te_description
 
 le_website
 
 combo_source
 
 le_sourcepath
 
- 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...
 

Detailed Description

Dialog to add or edit custom plugins.

Constructor & Destructor Documentation

◆ __init__()

def pycross.forms.CustomPluginDialog.__init__ (   self,
  mainwindow,
  title,
  plugin_category = '',
  plugin_name = '',
  plugin_desc = '',
  plugin_vers = '',
  plugin_auth = '',
  plugin_copyright = '',
  plugin_website = '',
  plugin_path = '',
  parent = None,
  flags = QtCore.Qt.WindowFlags() 
)

Constructor.

Parameters
mainwindowQtWidgets.QMainWindow pointer to gui::MainWindow instance
titlestr dialog title
plugin_categorystr plugin category name (default = empty, user will choose)
plugin_namestr plugin name (default = empty)
plugin_descstr plugin description (default = empty)
plugin_versstr plugin version (default = empty)
plugin_authstr plugin author (default = empty)
plugin_copyrightstr plugin copyright (default = empty)
plugin_websitestr plugin website (default = empty)
plugin_pathstr plugin module path (default = empty)
parentQtWidgets.QWidget parent widget (default = None, i.e. no parent)
flagsQtCore.Qt.WindowFlags Qt window flags

Member Function Documentation

◆ addMainLayout()

def pycross.forms.CustomPluginDialog.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.

◆ on_combo_source()

def pycross.forms.CustomPluginDialog.on_combo_source (   self,
  index 
)

Fires when an item in the 'Plugin source' combobox is selected.

◆ validate()

def pycross.forms.CustomPluginDialog.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

◆ combo_category

pycross.forms.CustomPluginDialog.combo_category

◆ combo_source

pycross.forms.CustomPluginDialog.combo_source

◆ layout_controls

pycross.forms.CustomPluginDialog.layout_controls

◆ le_author

pycross.forms.CustomPluginDialog.le_author

◆ le_copyright

pycross.forms.CustomPluginDialog.le_copyright

◆ le_name

pycross.forms.CustomPluginDialog.le_name

◆ le_sourcepath

pycross.forms.CustomPluginDialog.le_sourcepath

◆ le_version

pycross.forms.CustomPluginDialog.le_version

◆ le_website

pycross.forms.CustomPluginDialog.le_website

◆ mainwindow

pycross.forms.CustomPluginDialog.mainwindow

◆ presets

pycross.forms.CustomPluginDialog.presets

◆ te_description

pycross.forms.CustomPluginDialog.te_description

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