pip._vendor.pygments.formatters.rtf.RtfFormatter Class Reference

Inheritance diagram for pip._vendor.pygments.formatters.rtf.RtfFormatter:

Collaboration diagram for pip._vendor.pygments.formatters.rtf.RtfFormatter:

Public Member Functions
	__init__ (self, **options)
	format_unencoded (self, tokensource, outfile)
Public Member Functions inherited from pip._vendor.pygments.formatter.Formatter
	get_style_defs (self, arg='')
	format (self, tokensource, outfile)

Public Attributes
	fontface
	fontsize
Public Attributes inherited from pip._vendor.pygments.formatter.Formatter
	style
	full
	title
	encoding
	options

Static Public Attributes
str	name = 'RTF'
list	aliases = ['rtf']
list	filenames = ['*.rtf']
Static Public Attributes inherited from pip._vendor.pygments.formatter.Formatter
	name = None
list	aliases = []
list	filenames = []
bool	unicodeoutput = True

Protected Member Functions
	_escape (self, text)
	_escape_text (self, text)

Detailed Description

Format tokens as RTF markup. This formatter automatically outputs full RTF
documents with color information and other useful stuff. Perfect for Copy and
Paste into Microsoft(R) Word(R) documents.

Please note that ``encoding`` and ``outencoding`` options are ignored.
The RTF format is ASCII natively, but handles unicode characters correctly
thanks to escape sequences.

.. versionadded:: 0.6

Additional options accepted:

`style`
    The style to use, can be a string or a Style subclass (default:
    ``'default'``).

`fontface`
    The used font family, for example ``Bitstream Vera Sans``. Defaults to
    some generic font which is supposed to have fixed width.

`fontsize`
    Size of the font used. Size is specified in half points. The
    default is 24 half-points, giving a size 12 font.

    .. versionadded:: 2.0

Constructor & Destructor Documentation

__init__()

pip._vendor.pygments.formatters.rtf.RtfFormatter.__init__	(		self,
		**	options
	)

    Additional options accepted:

    ``fontface``
        Name of the font used. Could for example be ``'Courier New'``
        to further specify the default which is ``'\fmodern'``. The RTF
        specification claims that ``\fmodern`` are "Fixed-pitch serif
        and sans serif fonts". Hope every RTF implementation thinks
        the same about modern...

Reimplemented from pip._vendor.pygments.formatter.Formatter.

---

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

• docs/help/help-venv/lib/python3.12/site-packages/pip/_vendor/pygments/formatters/rtf.py