Integrated Help Support - Help Contents

VCF Framework Screenshots
Integrated Help Support - Help Contents

This screenshot (from the vcf/examples/Help example) show the Help integration that the VCF provides. You can bring up the Help Index or Help Contents through specific function calls, such as this code fragment: 

class HelpWindow : public Window {
public:
   

    HelpWindow() {
        setCaption( "Help" );

        CommandButton* showHelpContents = new CommandButton();

        showHelpContents->setBounds( 20, 20, 150, showHelpContents->getPreferredHeight() );
        showHelpContents->setCaption( "Help Contents" );
        showHelpContents->setWhatThisHelpString( "This displays the help contents." );
        add( showHelpContents );

        CommandButton* showHelpIndex = new CommandButton();

        showHelpIndex->setBounds( 20, 70, 150, showHelpIndex->getPreferredHeight() );
        showHelpIndex->setCaption( "Help Index" );
        add( showHelpIndex );

        showHelpContents->ButtonClicked += new GenericEventHandler<HelpWindow>( this, &HelpWindow::showContents, "HelpWindow::showContents" );
        showHelpIndex->ButtonClicked += new GenericEventHandler<HelpWindow>( this, &HelpWindow::showIndex, "HelpWindow::showIndex" );
       
    }

    void showContents( Event* e ) {
        UIToolkit::displayHelpContents();
    }

    void showIndex( Event* e ) {
        UIToolkit::displayHelpIndex();
    }

};

Note the calls to displayHelpContents() and displayHelpIndex(). These call the OS specific HTML routines. In this case we use the standard Win32 HTML Help facilities. Which means you can reuse your projects existing Help expertise, without having to learn some new process.