Robot Framework
robot.libdocpkg.consoleviewer.ConsoleViewer Class Reference

Public Member Functions

def __init__ (self, libdoc)
 
def handles (cls, command)
 
def list (self, *patterns)
 
def show (self, *names)
 
def validate_command (cls, command, args)
 
def version (self)
 
def view (self, command, *args)
 

Private Member Functions

def _console (self, msg)
 
def _data (self, items)
 
def _doc (self, doc)
 
def _header (self, name, underline)
 
def _show_inits (self, lib)
 
def _show_intro (self, lib)
 
def _show_keyword (self, kw, show_name=True)
 
def _wrap (self, text, width=78, **config)
 

Private Attributes

 _keywords
 
 _libdoc
 

Detailed Description

Definition at line 22 of file consoleviewer.py.

Constructor & Destructor Documentation

◆ __init__()

def robot.libdocpkg.consoleviewer.ConsoleViewer.__init__ (   self,
  libdoc 
)

Definition at line 24 of file consoleviewer.py.

Member Function Documentation

◆ _console()

def robot.libdocpkg.consoleviewer.ConsoleViewer._console (   self,
  msg 
)
private

Definition at line 58 of file consoleviewer.py.

◆ _data()

def robot.libdocpkg.consoleviewer.ConsoleViewer._data (   self,
  items 
)
private

Definition at line 81 of file consoleviewer.py.

◆ _doc()

def robot.libdocpkg.consoleviewer.ConsoleViewer._doc (   self,
  doc 
)
private

Definition at line 88 of file consoleviewer.py.

◆ _header()

def robot.libdocpkg.consoleviewer.ConsoleViewer._header (   self,
  name,
  underline 
)
private

Definition at line 78 of file consoleviewer.py.

◆ _show_inits()

def robot.libdocpkg.consoleviewer.ConsoleViewer._show_inits (   self,
  lib 
)
private

Definition at line 67 of file consoleviewer.py.

◆ _show_intro()

def robot.libdocpkg.consoleviewer.ConsoleViewer._show_intro (   self,
  lib 
)
private

Definition at line 61 of file consoleviewer.py.

◆ _show_keyword()

def robot.libdocpkg.consoleviewer.ConsoleViewer._show_keyword (   self,
  kw,
  show_name = True 
)
private

Definition at line 72 of file consoleviewer.py.

◆ _wrap()

def robot.libdocpkg.consoleviewer.ConsoleViewer._wrap (   self,
  text,
  width = 78,
**  config 
)
private

Definition at line 95 of file consoleviewer.py.

◆ handles()

def robot.libdocpkg.consoleviewer.ConsoleViewer.handles (   cls,
  command 
)

Definition at line 29 of file consoleviewer.py.

◆ list()

def robot.libdocpkg.consoleviewer.ConsoleViewer.list (   self,
patterns 
)

Definition at line 43 of file consoleviewer.py.

◆ show()

def robot.libdocpkg.consoleviewer.ConsoleViewer.show (   self,
names 
)

Definition at line 47 of file consoleviewer.py.

◆ validate_command()

def robot.libdocpkg.consoleviewer.ConsoleViewer.validate_command (   cls,
  command,
  args 
)

Definition at line 33 of file consoleviewer.py.

◆ version()

def robot.libdocpkg.consoleviewer.ConsoleViewer.version (   self)

Definition at line 55 of file consoleviewer.py.

◆ view()

def robot.libdocpkg.consoleviewer.ConsoleViewer.view (   self,
  command,
args 
)

Definition at line 39 of file consoleviewer.py.

Member Data Documentation

◆ _keywords

robot.libdocpkg.consoleviewer.ConsoleViewer._keywords
private

Definition at line 26 of file consoleviewer.py.

◆ _libdoc

robot.libdocpkg.consoleviewer.ConsoleViewer._libdoc
private

Definition at line 25 of file consoleviewer.py.


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