Back to index

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

import "mozIXMLTerminal.idl";

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

List of all members.

Public Member Functions

void init (in nsIDocShell aDocShell, in mozIXMLTermShell aXMLTermShell, in wstring aURL, in wstring args)
 Initializes XMLterm in specified web shell.
void finalize ()
 Finalizes (closes) XMLterm.
void poll ()
 Polls for readable data from XMLterm.
void sendTextAux (in wstring aString)
 Writes string to terminal as if the user had typed it (without authenitcation)
void sendText (in wstring aString, in wstring aCookie)
 Writes string to terminal as if the user had typed it (command input)
void paste ()
 Paste data from clipboard into XMLterm at current input line cursor location.
boolean matchesCookie (in wstring aCookie)
 Checks if supplied cookie is valid for XMLTerm.
void resize ()
 Resizes XMLterm to match a resized window.
boolean exportHTML (in wstring aFilename, in long permissions, in wstring style, in unsigned long refreshSeconds, in boolean forceRefresh)
 Exports HTML to file, with META REFRESH, if refreshSeconds is non-zero.
void showCaret ()
 Shows the caret and make it editable.
void screenSize (out long rows, out long cols, out long xPixels, out long yPixels)
 Returns current screen size in rows/cols and in pixels.

Public Attributes

readonly attribute long currentEntryNumber
 Current entry (command) number.
attribute long history
 History buffer count.
attribute wstring prompt
 Prompt string.
attribute boolean keyIgnore
 Ignore key press flag.
readonly attribute nsIDOMDocument document
 Document associated with XMLterm.
readonly attribute nsIDocShell docShell
 Web shell associated with XMLterm.
readonly attribute nsIPresShell presShell
 Presentation shell associated with XMLterm.
readonly attribute nsIDOMDocument DOMDocument
 DOM document associated with XMLterm.
readonly attribute
nsISelectionController 
selectionController
 Selection controller associated with XMLterm.
readonly attribute boolean screenMode
 Flag denoting whether terminal is in full screen mode.

Detailed Description

Definition at line 61 of file mozIXMLTerminal.idl.


Member Function Documentation

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

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.

Finalizes (closes) XMLterm.

void mozIXMLTerminal::init ( in nsIDocShell  aDocShell,
in mozIXMLTermShell  aXMLTermShell,
in wstring  aURL,
in wstring  args 
)

Initializes XMLterm in specified web shell.

Parameters:
aDocShellweb shell in which to embed XMLterm
aXMLTermShellscriptable wrapper shell for XMLterm
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)

Checks if supplied cookie is valid for XMLTerm.

Parameters:
aCookiesupplied cookie string
Returns:
PR_TRUE if supplied cookie matches XMLTerm cookie

Paste data from clipboard into XMLterm at current input line cursor location.

Polls for readable data from XMLterm.

Resizes XMLterm to match a resized window.

void mozIXMLTerminal::screenSize ( out long  rows,
out long  cols,
out long  xPixels,
out long  yPixels 
)

Returns current screen size in rows/cols and in pixels.

Parameters:
(output)rows
(output)cols
(output)xPixels
(output)yPixels
void mozIXMLTerminal::sendText ( in wstring  aString,
in wstring  aCookie 
)

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

Parameters:
aStringstring to be transmitted to terminal
aCookiedocument.cookie string for authentication
void mozIXMLTerminal::sendTextAux ( in wstring  aString)

Writes string to terminal as if the user had typed it (without authenitcation)

Parameters:
aStringstring to be transmitted to terminal

Shows the caret and make it editable.


Member Data Documentation

Current entry (command) number.

Definition at line 86 of file mozIXMLTerminal.idl.

Web shell associated with XMLterm.

Definition at line 121 of file mozIXMLTerminal.idl.

Document associated with XMLterm.

Definition at line 117 of file mozIXMLTerminal.idl.

DOM document associated with XMLterm.

Definition at line 129 of file mozIXMLTerminal.idl.

History buffer count.

Definition at line 90 of file mozIXMLTerminal.idl.

Ignore key press flag.

Definition at line 98 of file mozIXMLTerminal.idl.

Presentation shell associated with XMLterm.

Definition at line 125 of file mozIXMLTerminal.idl.

Prompt string.

Definition at line 94 of file mozIXMLTerminal.idl.

Flag denoting whether terminal is in full screen mode.

Parameters:
aFlag(output) screen mode flag

Definition at line 138 of file mozIXMLTerminal.idl.

Selection controller associated with XMLterm.

Definition at line 133 of file mozIXMLTerminal.idl.


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