Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
mozILineTerm Interface Reference

import "mozILineTerm.idl";

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

List of all members.

Public Member Functions

void Open (in wstring command, in wstring initInput, in wstring promptRegexp, in PRInt32 options, in PRInt32 processType, in nsIDOMDocument domDoc)
 Opens LineTerm, a line-oriented terminal interface (without graphics)
void Close (in wstring aCookie)
 Closes LineTerm.
void Write (in wstring buf, in wstring aCookie)
 Writes string to LineTerm as if the user had typed it (command input)
wstring Read (out PRInt32 opcodes, out PRInt32 opvals, out PRInt32 buf_row, out PRInt32 buf_col, in wstring aCookie)
 Read output data string and parameters from LineTerm (command output)

Detailed Description

Definition at line 59 of file mozILineTerm.idl.


Member Function Documentation

void mozILineTerm::Close ( in wstring  aCookie)

Closes LineTerm.

Parameters:
aCookiedocument.cookie string for authentication
void mozILineTerm::Open ( in wstring  command,
in wstring  initInput,
in wstring  promptRegexp,
in PRInt32  options,
in PRInt32  processType,
in nsIDOMDocument  domDoc 
)

Opens LineTerm, a line-oriented terminal interface (without graphics)

Parameters:
commandname of command to be executed; usually a shell, e.g., "/bin/sh"; if set to null string, the command name is determined from the environment variable SHELL (ASCII only)
initInputinitial input string to be transmitted to terminal; set to null string, if none. (ASCII only)
promptRegexpcommand prompt regular expression (for future use); at the moment, any string terminated by one of the characters "#$%>?", followed by a space, is assumed to be a prompt
optionsLineTerm option bits (usually 0; see lineterm.h)
processTypecommand shell type; if set to -1, type is determined from the command name
domDocDOM document object associated with the LineTerm (document.cookie will be defined for this document on return)
wstring mozILineTerm::Read ( out PRInt32  opcodes,
out PRInt32  opvals,
out PRInt32  buf_row,
out PRInt32  buf_col,
in wstring  aCookie 
)

Read output data string and parameters from LineTerm (command output)

Parameters:
opcodes(output) output data descriptor bits (see lineterm.h)
opvals(output) output data value(s)
buf_row(output) row number (>=-1) (-1 denotes line mode and 0 represents bottom row)
buf_col(output) column number (>=0)
aCookiedocument.cookie string for authentication
Returns:
output data string from LineTerm
void mozILineTerm::Write ( in wstring  buf,
in wstring  aCookie 
)

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

Parameters:
bufstring to be transmitted to LineTerm
aCookiedocument.cookie string for authentication

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