python.iconfTool.gui.modals.HelpModal Class Reference

Inheritance diagram for python.iconfTool.gui.modals.HelpModal:

Collaboration diagram for python.iconfTool.gui.modals.HelpModal:

Public Member Functions
None	__init__ (self, int start_x, int start_y, int width, int height)
None	add_line (self, str text, int blank_lines=1)
None	show_help (self)
None	refresh (self)
None	destroy (self)

Public Attributes
	help_window
	begin_x
	x
	window

Detailed Description

Definition at line 39 of file modals.py.

Constructor & Destructor Documentation

__init__()

None python.iconfTool.gui.modals.HelpModal.__init__	(		self,
		int	start_x,
		int	start_y,
		int	width,
		int	height
	)

Reimplemented from python.iconfTool.gui.modals.Modal.

Definition at line 40 of file modals.py.

    def __init__(
        self, start_x: int, start_y: int, width: int, height: int
    ) -> None:
        super().__init__(start_x, start_y, width, height)
        self.help_window = self.window.derwin(
            self.height - 2, self.width - 2, 1, 1
        )
 
        self.begin_y, self.begin_x = self.window.getparyx()
        self.y, self.x = self.begin_y, self.begin_x
        self.y += 2
        self.x += 2
 

Member Function Documentation

add_line()

None python.iconfTool.gui.modals.HelpModal.add_line	(		self,
		str	text,
		int	blank_lines = 1
	)

Definition at line 53 of file modals.py.

    def add_line(self, text: str, blank_lines: int = 1) -> None:
        self.window.addstr(self.y, self.x, text)
        self.y += blank_lines
 

destroy()

None python.iconfTool.gui.modals.Modal.destroy (   self )

inherited

Definition at line 21 of file modals.py.

    def destroy(self) -> None:
        del self.window
 
 

refresh()

None python.iconfTool.gui.modals.Modal.refresh (   self )

inherited

Definition at line 18 of file modals.py.

    def refresh(self) -> None:
        self.window.refresh()
 

show_help()

None python.iconfTool.gui.modals.HelpModal.show_help

(

self

)

Reimplemented in python.iconfTool.gui.modals.DoubleHelpModal, and python.iconfTool.gui.modals.SingleHelpModal.

Definition at line 57 of file modals.py.

    def show_help(self) -> None:
        pass
 
 

Member Data Documentation

begin_x

python.iconfTool.gui.modals.HelpModal.begin_x

Definition at line 46 of file modals.py.

help_window

python.iconfTool.gui.modals.HelpModal.help_window

Definition at line 42 of file modals.py.

window

python.iconfTool.gui.modals.Modal.window

inherited

Definition at line 12 of file modals.py.

x

python.iconfTool.gui.modals.HelpModal.x

Definition at line 47 of file modals.py.

---

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

• modals.py