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     mState = Docu;
  76     return KHTMLPart::openUrl( url );
  77 }
  78
  79 void View::saveState( QDataStream &stream )
  80 {
  81     stream << mState;
  82     if ( mState == Docu )
  83         KHTMLPart::saveState( stream );
  84 }
  85
  86 void View::restoreState( QDataStream &stream )
  87 {
  88     stream >> mState;
  89     if ( mState == Docu )
  90         KHTMLPart::restoreState( stream );
  91 }
  92
  93 QString View::langLookup( const QString &fname )
  94 {
  95     QStringList search;
  96
  97     // assemble the local search paths
  98     const QStringList localDoc = KGlobal::dirs()->resourceDirs("html");
  99
 100     // look up the different languages
 101     for (int id=localDoc.count()-1; id >= 0; --id)
 102     {
 103         QStringList langs = KGlobal::locale()->languageList();
 104         langs.append( "en" );
 105         langs.removeAll( "C" );
 106         QStringList::ConstIterator lang;
 107         for (lang = langs.constBegin(); lang != langs.constEnd(); ++lang)
 108             search.append(QString("%1%2/%3").arg(localDoc[id]).arg(*lang).arg(fname));
 109     }
 110
 111     // try to locate the file
 112     QStringList::Iterator it;
 113     for (it = search.begin(); it != search.end(); ++it)
 114     {
 115         QFileInfo info(*it);
 116         if (info.exists() && info.isFile() && info.isReadable())
 117             return *it;
 118
 119                 QString file = (*it).left((*it).lastIndexOf('/')) + "/index.docbook";
 120                 info.setFile(file);
 121                 if (info.exists() && info.isFile() && info.isReadable())
 122                         return *it;
 123     }
 124
 125     return QString();
 126 }
 127
 128 void View::setTitle( const QString &title )
 129 {
 130     mTitle = title;
 131 }
 132
 133 void View::beginSearchResult()
 134 {
 135   mState = Search;
 136
 137   begin();
 138   mSearchResult = "";
 139 }
 140
 141 void View::writeSearchResult( const QString &str )
 142 {
 143   write( str );
 144   mSearchResult += str;
 145 }
 146
 147 void View::endSearchResult()
 148 {
 149   end();
 150   if ( !mSearchResult.isEmpty() ) emit searchResultCacheAvailable();
 151 }
 152
 153 void View::beginInternal( const KUrl &url )
 154 {
 155   mInternalUrl = url;
 156   begin();
 157 }
 158
 159 KUrl View::internalUrl() const
 160 {
 161   return mInternalUrl;
 162 }
 163
 164 void View::lastSearch()
 165 {
 166   if ( mSearchResult.isEmpty() ) return;
 167
 168   mState = Search;
 169
 170   begin();
 171   write( mSearchResult );
 172   end();
 173 }
 174
 175 void View::slotIncFontSizes()
 176 {
 177   setZoomFactor( zoomFactor() + m_zoomStepping );
 178 }
 179
 180 void View::slotDecFontSizes()
 181 {
 182   setZoomFactor( zoomFactor() - m_zoomStepping );
 183 }
 184
 185 void View::showMenu( const QString& url, const QPoint& pos)
 186 {
 187   KMenu pop(view());
 188
 189   if (url.isEmpty())
 190   {
 191     QAction *action;
 192     action = mActionCollection->action("go_home");
 193     if (action) pop.addAction( action );
 194
 195     pop.addSeparator();
 196
 197     action = mActionCollection->action("prevPage");
 198     if (action) pop.addAction( action );
 199     action = mActionCollection->action("nextPage");
 200     if (action) pop.addAction( action);
 201
 202     pop.addSeparator();
 203
 204     pop.addAction( History::self().m_backAction );
 205     pop.addAction( History::self().m_forwardAction );
 206   }
 207   else
 208   {
 209     QAction *action = pop.addAction(i18n("Copy Link Address"));
 210     connect( action, SIGNAL( triggered() ), this, SLOT( slotCopyLink() ) );
 211
 212     mCopyURL = completeURL(url).url();
 213   }
 214
 215   pop.exec(pos);
 216 }
 217
 218 void View::slotCopyLink()
 219 {
 220   QApplication::clipboard()->setText(mCopyURL);
 221 }
 222
 223 bool View::prevPage(bool checkOnly)
 224 {
 225   const DOM::HTMLCollection links = htmlDocument().links();
 226
 227   KUrl prevURL;
 228
 229   // The first link on a page (top-left corner) would be the Prev link.
 230   if ( !baseURL().path().endsWith( "/index.html" ) )
 231     prevURL = urlFromLinkNode( links.item( 0 ) );
 232   else
 233     return false;
 234
 235   if (!prevURL.isValid())
 236     return false;
 237
 238   if (!checkOnly)
 239     openUrl( prevURL );
 240   return true;
 241 }
 242
 243 bool View::nextPage(bool checkOnly)
 244 {
 245   const DOM::HTMLCollection links = htmlDocument().links();
 246
 247   KUrl nextURL;
 248
 249   // If we're on the first page, the "Next" link is the second to the last link
 250   if ( baseURL().path().endsWith( "/index.html" ) )
 251     nextURL = urlFromLinkNode( links.item( links.length() - 2 ) );
 252   else
 253     nextURL = urlFromLinkNode( links.item( links.length() - 4 ) );
 254
 255   if (!nextURL.isValid())
 256     return false;
 257
 258   // If we get a mail link instead of a http URL, or the next link points
 259   // to an index.html page (a index.html page is always the first page
 260   // there can't be a Next link pointing to it!) there's probably nowhere
 261   // to go. Next link at all.
 262   if ( nextURL.protocol() == "mailto" ||
 263        nextURL.path().endsWith( "/index.html" ) )
 264     return false;
 265
 266   if (!checkOnly)
 267     openUrl( nextURL );
 268   return true;
 269 }
 270
 271 bool View::eventFilter( QObject *o, QEvent *e )
 272 {
 273   if ( e->type() != QEvent::KeyPress ||
 274        htmlDocument().links().length() == 0 )
 275     return KHTMLPart::eventFilter( o, e );
 276
 277   QKeyEvent *ke = static_cast<QKeyEvent *>( e );
 278   if ( ke->modifiers() & Qt::ShiftModifier && ke->key() == Qt::Key_Space ) {
 279     // If we're on the first page, it does not make sense to go back.
 280     if ( baseURL().path().endsWith( "/index.html" ) )
 281       return KHTMLPart::eventFilter( o, e );
 282
 283     const QScrollBar * const scrollBar = view()->verticalScrollBar();
 284     if ( scrollBar->value() == scrollBar->minimum() ) {
 285       if (prevPage())
 286          return true;
 287     }
 288   } else if ( ke->key() == Qt::Key_Space ) {
 289     const QScrollBar * const scrollBar = view()->verticalScrollBar();
 290     if ( scrollBar->value() == scrollBar->maximum() ) {
 291       if (nextPage())
 292         return true;
 293     }
 294   }
 295   return KHTMLPart::eventFilter( o, e );
 296 }
 297
 298 KUrl View::urlFromLinkNode( const DOM::Node &n ) const
 299 {
 300   if ( n.isNull() || n.nodeType() != DOM::Node::ELEMENT_NODE )
 301     return KUrl();
 302
 303   DOM::Element elem = static_cast<DOM::Element>( n );
 304
 305   KUrl href ( elem.getAttribute( "href" ).string() );
 306   if ( !href.protocol().isNull() )
 307     return href;
 308
 309   QString path = baseURL().path();
 310   path.truncate( path.lastIndexOf( '/' ) + 1 );
 311   path += href.url();
 312
 313   KUrl url = baseURL();
 314   url.setRef( QString() );
 315   url.setEncodedPathAndQuery( path );
 316
 317   return url;
 318 }
 319
 320 void View::slotReload( const KUrl &url )
 321 {
 322   const_cast<KHTMLSettings *>( settings() )->init( KGlobal::config().data() );
 323   KParts::OpenUrlArguments args = arguments();
 324   args.setReload( true );
 325   setArguments( args );
 326   if ( url.isEmpty() )
 327     openUrl( baseURL() );
 328   else
 329     openUrl( url );
 330 }
 331
 332 #include "view.moc"
 333 // vim:ts=2:sw=2:et