akregator/src

Public Types | Public Slots | Public Member Functions | Public Attributes | Protected Slots | Protected Member Functions | Friends | List of all members
Akregator::ArticleViewer Class Reference

#include <articleviewer.h>

Inherits Akregator::Viewer.

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 (TQWidget *parent, const char *name)
 
virtual bool openURL (const KURL &url)
 
void reload ()
 
void displayAboutPage ()
 
void renderContent (const TQString &body)
 
TQString formatArticleNormalMode (Feed *feed, const Article &article)
 
TQString 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
 
TQString m_normalModeCSS
 
TQString m_combinedModeCSS
 
TQString m_htmlFooter
 
TQString 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 TQValueList< Article > &list)
 
void slotArticlesAdded (TreeNode *node, const TQValueList< Article > &list)
 
void slotArticlesRemoved (TreeNode *node, const TQValueList< Article > &list)
 

Protected Member Functions

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

Friends

class ShowNodeSummaryVisitor
 

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.

Member Enumeration Documentation

◆ ViewMode

enum Akregator::ArticleViewer::ViewMode

Definition at line 150 of file articleviewer.h.

Constructor & Destructor Documentation

◆ ArticleViewer()

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

Constructor.

Definition at line 161 of file articleviewer.cpp.

◆ ~ArticleViewer()

Akregator::ArticleViewer::~ArticleViewer ( )
virtual

Definition at line 185 of file articleviewer.cpp.

Member Function Documentation

◆ beginWriting()

void Akregator::ArticleViewer::beginWriting ( )

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

Definition at line 594 of file articleviewer.cpp.

◆ connectToNode()

void Akregator::ArticleViewer::connectToNode ( TreeNode *  node)

Definition at line 764 of file articleviewer.cpp.

◆ disconnectFromNode()

void Akregator::ArticleViewer::disconnectFromNode ( TreeNode *  node)

Definition at line 782 of file articleviewer.cpp.

◆ displayAboutPage()

void Akregator::ArticleViewer::displayAboutPage ( )

Definition at line 368 of file articleviewer.cpp.

◆ endWriting()

void Akregator::ArticleViewer::endWriting ( )

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

Definition at line 603 of file articleviewer.cpp.

◆ formatArticleCombinedMode()

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

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

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

Definition at line 497 of file articleviewer.cpp.

◆ formatArticleNormalMode()

TQString 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
feedarticle's feed (used for feed icon atm) – article.feed() would do. better use a (No)Icon flag. -fo
articleThe article to render
Returns
the rendered article as HTML

Definition at line 404 of file articleviewer.cpp.

◆ generateCombinedModeCSS()

void Akregator::ArticleViewer::generateCombinedModeCSS ( )

generates the CSS for combined view mode

Definition at line 269 of file articleviewer.cpp.

◆ generateNormalModeCSS()

void Akregator::ArticleViewer::generateNormalModeCSS ( )

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

Definition at line 190 of file articleviewer.cpp.

◆ keyPressEvent()

void Akregator::ArticleViewer::keyPressEvent ( TQKeyEvent *  e)
protectedvirtual

Definition at line 739 of file articleviewer.cpp.

◆ openURL()

bool Akregator::ArticleViewer::openURL ( const KURL &  url)
virtual

Definition at line 355 of file articleviewer.cpp.

◆ reload()

void Akregator::ArticleViewer::reload ( )

Repaints the view.

Definition at line 348 of file articleviewer.cpp.

◆ renderContent()

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

renders body.

Use this method whereever possible.

Parameters
bodyhtml to render, without header and footer

Definition at line 584 of file articleviewer.cpp.

◆ slotArticlesAdded

void Akregator::ArticleViewer::slotArticlesAdded ( TreeNode *  node,
const TQValueList< Article > &  list 
)
protectedslot

Definition at line 694 of file articleviewer.cpp.

◆ slotArticlesRemoved

void Akregator::ArticleViewer::slotArticlesRemoved ( TreeNode *  node,
const TQValueList< Article > &  list 
)
protectedslot

Definition at line 698 of file articleviewer.cpp.

◆ slotArticlesUpdated

void Akregator::ArticleViewer::slotArticlesUpdated ( TreeNode *  node,
const TQValueList< Article > &  list 
)
protectedslot

Definition at line 688 of file articleviewer.cpp.

◆ slotClear

void Akregator::ArticleViewer::slotClear ( )
slot

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

Definition at line 710 of file articleviewer.cpp.

◆ slotPaletteOrFontChanged

void Akregator::ArticleViewer::slotPaletteOrFontChanged ( )
virtualslot

Definition at line 757 of file articleviewer.cpp.

◆ slotSetFilter

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
textFiltertext filter
statusFilterstatus filter

Definition at line 643 of file articleviewer.cpp.

◆ slotShowArticle

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

Show single article (normal view)

Parameters
articlethe article to render

Definition at line 630 of file articleviewer.cpp.

◆ slotShowNode

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
nodeThe node to observe

Definition at line 719 of file articleviewer.cpp.

◆ slotShowSummary

void Akregator::ArticleViewer::slotShowSummary ( TreeNode *  node)
slot

Definition at line 610 of file articleviewer.cpp.

◆ slotUpdateCombinedView

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 654 of file articleviewer.cpp.

◆ urlSelected()

void Akregator::ArticleViewer::urlSelected ( const TQString &  url,
int  button,
int  state,
const TQString &  _target,
KParts::URLArgs  args 
)
protectedvirtual

Definition at line 744 of file articleviewer.cpp.

Friends And Related Function Documentation

◆ ShowNodeSummaryVisitor

friend class ShowNodeSummaryVisitor
friend

Definition at line 106 of file articleviewer.h.

Member Data Documentation

◆ m_article

Article Akregator::ArticleViewer::m_article

Definition at line 146 of file articleviewer.h.

◆ m_combinedModeCSS

TQString Akregator::ArticleViewer::m_combinedModeCSS

Definition at line 141 of file articleviewer.h.

◆ m_currentText

TQString Akregator::ArticleViewer::m_currentText

Definition at line 143 of file articleviewer.h.

◆ m_htmlFooter

TQString Akregator::ArticleViewer::m_htmlFooter

Definition at line 142 of file articleviewer.h.

◆ m_imageDir

KURL Akregator::ArticleViewer::m_imageDir

Definition at line 144 of file articleviewer.h.

◆ m_link

KURL Akregator::ArticleViewer::m_link

Definition at line 147 of file articleviewer.h.

◆ m_node

TreeNode* Akregator::ArticleViewer::m_node

Definition at line 145 of file articleviewer.h.

◆ m_normalModeCSS

TQString Akregator::ArticleViewer::m_normalModeCSS

Definition at line 140 of file articleviewer.h.

◆ m_showSummaryVisitor

ShowSummaryVisitor* Akregator::ArticleViewer::m_showSummaryVisitor

Definition at line 108 of file articleviewer.h.

◆ m_statusFilter

Akregator::Filters::ArticleMatcher Akregator::ArticleViewer::m_statusFilter

Definition at line 149 of file articleviewer.h.

◆ m_textFilter

Akregator::Filters::ArticleMatcher Akregator::ArticleViewer::m_textFilter

Definition at line 148 of file articleviewer.h.

◆ m_viewMode

ViewMode Akregator::ArticleViewer::m_viewMode

Definition at line 151 of file articleviewer.h.

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