Tiny Toolbar - Software Development Kit

Tiny Toolbar SDK. Main events.

Events are sent to plugin via Event functoin.
The following applies for all events mentioned below:

PLUGIN_DATA::sFrom = tag name of plugin that sent the command, or "_MAIN" if event sent by main program.

PLUGIN_DATA::sTo = your plugin tag name, or mask that match to your plugin tag

PLUGIN_DATA::hBrowser = browser handle if event sent by main program. In other cases this variable is undefined.

sCommand "BrowserDestroyed"

Param1 reserved

Param2 reserved

Param3 reserved

Param4 reserved

Event is called before browser window is closed

sCommand "GetIDsOfNames"

Param1.nInt [in] number of requested elements

Param2.pChar [in] list of names separated by zero byte. Last element in list is ended with two zero bytes.

Param3.pVoid [out] points to array of DISPID elements.

Param4 reserved

see IDispatch::GetIDsOfNames for more information.

sCommand "Invoke"

Param1.InvokeVar [in/out] points to INVOKE_PARAMS structure

Param2.pVoid reference to IWebBrowser2 interface

Param3 reserved

Param4 reserved

see IDispatch::Invoke for more information

sCommand "IsExtendedNotifications"

Param1.nInt [out] set it to TRUE if you want to receive extended notifications like mouse clicks on HTML document etc.

Param2 reserved

Param3 reserved

Param4 reserved

see HTMLDocumentEvents2 for more info.

sCommand "EnableModeless"

Param1.nInt [in] BOOL fEnable

Param2 reserved

Param3 reserved

Param4.nInt [out] return value

see IDocHostUIHandler::EnableModeless for more info.

sCommand "FilterDataObject"

Param1.pVoid IDataObject *pDO

Param2.pVoid IDataObject **ppDORet

Param3 reserved

Param4.nInt [out] return value

see IDocHostUIHandler::FilterDataObject for more info.

sCommand "GetDropTarget"

Param1.pVoid IDropTarget *pDropTarget

Param2.pVoid IDropTarget **ppDropTarget

Param3 reserved

Param4.nInt [out] return value

see IDocHostUIHandler::GetDropTarget for more info.

sCommand "GetHostInfo"

Param1.nInt [in/out] DOCHOSTUIINFO *pInfo

Param2 reserved

Param3 reserved

Param4.nInt [out] return value

see IDocHostUIHandler::GetHostInfo for more info.

sCommand "HideUI"

Param1 reserved

Param2 reserved

Param3 reserved

Param4.nInt [out] return value

see IDocHostUIHandler::HideUI for more info.

sCommand "OnDocWindowActivate"

Param1.nInt [in] BOOL fActivate

Param2 reserved

Param3 reserved

Param4.nInt [out] return value

see IDocHostUIHandler::OnDocWindowActivate for more info.

sCommand "OnFrameWindowActivate"

Param1.nInt [in] BOOL fActivate

Param2 reserved

Param3 reserved

Param4.nInt [out] return value

see IDocHostUIHandler::OnFrameWindowActivate for more info.

sCommand "TranslateAccelerator"

Param1.dwDword DWORD dwTranslate

Param2.pVoid OLECHAR *pchURLIn

Param3.pVoid OLECHAR **ppchURLOut

Param4.nInt [out] return value

see IDocHostUIHandler::TranslateAccelerator for more info.

sCommand "Ole_QueryStatus"

Param1.pVoid [in/out]address of QUERYSTATUS_PARAMS structure

Param2.nInt sizeof(QUERYSTATUS_PARAMS)

Param3 reserved

Param4.nInt [out] return value

see IOleCommandTarget::QueryStatus for more info.

sCommand "Ole_Exec"

Param1.pVoid [in/out] sddress of OLEEXEC_PARAMS structure

Param2.nInt sizeof(OLEEXEC_PARAMS)

Param3 reserved

Param4.nInt [out] return value

see IDocHostUIHandler::Exec for more info.

sCommand "wnd_Menu"

Param1.hMenu [in] menu handle. You can add or delete menu items.

Param2.hWnd [in] toolbar window handle

Param3.pVoid IHTMLElement *iRightClickedElement - HTML element user clicked on

Param4.hWnd browser window handle

this event is called when user right clicked within browser window.

sCommand "wnd_MenuCommand"

Param1.nInt [in] selected menu item ID

Param2.hWnd toolbar window handle

Param3.pVoid IHTMLElement *iRightClickedElement - HTML element user clicked on

Param4.hWnd browser window handle

this event is called when user selected menu item

sCommand "wnd_MenuInit"

Param1.hMenu menu handle

Param2.hWnd toolbar window handle

Param3.pVoid IHTMLElement *iRightClickedElement - HTML element user clicked on

Param4.hWnd browser window handle

this event is called when WM_INITMENUPOPUP window message is received. You can enable/disable/etc menu items here.

sCommand "wnd_Command"

Param1.hWnd [in] toolbar window handle

Param2.dwDword [in] wParam

Param3.dwDword [in] lParam

Param4 reserved

this event is sent when unknown toolbar command is received via WM_COMMAND message

sCommand "OnTimer"

Param1.hWnd toolbar window handle

Param2 reserved

Param3 reserved

Param4 reserved

this is called periodically by timer set by "SetTimer" command

sCommand "Subclass_Msg"

Param1.hWnd [in] browser window handle
[out] return value of window callback function

Param2.dwDword [in] uMessage

Param3.dwDword [in] wParam

Param4.dwDword [in] lParam

this is called on every window message received by subclassed browser window callback function. You can subclass browser window using "SubClassBrowserWND" command

sCommand "OnFrame"

Param1.pVoid IDispatch *pDocument

Param2.pChar [in] URL of a document

Param3.pVoid IWebBrowser2 *pWebBrowser

Param4 reserved

this callback event is used in conjunction with "Enum_Frames" command

sCommand "OnHtmlText"

Param1.pChar text source code of HTML document

Param2.nInt size of text including zero at the end

Param3.pChar URL of the document

Param4 reserved

this callback event is used in conjunction with "Enum_HTML" command

sCommand "wnd_Init"

Param1.hWnd [in] toolbar window handle
[out] toolbar child window handle

Param2.nShort[0] [in] Toolbar height (TB_WINDOW_HEIGHT). You may not create larger or smaller toolbar buttons.

Param2.nShort[1] [in] reserved

Param2.nInt [out] toolbar child window width in pixels.

Param3 reserved

Param4 reserved

This event is send after toolbar is created. You can create toolbar child window here. Child window height must be always equal to PLUGIN_DATA::Param2.nShort[0]. Window width may be variable.
Important: you may not resize toolbar window and/or child items. You must execute update_wnd command instead