Public Member Functions
None	__init__ (self, *Union[ControlType, ControlCode] codes)

"Control"	bell (cls)

"Control"	home (cls)

"Control"	move (cls, int x=0, int y=0)

"Control"	move_to_column (cls, int x, int y=0)

"Control"	move_to (cls, int x, int y)

"Control"	clear (cls)

"Control"	show_cursor (cls, bool show)

"Control"	alt_screen (cls, bool enable)

"Control"	title (cls, str title)

str	__str__ (self)

"RenderResult"	__rich_console__ (self, "Console" console, "ConsoleOptions" options)

Public Attributes
	segment

Detailed Description

A renderable that inserts a control code (non printable but may move cursor).

Args:
    *codes (str): Positional arguments are either a :class:`~rich.segment.ControlType` enum or a
        tuple of ControlType and an integer parameter

Member Function Documentation

◆ alt_screen()

"Control" pip._vendor.rich.control.Control.alt_screen	(		cls,
		bool	enable
	)

Enable or disable alt screen.

◆ bell()

"Control" pip._vendor.rich.control.Control.bell ( cls )

Ring the 'bell'.

◆ clear()

"Control" pip._vendor.rich.control.Control.clear ( cls )

Clear the screen.

◆ home()

"Control" pip._vendor.rich.control.Control.home ( cls )

Move cursor to 'home' position.

◆ move()

"Control" pip._vendor.rich.control.Control.move	(		cls,
		int	x = `0`,
		int	y = `0`
	)

Move cursor relative to current position.

Args:
    x (int): X offset.
    y (int): Y offset.

Returns:
    ~Control: Control object.

◆ move_to()

"Control" pip._vendor.rich.control.Control.move_to	(		cls,
		int	x,
		int	y
	)

Move cursor to absolute position.

Args:
    x (int): x offset (column)
    y (int): y offset (row)

Returns:
    ~Control: Control object.

◆ move_to_column()

"Control" pip._vendor.rich.control.Control.move_to_column	(		cls,
		int	x,
		int	y = `0`
	)

Move to the given column, optionally add offset to row.

Returns:
    x (int): absolute x (column)
    y (int): optional y offset (row)

Returns:
    ~Control: Control object.

◆ show_cursor()

"Control" pip._vendor.rich.control.Control.show_cursor	(		cls,
		bool	show
	)

Show or hide the cursor.

◆ title()

"Control" pip._vendor.rich.control.Control.title	(		cls,
		str	title
	)

Set the terminal window title

Args:
    title (str): The new terminal window title

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

docs/help/help-venv/lib/python3.12/site-packages/pip/_vendor/rich/control.py

Public Member Functions

Public Attributes