akregator/src

Akregator::ArticleViewer

Akregator::ArticleViewer Class Reference

#include <articleviewer.h>

Inheritance diagram for Akregator::ArticleViewer:

Akregator::Viewer List of all members.

Detailed Description

This HTML viewer is used to display articles.

Use the high-level interface provided by the public slots whereever possible (and extend them when necessary instead of using low-level methods).

Definition at line 48 of file articleviewer.h.


Public Types

enum  ViewMode { NormalView, CombinedView, SummaryView }

Public Slots

void slotShowArticle (const Article &article)
void slotShowNode (TreeNode *node)
void slotSetFilter (const Akregator::Filters::ArticleMatcher &textFilter, const Akregator::Filters::ArticleMatcher &statusFilter)
void slotUpdateCombinedView ()
void slotClear ()
void slotShowSummary (TreeNode *node)
virtual void slotPaletteOrFontChanged ()

Public Member Functions

 ArticleViewer (QWidget *parent, const char *name)
virtual ~ArticleViewer ()
virtual bool openURL (const KURL &url)
void reload ()
void displayAboutPage ()
void renderContent (const QString &body)
QString formatArticleNormalMode (Feed *feed, const Article &article)
QString formatArticleCombinedMode (Feed *feed, const Article &article)
void beginWriting ()
void endWriting ()
void generateNormalModeCSS ()
void generateCombinedModeCSS ()
void connectToNode (TreeNode *node)
void disconnectFromNode (TreeNode *node)

Public Attributes

ShowSummaryVisitor * m_showSummaryVisitor
QString m_normalModeCSS
QString m_combinedModeCSS
QString m_htmlFooter
QString m_currentText
KURL m_imageDir
TreeNode * m_node
Article m_article
KURL m_link
Akregator::Filters::ArticleMatcher m_textFilter
Akregator::Filters::ArticleMatcher m_statusFilter
ViewMode m_viewMode

Protected Slots

void slotArticlesUpdated (TreeNode *node, const QValueList< Article > &list)
void slotArticlesAdded (TreeNode *node, const QValueList< Article > &list)
void slotArticlesRemoved (TreeNode *node, const QValueList< Article > &list)

Protected Member Functions

virtual void keyPressEvent (QKeyEvent *e)
virtual void urlSelected (const QString &url, int button, int state, const QString &_target, KParts::URLArgs args)

Friends

class ShowNodeSummaryVisitor

Constructor & Destructor Documentation

Akregator::ArticleViewer::ArticleViewer (  QWidget *  parent,
const char *  name
) 
 

Constructor.

Definition at line 160 of file articleviewer.cpp.

Member Function Documentation

void Akregator::ArticleViewer::beginWriting (   ) 
 

Resets the canvas and adds writes the HTML header to it.

Definition at line 593 of file articleviewer.cpp.

void Akregator::ArticleViewer::endWriting (   ) 
 

Finishes writing to the canvas and completes the HTML (by adding closing tags).

Definition at line 602 of file articleviewer.cpp.

QString Akregator::ArticleViewer::formatArticleCombinedMode (  Feed *  feed,
const Article &  article
) 
 

Takes an article and renders it as HTML with settings for combined view.

Parameters:
feed article's feed (used for feed icon atm) -- article.feed() would do. better use a (No)Icon flag. -fo
article The article to render
Returns:
the rendered article as HTML

Definition at line 496 of file articleviewer.cpp.

QString Akregator::ArticleViewer::formatArticleNormalMode (  Feed *  feed,
const Article &  article
) 
 

Takes an article and renders it as HTML with settings for normal view and widescreen view.

Parameters:
feed article's feed (used for feed icon atm) -- article.feed() would do. better use a (No)Icon flag. -fo
article The article to render
Returns:
the rendered article as HTML

Definition at line 403 of file articleviewer.cpp.

void Akregator::ArticleViewer::generateCombinedModeCSS (   ) 
 

generates the CSS for combined view mode

Definition at line 268 of file articleviewer.cpp.

void Akregator::ArticleViewer::generateNormalModeCSS (   ) 
 

generates the CSS used for rendering in single article mode (normal and wide screen view)

Definition at line 189 of file articleviewer.cpp.

void Akregator::ArticleViewer::reload (   ) 
 

Repaints the view.

Definition at line 347 of file articleviewer.cpp.

void Akregator::ArticleViewer::renderContent (  const QString &  body  ) 
 

renders body.

Use this method whereever possible.

Parameters:
body html to render, without header and footer

Definition at line 583 of file articleviewer.cpp.

void Akregator::ArticleViewer::slotClear (   )  [slot]
 

Clears the canvas and disconnects from the currently observed node (if in combined view mode).

Definition at line 709 of file articleviewer.cpp.

void Akregator::ArticleViewer::slotSetFilter (  const Akregator::Filters::ArticleMatcher &  textFilter,
const Akregator::Filters::ArticleMatcher &  statusFilter
)  [slot]
 

Set filters textFilter and statusFilter which will be used if the viewer is in combined view mode.

Parameters:
textFilter text filter
statusFilter status filter

Definition at line 642 of file articleviewer.cpp.

void Akregator::ArticleViewer::slotShowArticle (  const Article &  article  )  [slot]
 

Show single article (normal view).

Parameters:
article the article to render

Definition at line 629 of file articleviewer.cpp.

void Akregator::ArticleViewer::slotShowNode (  TreeNode *  node  )  [slot]
 

Shows the articles of the tree node node (combined view).

Changes in the node will update the view automatically.

Parameters:
node The node to observe

Definition at line 718 of file articleviewer.cpp.

void Akregator::ArticleViewer::slotUpdateCombinedView (   )  [slot]
 

Update view if combined view mode is set.

Has to be called when the displayed node gets modified.

Definition at line 653 of file articleviewer.cpp.

void Akregator::ArticleViewer::urlSelected (  const QString &  url,
int  button,
int  state,
const QString &  _target,
KParts::URLArgs  args
)  [protected, virtual]
 

reimplemented to handle url selection according to the settings for LMB and MMB

Reimplemented from Akregator::Viewer.

Definition at line 743 of file articleviewer.cpp.

The documentation for this class was generated from the following files:

akregator/src

API Dox
KDE Home | KDE Accessibility Home | Description of Access Keys