PxHelpUrl()

Display help information identified by a URL

Synopsis:

#include <photon/PxHelp.h>

int PxHelpUrl( char *url );

Description:

PxHelpUrl() tells the Helpviewer to display the help text located by the given Universal Resource Locator. If the URL is relative (i.e. it doesn't start with a /), it's appended to any partial URL root specified in a previous call to PxHelpUrlRoot().

PxHelpUrl() spawns the Helpviewer if it isn't running, or sends a message to the Helpviewer if it is. Using this function, a Photon application can respond to a help request from the user by telling the Helpviewer to display the relevant help information.

Returns:

0 on success, or -1 if the Helpviewer couldn't be found or spawned.

PxHelpUrl() returns immediately, before the help topic has been displayed.

Examples:

The following example shows a fragment from a hypothetical application built using PhAB. This application first sets up a URL root for all help requests; it then displays help for a particular part of the application in response to a callback (which could be attached to a hotkey, for example).

#include <Pt.h>
#include <photon/PxHelp.h>

void main( void )
{
    ...
    PxHelpUrlRoot(
       "/usr/help/product/photon/user_guide/desktop_man.html" );
    ...
}

int HelpCallback( PtWidget_t * widget, ApInfo_t * apinfo, 
                  PtCallbackInfo_t * cbinfo )
{
    ...
    if( widget == ABW_PDMConsole )
        PxHelpUrl( "#CONSOLESELECTOR" );
    ...
    return( Pt_CONTINUE );
}

Classification:

Photon

See also:

PxHelpQuit(), PxHelpSearch(), PxHelpTopic(), PxHelpTopicRoot(), PxHelpTopicTree(), PxHelpUrlRoot()

Context-Sensitive Help chapter of the Photon Programmer's Guide