WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsIMsgDBView

IID:8b3de23c-09c8-484c-9269-d35cf7865b2a
Inherits From:nsISupports

This interface is implemented by the following components:

Properties

readonly nsMsgViewIndex currentlyDisplayedMessage

readonly nsIMsgDatabase db

readonly nsIMsgDBHdr hdrForFirstSelectedMessage

readonly nsMsgKey keyForFirstSelectedMessage

readonly nsIMsgFolder msgFolder

readonly nsMsgViewIndex msgToSelectAfterDelete

readonly PRUint32 numSelected

readonly PRBool removeRowOnMoveOrDelete

nsIMsgSearchSession searchSession

readonly nsMsgViewSortOrderValue sortOrder

nsMsgViewSortTypeValue sortType

readonly PRBool supportsThreading

PRBool suppressCommandUpdating

PRBool suppressMsgDisplay

readonly ACString URIForFirstSelectedMessage

readonly PRBool usingLines

nsMsgViewFlagsTypeValue viewFlags

nsIMsgFolder viewFolder

readonly nsMsgViewIndex viewIndexForFirstSelectedMsg

readonly nsMsgViewTypeValue viewType

Methods

void addColumnHandler ( AString column , nsIMsgCustomColumnHandler handler ) nsIMsgDBView cloneDBView ( nsIMessenger messengerInstance , nsIMsgWindow msgWindow , nsIMsgDBViewCommandUpdater commandUpdater ) void close ( ) void doCommand ( nsMsgViewCommandTypeValue command ) void doCommandWithFolder ( nsMsgViewCommandTypeValue command , nsIMsgFolder destFolder ) void ExpandAndSelectThreadByIndex ( nsMsgViewIndex index , PRBool augment ) nsMsgViewIndex findIndexFromKey ( nsMsgKey msgKey , PRBool expand ) nsIMsgCustomColumnHandler getColumnHandler ( AString column ) void getCommandStatus ( nsMsgViewCommandTypeValue command , out PRBool selectable_p , out nsMsgViewCommandCheckStateValue selected_p ) nsIMsgFolder getFolderForViewIndex ( nsMsgViewIndex index ) void getIndicesForSelection ( out arrayof nsMsgViewIndex indices , out PRUint32 count ) nsMsgKey getKeyAt ( nsMsgViewIndex index ) ACString getURIForViewIndex ( nsMsgViewIndex index ) void getURIsForSelection ( out arrayof char* uris , out PRUint32 count ) void init ( nsIMessenger messengerInstance , nsIMsgWindow msgWindow , nsIMsgDBViewCommandUpdater commandUpdater ) void loadMessageByMsgKey ( nsMsgKey msgKey ) void loadMessageByUrl ( char* url ) void loadMessageByViewIndex ( nsMsgViewIndex index ) PRBool navigateStatus ( nsMsgNavigationTypeValue motion ) void onDeleteCompleted ( PRBool succeeded ) void open ( nsIMsgFolder folder , nsMsgViewSortTypeValue sortType , nsMsgViewSortOrderValue sortOrder , nsMsgViewFlagsTypeValue viewFlags , out PRInt32 count ) void openWithHdrs ( nsISimpleEnumerator headers , nsMsgViewSortTypeValue sortType , nsMsgViewSortOrderValue sortOrder , nsMsgViewFlagsTypeValue viewFlags , out PRInt32 count ) void reloadMessage ( ) void reloadMessageWithAllParts ( ) void removeColumnHandler ( AString column ) void selectFolderMsgByKey ( nsIMsgFolder folder , nsMsgKey key ) void selectMsgByKey ( nsMsgKey key ) void sort ( nsMsgViewSortTypeValue sortType , nsMsgViewSortOrderValue sortOrder ) void viewNavigate ( nsMsgNavigationTypeValue motion , out nsMsgKey resultId , out nsMsgViewIndex resultIndex , out nsMsgViewIndex threadIndex , PRBool wrap )

void addColumnHandler ( AString column , nsIMsgCustomColumnHandler handler )

Arguments:
column
handler

nsIMsgDBView cloneDBView ( nsIMessenger messengerInstance , nsIMsgWindow msgWindow , nsIMsgDBViewCommandUpdater commandUpdater )

Arguments:
messengerInstance
msgWindow
commandUpdater

void close ( )

void doCommand ( nsMsgViewCommandTypeValue command )

Arguments:
command

void doCommandWithFolder ( nsMsgViewCommandTypeValue command , nsIMsgFolder destFolder )

Arguments:
command
destFolder

void ExpandAndSelectThreadByIndex ( nsMsgViewIndex index , PRBool augment )

Arguments:
index
augment

nsMsgViewIndex findIndexFromKey ( nsMsgKey msgKey , PRBool expand )

Arguments:
msgKey
expand

nsIMsgCustomColumnHandler getColumnHandler ( AString column )

Arguments:
column

void getCommandStatus ( nsMsgViewCommandTypeValue command , out PRBool selectable_p , out nsMsgViewCommandCheckStateValue selected_p )

Arguments:
command
selectable_p
selected_p

nsIMsgFolder getFolderForViewIndex ( nsMsgViewIndex index )

Arguments:
index

void getIndicesForSelection ( out arrayof nsMsgViewIndex indices , out PRUint32 count )

Arguments:
indices
count

nsMsgKey getKeyAt ( nsMsgViewIndex index )

Arguments:
index

ACString getURIForViewIndex ( nsMsgViewIndex index )

Arguments:
index

void getURIsForSelection ( out arrayof char* uris , out PRUint32 count )

Arguments:
uris
count

void init ( nsIMessenger messengerInstance , nsIMsgWindow msgWindow , nsIMsgDBViewCommandUpdater commandUpdater )

Arguments:
messengerInstance
msgWindow
commandUpdater

void loadMessageByMsgKey ( nsMsgKey msgKey )

Arguments:
msgKey

void loadMessageByUrl ( char* url )

Arguments:
url

void loadMessageByViewIndex ( nsMsgViewIndex index )

Arguments:
index

PRBool navigateStatus ( nsMsgNavigationTypeValue motion )

Indicates if navigation of the passed motion type is valid.

Arguments:
motion

void onDeleteCompleted ( PRBool succeeded )

Arguments:
succeeded

void open ( nsIMsgFolder folder , nsMsgViewSortTypeValue sortType , nsMsgViewSortOrderValue sortOrder , nsMsgViewFlagsTypeValue viewFlags , out PRInt32 count )

Arguments:
folder
sortType
sortOrder
viewFlags
count

void openWithHdrs ( nsISimpleEnumerator headers , nsMsgViewSortTypeValue sortType , nsMsgViewSortOrderValue sortOrder , nsMsgViewFlagsTypeValue viewFlags , out PRInt32 count )

Arguments:
headers
sortType
sortOrder
viewFlags
count

void reloadMessage ( )

void reloadMessageWithAllParts ( )

void removeColumnHandler ( AString column )

Arguments:
column

void selectFolderMsgByKey ( nsIMsgFolder folder , nsMsgKey key )

Arguments:
folder
key

void selectMsgByKey ( nsMsgKey key )

Arguments:
key

void sort ( nsMsgViewSortTypeValue sortType , nsMsgViewSortOrderValue sortOrder )

Arguments:
sortType
sortOrder

void viewNavigate ( nsMsgNavigationTypeValue motion , out nsMsgKey resultId , out nsMsgViewIndex resultIndex , out nsMsgViewIndex threadIndex , PRBool wrap )

This method will automatically expand the destination thread, if needs be.

Arguments:
motion
resultId
resultIndex
threadIndex
wrap

References

This interface is returned from the following methods:

nsIMsgDBView.cloneDBView

Reference documentation is generated from Mozilla's source.