Files
superqt/docs/utilities/index.md
Talley Lambert 97bb814451 Docs (#124)
* wip

* wip

* more wip

* progress

* more docs

* more changes

* add link

* more examples and improvements

* fix check-manifest

* sort members

* remove autogen images

* remove _images

* add font docs

* add link to utils
2022-10-05 08:59:27 -04:00

2.2 KiB

Utilities

Font Icons

Object Description
addFont Add an OTF/TTF file at to the font registry.
font Create QFont for a given font-icon font family key
icon Create a QIcon for font-con glyph key
setTextIcon Set text on a QWidget to a specific font & glyph.
IconFont Helper class that provides a standard way to create an IconFont.
IconOpts Options for rendering an icon
Animation Base class for adding animations to a font-icon.

Threading tools

Object Description
ensure_main_thread Decorator that ensures a function is called in the main QApplication thread.
ensure_object_thread Decorator that ensures a QObject method is called in the object's thread.
FunctionWorker QRunnable with signals that wraps a simple long-running function.
GeneratorWorker QRunnable with signals that wraps a long-running generator.
create_worker Create a worker to run a target function in another thread.
thread_worker Decorator for create_worker, turn a function into a worker.

Miscellaneous

Object Description
QMessageHandler A context manager to intercept messages from Qt.
CodeSyntaxHighlight A QSyntaxHighlighter for code syntax highlighting.