Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
mozIXMLTermShell Interface Reference

import "mozIXMLTermShell.idl";

Inheritance diagram for mozIXMLTermShell:
Inheritance graph
[legend]
Collaboration diagram for mozIXMLTermShell:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void init (in nsIDOMWindowInternal aContentWin, in wstring URL, in wstring args)
 Initializes XMLterm in specified window.
void close (in wstring aCookie)
 Closes XMLterm, freeing resources.
void poll ()
 Polls for readable data from XMLterm.
void resize ()
 Resizes XMLterm to match a resized window.
void sendText (in wstring aString, in wstring aCookie)
 Writes string to terminal as if the user had typed it (command input)
void setHistory (in long aHistory, in wstring aCookie)
 Sets command history buffer count.
void setPrompt (in wstring aPrompt, in wstring aCookie)
 Sets command prompt.
boolean exportHTML (in wstring aFilename, in long permissions, in wstring style, in unsigned long refreshSeconds, in boolean forceRefresh, in wstring aCookie)
 Exports HTML to file, with META REFRESH, if refreshSeconds is non-zero.
void ignoreKeyPress (in boolean aIgnore, in wstring aCookie)
 Ignore key press events (workaround for form input being transmitted to xmlterm)
void exit ()
 Exit browser, closing all windows (not yet implemented)

Public Attributes

readonly attribute long currentEntryNumber

Detailed Description

Definition at line 59 of file mozIXMLTermShell.idl.


Member Function Documentation

void mozIXMLTermShell::close ( in wstring  aCookie)

Closes XMLterm, freeing resources.

Parameters:
aCookiedocument.cookie string for authentication

Exit browser, closing all windows (not yet implemented)

boolean mozIXMLTermShell::exportHTML ( in wstring  aFilename,
in long  permissions,
in wstring  style,
in unsigned long  refreshSeconds,
in boolean  forceRefresh,
in wstring  aCookie 
)

Exports HTML to file, with META REFRESH, if refreshSeconds is non-zero.

Nothing is done if display has not changed since last export, unless forceExport is true. Returns true if export actually takes place. If filename is a null string, HTML is written to STDERR.

void mozIXMLTermShell::ignoreKeyPress ( in boolean  aIgnore,
in wstring  aCookie 
)

Ignore key press events (workaround for form input being transmitted to xmlterm)

Parameters:
aIgnoreignore flag (true/false)
aCookiedocument.cookie string for authentication
void mozIXMLTermShell::init ( in nsIDOMWindowInternal  aContentWin,
in wstring  URL,
in wstring  args 
)

Initializes XMLterm in specified window.

Parameters:
contentWincontent window object
URLURL of document to be loaded in the window (set to null string if document is already loaded in window)
argsargument string to be passed to XMLterm (at the moment this just contains any initial input data)

Polls for readable data from XMLterm.

Resizes XMLterm to match a resized window.

void mozIXMLTermShell::sendText ( in wstring  aString,
in wstring  aCookie 
)

Writes string to terminal as if the user had typed it (command input)

Parameters:
bufstring to be transmitted to terminal
aCookiedocument.cookie string for authentication
void mozIXMLTermShell::setHistory ( in long  aHistory,
in wstring  aCookie 
)

Sets command history buffer count.

Parameters:
aHistoryhistory buffer count
aCookiedocument.cookie string for authentication
void mozIXMLTermShell::setPrompt ( in wstring  aPrompt,
in wstring  aCookie 
)

Sets command prompt.

Parameters:
aPromptcommand prompt string (HTML)
aCookiedocument.cookie string for authentication

Member Data Documentation

Definition at line 61 of file mozIXMLTermShell.idl.


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