helpwindow.cpp

Go to the documentation of this file.

//-------------------------------------------------------------
//        Go4 Release Package v3.04-01 (build 30401)
//                      28-November-2008
//---------------------------------------------------------------
//   The GSI Online Offline Object Oriented (Go4) Project
//   Experiment Data Processing at EE department, GSI
//---------------------------------------------------------------
//
//Copyright (C) 2000- Gesellschaft f. Schwerionenforschung, GSI
//                    Planckstr. 1, 64291 Darmstadt, Germany
//Contact:            http://go4.gsi.de
//----------------------------------------------------------------
//This software can be used under the license agreements as stated
//in Go4License.txt file which is part of the distribution.
//----------------------------------------------------------------
#include "helpwindow.h"

#include "TSystem.h"

#include "qtextbrowser.h"
#include "qdir.h"
#include "qstatusbar.h"
#include "qmenubar.h"
#include "qtoolbutton.h"
#include "qfile.h"
#include "qmessagebox.h"
#include "qfiledialog.h"
#include "qapplication.h"
#include "qcombobox.h"
#include "qprinter.h"
#include "qsimplerichtext.h"
#include "qpainter.h"
#include "qpaintdevicemetrics.h"

TGo4HelpWindow::TGo4HelpWindow( const QString& home_, QWidget* parent, const QString& subdir)
    : QMainWindow( parent, home_.latin1(), WDestructiveClose ),
      pathCombo( 0 ),
      selectedURL()
{
    readHistory();
    readBookmarks();

    browser = new QTextBrowser( this );

    _path = gSystem->Getenv("GO4SYS");
    _path.append("/docs");
    if(!subdir.isEmpty())
      {
         _path.append("/");
         _path.append(subdir);
      }
    browser->mimeSourceFactory()->setFilePath( _path );
    browser->setFrameStyle( QFrame::Panel | QFrame::Sunken );
    connect( browser, SIGNAL( textChanged() ),
        this, SLOT( textChanged() ) );

    setCentralWidget( browser );

    if ( !home_.isEmpty() )
    browser->setSource( home_ );

    connect( browser, SIGNAL( highlighted( const QString&) ),
        statusBar(), SLOT( message( const QString&)) );

    resize( 640,700 );


    QPopupMenu* file = new QPopupMenu( this );
    file->insertItem( tr("&Print"), this, SLOT( print() ), CTRL+Key_P );
    file->insertSeparator();
    file->insertItem( tr("&Close"), this, SLOT( close() ), CTRL+Key_Q );
    file->insertItem( tr("E&xit"), qApp, SLOT( closeAllWindows() ), CTRL+Key_X );

    // The same three icons are used twice each.
    QString picPath = gSystem->Getenv("GO4SYS");
    picPath.append("/images/");
    QIconSet icon_back(QPixmap(picPath + "back.xpm"));
    QIconSet icon_forward(QPixmap(picPath + "forward.xpm"));
    QIconSet icon_home(QPixmap(picPath + "home.xpm"));

    QPopupMenu* go = new QPopupMenu( this );
    backwardId = go->insertItem( icon_back,
             tr("&Backward"), browser, SLOT( backward() ),
             CTRL+Key_Left );
    forwardId = go->insertItem( icon_forward,
            tr("&Forward"), browser, SLOT( forward() ),
            CTRL+Key_Right );
    go->insertItem( icon_home, tr("&Home"), browser, SLOT( home() ) );

    QPopupMenu* help = new QPopupMenu( this );
    help->insertItem( tr("&About ..."), this, SLOT( about() ) );
    help->insertItem( tr("About &Qt ..."), this, SLOT( aboutQt() ) );

    hist = new QPopupMenu( this );
    QStringList::Iterator it = history.begin();
    for ( ; it != history.end(); ++it )
   mHistory[ hist->insertItem( *it ) ] = *it;
    connect( hist, SIGNAL( activated( int ) ),
        this, SLOT( histChosen( int ) ) );

    bookm = new QPopupMenu( this );
    bookm->insertItem( tr( "Add Bookmark" ), this, SLOT( addBookmark() ) );
    bookm->insertSeparator();

    QStringList::Iterator it2 = bookmarks.begin();
    for ( ; it2 != bookmarks.end(); ++it2 )
   mBookmarks[ bookm->insertItem( *it2 ) ] = *it2;
    connect( bookm, SIGNAL( activated( int ) ),
        this, SLOT( bookmChosen( int ) ) );

    menuBar()->insertItem( tr("&File"), file );
    menuBar()->insertItem( tr("&Go"), go );
    menuBar()->insertItem( tr( "History" ), hist );
    menuBar()->insertItem( tr( "Bookmarks" ), bookm );
    menuBar()->insertSeparator();
    menuBar()->insertItem( tr("&Help"), help );

    menuBar()->setItemEnabled( forwardId, FALSE);
    menuBar()->setItemEnabled( backwardId, FALSE);
    connect( browser, SIGNAL( backwardAvailable( bool ) ),
        this, SLOT( setBackwardAvailable( bool ) ) );
    connect( browser, SIGNAL( forwardAvailable( bool ) ),
        this, SLOT( setForwardAvailable( bool ) ) );


    QToolBar* toolbar = new QToolBar( this );
    addToolBar( toolbar, "Toolbar");
    QToolButton* button;

    button = new QToolButton( icon_back, tr("Backward"), "", browser, SLOT(backward()), toolbar );
    connect( browser, SIGNAL( backwardAvailable(bool) ), button, SLOT( setEnabled(bool) ) );
    button->setEnabled( FALSE );
    button = new QToolButton( icon_forward, tr("Forward"), "", browser, SLOT(forward()), toolbar );
    connect( browser, SIGNAL( forwardAvailable(bool) ), button, SLOT( setEnabled(bool) ) );
    button->setEnabled( FALSE );
    button = new QToolButton( icon_home, tr("Home"), "", browser, SLOT(home()), toolbar );

    toolbar->addSeparator();

    pathCombo = new QComboBox( TRUE, toolbar );
    connect( pathCombo, SIGNAL( activated( const QString & ) ),
        this, SLOT( pathSelected( const QString & ) ) );
    toolbar->setStretchableWidget( pathCombo );
    setRightJustification( TRUE );
    setDockEnabled( DockLeft, FALSE );
    setDockEnabled( DockRight, FALSE );

    pathCombo->insertItem( home_ );
    browser->setFocus();
}

void TGo4HelpWindow::setBackwardAvailable( bool b)
{
    menuBar()->setItemEnabled( backwardId, b);
}

void TGo4HelpWindow::setForwardAvailable( bool b)
{
    menuBar()->setItemEnabled( forwardId, b);
}

void TGo4HelpWindow::textChanged()
{
    browser->mimeSourceFactory()->setFilePath( _path );
    if ( browser->documentTitle().isNull() )
   setCaption( "Go4 - Helpviewer - " + browser->context() );
    else
   setCaption( "Go4 - Helpviewer - " + browser->documentTitle() ) ;

    selectedURL = browser->context();

    if ( !selectedURL.isEmpty() && pathCombo ) {
   bool exists = FALSE;
   int i;
   for ( i = 0; i < pathCombo->count(); ++i ) {
       if ( pathCombo->text( i ) == selectedURL ) {
      exists = TRUE;
      break;
       }
   }
   if ( !exists ) {
       pathCombo->insertItem( selectedURL, 0 );
       pathCombo->setCurrentItem( 0 );
       mHistory[ hist->insertItem( selectedURL ) ] = selectedURL;
   } else
       pathCombo->setCurrentItem( i );
   selectedURL = QString::null;
    }
}

TGo4HelpWindow::~TGo4HelpWindow()
{
    history.clear();
    QMap<int, QString>::Iterator it = mHistory.begin();
    for ( ; it != mHistory.end(); ++it )
   history.append( *it );

    QFile f( QDir::currentDirPath() + "/.history" );
    f.open( IO_WriteOnly );
    QDataStream s( &f );
    s << history;
    f.close();

    bookmarks.clear();
    QMap<int, QString>::Iterator it2 = mBookmarks.begin();
    for ( ; it2 != mBookmarks.end(); ++it2 )
   bookmarks.append( *it2 );

    QFile f2( QDir::currentDirPath() + "/.bookmarks" );
    f2.open( IO_WriteOnly );
    QDataStream s2( &f2 );
    s2 << bookmarks;
    f2.close();
}

void TGo4HelpWindow::about()
{
    QMessageBox::about( this, "Go4 Online Help",
         "Go4 Online Help"
         );
}

void TGo4HelpWindow::aboutQt()
{
  QMessageBox::aboutQt( this, "QBrowser" );
}

void TGo4HelpWindow::print()
{
#ifndef QT_NO_PRINTER
    QPrinter printer;
    printer.setFullPage(TRUE);
    if ( printer.setup( this ) ) {
   QPainter p( &printer );
   QPaintDeviceMetrics metrics(p.device());
   int dpix = metrics.logicalDpiX();
   int dpiy = metrics.logicalDpiY();
   const int margin = 72; // pt
   QRect body(margin*dpix/72, margin*dpiy/72,
         metrics.width()-margin*dpix/72*2,
         metrics.height()-margin*dpiy/72*2 );
   QSimpleRichText richText( browser->text(), QFont(), browser->context(), browser->styleSheet(),
              browser->mimeSourceFactory(), body.height() );
   richText.setWidth( &p, body.width() );
   QRect view( body );
   int page = 1;
   do {
       richText.draw( &p, body.left(), body.top(), view, colorGroup() );
       view.moveBy( 0, body.height() );
       p.translate( 0 , -body.height() );
       p.drawText( view.right() - p.fontMetrics().width( QString::number(page) ),
         view.bottom() + p.fontMetrics().ascent() + 5, QString::number(page) );
       if ( view.top()  >= richText.height() )
      break;
       printer.newPage();
       page++;
   } while (TRUE);
    }
#endif
}

void TGo4HelpWindow::pathSelected( const QString &_path )
{
    browser->setSource( _path );
    QMap<int, QString>::Iterator it = mHistory.begin();
    bool exists = FALSE;
    for ( ; it != mHistory.end(); ++it ) {
   if ( *it == _path ) {
       exists = TRUE;
       break;
   }
    }
    if ( !exists )
   mHistory[ hist->insertItem( _path ) ] = _path;
}

void TGo4HelpWindow::readHistory()
{
    if ( QFile::exists( QDir::currentDirPath() + "/.history" ) ) {
   QFile f( QDir::currentDirPath() + "/.history" );
   f.open( IO_ReadOnly );
   QDataStream s( &f );
   s >> history;
   f.close();
   while ( history.count() > 20 )
       history.remove( history.begin() );
    }
}

void TGo4HelpWindow::histChosen( int i )
{
   if ( mHistory.contains( i ) )
     browser->setSource( mHistory[ i ] );
}

void TGo4HelpWindow::bookmChosen( int i )
{
   if ( mBookmarks.contains( i ) )
     browser->setSource( mBookmarks[ i ] );
}

void TGo4HelpWindow::addBookmark()
{
    mBookmarks[ bookm->insertItem( caption() ) ] = browser->context();
}

void TGo4HelpWindow::readBookmarks()
{
   if ( QFile::exists( QDir::currentDirPath() + "/.bookmarks" ) ) {
      QFile f( QDir::currentDirPath() + "/.bookmarks" );
      f.open( IO_ReadOnly );
      QDataStream s( &f );
      s >> bookmarks;
      f.close();
   }
}



//----------------------------END OF GO4 SOURCE FILE ---------------------

---