addToClipboard ( self,  line )

Adds a line to the clipped buffer.

arrowDown ( self,  toedge=None )

If the user hits the down arrow key....

arrowLeft ( self )

If the user hits the left arrow key....

arrowRight ( self )

When the user hits the right arrow key....

arrowUp ( self,  toedge=None )

If the user hits the up arrow key....

backspaceCharacter ( self )

Deletes the previous character.

changed ( self )

Has this buffer been changed since the last saving? Returns a 1 if it has and a 0 if it hasn't.

clearClipboard ( self )

If they move after cutting text, then that text moves to the clipboard_buffer and this buffer gets cleared.

cursorPosition ( self )

If the user hits ctrl-c (cursor position)....

cutText ( self )

Deletes the whole line we're on (cut) and puts it in the clipboard thingy.

deleteCharFromBuffer (
        self,
        y=-1,
        x=-1,
        )

Deletes a character from the buffer.

deleteCharacter ( self )

Deletes the character the cursor is on.

deleteLineFromBuffer ( self,  lineno=-1 )

Deletes a line from the buffer.

drawAll ( self )

Calls all the draw functions to refresh the screen and Then flushes the buffer.

drawBody ( self,  fromline=1 )

Draws the visible portion of the text_buffer into the screen.

drawCommands ( self )

Draws the commands at the bottom of the screen.

drawHeader ( self )

Draws the header line on the top of the screen.

drawLine ( self,  lineno=-1 )

Redraws a line of the text_buffer.

drawStatus ( self,  status='' )

Draws the status bar and text (if there is any).

flush ( self,  s='' )

Sends everything in the output buffer over the socket and then clears the output buffer.

getBufLen ( self )

Returns the length of the text buffer.

getBuffer ( self )

Returns self.text_buffer which is a list of strings. Call this when you're saving the buffer because this is the stuff you want to save.

getClientEOL ( self )

Retrieves the EOL sequence of the client.

getClientHeight ( self )

Retrieves the height of the client (default is 22).

getClientWidth ( self )

Retrieves the width of the client (default is 72).

getClipboardContents ( self )

Returns the clipboard contents as an array of strings.

getFilename ( self )

Returns the filename.

getLine ( self,  lineno=-1 )

Returns the line at that index in the buffer and if no index is specified, it returns the line the cursor is on.

getLineNo ( self )

Returns the current line number in relation to the text_buffer. So the first line is 0 and the last line is len(text_buffer) - 1.

getLineWidth ( self,  lineno=-1 )

Returns the width of the line at the given index in the buffer. If no index is specified, it returns the width of the line the cursor is currently on.

initialize (
        self,
        filename="",
        text="",
        )

Initializes the processors, sets us into CxC mode, and loads the file (if any). Then it draws the screen.

Parameters

filename

(string) the name of the file being edited

text

(string) the initial text in the editing buffer

insertCR ( self )

Inserts a carriage return.

insertCharacters ( self,  data )

Retrieve the current line, insert the data, and set it in the buffer. Then redraw the important part of the screen.

insertLineIntoBuffer (
        self,
        data,
        lineno=-1,
        )

Inserts data into the buffer.

markChanged ( self,  status )

Sets whether this buffer has been changed or not.

moveCursor (
        self,
        y=-1,
        x=-1,
        )

Moves the cursor to the location so that it can print material there.

pageDown ( self,  lineno=-1 )

If the user hits ctrl-v (page down)....

pageUp ( self,  lineno=-1 )

If the user hits ctrl-y (page up)....

processInput ( self,  what )

Invoked by the player's mind to process each incoming character.

prompt ( self )

Invoked by the player's mind after each input line is processed. We don't do anything here because we don't require a prompt to be printed to the screen.

refresh ( self )

Refreshes the entire screen (in case something got garbled?). As a slight side effect, it also checks to make sure we're in character mode. The reason for this is due to refresh being the function that gets called on Naws events which could happen if the player comes back from linkdeath.

setBuffer (
        self,
        filename,
        text,
        )

Sets the text_buffer and the filename.

setLine (
        self,
        data,
        lineno=-1,
        )

Replaces a line in the buffer with a given line. If no index is specified, it replaces the line the cursor is on.

setMethodOnExit (
        self,
        methodToInvokeOnExit,
        optionalParam=None,
        )

Sets a method to be invoked when this editor exits normally. The method invoked upon normal exit and will be passed a string containing the contents of the input buffer and, if provided, the optional parameter.

switchHelpMode ( self,  mode=constants.FALSE )

Switches us in and out of help mode. Help is mostly just another text buffer, so we just swap them out.

# FIXME - this is not yet implemented.

uncutText ( self )

Takes the material in the clipboard buffer and tosses it into the document.

write ( self,  output )

Adds output to the output buffer for sending to the client.