knode

KNode::ArticleWidget

KNode::ArticleWidget Class Reference

#include <articlewidget.h>

Inheritance diagram for KNode::ArticleWidget:

[legend]

List of all members.

Detailed Description

Widget to display a news article.

Definition at line 53 of file articlewidget.h.


Public Slots
void	scrollDown ()
void	scrollNext ()
void	scrollPrior ()
void	scrollUp ()
Public Member Functions
KNArticle *	article () const
	ArticleWidget (QWidget parent, KXMLGUIClient guiClient, KActionCollection *actionCollection)
bool	atBottom () const
void	readConfig ()
void	setArticle (KNArticle *article)
void	writeConfig ()
	~ArticleWidget ()
Static Public Member Functions
static void	articleChanged (KNArticle *article)
static void	articleLoadError (KNArticle *article, const QString &error)
static void	articleRemoved (KNArticle *article)
static bool	articleVisible (KNArticle *article)
static void	cleanup ()
static void	collectionRemoved (KNArticleCollection *coll)
static void	configChanged ()
Protected Member Functions
void	processJob (KNJobData *j)

Constructor & Destructor Documentation

ArticleWidget::ArticleWidget	(	QWidget *	parent,
		KXMLGUIClient *	guiClient,
		KActionCollection *	actionCollection
	)

Construct a new article widget.

Definition at line 85 of file articlewidget.cpp.

ArticleWidget::~ArticleWidget ( )

Destroy the article widget.

Definition at line 131 of file articlewidget.cpp.

Member Function Documentation

KNArticle* KNode::ArticleWidget::article ( ) const [inline]

returns the currently shown article

Definition at line 75 of file articlewidget.h.

void ArticleWidget::articleChanged ( KNArticle * article ) [static]

notify all instances that the given article has changed

Parameters:

article

The changed article.

Definition at line 1101 of file articlewidget.cpp.

void ArticleWidget::articleLoadError	(	KNArticle *	article,
		const QString &	error
	)			`[static]`

notify all instances about an error during loading the given article

Parameters:

	article	The article that couldn't be loaded.
	error	The error message.

Definition at line 1109 of file articlewidget.cpp.

void ArticleWidget::articleRemoved ( KNArticle * article ) [static]

notify all instances that the given article has been removed

Parameters:

article

The removed article.

Definition at line 1093 of file articlewidget.cpp.

bool ArticleWidget::articleVisible ( KNArticle * article ) [static]

check wether the given article is displayed in any instance

Parameters:

article

The article to check.

Definition at line 1084 of file articlewidget.cpp.

bool ArticleWidget::atBottom ( ) const

checks wether the readers is scrolled down to the bottom

Definition at line 1133 of file articlewidget.cpp.

void ArticleWidget::cleanup ( ) [static]

cleanup all instances

Definition at line 1125 of file articlewidget.cpp.

void ArticleWidget::collectionRemoved ( KNArticleCollection * coll ) [static]

notify all instances that the given collection has been removed

Parameters:

coll

The removed article collection (a group or a folder).

Definition at line 1117 of file articlewidget.cpp.

void ArticleWidget::configChanged ( ) [static]

notify all instances about a config change

Definition at line 1075 of file articlewidget.cpp.

void ArticleWidget::processJob ( KNJobData * j ) [protected, virtual]

process download jobs for view source action

Reimplemented from KNJobConsumer.

Definition at line 1053 of file articlewidget.cpp.

void ArticleWidget::readConfig ( )

read config settings

Definition at line 331 of file articlewidget.cpp.

void ArticleWidget::scrollDown ( ) [slot]

scroll down by one line

Definition at line 1144 of file articlewidget.cpp.

void ArticleWidget::scrollNext ( ) [slot]

scroll down by one page

Definition at line 1154 of file articlewidget.cpp.

void ArticleWidget::scrollPrior ( ) [slot]

scroll up by one page

Definition at line 1149 of file articlewidget.cpp.

void ArticleWidget::scrollUp ( ) [slot]

scroll up by one line

Definition at line 1139 of file articlewidget.cpp.

void ArticleWidget::setArticle ( KNArticle * article )

display the given article

Parameters:

article

The article to display.

Definition at line 371 of file articlewidget.cpp.

void ArticleWidget::writeConfig ( )

write config settings (call only for the main viewer)

Definition at line 355 of file articlewidget.cpp.

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

knode

KNode::ArticleWidget Class Reference

Detailed Description

Public Slots

Public Member Functions

Static Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

Member Function Documentation

knode

kdepim