OEAPI::IOEAPIObjEvents Interface Reference

List of all members.

Public Member Functions

HRESULT OnCurrentMessageChanged ([in] LONG msgId)
HRESULT OnDatabaseChange ([in] OE_DATABASE_TRANSACTION dt,[in] LONG folderId,[in] LONG objId,[in] LONG newParentId)
HRESULT OnFolderSelectionChanged ([in] LONG folderId)
HRESULT OnMenuItemClicked ([in] LONG menuIndex,[in] LONG menuItemId)
HRESULT OnMessageDownloadFinished ()
HRESULT OnMessageDownloadStarted ()
HRESULT OnMessageSelectionChanged ()
HRESULT OnMsgWndClosed ([in] LONG msgWndId,[in] BOOL isMainWindow)
HRESULT OnMsgWndMenuItemClicked ([in] LONG menuIndex,[in] LONG menuItemId,[in] LONG msgWndId)
HRESULT OnNewMessageInOutbox ([in] LONG msgId)
HRESULT OnNewMsgWnd ([in] LONG msgWndId)
HRESULT OnSendButtonMsgWndClicked ([in] LONG msgWndId)
HRESULT OnToolbarButtonClicked ([in] LONG toolbarId,[in] LONG buttonId)
HRESULT OnToolbarButtonMsgWndClicked ([in] LONG toolbarId,[in] LONG buttonId,[in] LONG msgWndId)

Member Function Documentation

HRESULT OEAPI::IOEAPIObjEvents::OnCurrentMessageChanged ( [in] LONG  msgId  ) 

Only in Enterprise Edition.
Event triggered when the current message (that is displayed in OE's Preview Pane) changes.

HRESULT OEAPI::IOEAPIObjEvents::OnDatabaseChange ( [in] OE_DATABASE_TRANSACTION  dt,
[in] LONG  folderId,
[in] LONG  objId,
[in] LONG  newParentId 
)

Only in Enterprise Edition.
Event triggered when a message or folder is inserted or deleted, a message's read/unread state changes, and when a folder is moved.
Folder events: folderId contains the inserted/deleted folder's id, objId contains parent folder's id and newParentId is -1.
Message events: folderId contains the message folder's id, objId contains the message's id and newParentId is -1.
Move folder events: objId contains the original parent folder's id, newParentId contains the destination folder's id.

HRESULT OEAPI::IOEAPIObjEvents::OnFolderSelectionChanged ( [in] LONG  folderId  ) 

Only in Enterprise Edition.
Event triggered when the selected folder changes.
NOTE: Interaction with UI inside this events may cause an inaccurate behavior of the OnMessageSelectionChanged event.

HRESULT OEAPI::IOEAPIObjEvents::OnMenuItemClicked ( [in] LONG  menuIndex,
[in] LONG  menuItemId 
)

Event triggered when a menu item is clicked.

HRESULT OEAPI::IOEAPIObjEvents::OnMessageDownloadFinished (  ) 

Only in Enterprise Edition.
Event triggered when OE finishes downloading and uploading messages from the server.

HRESULT OEAPI::IOEAPIObjEvents::OnMessageDownloadStarted (  ) 

Only in Enterprise Edition.
Event triggered when OE starts downloading and uploading messages from the server.

HRESULT OEAPI::IOEAPIObjEvents::OnMessageSelectionChanged (  ) 

Only in Enterprise Edition.
Event triggered when the message selection changes in the current folder.
NOTE: Interaction with UI inside OnFolderSelectionChanged may cause an inaccurate behavior of this event.

HRESULT OEAPI::IOEAPIObjEvents::OnMsgWndClosed ( [in] LONG  msgWndId,
[in] BOOL  isMainWindow 
)

Only in Enterprise Edition.
Event triggered when a message window is closed.
If the message window is of style OE_MSG_DETAIL_WND or OE_MSG_SEND_WND, the
window is not destroyed until this event is processed.
If isMainWindow is TRUE the object doesn't exist when the event is triggered.
if isMainWindow is FALSE the object will leave until all clients return.

HRESULT OEAPI::IOEAPIObjEvents::OnMsgWndMenuItemClicked ( [in] LONG  menuIndex,
[in] LONG  menuItemId,
[in] LONG  msgWndId 
)

Event triggered when a menu item is pressed on a message window.

HRESULT OEAPI::IOEAPIObjEvents::OnNewMessageInOutbox ( [in] LONG  msgId  ) 

Only in Enterprise Edition.
Event triggered when a message is created in Outbox folder and OE is prepared to send it.
After this function returns, the message is sent.
This function is useful to implement an Outbox filter because it lets you change messages before they are sent.

HRESULT OEAPI::IOEAPIObjEvents::OnNewMsgWnd ( [in] LONG  msgWndId  ) 

Only in Enterprise Edition.
Event triggered when a message window is created.
It is also triggered when the current message changes, because the window where the current message is displayed can be changed too (only the body).

HRESULT OEAPI::IOEAPIObjEvents::OnSendButtonMsgWndClicked ( [in] LONG  msgWndId  ) 

Only in Enterprise Edition.
Event triggered when the 'Send' button is clicked in a message window.

HRESULT OEAPI::IOEAPIObjEvents::OnToolbarButtonClicked ( [in] LONG  toolbarId,
[in] LONG  buttonId 
)

Event triggered when a toolbar button is clicked.

HRESULT OEAPI::IOEAPIObjEvents::OnToolbarButtonMsgWndClicked ( [in] LONG  toolbarId,
[in] LONG  buttonId,
[in] LONG  msgWndId 
)

Only in Enterprise Edition.
Event triggered when a button of a toolbar is clicked in a message window.
Only useful when the toolbar is defined in a msg window



Developed by Nektra