Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | Static Protected Attributes
mozXMLTermShell Class Reference

#include <mozXMLTermShell.h>

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

List of all members.

Public Member Functions

 mozXMLTermShell ()
virtual ~mozXMLTermShell ()
NS_IMETHOD Finalize (void)
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)

Static Public Member Functions

NS_DECL_ISUPPORTS static
NS_DECL_MOZIXMLTERMSHELL
NS_METHOD 
Create (nsISupports *aOuter, REFNSIID aIID, void **aResult)
static NS_METHOD RegisterProc (nsIComponentManager *aCompMgr, nsIFile *aPath, const char *registryLocation, const char *componentType, const nsModuleComponentInfo *info)
static NS_METHOD UnregisterProc (nsIComponentManager *aCompMgr, nsIFile *aPath, const char *registryLocation, const nsModuleComponentInfo *info)

Public Attributes

readonly attribute long currentEntryNumber

Protected Attributes

PRBool mInitialized
 object initialization flag
nsIDOMWindowInternalmContentWindow
 non-owning reference to content window for XMLterm
nsIDocShellmContentAreaDocShell
 non-owning reference (??) to doc shell for content window
nsCOMPtr< mozIXMLTerminalmXMLTerminal
 owning reference to XMLTerminal object created by us

Static Protected Attributes

static PRBool mLoggingInitialized

Detailed Description

Definition at line 55 of file mozXMLTermShell.h.


Constructor & Destructor Documentation

Definition at line 138 of file mozXMLTermShell.cpp.

{
  Finalize();
}

Here is the call graph for this function:


Member Function Documentation

void mozIXMLTermShell::close ( in wstring  aCookie) [inherited]

Closes XMLterm, freeing resources.

Parameters:
aCookiedocument.cookie string for authentication
NS_DECL_ISUPPORTS static NS_DECL_MOZIXMLTERMSHELL NS_METHOD mozXMLTermShell::Create ( nsISupports *  aOuter,
REFNSIID  aIID,
void **  aResult 
) [static]
void mozIXMLTermShell::exit ( ) [inherited]

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 
) [inherited]

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.

Definition at line 322 of file mozXMLTermShell.cpp.

{
  if (!mInitialized)
    return NS_OK;

  XMLT_LOG(mozXMLTermShell::Finalize,10,("\n"));

  mInitialized = PR_FALSE;

  if (mXMLTerminal) {
    // Finalize and release reference to XMLTerm object owned by us
    mXMLTerminal->Finalize();
    mXMLTerminal = nsnull;
  }

  mContentAreaDocShell = nsnull;
  mContentWindow =       nsnull;

  XMLT_LOG(mozXMLTermShell::Finalize,12,("END\n"));

  return NS_OK;
}

Here is the caller graph for this function:

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

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 
) [inherited]

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)
void mozIXMLTermShell::poll ( ) [inherited]

Polls for readable data from XMLterm.

NS_METHOD mozXMLTermShell::RegisterProc ( nsIComponentManager aCompMgr,
nsIFile aPath,
const char *  registryLocation,
const char *  componentType,
const nsModuleComponentInfo info 
) [static]

Definition at line 108 of file mozXMLTermShell.cpp.

{
  // Component specific actions at registration time
  PR_LogPrint("mozXMLTermShell::RegisterProc: registered mozXMLTermShell\n");
  return NS_OK;
}
void mozIXMLTermShell::resize ( ) [inherited]

Resizes XMLterm to match a resized window.

void mozIXMLTermShell::sendText ( in wstring  aString,
in wstring  aCookie 
) [inherited]

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 
) [inherited]

Sets command history buffer count.

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

Sets command prompt.

Parameters:
aPromptcommand prompt string (HTML)
aCookiedocument.cookie string for authentication
NS_METHOD mozXMLTermShell::UnregisterProc ( nsIComponentManager aCompMgr,
nsIFile aPath,
const char *  registryLocation,
const nsModuleComponentInfo info 
) [static]

Definition at line 120 of file mozXMLTermShell.cpp.

{
  // Component specific actions at unregistration time
  return NS_OK;  // Return value is not used
}

Member Data Documentation

Definition at line 61 of file mozIXMLTermShell.idl.

non-owning reference (??) to doc shell for content window

Definition at line 93 of file mozXMLTermShell.h.

non-owning reference to content window for XMLterm

Definition at line 90 of file mozXMLTermShell.h.

object initialization flag

Definition at line 87 of file mozXMLTermShell.h.

Definition at line 98 of file mozXMLTermShell.h.

owning reference to XMLTerminal object created by us

Definition at line 96 of file mozXMLTermShell.h.


The documentation for this class was generated from the following files: