Classes
class	Coords
	This is a base class for word objects, basically consisting of a pair of (x, y) coordinates: the start coordinate given by Coords::start and the end coordinate given by Coords::end. More...

class	Crossword
	Implementation of a crossword puzzle with auto generation functionality. More...

class	CWError
	General-purpose crossword exceptions. More...

class	CWInfo
	A simple structure to hold crossword meta information, such as title, author, etc. More...

class	CWStopCheck
	Generation interrupt exception. More...

class	CWTimeoutError
	Generation timeout exception. More...

class	MLStripper
	Utility class that converts HTML text to plain text. More...

class	Word
	Implementation of a single word in a hypothetical crossword. More...

class	Wordgrid
	Core crossword implementation - a grid of characters + internal Word objects. More...

Variables
string	FILLER = '*'
	the placeholder used for filled (blocked / stopped) cells inside the cw grid (those that are usually shown as black cells in print) More...

string	FILLER2 = '~'
	the placeholder used for surrounding cells around the cw grid (used chiefly when the grid is of non-rectangular form) More...

string	BLANK = '_'
	the placeholder used for blank cells More...

	DEFAULT_GRID = \
	a default cw grid structure - used by Crossword constructor as default grid initializer More...

string	LOG_INDENT = '\t'
	indentation character(s) in log messages More...

Detailed Description

Implementation of crossword-related objects: words, crossword grid and crossword generator. The classes implemented here are independent of GUI and can be used in a console environment or accessed by plugins.

Variable Documentation

◆ BLANK

string pycross.crossword.BLANK = '_'

the placeholder used for blank cells

◆ DEFAULT_GRID

pycross.crossword.DEFAULT_GRID = \

a default cw grid structure - used by Crossword constructor as default grid initializer

◆ FILLER

string pycross.crossword.FILLER = '*'

the placeholder used for filled (blocked / stopped) cells inside the cw grid (those that are usually shown as black cells in print)

◆ FILLER2

string pycross.crossword.FILLER2 = '~'

the placeholder used for surrounding cells around the cw grid (used chiefly when the grid is of non-rectangular form)

◆ LOG_INDENT

string pycross.crossword.LOG_INDENT = '\t'

indentation character(s) in log messages

Classes