Back to index

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

import "nsITypeAheadFind.idl";

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

List of all members.

Public Member Functions

void startNewFind (in nsIDOMWindow aWindow, in boolean aLinksOnly)
 Manually start type ahead find mode.
void cancelFind ()
 Manually cancel type ahead find mode.
void setAutoStart (in nsIDOMWindow aWindow, in boolean aIsAutoStartOn)
 Will find as you type start automatically if the user types with the focus on page content other than a textfield or select? If autostart is off, the startNewFind() method can be used to enact type ahead find, as well as cmd_findTypeLinks or cmd_findTypeText.
boolean getAutoStart (in nsIDOMWindow aWindow)
void findNext (in boolean aReverse, in nsISupportsInterfacePointer aCallerWindowSupports)
 Find next recurrence if typeaheadfind was the last used find, as opposed to regular find.
boolean backOneChar ()
void init (in nsIDocShell aDocShell)
unsigned short find (in AString aSearchString, in boolean aLinksOnly)
unsigned short findNext ()
unsigned short findPrevious ()
void setDocShell (in nsIDocShell aDocShell)

Public Attributes

readonly attribute boolean isActive
 Is type ahead find mode currently on?
readonly attribute AString searchString
attribute boolean focusLinks
attribute boolean caseSensitive
readonly attribute nsIDOMElement foundLink
readonly attribute nsIDOMWindow currentWindow
const unsigned short FIND_FOUND = 0
const unsigned short FIND_NOTFOUND = 1
const unsigned short FIND_WRAPPED = 2

Detailed Description

Definition at line 55 of file nsITypeAheadFind.idl.


Member Function Documentation

Manually cancel type ahead find mode.

unsigned short nsITypeAheadFind::find ( in AString  aSearchString,
in boolean  aLinksOnly 
)
unsigned short nsITypeAheadFind::findNext ( )
void nsITypeAheadFind::findNext ( in boolean  aReverse,
in nsISupportsInterfacePointer  aCallerWindowSupports 
)

Find next recurrence if typeaheadfind was the last used find, as opposed to regular find.

Returns false in nsISupportsPRBool if we don't handle the request.

unsigned short nsITypeAheadFind::findPrevious ( )
void nsITypeAheadFind::setAutoStart ( in nsIDOMWindow  aWindow,
in boolean  aIsAutoStartOn 
)

Will find as you type start automatically if the user types with the focus on page content other than a textfield or select? If autostart is off, the startNewFind() method can be used to enact type ahead find, as well as cmd_findTypeLinks or cmd_findTypeText.

Manually start type ahead find mode.


Member Data Documentation

Definition at line 91 of file nsITypeAheadFind.idl.

Definition at line 94 of file nsITypeAheadFind.idl.

const unsigned short nsITypeAheadFind::FIND_FOUND = 0

Definition at line 101 of file nsITypeAheadFind.idl.

Definition at line 103 of file nsITypeAheadFind.idl.

Definition at line 105 of file nsITypeAheadFind.idl.

Definition at line 90 of file nsITypeAheadFind.idl.

Definition at line 92 of file nsITypeAheadFind.idl.

Is type ahead find mode currently on?

Definition at line 58 of file nsITypeAheadFind.idl.

Definition at line 88 of file nsITypeAheadFind.idl.


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