runtime/khelpcenter/view.cpp

   1 #include "view.h"
   2
   3 #include "formatter.h"
   4 #include "history.h"
   5
   6 #include <dom/html_document.h>
   7 #include <dom/html_misc.h>
   8 #include <kaction.h>
   9 #include <kactioncollection.h>
  10 #include <kapplication.h>
  11 #include <kdebug.h>
  12 #include <khtml_settings.h>
  13 #include <khtmlview.h>
  14 #include <klocale.h>
  15 #include <kmenu.h>
  16 #include <kstandarddirs.h>
  17 #include <ktoolbarpopupaction.h>
  18
  19 #include <QFileInfo>
  20 #include <QClipboard>
  21 //Added by qt3to4:
  22 #include <QTextStream>
  23 #include <QKeyEvent>
  24 #include <QEvent>
  25 #include <kglobal.h>
  26
  27 using namespace KHC;
  28
  29 View::View( QWidget *parentWidget, QObject *parent, KHTMLPart::GUIProfile prof, KActionCollection *col )
  30     : KHTMLPart( parentWidget, parent, prof ), mState( Docu ), mActionCollection(col)
  31 {
  32     setJScriptEnabled(false);
  33     setJavaEnabled(false);
  34     setPluginsEnabled(false);
  35
  36     mFormatter = new Formatter;
  37     if ( !mFormatter->readTemplates() ) {
  38       kDebug() << "Unable to read Formatter templates.";
  39     }
  40
  41     m_zoomStepping = 10;
  42
  43     connect( this, SIGNAL( setWindowCaption( const QString & ) ),
  44              this, SLOT( setTitle( const QString & ) ) );
  45     connect( this, SIGNAL( popupMenu( const QString &, const QPoint& ) ),
  46              this, SLOT( showMenu( const QString &, const QPoint& ) ) );
  47
  48     QString css = langLookup("common/kde-default.css");
  49     if (!css.isEmpty())
  50     {
  51        QFile css_file(css);
  52        if (css_file.open(QIODevice::ReadOnly))
  53        {
  54           QTextStream s(&css_file);
  55           QString stylesheet = s.readAll();
  56           preloadStyleSheet("help:/common/kde-default.css", stylesheet);
  57        }
  58     }
  59
  60     view()->installEventFilter( this );
  61 }
  62
  63 View::~View()
  64 {
  65   delete mFormatter;
  66 }
  67
  68 void View::copySelectedText()
  69 {
  70   kapp->clipboard()->setText( selectedText() );
  71 }
  72
  73 bool View::openUrl( const KUrl &url )
  74 {
  75     if ( url.protocol().toLower() == "about" )
  76     {
  77         showAboutPage();
  78         return true;
  79     }
  80     mState = Docu;
  81     return KHTMLPart::openUrl( url );
  82 }
  83
  84 void View::saveState( QDataStream &stream )
  85 {
  86     stream << mState;
  87     if ( mState == Docu )
  88         KHTMLPart::saveState( stream );
  89 }
  90
  91 void View::restoreState( QDataStream &stream )
  92 {
  93     stream >> mState;
  94     if ( mState == Docu )
  95         KHTMLPart::restoreState( stream );
  96     else if ( mState == About )
  97         showAboutPage();
  98 }
  99
 100 void View::showAboutPage()
 101 {
 102     QString file = KStandardDirs::locate( "data", "khelpcenter/intro.html.in" );
 103     if ( file.isEmpty() )
 104         return;
 105
 106     QFile f( file );
 107
 108     if ( !f.open( QIODevice::ReadOnly ) )
 109     return;
 110
 111     mState = About;
 112
 113     emit started( 0 );
 114
 115     QTextStream t( &f );
 116
 117     QString res = t.readAll();
 118
 119     res = res.arg( i18n("Conquer your Desktop!") )
 120           .arg( langLookup( "khelpcenter/konq.css" ) )
 121           .arg( langLookup( "khelpcenter/pointers.png" ) )
 122           .arg( langLookup( "khelpcenter/khelpcenter.png" ) )
 123           .arg( i18n("Help Center") )
 124           .arg( langLookup( "khelpcenter/lines.png" ) )
 125           .arg( i18n( "Welcome to the K Desktop Environment" ) )
 126           .arg( i18n( "The KDE team welcomes you to user-friendly UNIX computing" ) )
 127           .arg( i18n( "KDE is a powerful graphical desktop environment for UNIX workstations. A\n"
 128                       "KDE desktop combines ease of use, contemporary functionality and outstanding\n"
 129                       "graphical design with the technological superiority of the UNIX operating\n"
 130                       "system." ) )
 131           .arg( i18n( "What is the K Desktop Environment?" ) )
 132           .arg( i18n( "Contacting the KDE Project" ) )
 133           .arg( i18n( "Supporting the KDE Project" ) )
 134           .arg( i18n( "Useful links" ) )
 135           .arg( i18n( "Getting the most out of KDE" ) )
 136           .arg( i18n( "General Documentation" ) )
 137           .arg( i18n( "A Quick Start Guide to the Desktop" ) )
 138           .arg( i18n( "KDE Users' guide" ) )
 139           .arg( i18n( "Frequently asked questions" ) )
 140           .arg( i18n( "Basic Applications" ) )
 141           .arg( i18n( "The Kicker Desktop Panel" ) )
 142           .arg( i18n( "The KDE Control Center" ) )
 143           .arg( i18n( "The Konqueror File manager and Web Browser" ) )
 144           .arg( langLookup( "khelpcenter/kdelogo2.png" ) );
 145     begin( KUrl( "about:khelpcenter" ) );
 146     write( res );
 147     end();
 148     emit completed();
 149 }
 150
 151 QString View::langLookup( const QString &fname )
 152 {
 153     QStringList search;
 154
 155     // assemble the local search paths
 156     const QStringList localDoc = KGlobal::dirs()->resourceDirs("html");
 157
 158     // look up the different languages
 159     for (int id=localDoc.count()-1; id >= 0; --id)
 160     {
 161         QStringList langs = KGlobal::locale()->languageList();
 162         langs.append( "en" );
 163         langs.removeAll( "C" );
 164         QStringList::ConstIterator lang;
 165         for (lang = langs.begin(); lang != langs.end(); ++lang)
 166             search.append(QString("%1%2/%3").arg(localDoc[id]).arg(*lang).arg(fname));
 167     }
 168
 169     // try to locate the file
 170     QStringList::Iterator it;
 171     for (it = search.begin(); it != search.end(); ++it)
 172     {
 173         QFileInfo info(*it);
 174         if (info.exists() && info.isFile() && info.isReadable())
 175             return *it;
 176
 177                 QString file = (*it).left((*it).lastIndexOf('/')) + "/index.docbook";
 178                 info.setFile(file);
 179                 if (info.exists() && info.isFile() && info.isReadable())
 180                         return *it;
 181     }
 182
 183     return QString();
 184 }
 185
 186 void View::setTitle( const QString &title )
 187 {
 188     mTitle = title;
 189 }
 190
 191 void View::beginSearchResult()
 192 {
 193   mState = Search;
 194
 195   begin();
 196   mSearchResult = "";
 197 }
 198
 199 void View::writeSearchResult( const QString &str )
 200 {
 201   write( str );
 202   mSearchResult += str;
 203 }
 204
 205 void View::endSearchResult()
 206 {
 207   end();
 208   if ( !mSearchResult.isEmpty() ) emit searchResultCacheAvailable();
 209 }
 210
 211 void View::beginInternal( const KUrl &url )
 212 {
 213   mInternalUrl = url;
 214   begin();
 215 }
 216
 217 KUrl View::internalUrl() const
 218 {
 219   return mInternalUrl;
 220 }
 221
 222 void View::lastSearch()
 223 {
 224   if ( mSearchResult.isEmpty() ) return;
 225
 226   mState = Search;
 227
 228   begin();
 229   write( mSearchResult );
 230   end();
 231 }
 232
 233 void View::slotIncFontSizes()
 234 {
 235   setZoomFactor( zoomFactor() + m_zoomStepping );
 236 }
 237
 238 void View::slotDecFontSizes()
 239 {
 240   setZoomFactor( zoomFactor() - m_zoomStepping );
 241 }
 242
 243 void View::showMenu( const QString& url, const QPoint& pos)
 244 {
 245   KMenu pop(view());
 246
 247   if (url.isEmpty())
 248   {
 249     QAction *action;
 250     action = mActionCollection->action("go_home");
 251     if (action) pop.addAction( action );
 252
 253     pop.addSeparator();
 254
 255     action = mActionCollection->action("prevPage");
 256     if (action) pop.addAction( action );
 257     action = mActionCollection->action("nextPage");
 258     if (action) pop.addAction( action);
 259
 260     pop.addSeparator();
 261
 262     pop.addAction( History::self().m_backAction );
 263     pop.addAction( History::self().m_forwardAction );
 264   }
 265   else
 266   {
 267     QAction *action = pop.addAction(i18n("Copy Link Address"));
 268     connect( action, SIGNAL( triggered() ), this, SLOT( slotCopyLink() ) );
 269
 270     mCopyURL = completeURL(url).url();
 271   }
 272
 273   pop.exec(pos);
 274 }
 275
 276 void View::slotCopyLink()
 277 {
 278   QApplication::clipboard()->setText(mCopyURL);
 279 }
 280
 281 bool View::prevPage(bool checkOnly)
 282 {
 283   const DOM::HTMLCollection links = htmlDocument().links();
 284
 285   // The first link on a page (top-left corner) would be the Prev link.
 286   const DOM::Node prevLinkNode = links.item( 0 );
 287   KUrl prevURL = urlFromLinkNode( prevLinkNode );
 288   if (!prevURL.isValid())
 289     return false;
 290
 291   if (!checkOnly)
 292     openUrl( prevURL );
 293   return true;
 294 }
 295
 296 bool View::nextPage(bool checkOnly)
 297 {
 298   const DOM::HTMLCollection links = htmlDocument().links();
 299
 300   KUrl nextURL;
 301
 302   // If we're on the first page, the "Next" link is the last link
 303   if ( baseURL().path().endsWith( "/index.html" ) )
 304     nextURL = urlFromLinkNode( links.item( links.length() - 1 ) );
 305   else
 306     nextURL = urlFromLinkNode( links.item( links.length() - 2 ) );
 307
 308   if (!nextURL.isValid())
 309     return false;
 310
 311   // If we get a mail link instead of a http URL, or the next link points
 312   // to an index.html page (a index.html page is always the first page
 313   // there can't be a Next link pointing to it!) there's probably nowhere
 314   // to go. Next link at all.
 315   if ( nextURL.protocol() == "mailto" ||
 316        nextURL.path().endsWith( "/index.html" ) )
 317     return false;
 318
 319   if (!checkOnly)
 320     openUrl( nextURL );
 321   return true;
 322 }
 323
 324 bool View::eventFilter( QObject *o, QEvent *e )
 325 {
 326   if ( e->type() != QEvent::KeyPress ||
 327        htmlDocument().links().length() == 0 )
 328     return KHTMLPart::eventFilter( o, e );
 329
 330   QKeyEvent *ke = static_cast<QKeyEvent *>( e );
 331   if ( ke->modifiers() & Qt::ShiftModifier && ke->key() == Qt::Key_Space ) {
 332     // If we're on the first page, it does not make sense to go back.
 333     if ( baseURL().path().endsWith( "/index.html" ) )
 334       return KHTMLPart::eventFilter( o, e );
 335
 336     const QScrollBar * const scrollBar = view()->verticalScrollBar();
 337     if ( scrollBar->value() == scrollBar->minimum() ) {
 338       if (prevPage())
 339          return true;
 340     }
 341   } else if ( ke->key() == Qt::Key_Space ) {
 342     const QScrollBar * const scrollBar = view()->verticalScrollBar();
 343     if ( scrollBar->value() == scrollBar->maximum() ) {
 344       if (nextPage())
 345         return true;
 346     }
 347   }
 348   return KHTMLPart::eventFilter( o, e );
 349 }
 350
 351 KUrl View::urlFromLinkNode( const DOM::Node &n ) const
 352 {
 353   if ( n.isNull() || n.nodeType() != DOM::Node::ELEMENT_NODE )
 354     return KUrl();
 355
 356   DOM::Element elem = static_cast<DOM::Element>( n );
 357
 358   KUrl href ( elem.getAttribute( "href" ).string() );
 359   if ( !href.protocol().isNull() )
 360     return href;
 361
 362   QString path = baseURL().path();
 363   path.truncate( path.lastIndexOf( '/' ) + 1 );
 364   path += href.url();
 365
 366   KUrl url = baseURL();
 367   url.setRef( QString() );
 368   url.setEncodedPathAndQuery( path );
 369
 370   return url;
 371 }
 372
 373 void View::slotReload( const KUrl &url )
 374 {
 375   const_cast<KHTMLSettings *>( settings() )->init( KGlobal::config().data() );
 376   KParts::OpenUrlArguments args = arguments();
 377   args.setReload( true );
 378   setArguments( args );
 379   if ( url.isEmpty() )
 380     openUrl( baseURL() );
 381   else
 382     openUrl( url );
 383 }
 384
 385 #include "view.moc"
 386 // vim:ts=2:sw=2:et