us_help.cpp

Go to the documentation of this file.

#include "us_help.h"
#include "us_settings.h"

// Null constructor
US_Help::US_Help( QObject* parent ) : QObject( parent ) { }

// Show a specified help page in US3 manual
void US_Help::show_help( const QString& helpFile )
{
  // Create a new process each time.  If show_help() is called multiple
  // times from a process, the previous process will become unavailable,
  // but we don't use it.  It's a 'memory leak', but should be minimal.
  // This is done because a QProcess can't be started multiple times
  // and we would still need a way to get the helpFile to assistant.
  // QProcess is a link to the daemon and is each program that calls
  // help needs its own Qprocess instance.

  // If we wanted to clean up, we would need to do something like the
  // following (not tested).  This seems like a lot of work for
  // little gain.
  
  // header:
  // QList< QProcess*> processes;
  
  // here:
  // assistant = new QProcess;
  // processes << assistant;
  // connect( assistant, SIGNAL(  finished  ( int, QProcess::ExitStatus ) )
  //        ( this     , SLOT  (  endProcess( ( int, QProcess::ExitStatus ) ) );
  
  // Function ( note that we don't really need status
  // void US_Help::end_process( int, QProcess::ExitStatus ) 
  // {
  //    for ( int i = processes.size() - 1; i >= 0; i-- )
  //    {
  //       if ( processes[ i ]->state() == QProcess::NotRunning )
  //       {
  //          delete processes[ i ];
  //          processes.takeAt( i );
  //       }
  //    }
  // }

  assistant = new QProcess;
  QStringList args;
  args << helpFile;

  // This us_helpdaemon will check if an instance is already running and
  // exit immediately if it is.

#ifndef Q_WS_MAC
  assistant->start( "us_helpdaemon", args );
#else
  QString helpbin = US_Settings::appBaseDir() + "/bin/us_helpdaemon";
  QString helpapp = helpbin + ".app";
  if ( QFile( helpapp ).exists() )
    assistant->start( helpapp, args );
  else
    assistant->start( helpbin, args );
#endif
  // Don't bother to wait
}

// Show a specified URL in the user's configured browser
void US_Help::show_URL( const QString& location )
{
   openBrowser( location );
}

// Show a specified HTML file in the user's configured browser
void US_Help::show_html_file( const QString& location )
{
   openBrowser( "file://" + location );
}

// Open a web page or file in the user's configured browser
void US_Help::openBrowser( const QString& location )
{
   QProcess*   proc    = new QProcess( this );
   QString     program = US_Settings::browser();
   QStringList args;

#ifndef Q_WS_MAC
   args << location;
#else
   args << "-a" << program << location;
   program = "open";
#endif

   proc->start( program, args );

   if ( !proc->waitForStarted( 10000 ) )
   {
      QMessageBox::warning( 0,
         tr( "Ultrascan III Error" ),
         tr( "Cannot start browser window ...\n"
             "Please insure you have the configured browser installed.\n\n"
             "  Configured browser: %1\n"
             "  URL: %2" ).arg( program ).arg( location ) );
   }
}