Tiny Toolbar - Software Development Kit

Tiny Toolbar SDK. Main commands.

Commands are sent via callback routine. Address of this routine passed to plugin via Initialize function.
The following applies for all plugin commands mentioned below:

PLUGIN_DATA::sFrom = your plugin tag name

PLUGIN_DATA::sTo = "_MAIN"

PLUGIN_DATA::hBrowser = browser handle

sCommand "release_plugins"

Param1 reserved

Param2 reserved

Param3 reserved

Param4 reserved

this will release all plugins in current browser process.

sCommand "update_wnd"

Param1.hWnd reservedhandle to child window or NULL to close child window. Plugin window callback function will receive WM_CLOSE and WM_DESTROY messages before window will be closed.

Param2.nInt width of child window in pixels.

Param3 reserved

Param4 reserved

this will update toolbar's child window width.

sCommand "get_browser"

Param1.pVoid IWebBrowser2 interface

Param2.hWnd toolbar window handle

Param3.hWnd HTML document container window handle

Param4 reserved

this receives IWebBrowser2 insterface as well as couple window handles.

sCommand "write_html"

Param1.pChar HTML text

Param2.pChar HTML text

Param3.pChar HTML text

Param4.pChar HTML text

this will create new HTML document (not window!) and output text there. Old HTML document will be erased.

sCommand "get_Busy"

Param1.nInt [out] TRUE if browser is busy

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::get_Busy for more information

sCommand "get_FullScreen"

Param1.nInt [out] TRUE if browser is in full-screen mode

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::get_FullScreen for more information

sCommand "put_FullScreen"

Param1.nInt [in] TRUE to switch browser to full-screen mode, and FALSE otherwise.

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::put_FullScreen for more information

sCommand "GetProperty"

Param1.pChar [in] property name

Param2.pVariant [out] property value

Param3 reserved

Param4 reserved

see IWebBrowser2::GetProperty for more information

sCommand "GoBack"

Param1 reserved

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::GoBack for more information

sCommand "GoForward"

Param1 reserved

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::GoForward for more information

sCommand "GoHome"

Param1 reserved

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::GoHome for more information

sCommand "get_Height"

Param1.nInt [out] browser window height

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::get_Height for more information

sCommand "put_Height"

Param1.nInt [in] browser window height

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::put_Height for more information

sCommand "get_HWND"

Param1.hWnd [out] browser window handle

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::get_HWND for more information

sCommand "put_Left"

Param1.nInt [in] window left coordinate

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::put_Left for more information

sCommand "get_Left"

Param1.nInt [out] window left coordinate

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::get_Left for more information

sCommand "put_Top"

Param1.nInt [in] window top coordinate

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::put_Top for more information

sCommand "get_Top"

Param1.nInt [out] window top coordinate

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::get_Top for more information

sCommand "put_Height"

Param1.nInt [in] window height

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::put_Height for more information

sCommand "get_Height"

Param1.nInt [out] window height

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::get_Height for more information

sCommand "put_Width"

Param1.nInt [in] window width

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::put_Width for more information

sCommand "get_Width"

Param1.nInt [out] window width

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::get_Width for more information

sCommand "get_LocationName"

Param1.pChar [out] points to buffer that receives location name. Size of buffer must be MAX_DATA_LEN.

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::get_LocationName and globals.h for more information.

sCommand "get_LocationURL"

Param1.pChar [out] points to buffer that receives URL. Size of buffer must be MAX_DATA_LEN.

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::get_LocationURL and globals.h for more information.

sCommand "get_MenuBar"

Param1.nInt [out] TRUE if menu bar is visible

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::get_MenuBar for more information

sCommand "put_MenuBar"

Param1.nInt [in] TRUE shows menu bar, FALSE hides it

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::put_MenuBar for more information

sCommand "get_Name"

Param1.pChar [out] points to buffer that receives name. Size of buffer must be MAX_DATA_LEN.

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::get_Name and globals.h for more information.

sCommand "Navigate"

Param1.pChar web address (URL)

Param2.pVariant POST data or NULL for GET requests

Param3.pVariant additinal headers to sent to webserver

Param4.pChar target frame name. Set it to NULL to open document in current window (like tagret="_top" property in A tag)

see IWebBrowser2::Navigate for more information

sCommand "put_Offline"

Param1.nInt [out] offline flag

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::put_Offline for more information

sCommand "get_Offline"

Param1.nInt [in] offline flag

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::get_Offline for more information

sCommand "get_Path"

Param1.pChar [out] points to buffer that receives path. Size of buffer must be MAX_DATA_LEN.

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::get_Path and globals.h for more information.

sCommand "PutProperty"

Param1.pChar property name

Param2.pVariant property value

Param3 reserved

Param4 reserved

see IWebBrowser2::PutProperty for more information

sCommand "Quit"

Param1 reserved

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::Quit for more information

sCommand "get_ReadyState"

Param1.nInt [out] receives browser ready state

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::ReadyState for more information

sCommand "Refresh"

Param1 reserved

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::Refresh for more information

sCommand "get_Resizable"

Param1.nInt [in] TRUE if browser window is resizable

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::get_Resizable for more information

sCommand "put_Resizable"

Param1.nInt [out] TRUE if browser window is resizable

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::put_Resizable for more information

sCommand "ShowBrowserBar"

Param1.pVariant pvaClsid

Param2.pVariant pvarShow

Param3.pVariant pvarSize

Param4 reserved

see IWebBrowser2::ShowBrowserBar for more information

sCommand "get_Silent"

Param1.nInt [out] retrieves a value that indicates whether browser can show dialog boxes

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::get_Silent for more information

sCommand "put_Silent"

Param1.nInt [in] sets a value that indicates whether browser can show dialog boxes

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::put_Silent for more information

sCommand "get_StatusBar"

Param1.nInt [out] retrieves a value that indicates whether browser's status bar is visible

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::get_StatusBar for more information

sCommand "put_StatusBar"

Param1.nInt [in] sets a value that indicates whether browser's status bar is visible

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::put_StatusBar for more information

sCommand "get_StatusText"

Param1.pChar [out] points to buffer that retrieves the text in the status bar. Size of buffer must be MAX_DATA_LEN

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::get_StatusText for more information

sCommand "put_StatusText"

Param1.pChar [in]

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::put_StatusText for more information

sCommand "put_Stop"

Param1

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::Stop for more information

sCommand "get_TheaterMode"

Param1.nInt [out] retrieves a value that indicates whether the browser is in theater mode

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::get_TheaterMode for more information

sCommand "put_TheaterMode"

Param1.nInt [in] sets a value that indicates whether the browser is in theater mode

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::put_TheaterMode for more information

sCommand "get_ToolBar"

Param1.nInt [out] retrieves a value that indicates whether the toolbar is visible

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::get_ToolBar for more information

sCommand "put_ToolBar"

Param1.nInt [in] sets a value that indicates whether the toolbar is visible

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::put_ToolBar for more information

sCommand "get_TopLevelContainer"

Param1.nInt [out] retrieves a value that indicates whether the browser is a top-level container

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::get_TopLevelContainer for more information

sCommand "get_Type"

Param1.pChar [out] points to buffer that retrieves the type name of the contained document object. Size of the buffer must be MAX_DATA_LEN.

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::get_TopLevelContainer for more information

sCommand "get_Visible"

Param1.nInt [out] retrieves a value that indicates whether the browser is visible

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::get_Visible for more information

sCommand "put_Visible"

Param1.nInt [in] sets a value that indicates whether the browser is visible

Param2 reserved

Param3 reserved

Param4 reserved

see IWebBrowser2::put_Visible for more information

sCommand "Enum_HTML"

Param1 reserved

Param2 reserved

Param3 reserved

Param4 reserved

This will enumerate all available frames and send OnHtmlText event for every frame.

sCommand "Enum_Frames"

Param1 reserved

Param2 reserved

Param3 reserved

Param4 reserved

This will enumerate all available frames and send OnFrame event for every frame.

sCommand "ChangeFormItem"

Param1.pChar [in] tag name (INPUT, TEXTAREA, SELECT)

Param2.pChar [in] type to look for (for INPUT tag) or NULL if no tag type comparation is needed.

Param3.pChar [in] variable name to look for

Param4.pChar [in] new tag value

This will sets

sCommand "exec_script"

Param1.pChar script body

Param2.pChar script language. Leave it NULL for default language ("JavaScript")

Param3 reserved

Param4 reserved

This will execute script code in already loaded HTML document.

sCommand "get_html_block"

Param1.pChar [in] tag name

Param2.pChar [out] text buffer

Param3.dwDword [in] text buffer size

Param4.nInt index of HTML block (0 for first block, 1 for second and so on)

this will return the text between specified HTML tags including this tags.

sCommand "set_html_block"

Param1.pChar [in] tag name

Param2.pChar [in] text buffer

Param3.dwDword [in] text buffer size

Param4.nInt index of HTML block (0 for first block, 1 for second and so on)

this will replace the text between HTML tags with new one.

sCommand "append_html_block"

Param1.pChar [in] tag name

Param2.pChar [in] text buffer

Param3.dwDword [in] text buffer size

Param4.nInt index of HTML block (0 for first block, 1 for second and so on)

this will insert HTML text right after closing tag

sCommand "insert_html_block"

Param1.pChar [in] tag name

Param2.pChar [in] text buffer

Param3.dwDword [in] text buffer size

Param4.nInt index of HTML block (0 for first block, 1 for second and so on)

this will insert HTML text before opening HTML tag

sCommand "SubClassBrowserWND"

Param1 reserved

Param2 reserved

Param3 reserved

Param4 reserved

this will subclass browser window. All window messages are sent via "Subclass_Msg" event.

sCommand "SetTimer"

Param1.dwDword non-zero value - sets timer
zero value - kills the timer

Param2 reserved

Param3 reserved

Param4 reserved

this will force program to fire "OnTimer" event every PLUGIN_DATA::Param1.dwDword miliseconds.

sCommand "plugin_info"

sTo [in] plugin tag

hBrowser reserved

Param1.pVoid [out] address of PLUGIN_INFORMATION structure

Param2 reserved

Param3 reserved

Param4 reserved

This will return PLUGIN_INFORMATION structure for plugin

sCommand "is_Installed"

sTo [in] plugin tag

hBrowser reserved

Param1.nInt [out] TRUE if plugin is installed

Param2 reserved

Param3 reserved

Param4 reserved

This will return value that indicates whether plugin is installed or not

sCommand "toolbar_info"

Param1.dwDword [out] version number

Param2.pChar [out] release date and time

Param3 reserved

Param4 reserved

This will return informaion anout toolbar

sCommand "system_info"

Param1.pChar [in] "win_ver" for windows version, or "ie_ver" for Internet Explorer version

Param2.pChar [out] text buffer. Size of this buffer must be at least 128 bytes.

Param3 reserved

Param4 reserved

This will return informaion anout toolbar

sCommand "registry_write"

Param1.pVoid [in] buffer

Param2.dwDword [in] buffer size in bytes

Param3 reserved

Param4 reserved

This will save raw data in registry in HKCU\SOFTWARE\Tiny Toolbar\DATA\PLUGIN_DATA::sFrom. Simple XOR encryption is applied. You should use rijndael plugin for strong data encryption.

sCommand "registry_read"

Param1.pVoid [out] buffer

Param2.dwDword [in] buffer size in bytes

Param3 reserved

Param4 reserved

This will retrieve raw data from registry, prevoiusly saved with "registry_write" command.