Package hsh :: Package curses_display :: Module content_view :: Class ContentView
[hide private]
[frames] | no frames]

Class ContentView

object --+    
         |    
 view.View --+
             |
            ContentView
Known Subclasses:

An abstract subclass of view with additional functionality for displaying content provided as a Text object.

It provides a draw() method, formatting options including linefolding, and maintains a viewport and cursor on the provided Text.

Formatting, viewport and cursor tracking are provided by a TextViewport.

Limited editing functionality is provided.

Instance Methods [hide private]
 
__init__(self, display, text, name=None)
Initialize the new ContentView.
 
delete_left(self, ki)
 
delete_line(self, ki)
 
delete_right(self, ki)
boolean
draw(self, win, force_redraw=False, search=None)
Draw this view on the provided curses window.
 
draw_cursor(self, win)
Default implementation does not draw a cursor.
 
insert(self, ki)
 
insert_text(self, text)
 
is_dirty(self)
 
move_bottom(self, ki)
 
move_down(self, ki)
 
move_end(self, ki)
 
move_left(self, ki)
 
move_right(self, ki)
 
move_search(self, pattern, forward=True, from_end=False)
Update the display position so the next match of the given pattern is visible.
 
move_start(self, ki)
 
move_top(self, ki)
 
move_up(self, ki)
 
page_down(self, ki)
 
page_up(self, ki)
 
paste(self, ki)
 
toggle_wrap(self, ki)

Inherited from view.View: change_view, current_job, delete_job, draw_header, draw_line, edit_job, get_face, get_name, has_terminal, header_info, min_height, min_width, next_job, next_window, prev_job, putch, quit, restart_job, set_dirty, set_focus, set_has_terminal, set_visible_job, show_search, wants_terminal

Inherited from view.View (private): _content_win

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, display, text, name=None)
(Constructor)

 

Initialize the new ContentView.

Parameters:
  • display (CursesDisplay) - Where it will be drawn
  • text (Text or an array of strings) - What to draw
  • name (string or None) - Optional unique name, defaulting to class name.
Overrides: object.__init__

delete_left(self, ki)

 
Overrides: view.View.delete_left

delete_line(self, ki)

 
Overrides: view.View.delete_line

delete_right(self, ki)

 
Overrides: view.View.delete_right

draw(self, win, force_redraw=False, search=None)

 

Draw this view on the provided curses window. If force_redraw is True, then do a full redraw, otherwise just an update is enough.

Parameters:
  • force_redraw - If true the view object shouldn't try to optimize.
  • search - a regular expression object whose matches should be highlighted.
Returns: boolean
True means something was drawn or the cursor position has changed. This result is used by the main drawing loop to decide whether to draw the cursor, or take a nap.
Overrides: view.View.draw

draw_cursor(self, win)

 

Default implementation does not draw a cursor.

Overrides: view.View.draw_cursor
(inherited documentation)

insert(self, ki)

 
Overrides: view.View.insert

is_dirty(self)

 
Overrides: view.View.is_dirty

move_bottom(self, ki)

 
Overrides: view.View.move_bottom

move_down(self, ki)

 
Overrides: view.View.move_down

move_end(self, ki)

 
Overrides: view.View.move_end

move_left(self, ki)

 
Overrides: view.View.move_left

move_right(self, ki)

 
Overrides: view.View.move_right

move_search(self, pattern, forward=True, from_end=False)

 

Update the display position so the next match of the given pattern is visible.

Overrides: view.View.move_search

move_start(self, ki)

 
Overrides: view.View.move_start

move_top(self, ki)

 
Overrides: view.View.move_top

move_up(self, ki)

 
Overrides: view.View.move_up

page_down(self, ki)

 
Overrides: view.View.page_down

page_up(self, ki)

 
Overrides: view.View.page_up

paste(self, ki)

 
Overrides: view.View.paste

toggle_wrap(self, ki)

 
Overrides: view.View.toggle_wrap