Back to index

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

import "mozILineTerm.idl";

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

List of all members.

Public Member Functions

void openAux (in wstring command, in wstring initInput, in wstring promptRegexp, in PRInt32 options, in PRInt32 processType, in PRInt32 nRows, in PRInt32 nCols, in PRInt32 xPixels, in PRInt32 yPixels, in nsIDOMDocument domDoc, in nsIObserver anObserver, in nsNativeStringRef aCookie)
 Opens LineTerm, a line-oriented terminal interface (without graphics)
void suspendAux (in boolean suspend)
 Suspend/restores LineTerm operation.
void closeAux ()
 Closes LineTerm.
void closeAllAux ()
 Close all LineTerms, not just this one.
void resizeAux (in long nRows, in long nCols)
 Resizes XMLterm to match a resized window.
void readAux (out long opcodes, out long opvals, out long buf_row, out long buf_col, out wstring retval, out wstring retstyle)
 Read output data and style strings and parameters from LineTerm.
void getCookie (in nsNativeStringRef aCookie)
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)

Public Attributes

attribute long cursorRow
attribute long cursorColumn
attribute boolean echoFlag

Detailed Description

Definition at line 109 of file mozILineTerm.idl.


Member Function Documentation

void mozILineTerm::Close ( in wstring  aCookie) [inherited]

Closes LineTerm.

Parameters:
aCookiedocument.cookie string for authentication

Close all LineTerms, not just this one.

Closes LineTerm.

void mozILineTerm::Open ( in wstring  command,
in wstring  initInput,
in wstring  promptRegexp,
in PRInt32  options,
in PRInt32  processType,
in nsIDOMDocument  domDoc 
) [inherited]

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)
void mozILineTermAux::openAux ( in wstring  command,
in wstring  initInput,
in wstring  promptRegexp,
in PRInt32  options,
in PRInt32  processType,
in PRInt32  nRows,
in PRInt32  nCols,
in PRInt32  xPixels,
in PRInt32  yPixels,
in nsIDOMDocument  domDoc,
in nsIObserver  anObserver,
in nsNativeStringRef  aCookie 
)

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
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
nRowsno. of screen rows
nColsno. of screen columns
xPixelsscreen width in pixels (or 0 if unknown)
yPixelsscreen height in pixels (or 0 if unknown)
domDocDOM document object associated with the LineTerm (document.cookie will be defined for this document on return)
aCookie(output) cookie associated with LineTerm
wstring mozILineTerm::Read ( out PRInt32  opcodes,
out PRInt32  opvals,
out PRInt32  buf_row,
out PRInt32  buf_col,
in wstring  aCookie 
) [inherited]

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 mozILineTermAux::readAux ( out long  opcodes,
out long  opvals,
out long  buf_row,
out long  buf_col,
out wstring  retval,
out wstring  retstyle 
)

Read output data and style strings and parameters from LineTerm.

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)
_retval(output) success code
retstyle(output) output style string
Returns:
output data string from LineTerm
void mozILineTermAux::resizeAux ( in long  nRows,
in long  nCols 
)

Resizes XMLterm to match a resized window.

Parameters:
nRowsnumber of rows
nColsnumber of columns

Suspend/restores LineTerm operation.

Parameters:
aSuspendsuspension state flag
void mozILineTerm::Write ( in wstring  buf,
in wstring  aCookie 
) [inherited]

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

Member Data Documentation

Definition at line 177 of file mozILineTerm.idl.

Definition at line 176 of file mozILineTerm.idl.

Definition at line 178 of file mozILineTerm.idl.


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