|
This function can be invoked by a plugin on the FARR host:
host->callback_set_strvalue(COMMANDNAME,VALUE)
| • | launch, LAUNCHFILENAME_OR_SPECIAL_ALIAS_STRING |
IMPORTANT NOTE: this is the command you will use from your plugin to do all kinds of things like display html, etc. by using the Special/Virtual Alias Strings.
| • | launchmeta, SPECIAL_ALIAS_STRING |
does not perform % variable replacement and only works on launching special virtual alias strings, not files/folders
| • | statusbar, TEXTTOSETONSTATUSBAR |
| • | setsearch, TEXTTOSETINSEARCHEDIT |
| • | setsearchnogo, TEXTTOSETINSEARCHEDIT |
| • | window.richeditmode, TEXTOPUTINRICHEDITWINDOW |
| • | window.richeditheight, HEIGHTOFWINDOW |
| • | window.richeditwidth, WIDTHOFWINDOW |
| • | setshowallmode - tells farr to display ALL results returned by the plugin |
| • | resultcount NUMERICVAL - tells farr how many results to display in window |
| • | reporterror, ERRORTEXTTOREPORTINPLUGINLOG |
| • | clipboard - set internal clipboard text (referred to by $$c or %cliptext%) |
| • | PasteClipboardToLastActiveWindow,[TEXTTOSET] - paste the current clipboard text to the last active program (if value passed is not "" then clipboard will first be set to value). |
| • | DisplayAlertMessage, TEXTTOSHOWINALERT (use \n to separate lines with first line being title) - this shows a non-modal alert box in lower right of screen that will fade away. |
| • | DisplayAlertMessageNoTimeout, TEXTTOSHOWINALERT (use \n to separate lines with first line being title) - this shows a non-modal alert box in lower right of screen that will NOT fade away (requires user click). |
| • | DisplayMsgBox, TEXTTOSHOWINALERT (use \n to separate lines with first line being title) - this shows a simple MODAL messagebox with OK button; all FARR processing halts until user hits Ok. |
| • | DisplayBalloonMessage, TEXTTOSHOWINBALLOON (use \n to separate lines with first line being title) - this shows a non-modal system tray balloon message above FARR icon. |
| • | EmbeddedWb.ExecJavascript, JAVASCRIPT CALL TO MAKE - executes some javascript on the loaded page |
| • | (this tries to call back the plugin function set_strvalue("ExecJavascriptResult",returnvaluestring); |
| • | DockUserView.ByHandle, POINTERTOWINDOWHANDLE - tells FARR to capture the window handle passed and take over as its parent. Your plugin then needs to call "launch","setviewmode user" to display the newly docked window. It is safe to call this multiple times, only the first time will it be acted upon. |
| • | UndockUserView - tells FARR to undock the docked window and release it with no parent. |
| • | receivekeys - tells FARR that the plugin should receive special keys (function keys, etc); when the display is in html mode or richedit memo mode; a plugin should call this before switching to html or richedit memo mode. |
| • | addmenu.MENUNAME, MENUSTRING -- tells farr to add items (buttons/menus) to either the statusbar, or a result context menu. for more information see the help page on Adding Custom Menu/Button Items. |
| • | postpluginlaunch LAUNCHSTRING - tells farr to run the following launchstring AFTER the plugins have finished running; most useful if you want to unload the plugin itself using "preload pluginname\n" |
| • | ForceResultFilter - sets the search string used to filter and score returned results from a plugin (as if user had typed that string into search) |
|