Mozilla

Test Plan for nsIWebNavigation interface

The nsIWebNavigation interface has methods to navigate across urls. In order to test the nsIWebNavigation interface, you should have at least one url loaded in your session history. See nsIWebNavigation.idl for more information.

To access the nsIWebnavigation object, use a Query Interface on a web browser object. See nsIWebNavigation.idl for more info:

   nsCOMPtr theWebBrowser;
   nsCOMPtr theWebNav; // nsIWebNavigation object

   theWebBrowser = do_CreateInstance(NS_WEBBROWSER_CONTRACTID, &rv);
   theWebNav = do_QueryInterface(theWebBrowser, &rv);

    methods:
    canGoBack attribute
    canGoForward attribute
    goBack()
    goForward()
    gotoIndex()
    loadURI()
    reload()
    stop()
    document attribute
    currentURI attribute
    sessionHistory attribute
 

canGoBack attribute:

Introduction:
This attribute is used to determine if we can navigate back to a previous url (i.e. use an enabled back button). It is a readonly attribute. The GetCanGoBack() method accepts the boolean canGoBack parameter:

How to use:

   // use web navigation object from above (theWebNav)
   PRBool canGoBack = PR_FALSE;
   rv = theWebNav->GetCanGoBack(&canGoBack);

   // check rv and canGoBack values using local methods

Note: canGoBack will return true if back navigation is enabled, false if it's not.

Back To Top

canGoForward attribute:

Introduction:
This attribute is used to determine if we can navigate forward to another url (i.e. use an enabled forward button). It is a readonly attribute. The GetCanGoForward() method accepts the boolean canGoForward parameter:

How to use:

   // use web navigation object from above (theWebNav)
   PRBool canGoForward = PR_FALSE;
   rv = theWebNav->GetCanGoForward(&canGoForward);

   // check rv and canGoForward values using local methods

Note: canGoForward will return true if back navigation is enabled, false if it's not.

Back To Top

goBack():

Introduction:
This method navigates back to a previous url in the session history. It doesn't accept any parameters:

How to use:

   // use web navigation object from above (theWebNav)
   rv = theWebNav->GoBack();

   // check rv using local methods

Back To Top

goForward():

Introduction:
This method navigates forward to the next url in the session history. It doesn't accept any parameters:

How to use:

   // use web navigation object from above (theWebNav)
   rv = theWebNav->GoForward();

   // check rv using local methods

Back To Top

gotoIndex():

Introduction:
This method navigates to a given index in the session history. It accepts an integer parameter indicating the index entry in the session history:

How to use:

   // use web navigation object from above (theWebNav)
   PRInt32 theIndex = 0;

   rv = theWebNav->GotoIndex(theIndex);

   // check rv and theIndex using local methods

Back To Top

loadURI():

Introduction:
This method navigates to a given uri. It accepts two parameters: a uri string and a load flag. Legal flags for loadURI will be tested for basic functionality. It would be a good idea to create a url table with several url & flag entries.

How to use:

   // use web navigation object from above (theWebNav)

   rv = theWebNav->LoadURI(NS_ConvertASCIItoUCS2("http://www.netscape.com/").get(), 
						LOAD_FLAGS_NONE);
   // check rv and theIndex using local methods

Back To Top

reload():

Introduction:
This method reloads the current uri. It accepts one parameter: a load flag. Legal flags for reload() will be tested for basic functionality.

How to use:

   // use web navigation object from above (theWebNav)

   rv = theWebNav->Reload(LOAD_FLAGS_NONE);

   // check rv and theIndex using local methods

Back To Top

stop():

Introduction:
This method prevents a url from loading. It doesn't accept any parameters:

How to use:

   // use web navigation object from above (theWebNav)
   theWebNav->LoadURI(NS_ConvertASCIItoUCS2(theUrl).get(), 
						nsIWebNavigation::LOAD_FLAGS_NONE);
   rv = theWebNav->Stop();
   // check rv using local methods

Back To Top

document attribute:

Introduction:
This readonly attributes accesses an object of type nsIDOMDocument. You should then be able to use methods of this interface:

How to use:

   // use web navigation object from above (theWebNav)
   nsCOMPtr theDocument;
   nsCOMPtr theDocType;
   
   rv = theWebNav->GetDocument(getter_AddRefs(theDocument));
   // check rv using local methods

   // now, access a method of nsIDOMDocument (to obtain the document type):
   rv = theDocument->GetDoctype(getter_AddRefs(theDocType));

Back To Top

currentURI attribute:

Introduction:
This readonly attributes accesses an object of type nsIURI. You should then be able to use methods of this interface:

How to use:

   // use web navigation object from above (theWebNav)
   nsCOMPtr theUri;

   rv = theWebNav->GetCurrentURI(getter_AddRefs(theUri));
   // check rv using local methods

   // now, access a method of nsIURI (to obtain the uri):
   char *uriSpec;
   rv = theUri->GetSpec(&uriSpec);

Back To Top

sessionHistory attribute:

Introduction:
This readonly attributes accesses an object of type nsISHistory. You should then be able to use methods of this interface:

How to use:

   // use web navigation object from above (theWebNav)
   PRInt32 numOfElements;

   nsCOMPtr theSessionHistory;
   rv = theWebNav->GetSessionHistory(getter_AddRefs(theSessionHistory));
   // check rv using local methods

   // now, access a method of nsIURI (to obtain the uri count in session history):
   rv = theSessionHistory->GetCount(&numOfElements);

Back To Top

Revision History:

Date                        Changed By              Comments

07/17/01                                                   Test Plan written by David Epstein.